mongodb 0.0.13 → 2.0.0

data/Rakefile

@@ -1,11 +1,10 @@
 require 'rake_ext'
 
-project(
+project \
   name: "mongodb",
-  # version: '0.1.0',
+  version: '2.0.0',
   gem: true,
   summary: "Persistence for any Ruby Object & Driver enhancements for MongoDB.",
 
   author: "Alexey Petrushin",
-  homepage: "http://alexeypetrushin.github.com/mongodb"
-)
+  homepage: "http://alexeypetrushin.github.com/mongodb"

data/lib/mongo/driver.rb

@@ -12,7 +12,6 @@ class Mongo::NotFound < Mongo::Error; end
   dynamic_finders
 ).each{|f| require "mongo/driver/#{f}"}
 
-# defaults
 Mongo.class_eval do
   class << self
     def defaults; @defaults ||= {} end
@@ -29,7 +28,6 @@ Mongo.class_eval do
     end
   end
 end
-Mongo.defaults[:convert_id_to_string] = true
 
 Mongo::Connection.send :include, Mongo::ConnectionExt
 
@@ -42,4 +40,6 @@ Mongo::Collection.class_eval do
     alias_method "#{method}_without_ext", method
     alias_method method, "#{method}_with_ext"
   end
-end
+end
+
+Mongo.defaults[:convert_id_to_string] = true

data/lib/mongo/driver/collection.rb

@@ -2,9 +2,8 @@ require 'set'
 require 'date'
 
 module Mongo::CollectionExt
-  #
-  # CRUD
-  #
+  # CRUD.
+
   def save_with_ext doc, options = {}
     save_without_ext doc, reverse_merge_defaults(options, :safe)
   end
@@ -12,7 +11,7 @@ module Mongo::CollectionExt
   def insert_with_ext args, options = {}
     result = insert_without_ext args, reverse_merge_defaults(options, :safe)
 
-    # for some strange reason MongoDB Ruby driver
+    # For some strange reason MongoDB Ruby driver
     # uses Strings for all keys but _id.
     # It's inconvinient, fixing it.
     if Mongo.defaults[:convert_id_to_string]
@@ -20,7 +19,7 @@ module Mongo::CollectionExt
       list.each{|h| h['_id'] = h.delete :_id}
     end
 
-    # fix for mongodriver, it will return single result if we supply [doc] as args
+    # Fix for mongodriver, it will return single result if we supply [doc] as args.
     (args.is_a?(Array) and !result.is_a?(Array)) ? [result] : result
   end
 
@@ -43,7 +42,7 @@ module Mongo::CollectionExt
     remove_without_ext selector, reverse_merge_defaults(options, :safe, :multi)
   end
 
-  def destroy *args
+  def delete *args
     remove *args
   end
 
@@ -51,9 +50,8 @@ module Mongo::CollectionExt
     insert *args
   end
 
-  #
-  # Querying
-  #
+  # Querying.
+
   def first selector = {}, options = {}
     selector = convert_underscore_to_dollar_in_selector selector if selector.is_a? Hash
     find_one selector, options
@@ -114,17 +112,7 @@ module Mongo::CollectionExt
       h
     end
 
-    # # symbolizing hashes
-    # def symbolize_doc doc
-    #   return doc unless Mongo.defaults[:symbolize]
-    #
-    #   Mongo::CollectionExt.convert_doc doc do |k, v, result|
-    #     k = k.to_sym if k.is_a? String
-    #     result[k] = v
-    #   end
-    # end
-
-    # replaces :_lt to :$lt in query
+    # Replaces :_lt to :$lt in query.
     def convert_underscore_to_dollar_in_selector selector
       return selector unless Mongo.defaults[:convert_underscore_to_dollar]
 
@@ -134,7 +122,7 @@ module Mongo::CollectionExt
       end
     end
 
