mongoid 2.8.1 → 3.0.0.rc

data/lib/mongoid.rb

@@ -22,13 +22,18 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 require "delegate"
 require "time"
+require "set"
+
 require "active_support/core_ext"
 require 'active_support/json'
 require "active_support/inflector"
-require "active_support/lazy_load_hooks"
 require "active_support/time_with_zone"
 require "active_model"
-require "mongo"
+
+require "origin"
+require "moped"
+BSON = Moped::BSON
+
 require "mongoid/extensions"
 require "mongoid/errors"
 require "mongoid/threaded"
@@ -36,42 +41,34 @@ require "mongoid/relations"
 require "mongoid/atomic"
 require "mongoid/attributes"
 require "mongoid/callbacks"
-require "mongoid/collection"
-require "mongoid/collections"
 require "mongoid/config"
-require "mongoid/contexts"
+require "mongoid/contextual"
 require "mongoid/copyable"
 require "mongoid/criteria"
-require "mongoid/cursor"
-require "mongoid/default_scope"
 require "mongoid/dirty"
-require "mongoid/extras"
 require "mongoid/factory"
 require "mongoid/fields"
 require "mongoid/finders"
 require "mongoid/hierarchy"
-require "mongoid/identity"
 require "mongoid/identity_map"
 require "mongoid/indexes"
 require "mongoid/inspection"
 require "mongoid/javascript"
 require "mongoid/json"
-require "mongoid/keys"
-require "mongoid/logger"
+require "mongoid/loggable"
 require "mongoid/matchers"
 require "mongoid/multi_parameter_attributes"
-require "mongoid/multi_database"
-require "mongoid/named_scope"
 require "mongoid/nested_attributes"
 require "mongoid/observer"
 require "mongoid/persistence"
 require "mongoid/reloading"
-require "mongoid/safety"
-require "mongoid/scope"
+require "mongoid/scoping"
 require "mongoid/serialization"
+require "mongoid/sessions"
 require "mongoid/sharding"
 require "mongoid/state"
 require "mongoid/timestamps"
+require "mongoid/unit_of_work"
 require "mongoid/validations"
 require "mongoid/version"
 require "mongoid/versioning"
@@ -94,7 +91,9 @@ end
 # add english load path by default
 I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
 
-module Mongoid #:nodoc
+module Mongoid
+  extend Loggable
+  extend UnitOfWork
   extend self
 
   MONGODB_VERSION = "2.0.0"
@@ -103,10 +102,8 @@ module Mongoid #:nodoc
   #
   # @example Set up configuration options.
   #   Mongoid.configure do |config|
-  #     name = "mongoid_test"
-  #     host = "localhost"
   #     config.allow_dynamic_fields = false
-  #     config.master = Mongo::Connection.new.db(name)
+  #     config.use(name: "mongoid_test", host: "localhost", port: 27017)
   #   end
   #
   # @return [ Config ] The configuration obejct.
@@ -115,25 +112,13 @@ module Mongoid #:nodoc
   def configure
     block_given? ? yield(Config) : Config
   end
-  alias :config :configure
 
-  # We can process a unit of work in Mongoid and have the identity map
-  # automatically clear itself out after the work is complete.
-  #
-  # @example Process a unit of work.
-  #   Mongoid.unit_of_work do
-  #     Person.create(:title => "Sir")
-  #   end
-  #
-  # @return [ Object ] The result of the block.
-  #
-  # @since 2.1.0
-  def unit_of_work
-    begin
-      yield if block_given?
-    ensure
-      IdentityMap.clear
-    end
+  def default_session
+    Sessions.default
+  end
+
+  def session(name)
+    Sessions.with_name(name)
   end
 
   # Take all the public instance methods from the Config singleton and allow
@@ -143,7 +128,7 @@ module Mongoid #:nodoc
   #   Mongoid.database = Mongo::Connection.new.db("test")
   #
   # @since 1.0.0
-  delegate *(Config.public_instance_methods(false) +
+  delegate(*(Config.public_instance_methods(false) +
     ActiveModel::Observing::ClassMethods.public_instance_methods(false) <<
-    { :to => Config })
+    { to: Config }))
 end

data/lib/mongoid/atomic.rb

@@ -2,7 +2,7 @@
 require "mongoid/atomic/modifiers"
 require "mongoid/atomic/paths"
 
