mongoid 2.3.5 → 2.4.0

data/lib/mongoid/criterion/selector.rb

@@ -6,7 +6,7 @@ module Mongoid #:nodoc:
     # mongoid criteria selectors.
     class Selector < Hash
 
-      attr_reader :fields, :klass
+      attr_reader :aliased_fields, :fields, :klass
 
       # Create the new selector.
       #
@@ -17,7 +17,8 @@ module Mongoid #:nodoc:
       #
       # @since 1.0.0
       def initialize(klass)
-        @fields, @klass = klass.fields.except("_id", "_type"), klass
+        @aliased_fields, @fields, @klass =
+          klass.aliased_fields, klass.fields.except("_id", "_type"), klass
       end
 
       # Set the value for the supplied key, attempting to typecast the value.
@@ -84,8 +85,10 @@ module Mongoid #:nodoc:
       # @since 1.0.0
       def try_to_typecast(key, value)
         access = key.to_s
-        return value unless fields.has_key?(access)
-        field = fields[access]
+        if !fields.has_key?(access) && !aliased_fields.has_key?(access)
+          return value
+        end
+        field = fields[access] || fields[aliased_fields[access]]
         typecast_value_for(field, value)
       end
 
@@ -101,7 +104,7 @@ module Mongoid #:nodoc:
       #
       # @since 1.0.0
       def typecast_value_for(field, value)
-        return field.serialize(value) if field.type === value
+        return field.selection(value) if field.type === value
         case value
         when Hash
           value = value.dup
@@ -121,7 +124,7 @@ module Mongoid #:nodoc:
           if field.type == Array
             Serialization.mongoize(value, value.class)
           else
-            field.serialize(value)
+            field.selection(value)
           end
         end
       end

data/lib/mongoid/default_scope.rb

@@ -29,7 +29,7 @@ module Mongoid #:nodoc:
       #
       # @since 2.0.0.rc.1
       def default_scope(conditions = {})
-        self.default_scoping = Scope.new(conditions).conditions.scoped
+        self.default_scoping = Scope.new(conditions).conditions.as_conditions
       end
     end
   end

data/lib/mongoid/dirty.rb

@@ -2,7 +2,58 @@
 module Mongoid #:nodoc:
   module Dirty #:nodoc:
     extend ActiveSupport::Concern
-    include ActiveModel::Dirty
+
+    # Get the changed attributes for the document.
+    #
+    # @example Get the changed attributes.
+    #   model.changed
+    #
+    # @return [ Array<String> ] The changed attributes.
+    #
+    # @since 2.4.0
+    def changed
+      changed_attributes.keys
+    end
+
+    # Has the document changed?
+    #
+    # @example Has the document changed?
+    #   model.changed?
+    #
+    # @return [ true, false ] If the document is changed.
+    #
+    # @since 2.4.0
+    def changed?
+      changed_attributes.any?
+    end
+
+    # Get the attribute changes.
+    #
+    # @example Get the attribute changes.
+    #   model.changed_attributes
+    #
+    # @return [ Hash<String, Object> ] The attribute changes.
+    #
+    # @since 2.4.0
+    def changed_attributes
+      @changed_attributes ||= {}
+    end
+
+    # Get all the changes for the document.
+    #
+    # @example Get all the changes.
+    #   model.changes
+    #
+    # @return [ Hash<String, Array<Object, Object> ] The changes.
+    #
+    # @since 2.4.0
+    def changes
+      changed.inject({}.with_indifferent_access) do |changes, attr|
+        changes.tap do |hash|
+          hash[attr] = attribute_change(attr)
+        end
+      end
+    end
 
     # Call this method after save, so the changes can be properly switched.
     #
@@ -15,14 +66,25 @@ module Mongoid #:nodoc:
     # @since 2.1.0
     def move_changes
       @_children = nil
-      @previously_changed = changes
-      atomic_pulls.clear
-      atomic_unsets.clear
-      delayed_atomic_sets.clear
-      delayed_atomic_pulls.clear
+      @previous_changes = changes
+      Atomic::UPDATES.each do |update|
+        send(update).clear
+      end
       changed_attributes.clear
     end
 
+    # Get the previous changes on the document.
+    #
+    # @example Get the previous changes.
+    #   model.previous_changes
+    #
+    # @return [ Hash<String, Array<Object, Object> ] The previous changes.
+    #
+    # @since 2.4.0
+    def previous_changes
+      @previous_changes
+    end
+
     # Remove a change from the dirty attributes hash. Used by the single field
     # atomic updators.
     #
@@ -39,6 +101,8 @@ 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"
@@ -47,10 +111,17 @@ module Mongoid #:nodoc:
     # @return [ Hash ] A +Hash+ of atomic setters.
     def setters
       {}.tap do |modifications|