-    # replaces :_set to :$set in query
+    # Replaces :_set to :$set in query.
     def convert_underscore_to_dollar_in_update update
       return update unless Mongo.defaults[:convert_underscore_to_dollar]
 
@@ -144,7 +132,7 @@ module Mongo::CollectionExt
       end
     end
 
-    # walks on hash and creates another (also works with nested & arrays)
+    # Walks on hash and creates another (also works with nested & arrays).
     def self.convert_doc doc, &block
       if doc.is_a? Hash
         result = {}

data/lib/mongo/driver/dynamic_finders.rb

@@ -1,8 +1,6 @@
 module Mongo::DynamicFinders
   protected
-    #
-    # first_by_field, all_by_field, each_by_field, first_by_field
-    #
+    # Dynamic finders, like `first_by_field`, `all_by_field`, `each_by_field`, `first_by_field`.
     def method_missing clause, *args, &block
       if clause =~ /^([a-z]_by_[a-z_])|(by_[a-z_])/
         clause = clause.to_s

data/lib/mongo/object.rb

@@ -1,19 +1,5 @@
 require 'mongo/driver'
 
-%w(
-  support
-  object
-  object_helper
-).each{|f| require "mongo/object/#{f}"}
-
-Mongo.defaults[:callbacks] = true
-
-# collection
-Mongo::Collection.class_eval do
-  include Mongo::ObjectHelper
-
-  %w(create update save destroy).each do |method|
-    alias_method "#{method}_without_object", method
-    alias_method method, "#{method}_with_object"
-  end
+Mongo.class_eval do
+  autoload :Object, 'mongo/object/load'
 end

data/lib/mongo/object/{object_helper.rb → collection_helper.rb}

@@ -1,7 +1,6 @@
-module Mongo::ObjectHelper
-  #
-  # CRUD
-  #
+module Mongo::CollectionHelper
+  # CRUD.
+
   def create_with_object doc, options = {}
     if doc.is_a? ::Mongo::Object
       doc.create_object self, options
@@ -28,36 +27,34 @@ module Mongo::ObjectHelper
     end
   end
 
-  def destroy_with_object *args
+  def delete_with_object *args
     if args.first.is_a? ::Mongo::Object
       doc, options = args
       options ||= {}
-      doc.destroy_object self, options
+      doc.delete_object self, options
     else
-      destroy_without_object *args
+      delete_without_object *args
     end
   end
 
   def create! *args
-    create(*args) || raise(Mongo::Error, "can't create #{doc.inspect}!")
+    create(*args) || raise(Mongo::Error, "can't create #{args.inspect}!")
   end
 
   def update! *args
-    update(*args) || raise(Mongo::Error, "can't update #{doc.inspect}!")
+    update(*args) || raise(Mongo::Error, "can't update #{args.inspect}!")
   end
 
   def save! *args
-    save(*args) || raise(Mongo::Error, "can't save #{doc.inspect}!")
+    save(*args) || raise(Mongo::Error, "can't save #{args.inspect}!")
   end
 
-  def destroy! *args
-    destroy(*args) || raise(Mongo::Error, "can't destroy #{doc.inspect}!")
+  def delete! *args
+    delete(*args) || raise(Mongo::Error, "can't delete #{args.inspect}!")
   end
 
+  # Querying.
 
-  #
-  # Querying
-  #
   def first selector = {}, options = {}, &block
     options = options.clone
     if options.delete(:object) == false

data/lib/mongo/object/load.rb

@@ -0,0 +1,22 @@
+require 'mongo/object/support'
+require 'mongo/object/object'
+require 'mongo/object/collection_helper'
+
+Mongo::Collection.class_eval do
+  include Mongo::CollectionHelper
+
+  %w(create update save delete).each do |method|
+    alias_method "#{method}_without_object", method
+    alias_method method, "#{method}_with_object"
+  end
+end
+
+# By default MongoDB automatically generates BSON::ObjectId,
+# it has smaller size than string, but usually strings are more convinient to use.
+# This options changes this behaviour and allows to define `generate_id` method
+# on model and use it to generate ids.
+Mongo.defaults[:generate_id] = false
+
+# Size of autogenerated random string id in default `generate_id` method,
+# (used only if :generate_id option if enabled).
+Mongo.defaults[:random_string_id_size] = 6

