mongodb_model 0.2.8 → 2.0.0

data/Rakefile

@@ -1,11 +1,10 @@
 require 'rake_ext'
 
-project(
+project \
   name: "mongodb_model",
-  # version: '0.2.1',
+  version: '2.0.0',
   gem: true,
   summary: "Object Model for MongoDB",
 
   author: "Alexey Petrushin",
-  homepage: "http://alexeypetrushin.github.com/mongodb_model"
-)
+  homepage: "http://alexeypetrushin.github.com/mongodb_model"

data/lib/mongo/model/assignment.rb

@@ -1,3 +1,5 @@
+require 'mongo/model/support/conversions'
+
 module Mongo::Model::Assignment
   class Dsl < BasicObject
     def initialize model
@@ -47,9 +49,9 @@ module Mongo::Model::Assignment
         dsl = ::Mongo::Model::Assignment::Dsl.new self
         dsl.instance_eval &block
       else
-        args.size.must_be.in 2..3
+        args.size.must.be_in 2..3
         attr_name = args.shift
-        attr_name.must_be.a Symbol
+        attr_name.must.be_a Symbol
 
         if args.first.is_a? Class
           type, mass_assignment = args

data/lib/mongo/model/callbacks.rb

@@ -1,8 +1,33 @@
 module Mongo::Model::Callbacks
   inherit RubyExt::Callbacks
 
+  protected
+    def with_model_callbacks methods, options, models, &block
+      # Firing before callbacks.
+      unless options[:callbacks] == false
+        methods.each do |method|
+          models.each do |model|
+            return false unless model.run_before_callbacks method, method
+          end
+        end
+      end
+
+      result = block.call
+
+      # Firing after callbacks.
+      unless options[:callbacks] == false
+        methods.reverse.each do |method|
+          models.each do |model|
+            model.run_after_callbacks method, method
+          end
+        end
+      end
+
+      result
+    end
+
   module ClassMethods
-    [:validate, :create, :update, :save, :destroy].each do |method_name|
+    [:validate, :create, :update, :save, :delete].each do |method_name|
       define_method "before_#{method_name}" do |*args, &block|
         opt = args.extract_options!
         if block
@@ -14,7 +39,7 @@ module Mongo::Model::Callbacks
       end
     end
 
-    [:validate, :create, :update, :save, :destroy, :build].each do |method_name|
+    [:validate, :create, :update, :save, :delete, :build].each do |method_name|
       define_method "after_#{method_name}" do |*args, &block|
         opt = args.extract_options!
         if block

data/lib/mongo/model/conversion.rb

@@ -1,10 +1,10 @@
 module Mongo::Model::Conversion
   def model_to_json *args, &block
-    to_rson(*args, &block).to_json
+    to_hash(*args, &block).to_json
   end
 
   def model_to_xml *args, &block
-    to_rson(*args, &block).to_xml
+    to_hash(*args, &block).to_xml
   end
 
   alias_method :to_json, :model_to_json
@@ -14,24 +14,25 @@ module Mongo::Model::Conversion
     alias_method :to_json, :model_to_json
     alias_method :to_xml, :model_to_xml
 
-    # hack to supress ActiveSupport as_json
+    # Hack to supress ActiveSupport as_json.
     alias_method :as_json, :model_to_json
     alias_method :as_xml, :model_to_xml
   end
 
-  def to_rson options = {}
-    # hack to suppress ActiveSupport as_json
-    options ||= {}
+  def to_hash options = {}
+    # return super if args.empty?
+    #
+    # options = args.first
 
     if profile = options[:profile]
       raise "no other optins are allowed when using :profile option!" if options.size > 1
       profile_options = self.class.profiles[profile] || raise("profile :#{profile} not defined for #{self.class}!")
-      to_rson profile_options.merge(_profile: profile)
+      to_hash profile_options.merge(_profile: profile)
     else
       options.validate_options! :only, :except, :methods, :errors, :_profile
       child_options = options[:_profile] ? {profile: options[:_profile]} : {}
 
-      instance_variables = Mongo::Object.instance_variables(self)
+      instance_variables = self.persistent_instance_variable_names
 
       if only = options[:only]
         instance_variables &= Array(only).collect{|n| :"@#{n}"}
@@ -42,14 +43,14 @@ module Mongo::Model::Conversion
       result = {}
       instance_variables.each do |iv_name|
         value = instance_variable_get iv_name
-        value = Mongo::Object.convert value, :to_rson, child_options
+        value = convert_model value, :to_hash, child_options
         result[iv_name[1.. -1]] = value
       end
 
       methods = options[:methods] ? Array(options[:methods]) : []
       methods.each do |method|
         value = send method
