mongoid 2.8.1 → 3.0.0.rc

data/lib/mongoid/criterion/inspection.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Criterion #:nodoc:
-    module Inspection #:nodoc:
+module Mongoid
+  module Criterion
+    module Inspection
 
       # Get a pretty string representation of the criteria, including the
       # selector, options, matching count and documents for inspection.
@@ -10,12 +10,18 @@ module Mongoid #:nodoc:
       #   criteria.inspect
       #
       # @return [ String ] The inspection string.
+      #
+      # @since 1.0.0
       def inspect
-        "#<Mongoid::Criteria\n" <<
-        "  selector: #{selector.inspect},\n" <<
-        "  options:  #{options.inspect},\n" <<
-        "  class:    #{klass},\n" <<
-        "  embedded: #{embedded}>\n"
+        ::I18n.translate(
+          "mongoid.inspection.criteria",
+          {
+            selector: selector.inspect,
+            options: options.inspect,
+            klass: klass,
+            embedded: embedded?
+          }
+        )
       end
     end
   end

data/lib/mongoid/criterion/scoping.rb

@@ -1,82 +1,152 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Criterion #:nodoc:
+module Mongoid
+  module Criterion
     module Scoping
 
-      attr_accessor :default_scopable
-
-      # Apply the model's default scope to this criteria.
+      # Applies the default scope to the criteria.
       #
       # @example Apply the default scope.
       #   criteria.apply_default_scope
       #
       # @return [ Criteria ] The criteria.
       #
-      # @since 2.4.0
+      # @since 3.0.0
       def apply_default_scope
-        if klass.default_scoping && default_scopable?
-          self.default_scopable = false
-          fuse(klass.default_scoping)
-        else
-          self
+        klass.without_default_scope do
+          merge!(klass.default_scoping.call)
+        end
+        self.scoping_options = true, false
+      end
+
+      # Given another criteria, remove the other criteria's scoping from this
+      # criteria.
+      #
+      # @example Remove the scoping.
+      #   criteria.remove_scoping(other)
+      #
+      # @param [ Criteria ] other The other criteria.
+      #
+      # @return [ Criteria ] The criteria with scoping removed.
+      #
+      # @since 3.0.0
+      def remove_scoping(other)
+        if other
+          selector.reject! do |key, value|
+            other.selector[key] == value
+          end
+          options.reject! do |key, value|
+            other.options[key] == value
+          end
+          other.inclusions.each do |meta|
+            inclusions.delete_one(meta)
+          end
         end
+        self
       end
 
-      # Is the default scope of the class allowed to be applied?
+      # Forces the criteria to be scoped, unless it's inside an unscoped block.
       #
-      # @example Can the default scope be applied?
-      #   criteria.default_scopable?
+      # @example Force the criteria to be scoped.
+      #   criteria.scoped(skip: 10)
       #
-      # @return [ true, false ] The the default can be applied.
+      # @param [ Hash ] options Additional query options.
       #
-      # @since 2.4.0
-      def default_scopable?
-        default_scopable != false
+      # @return [ Criteria ] The scoped criteria.
+      #
+      # @since 3.0.0
+      def scoped(options = nil)
+        crit = clone
+        crit.options.merge!(options || {})
+        if klass.default_scopable? && !scoped?
+          crit.apply_default_scope
+        end
+        crit
       end
 
-      # Force the default scope to be applied to the criteria.
+      # Has the criteria had the default scope applied?
       #
-      # @example Force default scoping.
-      #   criteria.scoped
+      # @example Is the default scope applied?
+      #   criteria.scoped?
       #
-      # @return [ Criteria ] The criteria.
+      # @return [ true, false ] If the default scope is applied.
       #
-      # @since 2.4.0
-      def scoped
-        self.default_scopable = true
-        apply_default_scope
+      # @since 3.0.0
+      def scoped?
+        !!(defined?(@scoped) ? @scoped : nil)
       end
 
-      # Get the criteria with the default scoping removed.
+      # Clears all scoping from the criteria.
       #
-      # @note This has slightly different behaviour than AR - will remove the
-      #   default scoping if no other criteria have been chained and tampered
-      #   with the criterion instead of clearing everything.
-      #
-      # @example Get the criteria unscoped.
+      # @example Clear all scoping from the criteria.
       #   criteria.unscoped
       #
       # @return [ Criteria ] The unscoped criteria.
       #
-      # @since 2.4.0
+      # @since 3.0.0
       def unscoped
-        clone.tap do |criteria|
-          criteria.clear_scoping
-          criteria.default_scopable = false
+        crit = clone
+        unless unscoped?
+          crit.scoping_options = false, true
+          crit.selector.clear; crit.options.clear
         end
+        crit
+      end
+
+      # Is the criteria unscoped?
+      #
+      # @example Is the criteria unscoped?
+      #   criteria.unscoped?
+      #
+      # @return [ true, false ] If the criteria is force unscoped.
+      #
+      # @since 3.0.0
+      def unscoped?
+        !!(defined?(@unscoped) ? @unscoped : nil)
       end
 
-      # Remove all scoping from the criteria.
+      # Get the criteria scoping options, as a pair (scoped, unscoped).
       #
