Class: BSON::ObjectId
- Inherits:
-
Object
- Object
- BSON::ObjectId
- Defined in:
- lib/bson/types/object_id.rb
Overview
Generates MongoDB object ids.
Constant Summary collapse
- @@lock =
Mutex.new
- @@index =
0
Instance Attribute Summary collapse
-
#data ⇒ Array
Get the array representation without cloning.
Class Method Summary collapse
-
.create_pk(doc) ⇒ Mongo::ObjectId, Object
Adds a primary key to the given document if needed.
-
.from_string(str) ⇒ Mongo::ObjectId
Given a string representation of an ObjectId, return a new ObjectId with that value.
-
.from_time(time) ⇒ Mongo::ObjectId
Create an object id from the given time.
-
.legal?(str) ⇒ Boolean
Determine if the supplied string is legal.
Instance Method Summary collapse
-
#as_json(options = {}) ⇒ Hash
Create the JSON hash structure convert to MongoDB extended format.
-
#eql?(object_id) ⇒ Boolean
(also: #==)
Check equality of this object id with another.
-
#generation_time ⇒ Time
Return the UTC time at which this ObjectId was generated.
-
#hash ⇒ Integer
Get a unique hashcode for this object.
-
#initialize(data = nil) ⇒ ObjectId
constructor
Create a new object id.
- #inspect ⇒ Object
-
#to_a ⇒ Array
Get an array representation of the object id.
-
#to_json(*a) ⇒ String
Convert to MongoDB extended JSON format.
-
#to_s ⇒ String
Get a string representation of this object id.
Constructor Details
#initialize(data = nil) ⇒ ObjectId
Create a new object id. If no parameter is given, an id corresponding to the ObjectId BSON data type will be created. This is a 12-byte value consisting of a 4-byte timestamp, a 3-byte machine id, a 2-byte process id, and a 3-byte counter.
43 44 45 |
# File 'lib/bson/types/object_id.rb', line 43 def initialize(data=nil) @data = data || generate end |
Instance Attribute Details
#data ⇒ Array
Get the array representation without cloning.
111 112 113 |
# File 'lib/bson/types/object_id.rb', line 111 def data @data end |
Class Method Details
.create_pk(doc) ⇒ Mongo::ObjectId, Object
Adds a primary key to the given document if needed.
81 82 83 |
# File 'lib/bson/types/object_id.rb', line 81 def self.create_pk(doc) doc.has_key?(:_id) || doc.has_key?('_id') ? doc : doc.merge!(:_id => self.new) end |
.from_string(str) ⇒ Mongo::ObjectId
Given a string representation of an ObjectId, return a new ObjectId with that value.
121 122 123 124 125 126 127 128 |
# File 'lib/bson/types/object_id.rb', line 121 def self.from_string(str) raise InvalidObjectId, "illegal ObjectId format" unless legal?(str) data = [] 12.times do |i| data[i] = str[i * 2, 2].to_i(16) end self.new(data) end |
.from_time(time) ⇒ Mongo::ObjectId
Create an object id from the given time. This is useful for doing range queries; it works because MongoDB’s object ids begin with a timestamp.
71 72 73 |
# File 'lib/bson/types/object_id.rb', line 71 def self.from_time(time) self.new([time.to_i,0,0].pack("NNN").unpack("C12")) end |
.legal?(str) ⇒ Boolean
Determine if the supplied string is legal. Legal strings will consist of 24 hexadecimal characters.
55 56 57 |
# File 'lib/bson/types/object_id.rb', line 55 def self.legal?(str) str =~ /^[0-9a-f]{24}$/i ? true : false end |
Instance Method Details
#as_json(options = {}) ⇒ Hash
Create the JSON hash structure convert to MongoDB extended format. Rails 2.3.3 introduced as_json to create the needed hash structure to encode objects into JSON.
157 158 159 |
# File 'lib/bson/types/object_id.rb', line 157 def as_json( ={}) {"$oid" => to_s} end |
#eql?(object_id) ⇒ Boolean Also known as: ==
Check equality of this object id with another.
88 89 90 |
# File 'lib/bson/types/object_id.rb', line 88 def eql?(object_id) @data == object_id.instance_variable_get("@data") end |
#generation_time ⇒ Time
Return the UTC time at which this ObjectId was generated. This may be used in lieu of a created_at timestamp since this information is always encoded in the object id.
166 167 168 |
# File 'lib/bson/types/object_id.rb', line 166 def generation_time Time.at(@data.pack("C4").unpack("N")[0]).utc end |
#hash ⇒ Integer
Get a unique hashcode for this object. This is required since we’ve defined an #eql? method.
97 98 99 |
# File 'lib/bson/types/object_id.rb', line 97 def hash @data.hash end |
#inspect ⇒ Object
141 142 143 |
# File 'lib/bson/types/object_id.rb', line 141 def inspect "BSON::ObjectId('#{to_s}')" end |
#to_a ⇒ Array
Get an array representation of the object id.
104 105 106 |
# File 'lib/bson/types/object_id.rb', line 104 def to_a @data.dup end |
#to_json(*a) ⇒ String
Convert to MongoDB extended JSON format. Since JSON includes type information, but lacks an ObjectId type, this JSON format encodes the type using an $oid key.
149 150 151 |
# File 'lib/bson/types/object_id.rb', line 149 def to_json(*a) "{\"$oid\": \"#{to_s}\"}" end |
#to_s ⇒ String
Get a string representation of this object id.
133 134 135 136 137 138 139 |
# File 'lib/bson/types/object_id.rb', line 133 def to_s str = ' ' * 24 12.times do |i| str[i * 2, 2] = '%02x' % @data[i] end str end |