-        value = Mongo::Object.convert value, :to_rson, child_options
+        value = convert_model value, :to_hash, child_options
         result[method.to_s] = value
       end
 
@@ -59,11 +60,25 @@ module Mongo::Model::Conversion
         errors.each{|k, v| stringified_errors[k.to_s] = v}
         result['errors'] = stringified_errors
       end
-      
+
       result
     end
   end
 
+  protected
+    def convert_model obj, method, options
+      if obj.respond_to? :collect_with_value
+        # Array or Hash.
+        obj.collect_with_value{|v| convert_model v, method, options}
+      elsif obj.respond_to? method
+        # Model.
+        obj.send method, options
+      else
+        # Simple object.
+        obj
+      end
+    end
+
   module ClassMethods
     inheritable_accessor :profiles, {}
     def profile name, options = {}

data/lib/mongo/model/crud.rb

@@ -1,4 +1,29 @@
 module Mongo::Model::Crud
+  # Enhancing Mongo::Object CRUD.
+
+  def create_object collection, options
+    with_model_crud_callbacks [:save, :create], options do |mongo_options|
+      super collection, mongo_options
+      true
+    end
+  end
+
+  def update_object collection, options
+    with_model_crud_callbacks [:save, :update], options do |mongo_options|
+      super collection, mongo_options
+      true
+    end
+  end
+
+  def delete_object collection, options
+    with_model_crud_callbacks [:delete], options do |mongo_options|
+      super collection, mongo_options
+      true
+    end
+  end
+
+  # Model CRUD.
+
   def save options = {}
     with_collection options do |collection, options|
       collection.save self, options
@@ -9,20 +34,38 @@ module Mongo::Model::Crud
     save(*args) || raise(Mongo::Error, "can't save invalid model (#{self.errors})!")
   end
 
-  def destroy options = {}
+  def delete options = {}
     with_collection options do |collection, options|
-      collection.destroy self, options
+      collection.delete self, options
     end
   end
 
-  def destroy! *args
-    destroy(*args) || raise(Mongo::Error, "can't destroy invalid model #{self.errors}!")
+  def delete! *args
+    delete(*args) || raise(Mongo::Error, "can't delete invalid model #{self.errors}!")
   end
 
   def update doc, options = {}
-    self.class.collection.update({_id: _id}, doc, options)
+    with_collection options do |collection, options|
+      collection.update({_id: _id}, doc, options)
+    end
   end
 
+  protected
+    def with_model_crud_callbacks methods, options, &block
+      models = [self] + embedded_models(true)
+
+      return false if (options[:validate] != false) and invalid?(options)
+
+      with_model_callbacks methods, options, models do
+        mongo_options = options.clone
+        mongo_options.delete :validate
+        mongo_options.delete :callbacks
+
+        block.call mongo_options
+      end
+    end
+
+
   module ClassMethods
     def build attributes = {}, options = {}, &block
       model = self.new
@@ -43,14 +86,14 @@ module Mongo::Model::Crud
       model
     end
 
-    def destroy_all selector = {}, options = {}
+    def delete_all selector = {}, options = {}
       success = true
-      each(selector){|o| success = false unless o.destroy options}
+      each(selector){|o| success = false unless o.delete options}
       success
     end
 
-    def destroy_all! selector = {}, options = {}
-      destroy_all(selector, options) || raise(Mongo::Error, "can't destroy #{selector.inspect}!")
+    def delete_all! selector = {}, options = {}
+      delete_all(selector, options) || raise(Mongo::Error, "can't delete #{selector.inspect}!")
     end
 
     def update selector, doc, options = {}

data/lib/mongo/model/{file_model.rb → integration/file_model.rb}

@@ -23,7 +23,7 @@ module Mongo::Model::FileModel
 
       after_save{|model| model.send(attr_name).save!}
 
-      after_destroy{|model| model.send(attr_name).destroy!}
+      after_delete{|model| model.send(attr_name).delete!}
     end
   end
 end

data/lib/mongo/model/{validation → integration/validatable}/uniqueness_validator.rb

@@ -1,4 +1,4 @@
-class Mongo::Model::UniquenessValidator < Validatable::ValidationBase
+class Validatable::UniquenessValidator < Validatable::ValidationBase
   attr_accessor :scope, :case_sensitive
 
   def initialize(klass, attribute, options={})
@@ -18,7 +18,7 @@ class Mongo::Model::UniquenessValidator < Validatable::ValidationBase
       conditions[attribute] = /^#{Regexp.escape(value.to_s)}$/i
     end
 
-    # Make sure we're not including the current document in the query
+    # Make sure we're not including the current document in the query.
     conditions[:_id] = {_ne: instance._id} if instance._id
 
     !klass.exists?(conditions)

