Class: MongoRecord::Base

Inherits:
Object show all
Defined in:
lib/mongo_record/base.rb

Overview

A superclass for database collection instances. The API is very similar to ActiveRecord. See #find for examples.

If you override initialize, make sure to call the superclass version, passing it the database row or hash that it was given.

Example:

class MP3Track < MongoRecord::Base
  collection_name :mp3_track
  fields :artist, :album, :song, :track
  def to_s
    "artist: #{self.artist}, album: #{self.album}, song: #{self.song}, track: #{track}"
  end
end

track = MP3Track.find_by_song('She Blinded Me With Science')
puts track.to_s

The database connection defaults to the global $db. You can set the connection using MongoRecord::Base.connection= and read it with MongoRecord::Base.connection.

# Set the connection to something besides $db
MongoRecord::Base.connection = connect('my-database')

Direct Known Subclasses

Subobject

Constant Summary collapse

@@connection = 
nil

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(row = {}) {|_self| ... } ⇒ Base

Initialize a new object with either a hash of values or a row returned from the database.

Yields:

  • (_self)

Yield Parameters:



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/mongo_record/base.rb', line 752

def initialize(row={})
  case row
  when Hash
    row.each { |k, val|
      k = '_id' if k == 'id' # Rails helper
      init_ivar("@#{k}", val)
    }
  else
    row.instance_variables.each { |iv|
      init_ivar(iv, row.instance_variable_get(iv))
    }
  end
  # Default values for remaining fields
  (self.class.field_names + self.class.subobjects.keys).each { |iv|
    iv = "@#{iv}"
    instance_variable_set(iv, nil) unless instance_variable_defined?(iv)
  }
  self.class.arrays.keys.each { |iv|
    iv = "@#{iv}"
    instance_variable_set(iv, []) unless instance_variable_defined?(iv)
  }
  yield self if block_given?
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args) ⇒ Object 



892
893
894
895
896
897
898
899
 
# File 'lib/mongo_record/base.rb', line 892

def method_missing(sym, *args)
  if self.instance_variables.include?("@#{sym}")
    self.class.field(sym)
    return self.send(sym)
  else
    super
  end
end

Class Method Details

.all(*args) ⇒ Object 



360
361
362
363
 
# File 'lib/mongo_record/base.rb', line 360

def all(*args)
  options = extract_options_from_args!(args)
  find_every(options)
end

.arrays ⇒ Object

Return the names of all instance variables that hold objects declared using has_many. The names do not start with ‘@’.



193
 
# File 'lib/mongo_record/base.rb', line 193

def arrays; @arrays; end

.belongs_to(name, options = {}) ⇒ Object

Tells Mongo that this object belongs to another. A no-op.



241
242
 
# File 'lib/mongo_record/base.rb', line 241

def belongs_to(name, options={})
end

.collection ⇒ Object

The collection object for this class, which will be different for every subclass of MongoRecord::Base.



246
247
248
 
# File 'lib/mongo_record/base.rb', line 246

def collection
  connection.collection(@coll_name.to_s)
end

.collection_name(coll_name) ⇒ Object

Call this method to set the Mongo collection name for this class. The default value is the class name turned into lower_case_with_underscores.



120
121
122
123
 
# File 'lib/mongo_record/base.rb', line 120

def collection_name(coll_name)
  @coll_name = coll_name
  field(:_id, :_ns)
end

.connection ⇒ Object

Return the database connection. The default value is # $db.



90
91
92
93
94
 
# File 'lib/mongo_record/base.rb', line 90

def connection
  conn = @@connection || $db
  raise "connection not defined" unless conn
  conn
end

.connection=(val) ⇒ Object

Set the database connection. If the connection is set to nil, then $db will be used.



98
99
100
101
 
# File 'lib/mongo_record/base.rb', line 98

def connection=(val)
  @@connection = val
  @@connection.pk_factory = PKFactory.new unless @@connection.pk_factory
end

.count(options = {}) ⇒ Object

Returns the number of matching records.



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/mongo_record/base.rb', line 383

def count(options={})
  criteria = criteria_from(options[:conditions],options[:criteria]).merge!(where_func(options[:where]))
  begin
    collection.count(criteria)
  rescue => ex
    if ex.to_s =~ /Error with count command.*ns missing/
      # Return 0 because we will graciously assume that we are being
      # called from a subclass that has been initialized properly, and
      # is therefore mentioned in the schema.
      0
    else
      raise ex
    end
  end
