mongoid 2.3.5 → 2.4.0

data/lib/mongoid/errors/scope_overwrite.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # This error is raised when trying to create a scope with an name already
+    # taken by another scope or method
+    #
+    # @example Create the error.
+    #   ScopeOverwrite.new(Person,'teenies')
+    class ScopeOverwrite < MongoidError
+      def initialize(model_name,scope_name)
+        super(
+          translate(
+            "scope_overwrite",
+            { :model_name => model_name, :scope_name => scope_name }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/extensions.rb

@@ -1,11 +1,14 @@
 # encoding: utf-8
+require "mongoid/extensions/array/deep_copy"
 require "mongoid/extensions/array/deletion"
 require "mongoid/extensions/false_class/equality"
+require "mongoid/extensions/hash/deep_copy"
 require "mongoid/extensions/hash/criteria_helpers"
 require "mongoid/extensions/hash/scoping"
 require "mongoid/extensions/integer/checks"
 require "mongoid/extensions/nil/collectionization"
 require "mongoid/extensions/object/checks"
+require "mongoid/extensions/object/deep_copy"
 require "mongoid/extensions/object/reflections"
 require "mongoid/extensions/object/substitutable"
 require "mongoid/extensions/object/yoda"
@@ -19,6 +22,7 @@ require "mongoid/extensions/true_class/equality"
 require "mongoid/extensions/object_id/conversions"
 
 class Array #:nodoc
+  include Mongoid::Extensions::Array::DeepCopy
   include Mongoid::Extensions::Array::Deletion
 end
 
@@ -32,6 +36,7 @@ class FalseClass #:nodoc
 end
 
 class Hash #:nodoc
+  include Mongoid::Extensions::Hash::DeepCopy
   include Mongoid::Extensions::Hash::CriteriaHelpers
   include Mongoid::Extensions::Hash::Scoping
 end
@@ -46,6 +51,7 @@ end
 
 class Object #:nodoc:
   include Mongoid::Extensions::Object::Checks
+  include Mongoid::Extensions::Object::DeepCopy
   include Mongoid::Extensions::Object::Reflections
   include Mongoid::Extensions::Object::Substitutable
   include Mongoid::Extensions::Object::Yoda

data/lib/mongoid/extensions/array/deep_copy.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Array #:nodoc:
+      module DeepCopy #:nodoc:
+
+        # Make a deep copy of the array.
+        #
+        # @example Make a deep copy.
+        #   [ 1, 2, 3 ]._deep_copy
+        #
+        # @return [ Array ] The deep copy.
+        #
+        # @since 2.4.0
+        def _deep_copy
+          [].tap do |copy|
+            each do |value|
+              copy.push(value._deep_copy)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/hash/deep_copy.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Hash #:nodoc:
+      module DeepCopy #:nodoc:
+
+        # Make a deep copy of the hash.
+        #
+        # @example Make a deep copy.
+        #   { :test => "value" }._deep_copy
+        #
+        # @return [ Hash ] The deep copy.
+        #
+        # @since 2.4.0
+        def _deep_copy
+          {}.tap do |copy|
+            each_pair do |key, value|
+              copy[key] = value._deep_copy
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/hash/scoping.rb

@@ -16,7 +16,7 @@ module Mongoid #:nodoc:
         # @return [ Hash ] The hash unmodified.
         #
         # @since 1.0.0
-        def scoped(*args)
+        def as_conditions(*args)
           self
         end
       end

data/lib/mongoid/extensions/object/deep_copy.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Object #:nodoc:
+      module DeepCopy #:nodoc:
+
+        # Make a deep copy of the object.
+        #
+        # @example Make a deep copy.
+        #   "testing"._deep_copy
+        #
+        # @return [ Object ] The deep copy.
+        #
+        # @since 2.4.0
+        def _deep_copy
+          duplicable? ? dup : self
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/proc/scoping.rb

@@ -16,8 +16,8 @@ module Mongoid #:nodoc:
         # @return [ Object ] The result of the proc call.
         #
         # @since 1.0.0
-        def scoped(*args)
-          call(*args).scoped
+        def as_conditions(*args)
+          call(*args).as_conditions
         end
       end
     end

data/lib/mongoid/extensions/symbol/inflections.rb

@@ -48,6 +48,7 @@ module Mongoid #:nodoc:
           "mod",
           "ne",
           "near",
+          "not",
           "nin",
           "size",
           "within",

data/lib/mongoid/fields.rb

@@ -1,30 +1,30 @@
 # encoding: utf-8
 require "mongoid/fields/mappings"
 require "mongoid/fields/serializable"
-require "mongoid/fields/serializable/timekeeping"
-require "mongoid/fields/serializable/array"
-require "mongoid/fields/serializable/big_decimal"
-require "mongoid/fields/serializable/binary"
-require "mongoid/fields/serializable/boolean"
-require "mongoid/fields/serializable/date"
-require "mongoid/fields/serializable/date_time"
-require "mongoid/fields/serializable/float"
-require "mongoid/fields/serializable/hash"
-require "mongoid/fields/serializable/integer"
-require "mongoid/fields/serializable/bignum"
-require "mongoid/fields/serializable/fixnum"
-require "mongoid/fields/serializable/localized"
-require "mongoid/fields/serializable/nil_class"
-require "mongoid/fields/serializable/object"
-require "mongoid/fields/serializable/object_id"
-require "mongoid/fields/serializable/range"
-require "mongoid/fields/serializable/set"
-require "mongoid/fields/serializable/string"
-require "mongoid/fields/serializable/symbol"
-require "mongoid/fields/serializable/time"
-require "mongoid/fields/serializable/time_with_zone"
-require "mongoid/fields/serializable/foreign_keys/array"
-require "mongoid/fields/serializable/foreign_keys/object"
+require "mongoid/fields/internal/timekeeping"
+require "mongoid/fields/internal/array"
+require "mongoid/fields/internal/big_decimal"
+require "mongoid/fields/internal/binary"
+require "mongoid/fields/internal/boolean"
+require "mongoid/fields/internal/date"
+require "mongoid/fields/internal/date_time"
+require "mongoid/fields/internal/float"
+require "mongoid/fields/internal/hash"
+require "mongoid/fields/internal/integer"
+require "mongoid/fields/internal/bignum"
+require "mongoid/fields/internal/fixnum"
+require "mongoid/fields/internal/localized"
+require "mongoid/fields/internal/nil_class"
+require "mongoid/fields/internal/object"
+require "mongoid/fields/internal/object_id"
+require "mongoid/fields/internal/range"
+require "mongoid/fields/internal/set"
+require "mongoid/fields/internal/string"
+require "mongoid/fields/internal/symbol"
+require "mongoid/fields/internal/time"
+require "mongoid/fields/internal/time_with_zone"
+require "mongoid/fields/internal/foreign_keys/array"
+require "mongoid/fields/internal/foreign_keys/object"
 
 module Mongoid #:nodoc
 
@@ -33,6 +33,16 @@ module Mongoid #:nodoc
     extend ActiveSupport::Concern
 
     included do
+      class_attribute :aliased_fields
+      class_attribute :fields
+      class_attribute :non_proc_defaults
+      class_attribute :proc_defaults
+
+      self.aliased_fields = {}
+      self.fields = {}
+      self.non_proc_defaults = []
+      self.proc_defaults = []
+
       field(:_type, :type => String)
       field(:_id, :type => BSON::ObjectId)
 
@@ -40,28 +50,73 @@ module Mongoid #:nodoc
       alias :id= :_id=
     end
 
-    # Get the default fields.
+    # Apply all default values to the document which are not procs.
     #
-    # @note Refactored from using delegate for class load performance.
+    # @example Apply all the non-proc defaults.
+    #   model.apply_non_proc_defaults
     #
-    # @example Get the defaults.
-    #   model.defaults
+    # @return [ Array<String ] The names of the non-proc defaults.
     #
-    # @return [ Array<String> ] The default field names.
-    def defaults
-      self.class.defaults
+    # @since 2.4.0
+    def apply_non_proc_defaults
+      non_proc_defaults.each do |name|
+        apply_default(name)
+      end
     end
 
-    # Get the document's fields.
+    # Apply all default values to the document which are procs.
     #
-    # @note Refactored from using delegate for class load performance.
+    # @example Apply all the proc defaults.
+    #   model.apply_proc_defaults
     #
-    # @example Get the fields.
-    #   model.fields
+    # @return [ Array<String ] The names of the proc defaults.
     #
-    # @return [ Hash ] The fields.
-    def fields
-      self.class.fields
+    # @since 2.4.0
+    def apply_proc_defaults
+      proc_defaults.each do |name|
+        apply_default(name)
+      end
+    end
+
+    # Applies a single default value for the given name.
+    #
+    # @example Apply a single default.
+    #   model.apply_default("name")
+    #
+    # @param [ String ] name The name of the field.
+    #
+    # @since 2.4.0
+    def apply_default(name)
+      unless attributes.has_key?(name)
+        if field = fields[name]
+          default = field.eval_default(self)
+          attribute_will_change!(name)
+          attributes[name] = default
+        end
+      end
+    end
+
+    # Apply all the defaults at once.
+    #
+    # @example Apply all the defaults.
+    #   model.apply_defaults
+    #
+    # @since 2.4.0
+    def apply_defaults
+      apply_non_proc_defaults
+      apply_proc_defaults
+    end
+
+    # Get a list of all the default fields for the model.
+    #
+    # @example Get a list of the defaults.
+    #   model.defaults
+    #
+    # @return [ Array<String ] The names of all defaults.
+    #
+    # @since 2.4.0
+    def defaults
+      self.class.defaults
     end
 
     class << self
@@ -103,26 +158,16 @@ module Mongoid #:nodoc
 
     module ClassMethods #:nodoc
 
-      # Returns the default values for the fields on the document.
-      #
-      # @example Get the defaults.
-      #   Person.defaults
-      #
-      # @return [ Hash ] The field defaults.
-      def defaults
-        @defaults ||= []
-      end
-
-      # Set the defaults for the class.
+      # Get a list of all the default fields for the model.
       #
-      # @example Set the defaults.
-      #   Person.defaults = defaults
+      # @example Get a list of the defaults.
+      #   Model.defaults
       #
-      # @param [ Array ] defaults The array of defaults to set.
+      # @return [ Array<String ] The names of all defaults.
       #
-      # @since 2.0.0.rc.6
-      def defaults=(defaults)
-        @defaults = defaults
+      # @since 2.4.0
+      def defaults
+        non_proc_defaults + proc_defaults
       end
 
       # Defines all the fields that are accessible on the Document
@@ -141,32 +186,13 @@ module Mongoid #:nodoc
       #
       # @return [ Field ] The generated field
       def field(name, options = {})
+        named = name.to_s
         check_field_name!(name)
-        add_field(name.to_s, options)
-      end
-
-      # Return the fields for this class.
-      #
-      # @example Get the fields.
-      #   Person.fields
-      #
-      # @return [ Hash ] The fields for this document.
-      #
-      # @since 2.0.0.rc.6
-      def fields
-        @fields ||= {}
-      end
-
-      # Set the fields for the class.
-      #
-      # @example Set the fields.
-      #   Person.fields = fields
-      #
-      # @param [ Hash ] fields The hash of fields to set.
-      #
-      # @since 2.0.0.rc.6
-      def fields=(fields)
-        @fields = fields
+        add_field(named, options).tap do
+          descendants.each do |subclass|
+            subclass.add_field(named, options)
+          end
+        end
       end
 
       # When inheriting, we want to copy the fields from the parent class and
@@ -181,7 +207,8 @@ module Mongoid #:nodoc
       # @since 2.0.0.rc.6
       def inherited(subclass)
         super
-        subclass.defaults, subclass.fields = defaults.dup, fields.dup
+        subclass.fields, subclass.non_proc_defaults, subclass.proc_defaults =
+          fields.dup, non_proc_defaults.dup, proc_defaults.dup
       end
 
       # Is the field with the provided name a BSON::ObjectId?
@@ -219,6 +246,26 @@ module Mongoid #:nodoc
 
       protected
 
+      # Add the defaults to the model. This breaks them up between ones that
+      # are procs and ones that are not.
+      #
+      # @example Add to the defaults.
+      #   Model.add_defaults(field)
+      #
+      # @param [ Field ] field The field to add for.
+      #
+      # @since 2.4.0
+      def add_defaults(field)
+        default, name = field.default_val, field.name.to_s
+        unless default.nil?
+          if field.default_val.is_a?(::Proc)
+            proc_defaults.push(name)
+          else
+            non_proc_defaults.push(name)
+          end
+        end
+      end
+
       # Define a field attribute for the +Document+.
       #
       # @example Set the field.
@@ -227,14 +274,16 @@ module Mongoid #:nodoc
       # @param [ Symbol ] name The name of the field.
       # @param [ Hash ] options The hash of options.
       def add_field(name, options = {})
-        meth = options.delete(:as) || name
-        type = options[:localize] ? Fields::Serializable::Localized : options[:type]
+        aliased = options[:as]
+        aliased_fields[aliased.to_s] = name if aliased
+        meth = aliased || name
+        type = options[:localize] ? Fields::Internal::Localized : options[:type]
         Mappings.for(type, options[:identity]).instantiate(name, options).tap do |field|
           fields[name] = field
-          defaults << name unless field.default_val.nil?
+          add_defaults(field)
           create_accessors(name, meth, options)
           process_options(field)
-          define_attribute_method(name)
+          create_dirty_methods(name)
         end
       end
 
@@ -290,28 +339,46 @@ module Mongoid #:nodoc
       # @param [ Hash ] options The options.
       def create_accessors(name, meth, options = {})
         field = fields[name]
-        generated_field_methods.module_eval do
+        generated_methods.module_eval do
           if field.cast_on_read?
-            define_method(meth) do
-              field.deserialize(read_attribute(name))
-            end
+            class_eval <<-EOM
+              def #{meth}
+                fields[#{name.inspect}].deserialize(read_attribute(#{name.inspect}))
+              end
+            EOM
           else
-            define_method(meth) do
-              read_attribute(name).tap do |value|
-                if value.is_a?(Array) || value.is_a?(Hash)
-                  unless changed_attributes.include?(name)
-                    changed_attributes[name] = value.clone
+            class_eval <<-EOM
+              def #{meth}
+                read_attribute(#{name.inspect}).tap do |value|
+                  if value.is_a?(Array) || value.is_a?(Hash)
+                    attribute_will_change!(#{name.inspect})
                   end
                 end
               end
-            end
+            EOM
           end
-          define_method("#{meth}=") do |value|
-            write_attribute(name, value)
-          end
-          define_method("#{meth}?") do
-            attr = read_attribute(name)
-            (options[:type] == Boolean) ? attr == true : attr.present?
+          class_eval <<-EOM
+            def #{meth}=(value)
+              write_attribute(#{name.inspect}, value)
+            end
+
+            def #{meth}?
+              attr = read_attribute(#{name.inspect})
+              attr == true || attr.present?
+            end
+          EOM
+
+          if options[:localize]
+            class_eval <<-EOM
+              def #{meth}_translations
+                attributes[#{name.inspect}]
+              end
+
+              def #{meth}_translations=(value)
+                attribute_will_change!(#{name.inspect})
+                attributes[#{name.inspect}] = value
+              end
+            EOM
           end
         end
       end
@@ -319,9 +386,9 @@ module Mongoid #:nodoc
       # Include the field methods as a module, so they can be overridden.
       #
       # @example Include the fields.
-      #   Person.generated_field_methods
-      def generated_field_methods
-        @generated_field_methods ||= begin
+      #   Person.generated_methods
+      def generated_methods
+        @generated_methods ||= begin
           Module.new.tap do |mod|
             include mod
           end