data/lib/mongo/object/object.rb

@@ -1,56 +1,30 @@
 module Mongo::Object
   attr_accessor :_id, :_parent
 
-  def valid? options = {}
-    errors.clear
-    run_validations options
-  end
-
-  def run_validations options = {}
-    options = ::Mongo::Object.parse_options options
-    begin
-      return false if options[:callbacks] and !::Mongo::Object.run_before_callbacks(self, :validate)
-
-      child_options = options.merge internal: true
-      result = [
-        (respond_to?(:run_model_validations) ? run_model_validations : true),
-        child_objects.all?{|group| group.all?{|obj| obj.valid?(child_options)}},
-        errors.empty?
-      ].all?
+  def _id?; !!_id end
+  def new?; !_id end
+  alias_method :new_record?, :new?
 
-      ::Mongo::Object.run_after_callbacks(self, :validate) if options[:callbacks]
-
-      result
-    ensure
-      clear_child_objects_cache unless options[:internal]
-    end
-  end
+  def create_object collection, options
+    doc = to_mongo
 
-  def errors
-    @_errors ||= Hash.new([])
-  end
+    # Generating custom id if option enabled.
+    doc['_id'] = generate_id if Mongo.defaults[:generate_id]
 
-  def create_object collection, options
-    with_object_callbacks :create, options do |options|
-      doc = ::Mongo::Object.to_mongo self
-      collection.create(doc, options)
-      self._id = doc['_id']
-    end
+    id = collection.create doc, options
+    self._id = id
+    id
   end
 
   def update_object collection, options
-    with_object_callbacks :update, options do |options|
-      id = _id || "can't update object without _id (#{self})!"
-      doc = ::Mongo::Object.to_mongo self
-      collection.update({_id: id}, doc, options)
-    end
+    id = _id || "can't update object without _id (#{self})!"
+    doc = to_mongo
+    collection.update({_id: id}, doc, options)
   end
 
-  def destroy_object collection, options
-    with_object_callbacks :destroy, options do |options|
-      id = _id || "can't destroy object without _id (#{self})!"
-      collection.destroy({_id: id}, options)
-    end
+  def delete_object collection, options
+    id = _id || "can't delete object without _id (#{self})!"
+    collection.delete({_id: id}, options)
   end
 
   def save_object collection, options
@@ -61,124 +35,53 @@ module Mongo::Object
     end
   end
 
-  # need this to allow change it in specs
-  # RSpec adds @mock_proxy, and we need to skip it
-  SKIP_IV_REGEXP = /^@_/
-
-  class << self
-    def parse_options options
-      options = options.clone
-      options[:validate]  = true                       unless options.include?(:validate)
-      options[:callbacks] = Mongo.defaults[:callbacks] unless options.include?(:callbacks)
-      return options
-    end
-
-    def parse_mongo_options options
-      options = options.clone
-      options.delete :validate
-      options.delete :callbacks
-      options
-    end
+  # Skipping variables starting with @_, usually they
+  # have specific meaning and used for things like cache.
+  def persistent_instance_variable_names *args
+    instance_variables(*args).select{|n| n !~ /^@_/}
+  end
 
-    def each_instance_variable obj, &block
-      instance_variables(obj).each do |iv_name|
-        block.call iv_name, obj.instance_variable_get(iv_name)
+  # Convert object to document (with nested documents & arrays).
+  def to_mongo
+    {}.tap do |h|
+      # Copy instance variables.
+      persistent_instance_variable_names.each do |iv_name|
+        k = iv_name.to_s[1..-1]
+        v = instance_variable_get iv_name
+        h[k] = v.to_mongo
       end
