mongoid 2.0.2 → 2.1.0

data/lib/config/locales/ro.yml

@@ -11,6 +11,9 @@ ro:
         invalid_type:
           Câmpul a fost definit ca şi un(o) %{klass}, dar valoarea
           recepţionată %{value} este de clasa %{other}.
+        invalid_options:
+          "Invalid option :%{invalid} provided to relation :%{name}. Valid options
+          are: %{valid}."
         unsupported_version:
           Versiunea MongoDB %{version} nu este suportată.
           Vă rugăm să folosiţi versiunea %{mongo_version}.
@@ -44,3 +47,6 @@ ro:
         unsaved_document:
           You cannot call create or create! through a relational association
           relation (%{document}) who's parent (%{base}) is not already saved.
+        mixed_relations:
+          Referencing a(n) %{embedded} document from the %{root} document via a
+          relational association is not allowed since the %{embedded} is embedded.

data/lib/config/locales/ru.yml

@@ -11,6 +11,9 @@ ru:
         invalid_type:
           Поле уже было определено в классе %{klass}, но получено как %{other}
           со значением %{value}.
+        invalid_options:
+          "Invalid option :%{invalid} provided to relation :%{name}. Valid options
+          are: %{valid}."
         unsupported_version:
           Версия MongoDB %{version} не поддерживается. Пожалуйста, обновитесь до
           версии %{mongo_version}.
@@ -39,3 +42,6 @@ ru:
         unsaved_document:
           Вызов методов create или create! запрещён у реляционной ассоциации
           (%{document}), у которой родитель (%{base}) не сохранён.
+        mixed_relations:
+          Referencing a(n) %{embedded} document from the %{root} document via a
+          relational association is not allowed since the %{embedded} is embedded.

data/lib/config/locales/sv.yml

@@ -11,6 +11,9 @@ sv:
         invalid_type:
           Fältet var definerat som %{klass}, men fick %{other} med
           värdet %{value}.
+        invalid_options:
+          "Invalid option :%{invalid} provided to relation :%{name}. Valid options
+          are: %{valid}."
         unsupported_version:
           MongoDB %{version} stöds ej, vänligen upgradera
           till %{mongo_version}.
@@ -38,3 +41,6 @@ sv:
         unsaved_document:
           You cannot call create or create! through a relational association
           relation (%{document}) who's parent (%{base}) is not already saved.
+        mixed_relations:
+          Referencing a(n) %{embedded} document from the %{root} document via a
+          relational association is not allowed since the %{embedded} is embedded.

data/lib/config/locales/vi.yml

@@ -11,6 +11,9 @@ vi:
         invalid_type:
           Trường được định nghĩa là một %{klass}, nhưng nhận được %{other} với 
           giá trị %{value}.
+        invalid_options:
+          "Invalid option :%{invalid} provided to relation :%{name}. Valid options
+          are: %{valid}."
         unsupported_version:
           MongoDB %{version} không được hỗ trợ, xin vui lòng nâng cấp
           lên %{mongo_version}.

data/lib/config/locales/zh-CN.yml

@@ -12,6 +12,9 @@ zh-CN:
           数据库应该是Mongo::DB,而不是%{name}.
         invalid_type:
           在类%{klass}中定义了字段,实际值是%{value}的%{other}.
+        invalid_options:
+          "Invalid option :%{invalid} provided to relation :%{name}. Valid options
+          are: %{valid}."
         unsupported_version:
           MongoDB %{version} 版本已过期，请升级到 %{mongo_version}.
         validations:
@@ -31,3 +34,6 @@ zh-CN:
         unsaved_document:
           You cannot call create or create! through a relational association
           relation (%{document}) who's parent (%{base}) is not already saved.
+        mixed_relations:
+          Referencing a(n) %{embedded} document from the %{root} document via a
+          relational association is not allowed since the %{embedded} is embedded.

data/lib/mongoid.rb

@@ -22,27 +22,17 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 require "delegate"
 require "time"
-require "ostruct"
 require "active_support/core_ext"
 require 'active_support/json'
 require "active_support/inflector"
 require "active_support/time_with_zone"
 require "active_model"
-require "active_model/callbacks"
-require "active_model/conversion"
-require "active_model/errors"
-require "active_model/mass_assignment_security"
-require "active_model/naming"
-require "active_model/serialization"
-require "active_model/translation"
-require "active_model/validator"
-require "active_model/validations"
 require "mongo"
 require "mongoid/errors"
 require "mongoid/extensions"
-require "mongoid/safe"
 require "mongoid/relations"
-require "mongoid/atomicity"
+require "mongoid/threaded"
+require "mongoid/atomic"
 require "mongoid/attributes"
 require "mongoid/callbacks"
 require "mongoid/collection"
@@ -56,11 +46,11 @@ require "mongoid/default_scope"
 require "mongoid/dirty"
 require "mongoid/extras"
 require "mongoid/factory"
-require "mongoid/field"
 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"