end

.create(values_hash) ⇒ Object

Creates, saves, and returns a new database object.



438
439
440
441
442
 
# File 'lib/mongo_record/base.rb', line 438

def create(values_hash)
  object = self.new(values_hash)
  object.save
  object
end

.delete(id) ⇒ Object

Deletes the record with the given id from the collection.



405
406
407
 
# File 'lib/mongo_record/base.rb', line 405

def delete(id)
  collection.remove({:_id => id})
end

.delete_all(conditions = nil) ⇒ Object

Deletes all records that match condition, which can be a Mongo-style hash or an ActiveRecord-like hash. Examples:

Person.destroy_all "name like '%fred%'   # SQL WHERE clause
Person.destroy_all ["name = ?", 'Fred']  # Rails condition
Person.destroy_all {:name => 'Fred'}     # Mongo hash



433
434
435
 
# File 'lib/mongo_record/base.rb', line 433

def delete_all(conditions=nil)
  collection.remove(criteria_from(conditions))
end

.destroy(id) ⇒ Object

Load the object with id and delete it.



411
412
413
 
# File 'lib/mongo_record/base.rb', line 411

def destroy(id)
  id.is_a?(Array) ? id.each { |oid| destroy(oid) } : find(id).destroy
end

.destroy_all(conditions = nil) ⇒ Object

Destroy all objects that match conditions. Warning: if conditions is nil, all records in the collection will be destroyed.



424
425
426
 
# File 'lib/mongo_record/base.rb', line 424

def destroy_all(conditions = nil)
  find(:all, :conditions => conditions).each { |object| object.destroy }
end

.field(*fields) ⇒ Object Also known as: fields

Creates one or more collection fields. Each field will be saved to and loaded from the database. The fields named “_id” and “_ns” are automatically saved and loaded.

The method “field” is also called “fields”; you can use either one.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/mongo_record/base.rb', line 130

def field(*fields)
  fields.each { |field|
    field = field.to_sym
    unless @field_names.include?(field)
      ivar_name = "@" + field.to_s
      define_method(field, lambda { instance_variable_get(ivar_name) })
      define_method("#{field}=".to_sym, lambda { |val| instance_variable_set(ivar_name, val) })
      define_method("#{field}?".to_sym, lambda {
                      val = instance_variable_get(ivar_name)
                      val != nil && (!val.kind_of?(String) || val != '')
                    })
      @field_names << field
    end
  }
end

.field_names ⇒ Object

Return the field names.



148
 
# File 'lib/mongo_record/base.rb', line 148

def field_names; @field_names; end

.find(*args) ⇒ Object 



327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/mongo_record/base.rb', line 327

def find(*args)
  options = extract_options_from_args!(args)
  options.symbolize_keys!
  case args.first
  when :first
    find_initial(options)
  when :all
    find_every(options)
  when :last
    find_last(options)
  else
    find_from_ids(args, options)
  end
end

.find_by_mql(mql) ⇒ Object Also known as: find_by_sql

Returns all records matching mql. Not yet implemented.



377
378
379
 
# File 'lib/mongo_record/base.rb', line 377

def find_by_mql(mql)    # :nodoc:
  raise "not implemented"
end

.find_each(*args) ⇒ Object

Yields each record that was found by the find options. The find is performed by find.

Example:

Person.find_each(:conditions => "age > 21") do |person|
  person.party_all_night!
end



351
352
353
354
355
356
357
358
 
# File 'lib/mongo_record/base.rb', line 351

def find_each(*args)
  options = extract_options_from_args!(args)
  options.symbolize_keys!
  find_every(options).each do |record|
    yield record
  end
  self
end

.first(*args) ⇒ Object 



365
366
367
368
369
 
# File 'lib/mongo_record/base.rb', line 365

def first(*args)
#        args = ([:first]<<args).flatten
  options = extract_options_from_args!(args)
  find_initial(options)
end

.has_and_belongs_to_many(name, options = {}) ⇒ Object

Tells Mongo that this object has and many belongs to another object. A no-op.



237
238
 
# File 'lib/mongo_record/base.rb', line 237

def has_and_belongs_to_many(name, options={})
end

.has_many(name, options = {}) ⇒ Object

Tells Mongo about an array of subobjects (which need not be MongoRecord::Subobjects).

Options: :class_name - Name of the class of the subobject.



223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/mongo_record/base.rb', line 223