-        changes.each_pair do |field, changes|
+        changes.each_pair do |name, changes|
           if changes
-            key = embedded? ? "#{atomic_position}.#{field}" : field
-            modifications[key] = changes[1]
+            old, new = changes
+            field = fields[name]
+            key = embedded? ? "#{atomic_position}.#{name}" : name
+            if field && field.resizable?
+              pushes, pulls = new - (old || []), (old || []) - new
+              field.add_atomic_changes(self, key, modifications, pushes, pulls)
+            else
+              modifications[key] = new
+            end
           end
         end
       end
@@ -58,15 +129,14 @@ module Mongoid #:nodoc:
 
     private
 
-    # Get the current value for the specified attribute, if the attribute has changed.
+    # Get the old and new value for the provided attribute.
     #
-    # @note This is overriding the AM::Dirty implementation to read from the mongoid
-    #   attributes hash, which may contain a serialized version of the attributes data. It is
-    #   necessary to read the serialized version as the changed value, to allow updates to
-    #   the MongoDB document to persist correctly. For example, if a DateTime field is updated
-    #   it must be persisted as a UTC Time.
+    # @example Get the attribute change.
+    #   model.attribute_change("name")
+    #
+    # @param [ String ] attr The name of the attribute.
     #
-    # @return [ Object ] The current value of the field, or nil if no change made.
+    # @return [ Array<Object> ] The old and new values.
     #
     # @since 2.1.0
     def attribute_change(attr)
@@ -75,8 +145,8 @@ module Mongoid #:nodoc:
 
     # Determine if a specific attribute has changed.
     #
-    # @note Overriding AM::Dirty once again since their implementation is not
-    #   friendly to fields that can be changed in place.
+    # @example Has the attribute changed?
+    #   model.attribute_changed?("name")
     #
     # @param [ String ] attr The name of the attribute.
     #
@@ -84,26 +154,90 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.6
     def attribute_changed?(attr)
-      return false unless changed_attributes.include?(attr)
+      return false unless changed_attributes.has_key?(attr)
       changed_attributes[attr] != attributes[attr]
     end
 
-    # Override Active Model's behaviour here in order to stay away from
-    # infinite loops on getter/setter overrides.
+    # Get the previous value for the attribute.
+    #
+    # @example Get the previous value.
+    #   model.attribute_was("name")
+    #
+    # @param [ String ] attr The attribute name.
+    #
+    # @since 2.4.0
+    def attribute_was(attr)
+      attribute_changed?(attr) ? changed_attributes[attr] : attributes[attr]
+    end
+
+    # Flag an attribute as going to change.
     #
-    # @example Flag an attribute as changing.
-    #   document.attribute_will_change!(:name)
+    # @example Flag the attribute.
+    #   model.attribute_will_change!("name")
     #
-    # @param [ Symbol ] attr The attribute.
+    # @param [ String ] attr The name of the attribute.
     #
-    # @return [ Object ] The value of the attribute.
+    # @return [ Object ] The old value.
     #
     # @since 2.3.0
     def attribute_will_change!(attr)
