github-migration
/
mongo-ruby-driver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

remove deprecated legacy object id support

This commit is contained in:
Kyle Banker 2010-02-23 12:53:53 -05:00
parent a7d4d5d277
commit 64a8b09c2e
1 changed files with 9 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
lib/mongo/types/objectid.rb
View File

@ -20,18 +20,10 @@ require 'digest/md5'
module Mongo module Mongo
# ObjectID class for documents in MongoDB. # Generates MongoDB object ids.
# #
# @core objectids # @core objectids
class ObjectID class ObjectID
# This is the legacy byte ordering for Babble. Versions of the Ruby
# driver prior to 0.14 used this byte ordering when converting ObjectID
# instances to and from strings. If you have string representations of
# ObjectIDs using the legacy byte ordering make sure to use the
# to_s_legacy and from_string_legacy methods, or convert your strings
# with ObjectID#legacy_string_convert
BYTE_ORDER = [7, 6, 5, 4, 3, 2, 1, 0, 11, 10, 9, 8]
@@lock = Mutex.new @@lock = Mutex.new
@@index = 0 @@index = 0
@ -46,8 +38,14 @@ module Mongo
@data = data || generate @data = data || generate
end end
# Determine if the supplied string is legal. Legal strings will
# consist of 24 hexadecimal characters.
#
# @param [String] str
#
# @return [Boolean]
def self.legal?(str) def self.legal?(str)
len = BYTE_ORDER.length * 2 len = 24
str =~ /([0-9a-f]+)/i str =~ /([0-9a-f]+)/i
match = $1 match = $1
str && str.length == len && match == str str && str.length == len && match == str
@ -117,21 +115,6 @@ module Mongo
self.new(data) self.new(data)
end end
# @deprecated
# Create a new ObjectID given a string representation of an ObjectID
# using the legacy byte ordering. This method may eventually be
# removed. If you are not sure that you need this method you should be
# using the regular from_string.
def self.from_string_legacy(str)
warn "Support for legacy object ids has been DEPRECATED."
raise InvalidObjectID, "illegal ObjectID format" unless legal?(str)
data = []
BYTE_ORDER.each_with_index { |string_position, data_index|
data[data_index] = str[string_position * 2, 2].to_i(16)
}
self.new(data)
end
# Get a string representation of this object id. # Get a string representation of this object id.
# #
# @return [String] # @return [String]
@ -152,33 +135,6 @@ module Mongo
"{\"$oid\": \"#{to_s}\"}" "{\"$oid\": \"#{to_s}\"}"
end end
# @deprecated
# Get a string representation of this ObjectID using the legacy byte
# ordering. This method may eventually be removed. If you are not sure
# that you need this method you should be using the regular to_s.
def to_s_legacy
warn "Support for legacy object ids has been DEPRECATED."
str = ' ' * 24
BYTE_ORDER.each_with_index { |string_position, data_index|
str[string_position * 2, 2] = '%02x' % @data[data_index]
}
str
end
# @deprecated
# Convert a string representation of an ObjectID using the legacy byte
# ordering to the proper byte ordering. This method may eventually be
# removed. If you are not sure that you need this method it is probably
# unnecessary.
def self.legacy_string_convert(str)
warn "Support for legacy object ids has been DEPRECATED."
legacy = ' ' * 24
BYTE_ORDER.each_with_index do |legacy_pos, pos|
legacy[legacy_pos * 2, 2] = str[pos * 2, 2]
end
legacy
end
# Return the UTC time at which this ObjectID was generated. This may # Return the UTC time at which this ObjectID was generated. This may
# be used in lieu of a created_at timestamp since this information # be used in lieu of a created_at timestamp since this information
# is always encoded in the object id. # is always encoded in the object id.