-      # @example Remove the default scope.
-      #   criteria.clear_scoping
+      # @example Get the scoping options.
+      #   criteria.scoping_options
       #
-      # @return [ nil ] No guaranteed return value.
+      # @return [ Array ] Scoped, unscoped.
       #
-      # @since 2.4.0
-      def clear_scoping
-        selector.clear
-        options.clear
+      # @since 3.0.0
+      def scoping_options
+        [ (defined?(@scoped) ? @scoped : nil), (defined?(@unscoped) ? @unscoped : nil) ]
+      end
+
+      # Set the criteria scoping options, as a pair (scoped, unscoped).
+      #
+      # @example Set the scoping options.
+      #   criteria.scoping_options = true, false
+      #
+      # @param [ Array ] options Scoped, unscoped.
+      #
+      # @return [ Array ] The new scoping options.
+      #
+      # @since 3.0.0
+      def scoping_options=(options)
+        @scoped, @unscoped = options
+      end
+
+      # Get the criteria with the default scope applied, if the default scope
+      # is able to be applied. Cases in which it cannot are: If we are in an
+      # unscoped block, if the criteria is already forced unscoped, or the
+      # default scope has already been applied.
+      #
+      # @example Get the criteria with the default scope.
+      #   criteria.with_default_scope
+      #
+      # @return [ Criteria ] The criteria.
+      #
+      # @since 3.0.0
+      def with_default_scope
+        crit = clone
+        if klass.default_scopable? && !unscoped? && !scoped?
+          crit.apply_default_scope
+        end
+        crit
       end
     end
   end

data/lib/mongoid/dirty.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Dirty #:nodoc:
+module Mongoid
+  module Dirty
     extend ActiveSupport::Concern
 
     # Get the changed attributes for the document.
@@ -24,7 +24,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.4.0
     def changed?
-      changed_attributes.any? || children_changed?
+      changes.values.any? { |val| val } || children_changed?
     end
 
     # Have any children (embedded documents) of this document changed?
@@ -62,11 +62,11 @@ module Mongoid #:nodoc:
     #
     # @since 2.4.0
     def changes
-      changed.inject({}.with_indifferent_access) do |changes, attr|
-        changes.tap do |hash|
-          hash[attr] = attribute_change(attr)
-        end
+      _changes = {}
+      changed.each do |attr|
+        _changes[attr] = attribute_change(attr)
       end
+      _changes
     end
 
     # Call this method after save, so the changes can be properly switched.
@@ -87,6 +87,18 @@ module Mongoid #:nodoc:
       changed_attributes.clear
     end
 
+    # Things that need to execute after a document has been persisted.
+    #
+    # @example Handle post persistence.
+    #   document.post_persist
+    #
+    # @since 3.0.0
+    def post_persist
+      reset_persisted_children
+      move_changes
+      Threaded.clear_options!
+    end
+
     # Get the previous changes on the document.
     #
     # @example Get the previous changes.
@@ -96,7 +108,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.4.0
     def previous_changes
-      @previous_changes
+      @previous_changes ||= {}
     end
 
     # Remove a change from the dirty attributes hash. Used by the single field
@@ -115,36 +127,29 @@ module Mongoid #:nodoc:
     # Gets all the new values for each of the changed fields, to be passed to
     # a MongoDB $set modifier.
     #
-    # @todo: Durran: Refactor 3.0
-    #
     # @example Get the setters for the atomic updates.
     #   person = Person.new(:title => "Sir")
     #   person.title = "Madam"
     #   person.setters # returns { "title" => "Madam" }
     #
     # @return [ Hash ] A +Hash+ of atomic setters.
+    #
+    # @since 2.0.0
     def setters
-      {}.tap do |modifications|
-        changes.each_pair do |name, changes|
-          if changes
-            old, new = changes
-            field = fields[name]
-            key = embedded? ? "#{atomic_position}.#{name}" : name
-            if field && field.resizable?
-              field.add_atomic_changes(
-                self,
-                name,
-                key,
-                modifications,
-                new,
-                old
-              )
-            else
-              modifications[key] = new
-            end
+      mods = {}
+      changes.each_pair do |name, changes|
+        if changes
+          old, new = changes
+          field = fields[name]
+          key = atomic_attribute_name(name)
+          if field && field.resizable?
+            field.add_atomic_changes(self, name, key, mods, new, old)
+          else
+            mods[key] = new unless atomic_unsets.include?(key)
           end
         end
       end
+      mods
     end
 
     private
@@ -178,6 +183,22 @@ module Mongoid #:nodoc:
       changed_attributes[attr] != attributes[attr]
     end
 
+    # Get whether or not the field has a different value from the default.
+    #
+    # @example Is the field different from the default?
+    #   model.attribute_changed_from_default?
+    #
+    # @param [ String ] attr The name of the attribute.
+    #
+    # @return [ true, false ] If the attribute differs.
+    #
+    # @since 3.0.0
+    def attribute_changed_from_default?(attr)
+      field = fields[attr]
+      return false unless field
+      attributes[attr] != field.eval_default(self)
+    end
+
     # Get the previous value for the attribute.
     #
     # @example Get the previous value.