@@ -73,7 +63,6 @@ require "mongoid/multi_database"
 require "mongoid/named_scope"
 require "mongoid/nested_attributes"
 require "mongoid/observer"
-require "mongoid/paths"
 require "mongoid/persistence"
 require "mongoid/safety"
 require "mongoid/scope"
@@ -87,41 +76,61 @@ require "mongoid/components"
 require "mongoid/paranoia"
 require "mongoid/document"
 
-# add railtie
+# If we are using Rails then we will include the Mongoid railtie. This has all
+# the nifty initializers that Mongoid needs.
 if defined?(Rails)
   require "mongoid/railtie"
 end
 
+# If we are using any Rack based application then we need the Mongoid rack
+# middleware to ensure our app is running properly.
+if defined?(Rack)
+  require "rack/mongoid"
+end
+
 # add english load path by default
 I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
 
 module Mongoid #:nodoc
+  extend self
 
-  MONGODB_VERSION = "1.6.0"
+  MONGODB_VERSION = "1.8.0"
 
-  class << self
+  # Sets the Mongoid configuration options. Best used by passing a block.
+  #
+  # @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)
+  #   end
+  #
+  # @return [ Config ] The configuration obejct.
+  #
+  # @since 1.0.0
+  def configure
+    block_given? ? yield(Config) : Config
+  end
+  alias :config :configure
 
-    # Sets the Mongoid configuration options. Best used by passing a block.
-    #
-    # @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.slaves = [
-    #       Mongo::Connection.new(host, 27018, :slave_ok => true).db(name),
-    #       Mongo::Connection.new(host, 27019, :slave_ok => true).db(name)
-    #     ]
-    #   end
-    #
-    # @return [ Config ] The configuration obejct.
-    def configure
-      config = Mongoid::Config
-      block_given? ? yield(config) : config
+  # 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
-    alias :config :configure
   end
 
   # Take all the public instance methods from the Config singleton and allow
@@ -129,12 +138,9 @@ module Mongoid #:nodoc
   #
   # @example Delegate the configuration methods.
   #   Mongoid.database = Mongo::Connection.new.db("test")
-  (Mongoid::Config.public_instance_methods(false) +
-    ActiveModel::Observing::ClassMethods.public_instance_methods(false)).each do |name|
-    (class << self; self; end).class_eval <<-EOT
-      def #{name}(*args)
-        configure.send("#{name}", *args)
-      end
-    EOT
-  end
+  #
+  # @since 1.0.0
+  delegate *(Config.public_instance_methods(false) +
+    ActiveModel::Observing::ClassMethods.public_instance_methods(false) <<
+    { :to => Config })
 end

data/lib/mongoid/atomic.rb

@@ -0,0 +1,145 @@
+# encoding: utf-8
+require "mongoid/atomic/modifiers"
+require "mongoid/atomic/paths"
+
+module Mongoid #:nodoc:
+
+  # This module contains the logic for supporting atomic operations against the
+  # database.
+  module Atomic
+    extend ActiveSupport::Concern
+
+    included do
+
+      # When MongoDB finally fully implements the positional operator, we can
+      # get rid of all indexing related code in Mongoid.
+      attr_accessor :_index
+    end
+
+    # Get all the atomic updates that need to happen for the current
+    # +Document+. This includes all changes that need to happen in the
+    # entire hierarchy that exists below where the save call was made.
+    #
+    # @note MongoDB does not allow "conflicting modifications" to be
+    #   performed in a single operation. Conflicting modifications are
+    #   detected by the 'haveConflictingMod' function in MongoDB.
+    #   Examination of the code suggests that two modifications (a $set
+    #   and a $pushAll, for example) conflict if:
+    #     (1) the key paths being modified are equal.
+    #     (2) one key path is a prefix of the other.
+    #   So a $set of 'addresses.0.street' will conflict with a $pushAll
+    #   to 'addresses', and we will need to split our update into two
+    #   pieces. We do not, however, attempt to match MongoDB's logic
+    #   exactly. Instead, we assume that two updates conflict if the
+    #   first component of the two key paths matches.
+    #
+    # @example Get the updates that need to occur.
+    #   person.atomic_updates(children)
+    #
+    # @return [ Hash ] The updates and their modifiers.
+    #
+    # @since 2.1.0
+    def atomic_updates
+      Modifiers.new.tap do |mods|
+        mods.set(atomic_sets)
+        _children.each do |child|
+          mods.set(child.atomic_sets)
+          mods.push(child.atomic_pushes)
+        end
+      end
+    end
+    alias :_updates :atomic_updates
+
+    # Get the removal modifier for the document. Will be nil on root
+    # documents, $unset on embeds_one, $set on embeds_many.
+    #
+    # @example Get the removal operator.
+    #   name.remover
+    #
+    # @return [ String ] The pull or unset operation.
+    def atomic_delete_modifier
+      atomic_paths.delete_modifier
+    end
+
+    # Get the insertion modifier for the document. Will be nil on root
+    # documents, $set on embeds_one, $push on embeds_many.
+    #
+    # @example Get the insert operation.
+    #   name.inserter
+    #
+    # @return [ String ] The pull or set operator.
+    def atomic_insert_modifier
+      atomic_paths.insert_modifier
+    end
+
+    # Return the path to this +Document+ in JSON notation, used for atomic
+    # updates via $set in MongoDB.
+    #
+    # @example Get the path to this document.
+    #   address.path
+    #
+    # @return [ String ] The path to the document in the database.
+    def atomic_path
+      atomic_paths.path
+    end
+
+    # Returns the positional operator of this document for modification.
+    #
+    # @example Get the positional operator.
+    #   address.position
+    #
+    # @return [ String ] The positional operator with indexes.
+    def atomic_position
+      atomic_paths.position
+    end
+
+    # Get all the push attributes that need to occur.
+    #
+    # @example Get the pushes.
+    #   person._pushes
+    #
+    # @return [ Hash ] The $pushAll operations.
+    #
+    # @since 2.1.0
+    def atomic_pushes
+      pushable? ? { atomic_path => as_document } : {}
+    end
+
+    # Return the selector for this document to be matched exactly for use
+    # with MongoDB's $ operator.
+    #
+    # @example Get the selector.
+    #   address.selector
+    #
+    # @return [ String ] The exact selector for this document.
+    def atomic_selector
+      atomic_paths.selector
+    end
+
+    # Get all the attributes that need to be set.
+    #
+    # @example Get the sets.
+    #   person._sets
+    #
+    # @return [ Hash ] The $set operations.
+    #
+    # @since 2.1.0
+    def atomic_sets
+      updateable? ? setters : settable? ? { atomic_path => as_document } : {}
+    end
+
+    private
+
+    # Get the atomic paths utility for this document.
+    #
+    # @example Get the atomic paths.
+    #   document.atomic_paths
+    #
+    # @return [ Object ] The associated path.
+    #
+    # @since 2.1.0
+    def atomic_paths
+      @atomic_paths ||= metadata ? metadata.path(self) : Atomic::Paths::Root.new(self)
+    end
+  end
+end