def has_many(name, options={})
  name = name.to_sym
  unless @arrays[name]
    ivar_name = "@" + name.to_s
    define_method(name, lambda { instance_variable_get(ivar_name) })
    define_method("#{name}=".to_sym, lambda { |val| instance_variable_set(ivar_name, val) })
    define_method("#{name}?".to_sym, lambda { !instance_variable_get(ivar_name).empty? })
    klass_name = options[:class_name] || field_name_to_class_name(name)
    @arrays[name] = eval(klass_name)
  end
end

.has_one(name, options = {}) ⇒ Object

Tell Mongo about a subobject (which need not be a MongoRecord::Subobject).

Options: <code>:class_name<code> - Name of the class of the subobject.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/mongo_record/base.rb', line 203

def has_one(name, options={})
  name = name.to_sym
  unless @subobjects[name]
    ivar_name = "@" + name.to_s
    define_method(name, lambda { instance_variable_get(ivar_name) })
    define_method("#{name}=".to_sym, lambda { |val| instance_variable_set(ivar_name, val) })
    define_method("#{name}?".to_sym, lambda {
                    val = instance_variable_get(ivar_name)
                    val != nil && (!val.kind_of?(String) || val != '')
                  })
    klass_name = options[:class_name] || field_name_to_class_name(name)
    @subobjects[name] = eval(klass_name)
  end
end

.index(fields, unique = false) ⇒ Object

Creates an index for this collection. fields should be either a single field name (:title) or an array of fields ([:title, :author, :date]) or an array of a field name and direction ([:title, :asc] or [:title, :desc]) or an array of field names and directions ([[:title, :asc], [:author, :desc]]) unique should be true or false and indicates whether this index should enforce a uniqueness constraint.



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/mongo_record/base.rb', line 157

def index(fields, unique = false)
  fields = Array(fields)
  
  if fields.length == 2 && 
    ( fields[1].to_s == 'asc' || fields[1].to_s == 'desc' ||
      fields[1] == XGen::Mongo::ASCENDING || fields[1] == XGen::Mongo::DESCENDING )
    fields = [fields]
  end
  
  fields = fields.map do |field| 
    field = field.respond_to?(:[]) ? field : [field, :asc]
    field[1] = (field[1] == :desc) ? XGen::Mongo::DESCENDING : XGen::Mongo::ASCENDING
    field          
  end
  
  collection.create_index(fields, unique)
end

.indexes(*fields) ⇒ Object

Returns list of indexes for model, unless fields are passed. In that case, creates an index.



177
178
179
180
181
182
183
 
# File 'lib/mongo_record/base.rb', line 177

def indexes(*fields)
  if fields.empty?
    collection.index_information
  else
    index(*fields)
  end
end

.inherited(subclass) ⇒ Object

Get ready to save information about subclass.



110
111
112
113
114
115
 
# File 'lib/mongo_record/base.rb', line 110

def inherited(subclass)
  subclass.instance_variable_set("@coll_name", class_name_to_field_name(subclass.name)) # default name
  subclass.instance_variable_set("@field_names", []) # array of scalars names (symbols)
  subclass.instance_variable_set("@subobjects", {}) # key = name (symbol), value = class
  subclass.instance_variable_set("@arrays", {})     # key = name (symbol), value = class
end

.instantiate(row = {}) ⇒ Object

This method only exists so that MongoRecord::Base and ActiveRecord::Base can live side by side.



105
106
107
 
# File 'lib/mongo_record/base.rb', line 105

def instantiate(row={})
  new(row)
end

.last(*args) ⇒ Object 



371
372
373
374
 
# File 'lib/mongo_record/base.rb', line 371

def last(*args)
  options = extract_options_from_args!(args)
  find_last(options)
end

.method_missing(sym, *args) ⇒ Object

Handles find_* methods such as find_by_name, find_all_by_shoe_size, and find_or_create_by_name.



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/mongo_record/base.rb', line 469

def method_missing(sym, *args)
  if match = /^find_(all_by|by)_([_a-zA-Z]\w*)$/.match(sym.to_s)
    find_how_many = ($1 == 'all_by') ? :all : :first
    field_names = $2.split(/_and_/)
    super unless all_fields_exist?(field_names)
    search = search_from_names_and_values(field_names, args)
    self.find(find_how_many, {:conditions => search}, *args[field_names.length..-1])
  elsif match = /^find_or_(initialize|create)_by_([_a-zA-Z]\w*)$/.match(sym.to_s)
    create = $1 == 'create'
    field_names = $2.split(/_and_/)
    super unless all_fields_exist?(field_names)
    search = search_from_names_and_values(field_names, args)
    row = self.find(:first, {:conditions => search})
    return self.new(row) if row # found
    obj = self.new(search.merge(args[field_names.length] || {})) # new object using search and remainder of args
    obj.save if create
    obj
  else
    super
  end