data/lib/mongo/model/integration/validatable.rb

@@ -0,0 +1,41 @@
+module Validatable::Model
+  def errors
+    @_errors ||= Validatable::Errors.new
+  end
+
+  protected
+    def run_validations_for_this_model_only
+      self.class.validations.each do |v|
+        if v.respond_to?(:validate)
+          v.validate self
+        elsif v.is_a? Proc
+          v.call self
+        else
+          send v
+        end
+      end
+    end
+
+  module ClassMethods
+    include ::Validatable::Macros
+
+    inheritable_accessor :validations, []
+
+    def validates_uniqueness_of *args
+      add_validations(args, ::Validatable::UniquenessValidator)
+    end
+
+    def validate validation = nil, &block
+      validations.push block || validation
+    end
+
+    protected
+      def add_validations(args, klass)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        args.each do |attribute|
+          new_validation = klass.new self, attribute, options
+          validate new_validation
+        end
+      end
+  end
+end

data/lib/mongo/model/load.rb

@@ -0,0 +1,59 @@
+require 'mongo/object'
+require 'ruby_ext'
+
+module Mongo::Model; end
+
+%w(
+  support
+
+  db
+  conversion
+  assignment
+  callbacks
+  validation
+  crud
+  query
+  query_mixin
+  scope
+  attribute_convertors
+  misc
+  model
+).each{|f| require "mongo/model/#{f}"}
+
+module Mongo
+  module Model
+    autoload :FileModel, 'mongo/model/integration/file_model'
+
+    inherit \
+      Db,
+      Conversion,
+      Assignment,
+      Callbacks,
+      Validation,
+      Crud,
+      QueryMixin,
+      Scope,
+      AttributeConvertors,
+      Misc
+  end
+end
+
+Mongo.defaults.merge! \
+  convert_underscore_to_dollar: true,
+  batch_size:                   50,
+  multi:                        true,
+  safe:                         true,
+  generate_id:                  true
+
+# Integration with Rails.
+unless $dont_use_rails
+  require 'mongo/model/integration/rails' if defined? Rails
+end
+
+# Integration with Validatable2
+unless $dont_use_validatable
+  require 'validatable'
+  require 'mongo/model/integration/validatable'
+  require 'mongo/model/integration/validatable/uniqueness_validator'
+  Mongo::Model.inherit Validatable::Model
+end

data/lib/mongo/model/model.rb

@@ -1,12 +1,6 @@
 module Mongo::Model
   include Mongo::Object
 
-  attr_accessor :_id, :_class
-
-  def _id?; !!_id end
-  def new?; !_id end
-  alias_method :new_record?, :new?
-
   inherited do
     unless is?(Array) or is?(Hash)
       alias_method :eql?, :model_eql?
@@ -14,6 +8,8 @@ module Mongo::Model
     end
   end
 
+  # Equality.
+
   def model_eql? o
     return true if equal? o
     self.class == o.class and self == o
@@ -21,22 +17,58 @@ module Mongo::Model
 
   def model_eq? o
     return true if equal? o
+    return false unless o.is_a? Mongo::Model
 
-    variables = {}; ::Mongo::Object.each_instance_variable(self){|n, v| variables[n] = v}
-    o_variables = {}; ::Mongo::Object.each_instance_variable(o){|n, v| o_variables[n] = v}
+    variables = {}.tap do |h|
+      persistent_instance_variable_names.each{|n| h[n] = instance_variable_get(n)}
+    end
+
+    o_variables = {}.tap do |h|
+      o.persistent_instance_variable_names.each{|n| h[n] = o.instance_variable_get(n)}
+    end
 
     variables == o_variables
   end
 
-  # class << self
-  #   attr_accessor :db, :connection
-  #   attr_required :db, :connection
-  #
-  #   # Override this method to provide custom alias to db name translation,
-  #   # for example db_name = my_config[alias_name]
-  #   def resolve_db_alias alias_name
-  #     db_name = alias_name.to_s
-  #     connection.db db_name
-  #   end
-  # end
+  protected
+    # Traversing models.
+
+    def embedded_models recursive = false
+      [].tap{|a| each_embedded(recursive){|m| a.add m}}
+    end
+
+    def each_embedded recursive = false, &block
+      self.class.embedded.each do |name|
+        if o = instance_variable_get(name)
+          _each_embedded o, recursive, &block
+        end
+      end
+    end
+
+    # Hash or Array also can be the Model by itsef, so we need to check
+    # for presence both `:each_embedded` and `:each_value` methods.
+    def _each_embedded o, recursive, &block
+      # If o is model adding it and its children.
+      if o.respond_to? :each_embedded
+        block.call o
+        o.each_embedded recursive, &block if recursive
+      end
+
+      # If o is Hash or Array, iterating and adding all models from there,
+      # recursivelly, hashes and arrays can be nested in any order.
+      if o.respond_to? :each_value
+        o.each_value do |o|
+          _each_embedded o, recursive, &block
+        end
+      end
+    end
+
+  module ClassMethods
+    inheritable_accessor :_embedded, []
+
+    def embedded *list
+      list.collect!{|n| :"@#{n}"}
+      if list.empty? then _embedded else _embedded.push(*list) end
+    end
+  end
 end