@@ -202,7 +223,7 @@ module Mongoid #:nodoc:
     # @since 2.3.0
     def attribute_will_change!(attr)
       unless changed_attributes.has_key?(attr)
-        changed_attributes[attr] = read_attribute(attr)._deep_copy
+        changed_attributes[attr] = read_attribute(attr).__deep_copy__
       end
     end
 
@@ -220,7 +241,7 @@ module Mongoid #:nodoc:
       attributes[attr] = changed_attributes[attr] if attribute_changed?(attr)
     end
 
-    module ClassMethods #:nodoc:
+    module ClassMethods
 
       private
 
@@ -236,49 +257,113 @@ module Mongoid #:nodoc:
       #
       # @since 2.4.0
       def create_dirty_methods(name, meth)
-        generated_methods.module_eval do
-          if meth =~ /\W/
-            define_method("#{meth}_change") do
-              attribute_change(name)
-            end
-
-            define_method("#{meth}_changed?") do
-              attribute_changed?(name)
-            end
-
-            define_method("#{meth}_was") do
-              attribute_was(name)
-            end
+        create_dirty_change_accessor(name, meth)
+        create_dirty_change_check(name, meth)
+        create_dirty_change_flag(name, meth)
+        create_dirty_default_change_check(name, meth)
+        create_dirty_previous_value_accessor(name, meth)
+        create_dirty_reset(name, meth)
+        create_dirty_reset(name, meth)
+      end
 
-            define_method("#{meth}_will_change!") do
-              attribute_will_change!(name)
-            end
+      # Creates the dirty change accessor.
+      #
+      # @example Create the accessor.
+      #   Model.create_dirty_change_accessor("name", "alias")
+      #
+      # @param [ String ] name The attribute name.
+      # @param [ String ] meth The name of the accessor.
+      #
+      # @since 3.0.0
+      def create_dirty_change_accessor(name, meth)
+        generated_methods.module_eval do
+          re_define_method("#{meth}_change") do
+            attribute_change(name)
+          end
+        end
+      end
 
-            define_method("reset_#{meth}!") do
-              reset_attribute!(name)
-            end
-          else
-            class_eval <<-EOM
-              def #{meth}_change
-                attribute_change(#{name.inspect})
-              end
+      # Creates the dirty change check.
+      #
+      # @example Create the check.
+      #   Model.create_dirty_change_check("name", "alias")
+      #
+      # @param [ String ] name The attribute name.
+      # @param [ String ] meth The name of the accessor.
+      #
+      # @since 3.0.0
+      def create_dirty_change_check(name, meth)
+        generated_methods.module_eval do
+          re_define_method("#{meth}_changed?") do
+            attribute_changed?(name)
+          end
+        end
+      end
 
-              def #{meth}_changed?
-                attribute_changed?(#{name.inspect})
-              end
+      # Creates the dirty default change check.
+      #
+      # @example Create the check.
+      #   Model.create_dirty_default_change_check("name", "alias")
+      #
+      # @param [ String ] name The attribute name.
+      # @param [ String ] meth The name of the accessor.
+      #
+      # @since 3.0.0
+      def create_dirty_default_change_check(name, meth)
+        generated_methods.module_eval do
+          re_define_method("#{meth}_changed_from_default?") do
+            attribute_changed_from_default?(name)
+          end
+        end
+      end
 
-              def #{meth}_was
-                attribute_was(#{name.inspect})
-              end
+      # Creates the dirty change previous value accessor.
+      #
+      # @example Create the accessor.
+      #   Model.create_dirty_previous_value_accessor("name", "alias")
+      #
+      # @param [ String ] name The attribute name.
+      # @param [ String ] meth The name of the accessor.
+      #
+      # @since 3.0.0
+      def create_dirty_previous_value_accessor(name, meth)
+        generated_methods.module_eval do
+          re_define_method("#{meth}_was") do
+            attribute_was(name)
+          end
+        end
+      end
 
-              def #{meth}_will_change!
-                attribute_will_change!(#{name.inspect})
-              end
+      # Creates the dirty change flag.
+      #
+      # @example Create the flag.
+      #   Model.create_dirty_change_flag("name", "alias")
+      #
+      # @param [ String ] name The attribute name.
+      # @param [ String ] meth The name of the accessor.
+      #
+      # @since 3.0.0
+      def create_dirty_change_flag(name, meth)
+        generated_methods.module_eval do
+          re_define_method("#{meth}_will_change!") do
+            attribute_will_change!(name)
+          end
+        end
+      end
 
-              def reset_#{meth}!
-                reset_attribute!(#{name.inspect})
-              end
-            EOM
+      # Creates the dirty change reset.
+      #
+      # @example Create the reset.
+      #   Model.create_dirty_reset("name", "alias")
+      #
+      # @param [ String ] name The attribute name.
+      # @param [ String ] meth The name of the accessor.
+      #
+      # @since 3.0.0
+      def create_dirty_reset(name, meth)
+        generated_methods.module_eval do
+          re_define_method("reset_#{meth}!") do
+            reset_attribute!(name)
           end
         end
       end