end

.mongo_ivar_names ⇒ Object

Return the names of all fields, subobjects, and arrays.



196
 
# File 'lib/mongo_record/base.rb', line 196

def mongo_ivar_names; @field_names + @subobjects.keys + @arrays.keys; end

.remove ⇒ Object

Deletes the record with the given id from the collection.



408
409
410
 
# File 'lib/mongo_record/base.rb', line 408

def delete(id)
  collection.remove({:_id => id})
end

.subobjects ⇒ Object

Return the names of all instance variables that hold objects declared using has_one. The names do not start with ‘@’.

These are not necessarily MongoRecord::Subobject subclasses.



189
 
# File 'lib/mongo_record/base.rb', line 189

def subobjects; @subobjects; end

.sum(column) ⇒ Object 



399
400
401
402
 
# File 'lib/mongo_record/base.rb', line 399

def sum(column)
  x = self.find(:all, :select=>column)
  x.map {|p1| p1.followers_count}.compact.sum
end

.update(id, attributes) ⇒ Object

Finds the record from the passed id, instantly saves it with the passed attributes (if the validation permits it), and returns it. If the save fails under validations, the unsaved object is still returned.

The arguments may also be given as arrays in which case the update method is called for each pair of id and attributes and an array of objects is returned.

>

Example of updating one record:

Person.update(15, {:user_name => 'Samuel', :group => 'expert'})

Example of updating multiple records:

people = { 1 => { "first_name" => "David" }, 2 => { "first_name" => "Jeremy"} }
Person.update(people.keys, people.values)



456
457
458
459
460
461
462
463
464
465
 
# File 'lib/mongo_record/base.rb', line 456

def update(id, attributes)
  if id.is_a?(Array)
    i = -1
    id.collect { |id| i += 1; update(id, attributes[i]) }
  else
    object = find(id)
    object.update_attributes(attributes)
    object
  end
end

.update_all(updates, conditions = nil) ⇒ Object

Not yet implemented.



416
417
418
419
 
# File 'lib/mongo_record/base.rb', line 416

def update_all(updates, conditions = nil)
  # TODO
  raise "not yet implemented"
end

Instance Method Details

#==(comparison_object) ⇒ Object

Return true if the comparison_object is the same object, or is of the same type and has the same id.



784
785
786
787
788
789
 
# File 'lib/mongo_record/base.rb', line 784

def ==(comparison_object)
  comparison_object.equal?(self) ||
    (comparison_object.instance_of?(self.class) &&
     comparison_object.id == id &&
     !comparison_object.new_record?)
end

#[](attr_name) ⇒ Object 



883
884
885
 
# File 'lib/mongo_record/base.rb', line 883

def [](attr_name)
  self.send(attr_name)
end

#[]=(attr_name, value) ⇒ Object 



887
888
889
890
 
# File 'lib/mongo_record/base.rb', line 887

def []=(attr_name, value)
  self.class.field(attr_name)
  self.send(attr_name.to_s + '=', value)
end

#attributes_from_column_definition ⇒ Object

Does nothing.



934
 
# File 'lib/mongo_record/base.rb', line 934

def attributes_from_column_definition; end

#create ⇒ Object

Save self to the database and set the id.



847
848
849
850
851
852
853
854
 
# File 'lib/mongo_record/base.rb', line 847

def create
  create_date = self.instance_variable_defined?("@created_at") ? self.created_at : nil
  set_create_times(create_date)
  @_ns = self.class.collection.name
  with_id = self.class.collection.insert(to_mongo_value)
  @_id = with_id['_id'] || with_id[:_id]
  with_id
end

#delete ⇒ Object Also known as: remove

Remove self from the database and set @_id to nil. If self has no @_id, does nothing.



869
870
871
872
873
874
 
# File 'lib/mongo_record/base.rb', line 869

def delete
  if @_id
    self.class.collection.remove({:_id => self._id})
    @_id = nil
  end
end

#destroy ⇒ Object

Delete and freeze self.



878
879
880
881
 
# File 'lib/mongo_record/base.rb', line 878