-module Mongoid #:nodoc:
+module Mongoid
 
   # This module contains the logic for supporting atomic operations against the
   # database.
@@ -99,12 +99,12 @@ module Mongoid #:nodoc:
     #
     # @since 2.1.0
     def atomic_updates
-      Modifiers.new.tap do |mods|
-        generate_atomic_updates(mods, self)
-        _children.each do |child|
-          generate_atomic_updates(mods, child)
-        end
+      mods = Modifiers.new
+      generate_atomic_updates(mods, self)
+      _children.each do |child|
+        generate_atomic_updates(mods, child)
       end
+      mods
     end
     alias :_updates :atomic_updates
 
@@ -151,6 +151,16 @@ module Mongoid #:nodoc:
       atomic_paths.position
     end
 
+    # Returns path of the attribute for modification
+    #
+    # @example Get path of the attribute
+    #   address.atomic_attribute_name(:city)
+    #
+    # @return [ String ] The path to the document attribute in the database
+    def atomic_attribute_name(name)
+      embedded? ? "#{atomic_position}.#{name}" : name
+    end
+
     # Get all the attributes that need to be pulled.
     #
     # @example Get the pulls.
@@ -252,9 +262,6 @@ module Mongoid #:nodoc:
     # @example Get the atomic paths.
     #   document.atomic_paths
     #
-    # @todo: Durran: Should probably raise error for embedded docs w/o
-    #   metadata.
-    #
     # @return [ Object ] The associated path.
     #
     # @since 2.1.0
@@ -281,29 +288,5 @@ module Mongoid #:nodoc:
       mods.add_to_set(doc.atomic_array_add_to_sets)
       mods.pull_all(doc.atomic_array_pulls)
     end
-
-
-    # Get the atomic updates for a touch operation. Should only include the
-    # updated_at field and the optional extra field.
-    #
-    # @api private
-    #
-    # @example Get the touch atomic updates.
-    #   document.touch_atomic_updates
-    #
-    # @param [ Symbol ] field The optional field.
-    #
-    # @return [ Hash ] The atomic updates.
-    #
-    # @since 2.6.0
-    def touch_atomic_updates(field = nil)
-      updates = atomic_updates
-      return {} unless atomic_updates.has_key?("$set")
-      touches = {}
-      updates["$set"].each_pair do |key, value|
-        touches.merge!({ key => value }) if key =~ /updated_at|#{field}/
-      end
-      { "$set" => touches }
-    end
   end
 end

data/lib/mongoid/atomic/modifiers.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Atomic #:nodoc:
+module Mongoid
+  module Atomic
 
     # This class contains the logic for supporting atomic operations against the
     # database.

data/lib/mongoid/atomic/paths/embedded.rb

@@ -2,9 +2,9 @@
 require "mongoid/atomic/paths/embedded/one"
 require "mongoid/atomic/paths/embedded/many"
 
-module Mongoid #:nodoc:
-  module Atomic #:nodoc:
-    module Paths #:nodoc:
+module Mongoid
+  module Atomic
+    module Paths
 
       # Common functionality between the two different embedded paths.
       module Embedded
@@ -34,8 +34,7 @@ module Mongoid #:nodoc:
         # @since 2.1.0
         def selector
           parent.atomic_selector.
-            merge!({ "#{path}._id" => document.identifier || document._id }).
-            merge!(document.shard_key_selector)
+            merge!({ "#{path}._id" => document._id }).merge!(document.shard_key_selector)
         end
       end
     end

data/lib/mongoid/atomic/paths/embedded/many.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Atomic #:nodoc:
-    module Paths #:nodoc:
-      module Embedded #:nodoc:
+module Mongoid
+  module Atomic
+    module Paths
+      module Embedded
 
         # This class encapsulates behaviour for locating and updating
         # documents that are defined as an embedded 1-n.
@@ -34,8 +34,8 @@ module Mongoid #:nodoc:
           # @since 2.1.0
           def position
             pos = parent.atomic_position
-            locator = document.new? ? "" : ".#{document._index}"
-            "#{pos}#{"." unless pos.blank?}#{document.metadata.name}#{locator}"
+            locator = document.new_record? ? "" : ".#{document._index}"
+            "#{pos}#{"." unless pos.blank?}#{document.metadata.store_as}#{locator}"
           end
         end
       end