data/lib/mongoid/atomic/modifiers.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Atomic #:nodoc:
+
+    # This class contains the logic for supporting atomic operations against the
+    # database.
+    class Modifiers < Hash
+
+      # Adds push modifiers to the modifiers hash.
+      #
+      # @example Add push operations.
+      #   modifiers.push({ "addresses" => { "street" => "Bond" }})
+      #
+      # @param [ Hash ] modifications The push modifiers.
+      #
+      # @since 2.1.0
+      def push(modifications)
+        modifications.each_pair do |field, value|
+          mods = conflicting?(field) ? conflicts : pushes
+          if mods.has_key?(field)
+            mods[field].push(value)
+          else
+            mods[field] = [ value ]
+          end
+        end
+      end
+
+      # Adds set operations to the modifiers hash.
+      #
+      # @example Add set operations.
+      #   modifiers.set({ "title" => "sir" })
+      #
+      # @param [ Hash ] modifications The set modifiers.
+      #
+      # @since 2.1.0
+      def set(modifications)
+        modifications.each_pair do |field, value|
+          sets.update(field => value)
+          fields << field.split(".", 2)[0]
+        end
+      end
+
+      private
+
+      # Determines whether or not the provided field has a conflicting
+      # modification with an already added $set operation.
+      #
+      # @example Does the field conflict?
+      #   modifiers.conflicting?("addresses")
+      #
+      # @param [ String ] field The name of the field.
+      #
+      # @return [ true, false ] If the field conflicts.
+      #
+      # @since 2.1.0
+      def conflicting?(field)
+        fields.include?(field.split(".", 2)[0])
+      end
+
+      # Get the push operations that would have conflicted with the sets.
+      #
+      # @example Get the conflicts.
+      #   modifiers.conflicts
+      #
+      # @return [ Hash ] The conflicting modifications.
+      #
+      # @since 2.1.0
+      def conflicts
+        self[:other] ||= {}
+      end
+
+      # Get the list of stripped fields that are being updated.
+      #
+      # @example Get the fields.
+      #   modifiers.fields
+      #
+      # @return [ Array ] The stripped field names.
+      #
+      # @since 2.1.0
+      def fields
+        @fields ||= []
+      end
+
+      # Get the $pushAll operations or intialize a new one.
+      #
+      # @example Get the $pushAll operations.
+      #   modifiers.pushes
+      #
+      # @return [ Hash ] The $pushAll operations.
+      #
+      # @since 2.1.0
+      def pushes
+        self["$pushAll"] ||= {}
+      end
+
+      # Get the $set operations or intialize a new one.
+      #
+      # @example Get the $set operations.
+      #   modifiers.sets
+      #
+      # @return [ Hash ] The $set operations.
+      #
+      # @since 2.1.0
+      def sets
+        self["$set"] ||= {}
+      end
+    end
+  end
+end