def destroy
  delete
  freeze
end

#eql?(comparison_object) ⇒ Boolean

Delegate to ==

Returns:

  • (Boolean) 


792
793
794
 
# File 'lib/mongo_record/base.rb', line 792

def eql?(comparison_object)
  self == (comparison_object)
end

#hash ⇒ Object

Delegate to id in order to allow two records of the same type and id to work with something like:

[ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]



798
799
800
 
# File 'lib/mongo_record/base.rb', line 798

def hash
  id.hash
end

#id ⇒ Object

Return this object’s id.



780
 
# File 'lib/mongo_record/base.rb', line 780

def id; @_id ? @_id.to_s : nil; end

#id=(val) ⇒ Object

Set the id of this object. Normally not called by user code.



777
 
# File 'lib/mongo_record/base.rb', line 777

def id=(val); @_id = (val == '' ? nil : val); end

#new_record? ⇒ Boolean

Return true if this object is new—that is, does not yet have an id.

Returns:

  • (Boolean) 


819
820
821
 
# File 'lib/mongo_record/base.rb', line 819

def new_record?
  @_id.nil? || self.class.collection.find_first("_id" => @_id).nil?
end

#save ⇒ Object

Save self and returns true if the save was successful, false if not.



808
809
810
 
# File 'lib/mongo_record/base.rb', line 808

def save
  create_or_update
end

#save! ⇒ Object

Save self and returns true if the save was successful and raises RecordNotSaved if not.



814
815
816
 
# File 'lib/mongo_record/base.rb', line 814

def save!
  create_or_update || raise(RecordNotSaved)
end

#set_create_times(t = nil) ⇒ Object 



938
939
940
941
942
943
944
945
946
947
 
# File 'lib/mongo_record/base.rb', line 938

def set_create_times(t=nil)
  t ||= Time.now
  t = Time.parse(t) if t.is_a?(String)
  self["created_at"] = t
  self["created_on"] = Time.local(t.year, t.month, t.day)
  self.class.subobjects.keys.each { |iv|
    val = instance_variable_get("@#{iv}")
    val.send(:set_create_times, t) if val
  }
end

#to_mongo_value ⇒ Object

Convert this object to a Mongo value suitable for saving to the database.



825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
 
# File 'lib/mongo_record/base.rb', line 825

def to_mongo_value
  h = {}
  key_names = self.instance_values.keys
  key_names.each {|key|
    value = instance_variable_get("@#{key}").to_mongo_value
    if value.instance_of? Hash and value["_ns"]
      value = XGen::Mongo::Driver::DBRef.new(value["_ns"], value["_id"])
    elsif value.instance_of? Array
      value = value.map {|v|
        if v.instance_of? Hash and v["_ns"]
          XGen::Mongo::Driver::DBRef.new(v["_ns"], v["_id"])
        else
          v
        end
      }
    end
    h[key] = value
  }
  h
end

#to_param ⇒ Object

Rails convenience method. Return this object’s id as a string.



803
804
805
 
# File 'lib/mongo_record/base.rb', line 803

def to_param
  @_id.to_s
end

#update ⇒ Object

Save self to the database. Return false if there was an error, self if all is well.



858
859
860
861
862
863
864
865
 
# File 'lib/mongo_record/base.rb', line 858

def update
  set_update_times
  self.class.collection.modify({:_id => @_id}, to_mongo_value)
  if self.class.collection.db.error?
    return false
  end
  self
end

#update_attribute(name, value) ⇒ Object

Updates a single attribute and saves the record. This is especially useful for boolean flags on existing records. Note: This method is overwritten by the Validation module that’ll make sure that updates made with this method doesn’t get subjected to validation checks. Hence, attributes can be updated even if the full object isn’t valid.



912
913
914
915
 
# File 'lib/mongo_record/base.rb', line 912

def update_attribute(name, value)
  self[name] = value
  save
end

#update_attributes(attributes) ⇒ Object

Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will fail and false will be returned.



920
921
922
923
924
 
# File 'lib/mongo_record/base.rb', line 920

def update_attributes(attributes)
  attributes.each do |name, value|
    update_attribute(name, value)
  end
end

#update_attributes!(attributes) ⇒ Object

Updates an object just like Base.update_attributes but calls save! instead of save so an exception is raised if the record is invalid.



928
929
930
931
 
# File 'lib/mongo_record/base.rb', line 928

def update_attributes!(attributes)
  self.attributes = attributes
  save!
end