data/lib/mongoid/atomic/paths/embedded/one.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Atomic #:nodoc:
-    module Paths #:nodoc:
-      module Embedded #:nodoc:
+module Mongoid
+  module Atomic
+    module Paths
+      module Embedded
 
         # This class encapsulates behaviour for locating and updating
         # documents that are defined as an embedded 1-1.
@@ -34,7 +34,7 @@ module Mongoid #:nodoc:
           # @since 2.1.0
           def position
             pos = parent.atomic_position
-            "#{pos}#{"." unless pos.blank?}#{document.metadata.name}"
+            "#{pos}#{"." unless pos.blank?}#{document.metadata.store_as}"
           end
         end
       end

data/lib/mongoid/atomic/paths/root.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Atomic #:nodoc:
-    module Paths #:nodoc:
+module Mongoid
+  module Atomic
+    module Paths
 
       # This class encapsulates behaviour for locating and updating root
       # documents atomically.
@@ -31,8 +31,7 @@ module Mongoid #:nodoc:
         #
         # @since 2.1.0
         def selector
-          { "_id" => document.identifier || document._id }.
-            merge!(document.shard_key_selector)
+          { "_id" => document._id }.merge!(document.shard_key_selector)
         end
       end
     end

data/lib/mongoid/attributes.rb

@@ -1,13 +1,15 @@
 # encoding: utf-8
 require "mongoid/attributes/processing"
+require "mongoid/attributes/readonly"
 
-module Mongoid #:nodoc:
+module Mongoid
 
   # This module contains the logic for handling the internal attributes hash,
   # and how to get and set values.
   module Attributes
     extend ActiveSupport::Concern
     include Processing
+    include Readonly
 
     attr_reader :attributes
     alias :raw_attributes :attributes
@@ -24,9 +26,22 @@ module Mongoid #:nodoc:
     # @since 1.0.0
     def attribute_present?(name)
       attribute = read_attribute(name)
-      ! attribute.blank? || attribute == false
+      !attribute.blank? || attribute == false
+    end
+
+    # Does the document have the provided attribute?
+    #
+    # @example Does the document have the attribute?
+    #   model.has_attribute?(:name)
+    #
+    # @param [ String, Symbol ] name The name of the attribute.
+    #
+    # @return [ true, false ] If the key is present in the attributes.
+    #
+    # @since 3.0.0
+    def has_attribute?(name)
+      attributes.has_key?(name.to_s)
     end
-    alias :has_attribute? :attribute_present?
 
     # Read a value from the document attributes. If the value does not exist
     # it will return nil.
@@ -55,11 +70,18 @@ module Mongoid #:nodoc:
     #
     # @param [ String, Symbol ] name The name of the attribute to remove.
     #
+    # @raise [ Errors::ReadonlyAttribute ] If the field cannot be removed due
+    #   to being flagged as reaodnly.
+    #
     # @since 1.0.0
     def remove_attribute(name)
+      access = name.to_s
+      unless attribute_writable?(name)
+        raise Errors::ReadonlyAttribute.new(name, :nil)
+      end
       _assigning do
-        access = name.to_s
         attribute_will_change!(access)
+        atomic_unsets.push(atomic_attribute_name(access))
         attributes.delete(access)
       end
     end
@@ -74,11 +96,12 @@ module Mongoid #:nodoc:
     # @return [ true, false ] True if it does, false if not.
     #
     # @since 1.0.0
-    def respond_to?(*args)
-      (Mongoid.allow_dynamic_fields &&
+    def respond_to?(name, include_private = false)
+      super || (
+        Mongoid.allow_dynamic_fields &&
         attributes &&
-        attributes.has_key?(args.first.to_s.reader)
-      ) || super
+        attributes.has_key?(name.to_s.reader)
+      )
     end
 
     # Write a single attribute to the document attribute hash. This will
@@ -96,18 +119,20 @@ module Mongoid #:nodoc:
     #
     # @since 1.0.0
     def write_attribute(name, value)