-      unless changed_attributes.include?(attr)
-        value = read_attribute(attr)
-        value = value.duplicable? ? value.clone : value
-        changed_attributes[attr] = value
+      unless changed_attributes.has_key?(attr)
+        changed_attributes[attr] = read_attribute(attr)._deep_copy
+      end
+    end
+
+    # Set the attribute back to it's old value.
+    #
+    # @example Reset the attribute.
+    #   model.reset_attribute!("name")
+    #
+    # @param [ String ] attr The name of the attribute.
+    #
+    # @return [ Object ] The old value.
+    #
+    # @since 2.4.0
+    def reset_attribute!(attr)
+      attributes[attr] = changed_attributes[attr] if attribute_changed?(attr)
+    end
+
+    module ClassMethods #:nodoc:
+
+      private
+
+      # Generate all the dirty methods needed for the attribute.
+      #
+      # @example Generate the dirty methods.
+      #   Model.create_dirty_methods("name")
+      #
+      # @param [ String ] name The name of the attribute.
+      #
+      # @return [ Module ] The fields module.
+      #
+      # @since 2.4.0
+      def create_dirty_methods(name)
+        generated_methods.module_eval do
+          class_eval <<-EOM
+            def #{name}_change
+              attribute_change(#{name.inspect})
+            end
+
+            def #{name}_changed?
+              attribute_changed?(#{name.inspect})
+            end
+
+            def #{name}_was
+              attribute_was(#{name.inspect})
+            end
+
+            def #{name}_will_change!
+              attribute_will_change!(#{name.inspect})
+            end
+
+            def reset_#{name}!
+              reset_attribute!(#{name.inspect})
+            end
+          EOM
+        end
       end
     end
   end

data/lib/mongoid/document.rb

@@ -68,8 +68,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.0.0
     def freeze
-      attributes.freeze
-      self
+      tap { |doc| doc.as_document.freeze }
     end
 
     # Checks if the document is frozen
@@ -81,7 +80,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.0.0
     def frozen?
-      raw_attributes.frozen?
+      attributes.frozen?
     end
 
     # Delegates to id in order to allow two records of the same type and id to
@@ -95,7 +94,7 @@ module Mongoid #:nodoc:
     #
     # @return [ Integer ] The hash of the document's id.
     def hash
-      raw_attributes["_id"].hash
+      attributes["_id"].hash
     end
 
     # Generate an id for this +Document+.
@@ -128,15 +127,33 @@ module Mongoid #:nodoc:
         @new_record = true
         @attributes ||= {}
         options ||= {}
+        apply_non_proc_defaults
+        identify if using_object_ids?
         process(attrs, options[:as] || :default, !options[:without_protection]) do
-          identify
-          apply_defaults
+          identify unless using_object_ids?
           yield(self) if block_given?
         end
+        apply_proc_defaults
         run_callbacks(:initialize) { self }
       end
     end
 
+    # Return the key value for the document.
+    #
+    # @example Return the key.
+    #   document.to_key
+    #
+    # @return [ Object ] The id of the document or nil if new.
+    #
+    # @since 2.4.0
+    def to_key
+      if destroyed?
+        [ id ]
+      else
+        persisted? ? [ id ] : nil
+      end
+    end
+
     # Return an array with this +Document+ only in it.
     #
     # @example Return the document in an array.
@@ -157,6 +174,7 @@ module Mongoid #:nodoc:
     # @return [ Hash ] A hash of all attributes in the hierarchy.
     def as_document
       attributes.tap do |attrs|
+        return attrs if frozen?
         relations.each_pair do |name, meta|
           if meta.embedded?
             relation = send(name)
@@ -189,6 +207,27 @@ module Mongoid #:nodoc:
       end
     end
 
+    # Print out the cache key. This will append different values on the
+    # plural model name.
+    #
+    # If new_record?     - will append /new
+    # If not             - will append /id-updated_at.to_s(:number)
+    # Without updated_at - will append /id
+    #
+    # This is usually called insode a cache() block
+    #
+    # @example Returns the cache key
+    #   document.cache_key
+    #
+    # @return [ String ] the string with or without updated_at
+    #
+    # @since 2.4.0
+    def cache_key
+      return "#{model_key}/new" if new_record?
+      return "#{model_key}/#{id}-#{updated_at.utc.to_s(:number)}" if updated_at
+      "#{model_key}/#{id}"
+    end
+
     private
 
     # Returns the logger
@@ -200,6 +239,18 @@ module Mongoid #:nodoc:
       Mongoid.logger
     end
 
+    # Get the name of the model used in caching.
+    #
+    # @example Get the model key.
+    #   model.model_key
+    #
+    # @return [ String ] The model key.
+    #
+    # @since 2.4.0
+    def model_key
+      @model_cache_key ||= "#{self.class.model_name.cache_key}"
+    end
+
     # Implement this for calls to flatten on array.
     #
     # @example Get the document as an array.
@@ -241,7 +292,7 @@ module Mongoid #:nodoc:
         attributes = attrs || {}
         allocate.tap do |doc|
           doc.instance_variable_set(:@attributes, attributes)
-          doc.send(:apply_defaults)
+          doc.apply_defaults
           IdentityMap.set(doc) unless _loading_revision?
           doc.run_callbacks(:initialize) { doc }
         end

data/lib/mongoid/errors.rb

@@ -11,6 +11,8 @@ require "mongoid/errors/invalid_options"
 require "mongoid/errors/invalid_time"
 require "mongoid/errors/invalid_type"
 require "mongoid/errors/mixed_relations"
+require "mongoid/errors/no_environment"
+require "mongoid/errors/scope_overwrite"
 require "mongoid/errors/too_many_nested_attribute_records"
 require "mongoid/errors/unsaved_document"
 require "mongoid/errors/unsupported_version"

data/lib/mongoid/errors/no_environment.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # Raised when trying to load configuration with no RACK_ENV set
+    class NoEnvironment < MongoidError
+
+      # Create the new no environment error.
+      #
+      # @example Create the new no environment error.
+      #   NoEnvironment.new
+      #
+      # @since 2.4.0
+      def initialize
+        super(translate("no_environment", {}))
+      end
+    end
+  end
+end