-    end
 
-    def instance_variables obj
-      # skipping variables starting with @_, usually they
-      # have specific meaning and used for example for cache
-      obj.instance_variables.select{|n| n !~ SKIP_IV_REGEXP}
+      # Adding _id & _class.
+      h['_id']    = _id if _id
+      h['_class'] = self.class.name || \
+        raise("unknow class name for model #{h.inspect}!")
     end
+  end
+  alias_method :to_hash, :to_mongo
 
-    # converts object to document (also works with nested & arrays)
-    def to_mongo obj
-      return obj.to_mongo if obj.respond_to? :to_mongo
-
-      if obj.is_a? Hash
-        doc = {}
-        obj.each do |k, v|
-          doc[k] = to_mongo v
-        end
-        doc
-      elsif obj.is_a? Array
-        obj.collect{|v| to_mongo v}
-      elsif obj.is_a? Mongo::Object
-        doc = {}
-
-        # copying instance variables
-        each_instance_variable obj do |iv_name, v|
-          k = iv_name.to_s[1..-1]
-          doc[k] = to_mongo v
-        end
-
-        # adding _id & _class
-        id = instance_variable_get('@_id')
-        doc['_id']    = id if id
-        doc['_class'] = obj.class.name
-
-        doc
-      else # simple type
-        obj
-      end
-    end
+  # Override it to generate Your custom ids.
+  def generate_id
+    generate_random_string_id
+  end
 
-    def convert obj, method, options = {}
-      if obj.is_a? Hash
-        r = {}
-        obj.each do |k, v|
-          r[k] = convert v, method, options
-        end
-        r
-      elsif obj.is_a? Array
-        obj.collect{|v| convert v, method, options}
-      elsif obj.is_a? Mongo::Object
-        obj.send method, options
-      else # simple type
-        obj
-      end
-    end
+  def inspect
+    h = to_hash
+    h.delete '_class'
+    "#<#{self.class}:#{h.inspect}>"
+  end
+  alias_method :to_s, :inspect
 