data/lib/mongo/model/query.rb

@@ -1,4 +1,4 @@
-class Mongo::Model::Query < Object
+class Mongo::Model::Query
   attr_reader :model_class, :selector, :options
 
   def initialize model_class, selector = {}, options = {}

data/lib/mongo/model/scope.rb

@@ -53,10 +53,8 @@ module Mongo::Model::Scope
       end
     end
 
+    # Finders.
 
-    #
-    # finders
-    #
     def count selector = {}, options = {}
       if current = current_scope
         super current.selector.merge(selector), current.options.merge(options)
@@ -81,10 +79,8 @@ module Mongo::Model::Scope
       end
     end
 
+    # Shortcuts for frequently used scopes.
 
-    #
-    # Handy scopes
-    #
     def limit n; query({}, limit: n) end
     def skip n; query({}, skip: n) end
     def sort *list

data/lib/mongo/model/spec.rb

@@ -5,9 +5,6 @@ rspec do
   class << self
     def with_mongo_model
       with_mongo
-      #
-      # before{Mongo::Model.db = mongo.db}
-      # after{Mongo::Model.db = nil}
     end
   end
 end

data/lib/mongo/model/support/{types.rb → conversions.rb}

@@ -1,6 +1,7 @@
-#
-# Boolean
-#
+# Converting basic Ruby types to and from String, needed
+# in mass assignment.
+
+# Boolean.
 module Mongo::Model::BooleanType
   Mapping = {
     true    => true,
@@ -37,10 +38,7 @@ class Boolean; end unless defined?(Boolean)
 
 Boolean.extend Mongo::Model::BooleanType
 
-
-#
-# Date
-#
+# Date.
 require 'date'
 Date.class_eval do
   def self.cast value
@@ -55,20 +53,14 @@ Date.class_eval do
   end
 end
 
-
-#
-# Float
-#
+# Float.
 Float.class_eval do
   def self.cast value
     value.nil? ? nil : value.to_f
   end
 end
 
-
-#
-# Integer
-#
+# Integer.
 Integer.class_eval do
   def self.cast value
     value_to_i = value.to_i
@@ -80,20 +72,14 @@ Integer.class_eval do
   end
 end
 
-
-#
-# String
-#
+# String.
 String.class_eval do
   def self.cast value
     value.nil? ? nil : value.to_s
   end
 end
 
-
-#
-# Time
-#
+# Time.
 Time.class_eval do
   def self.cast value
     if value.nil? || value == ''

data/lib/mongo/model/support.rb

@@ -0,0 +1,11 @@
+Array.class_eval do
+  alias_method :each_value, :each
+  alias_method :collect_with_value, :collect
+end
+
+Hash.class_eval do
+  def collect_with_value &block
+    {}.tap{|h| self.each{|k, v| h[k] = block.call v}}
+  end
+end
+

data/lib/mongo/model/validation.rb

@@ -1,41 +1,21 @@
 module Mongo::Model::Validation
-  def errors
-    @_errors ||= Validatable::Errors.new
+  def valid? options = {}
+    errors.clear
+    run_validations options
   end
+  def invalid?(options = {}); !valid?(options) end
 
-  def run_model_validations
-    self.class.validations.each do |v|
-      if v.respond_to?(:validate)
-        v.validate self
-      elsif v.is_a? Proc
-        v.call self
-      else
-        send v
-      end
-    end
-    true
-  end
+  protected
+    def run_validations options = {}
+      with_model_callbacks [:validate], options, [self] do
+        # Validating main model.
+        self.run_validations_for_this_model_only
+        result = errors.empty?
 
-  module ClassMethods
-    include ::Validatable::Macros
-
-    inheritable_accessor :validations, []
-
-    def validates_uniqueness_of *args
-      add_validations(args, Mongo::Model::UniquenessValidator)
-    end
-
-    def validate validation = nil, &block
-      validations.push block || validation
-    end
-
-    protected
-      def add_validations(args, klass)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        args.each do |attribute|
-          new_validation = klass.new self, attribute, options
-          validate new_validation
+        # Validating embedded models.
+        embedded_models.reduce result do |result, model|
+          result &= model.valid?(options)
         end
       end
-  end
+    end
 end