-      _assigning do
-        access = name.to_s
-        localized = fields[access].try(:localized?)
-        typed_value_for(access, value).tap do |value|
-          unless attributes[access] == value || attribute_changed?(access)
+      access = name.to_s
+      if attribute_writable?(access)
+        _assigning do
+          localized = fields[access].try(:localized?)
+          typed_value = typed_value_for(access, value)
+          unless attributes[access] == typed_value || attribute_changed?(access)
             attribute_will_change!(access)
           end
           if localized
-            (attributes[access] ||= {}).merge!(value)
+            (attributes[access] ||= {}).merge!(typed_value)
           else
-            attributes[access] = value
+            attributes[access] = typed_value
           end
+          typed_value
         end
       end
     end
@@ -130,9 +155,7 @@ module Mongoid #:nodoc:
     # @since 2.2.1
     def assign_attributes(attrs = nil, options = {})
       _assigning do
-        process(attrs, options[:as] || :default, !options[:without_protection]) do |document|
-          document.identify if new? && id.blank?
-        end
+        process_attributes(attrs, options[:as] || :default, !options[:without_protection])
       end
     end
 
@@ -151,11 +174,47 @@ module Mongoid #:nodoc:
     #
     # @since 1.0.0
     def write_attributes(attrs = nil, guard_protected_attributes = true)
-      assign_attributes(attrs, :without_protection => !guard_protected_attributes)
+      assign_attributes(attrs, without_protection: !guard_protected_attributes)
     end
     alias :attributes= :write_attributes
 
-    protected
+    private
+
+    # Define a reader method for a dynamic attribute.
+    #
+    # @api private
+    #
+    # @example Define a reader method.
+    #   model.define_dynamic_reader(:field)
+    #
+    # @param [ String ] name The name of the field.
+    #
+    # @since 3.0.0
+    def define_dynamic_reader(name)
+      class_eval <<-READER
+        def #{name}
+          read_attribute(#{name.inspect})
+        end
+      READER
+    end
+
+    # Define a writer method for a dynamic attribute.
+    #
+    # @api private
+    #
+    # @example Define a writer method.
+    #   model.define_dynamic_writer(:field)
+    #
+    # @param [ String ] name The name of the field.
+    #
+    # @since 3.0.0
+    def define_dynamic_writer(name)
+      class_eval <<-WRITER
+        def #{name}=(value)
+          write_attribute(#{name.inspect}, value)
+        end
+      WRITER
+    end
 
     # Used for allowing accessor methods for dynamic attributes.
     #
@@ -165,9 +224,13 @@ module Mongoid #:nodoc:
       attr = name.to_s
       return super unless attributes.has_key?(attr.reader)
       if attr.writer?
-        write_attribute(attr.reader, (args.size > 1) ? args : args.first)
+        getter = attr.reader
+        define_dynamic_writer(getter)
+        write_attribute(getter, args.first)
       else
-        read_attribute(attr.reader)
+        getter = attr.reader
+        define_dynamic_reader(getter)
+        read_attribute(getter)
       end
     end
 
@@ -183,10 +246,10 @@ module Mongoid #:nodoc:
     #
     # @since 1.0.0
     def typed_value_for(key, value)
-      fields.has_key?(key) ? fields[key].serialize(value) : value
+      fields.has_key?(key) ? fields[key].mongoize(value) : value
     end
 
-    module ClassMethods #:nodoc:
+    module ClassMethods
 
       # Alias the provided name to the original field. This will provide an
       # aliased getter, setter, existance check, and all dirty attribute
@@ -205,14 +268,14 @@ module Mongoid #:nodoc:
       # @since 2.3.0
       def alias_attribute(name, original)
         class_eval <<-RUBY
-          alias :#{name} :#{original}
-          alias :#{name}= :#{original}=
-          alias :#{name}? :#{original}?
-          alias :#{name}_change :#{original}_change
-          alias :#{name}_changed? :#{original}_changed?
-          alias :reset_#{name}! :reset_#{original}!
-          alias :#{name}_was :#{original}_was
-          alias :#{name}_will_change! :#{original}_will_change!
+          alias #{name}  #{original}
+          alias #{name}= #{original}=
+          alias #{name}? #{original}?
+          alias #{name}_change   #{original}_change
+          alias #{name}_changed? #{original}_changed?
+          alias reset_#{name}!   reset_#{original}!
+          alias #{name}_was      #{original}_was
+          alias #{name}_will_change! #{original}_will_change!
         RUBY
       end
     end