-    def each_object obj, &block
-      if obj.is_a? Hash
-        block.call obj if obj.is_a? ::Mongo::Object
-        obj.each{|k, v| each_object v, &block}
-      elsif obj.is_a? Array
-        block.call obj if obj.is_a? ::Mongo::Object
-        obj.each{|v| each_object v, &block}
-      elsif obj.is_a? ::Mongo::Object
-        block.call obj
-        each_instance_variable obj do |iv_name, v|
-          each_object v, &block
-        end
-      end
-      nil
+  protected
+    ID_SYMBOLS = ('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a
+    def generate_random_string_id
+      id, size = "", Mongo.defaults[:random_string_id_size]
+      size.times{id << ID_SYMBOLS[rand(ID_SYMBOLS.size)]}
+      id
     end
 
+  class << self
     def build doc
-      return unless doc
-      obj = _build doc, nil
-      obj.send :update_original_children! if obj.is_a? ::Mongo::Object
-      obj
-    end
-
-    def run_before_callbacks obj, method
-      if obj.respond_to?(:run_before_callbacks)
-        obj.run_before_callbacks(:save, method: :save) if method == :update or method == :create
-        obj.run_before_callbacks(method, method: method)
-      else
-        true
-      end
-    end
-
-    def run_after_callbacks obj, method
-      if obj.respond_to?(:run_after_callbacks)
-        obj.run_after_callbacks(method, method: method)
-        obj.run_after_callbacks(:save, method: :save) if method == :update or method == :create
-      else
-        true
-      end
+      doc && _build(doc, nil)
     end
 
     protected
@@ -187,30 +90,31 @@ module Mongo::Object
           if class_name = doc[:_class] || doc['_class']
             klass = constantize class_name
 
+            # Unmarshalling object.
             if klass.respond_to? :from_mongo
               obj = klass.from_mongo doc
             else
               obj = klass.new
               parent ||= obj
               doc.each do |k, v|
-                next if k.to_sym == :_class
-
                 v = _build v, parent
                 obj.instance_variable_set "@#{k}", v
               end
               obj
             end
             obj._parent = parent if parent
-            run_after_callbacks obj, :build
+
+            # Firing special after build callback if defined.
+            obj.run_after_callbacks :build, :build if obj.respond_to? :run_after_callbacks
+
             obj
           else
-            hash = {}
-            doc.each{|k, v| hash[k] = _build v, parent}
-            hash
+            {}.tap{|h| doc.each{|k, v| h[k] = _build v, parent}}
           end
         elsif doc.is_a? Array
           doc.collect{|v| _build v, parent}
         else
+          # Simple type.
           doc
         end
       end
@@ -224,102 +128,4 @@ module Mongo::Object
         klass
       end
   end
-
-  protected
-    def original_children; @_original_children ||= [] end
-
-    def update_original_children!
-      return unless ::Mongo.defaults[:callbacks]
-
-      original_children.clear
-      ::Mongo::Object.each_object self do |obj|
-        original_children << obj unless obj.equal?(self)
-      end
-    end
-
-    def clear_child_objects_cache
-      if instance_variable_get(:@_child_objects_cache)
-        child_objects.each do |group|
-          group.each{|obj| obj.clear_child_objects_cache}
-        end
-        remove_instance_variable :@_child_objects_cache
-      end
-    end
-
-    def child_objects
-      unless @_child_objects_cache
-        created_children, updated_children, destroyed_children = [], [], []
-
-        original_children_ids = Set.new; original_children.each{|obj| original_children_ids << obj.object_id}
-        ::Mongo::Object.each_object self do |obj|
-          (original_children_ids.include?(obj.object_id) ? updated_children : created_children) << obj unless obj.equal?(self)
-        end
-
-        children_ids = Set.new; ::Mongo::Object.each_object self do |obj|
-          children_ids << obj.object_id unless obj.equal?(self)
-        end
-        destroyed_children = original_children.select{|obj| !children_ids.include?(obj.object_id)}
-
-        @_child_objects_cache = [created_children, updated_children, destroyed_children]
-      end
-      @_child_objects_cache
-    end
-
-    def with_object_callbacks method, options, &block
-      options = ::Mongo::Object.parse_options options
-
-      # validation
-      return false if options[:validate] and !valid?(options.merge(internal: true))
-
-      # before callbacks
-      return false if options[:callbacks] and !run_all_callbacks(:before, method)
-
-      # saving
-      block.call ::Mongo::Object.parse_mongo_options(options)
-      update_original_children!
-
-      # after callbacks
-      run_all_callbacks :after, method if options[:callbacks]
-
-      true
-    ensure
-      clear_child_objects_cache
-    end
-
-    def run_all_callbacks type, method
-      result = if type == :before
-        ::Mongo::Object.run_before_callbacks self, method
-      else
-        true
-      end
-
-      result &= if method == :create
-        child_objects.all? do |group|
-          group.all? do |obj|
-            obj.run_all_callbacks type, method
-          end
-        end
-      elsif method == :update
-        created_children, updated_children, destroyed_children = child_objects
-        created_children.all?{|obj| obj.run_all_callbacks type, :create} and
-          updated_children.all?{|obj| obj.run_all_callbacks type, :update} and
-          destroyed_children.all?{|obj| obj.run_all_callbacks type, :destroy}
-      elsif method == :destroy
-        child_objects.all? do |group|
-          group.all? do |obj|
-            obj.run_all_callbacks type, method
-          end
-        end
-      else
-        raise_error "unknown callback method (#{method})!"
-      end
-
-      if type == :after
-        ::Mongo::Object.run_after_callbacks self, method
-      else
-        true
-      end
-
-      result
-    end
 end