mongoid_rails4 4.0.0

data/lib/mongoid/atomic/modifiers.rb

@@ -0,0 +1,317 @@
+# encoding: utf-8
+module Mongoid
+  module Atomic
+
+    # This class contains the logic for supporting atomic operations against the
+    # database.
+    class Modifiers < Hash
+
+      # Add the atomic $addToSet modifiers to the hash.
+      #
+      # @example Add the $addToSet modifiers.
+      #   modifiers.add_to_set({ "preference_ids" => [ "one" ] })
+      #
+      # @param [ Hash ] modifications The add to set modifiers.
+      #
+      # @since 2.4.0
+      def add_to_set(modifications)
+        modifications.each_pair do |field, value|
+          if add_to_sets.has_key?(field)
+            value.each do |val|
+              add_to_sets[field]["$each"].push(val)
+            end
+          else
+            add_to_sets[field] = { "$each" => value }
+          end
+        end
+      end
+
+      # Adds pull all modifiers to the modifiers hash.
+      #
+      # @example Add pull all operations.
+      #   modifiers.pull_all({ "addresses" => { "street" => "Bond" }})
+      #
+      # @param [ Hash ] modifications The pull all modifiers.
+      #
+      # @since 3.0.0
+      def pull_all(modifications)
+        modifications.each_pair do |field, value|
+          add_operation(pull_alls, field, value)
+          pull_fields[field.split(".", 2)[0]] = field
+        end
+      end
+
+      # Adds pull all modifiers to the modifiers hash.
+      #
+      # @example Add pull all operations.
+      #   modifiers.pull({ "addresses" => { "_id" => { "$in" => [ 1, 2, 3 ]}}})
+      #
+      # @param [ Hash ] modifications The pull all modifiers.
+      #
+      # @since 3.0.0
+      def pull(modifications)
+        modifications.each_pair do |field, value|
+          pulls[field] = value
+          pull_fields[field.split(".", 2)[0]] = field
+        end
+      end
+
+      # 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|
+          push_fields[field] = field
+          mods = push_conflict?(field) ? conflicting_pushes : pushes
+          add_operation(mods, field, Array.wrap(value))
+        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|
+          next if field == "_id"
+          mods = set_conflict?(field) ? conflicting_sets : sets
+          add_operation(mods, field, value)
+          set_fields[field.split(".", 2)[0]] = field
+        end
+      end
+
+      # Adds unset operations to the modifiers hash.
+      #
+      # @example Add unset operations.
+      #   modifiers.unset([ "addresses" ])
+      #
+      # @param [ Array<String> ] modifications The unset relation names.
+      #
+      # @since 2.2.0
+      def unset(modifications)
+        modifications.each do |field|
+          unsets.update(field => true)
+        end
+      end
+
+      private
+
+      # Add the operation to the modifications, either appending or creating a
+      # new one.
+      #
+      # @example Add the operation.
+      #   modifications.add_operation(mods, field, value)
+      #
+      # @param [ Hash ] mods The modifications.
+      # @param [ String ] field The field.
+      # @param [ Hash ] value The atomic op.
+      #
+      # @since 2.2.0
+      def add_operation(mods, field, value)
+        if mods.has_key?(field)
+          value.each do |val|
+            mods[field].push(val)
+          end
+        else
+          mods[field] = value
+        end
+      end
+
+      # Get the $addToSet operations or intialize a new one.
+      #
+      # @example Get the $addToSet operations.
+      #   modifiers.add_to_sets
+      #
+      # @return [ Hash ] The $addToSet operations.
+      #
+      # @since 2.4.0
+      def add_to_sets
+        self["$addToSet"] ||= {}
+      end
+
+      # Is the operation going to be a conflict for a $set?
+      #
+      # @example Is this a conflict for a set?
+      #   modifiers.set_conflict?(field)
+      #
+      # @param [ String ] field The field.
+      #
+      # @return [ true, false ] If this field is a conflict.
+      #
+      # @since 2.2.0
+      def set_conflict?(field)
+        name = field.split(".", 2)[0]
+        pull_fields.has_key?(name) || push_fields.has_key?(name)
+      end
+
+      # Is the operation going to be a conflict for a $push?
+      #
+      # @example Is this a conflict for a push?
+      #   modifiers.push_conflict?(field)
+      #
+      # @param [ String ] field The field.
+      #
+      # @return [ true, false ] If this field is a conflict.
+      #
+      # @since 2.2.0
+      def push_conflict?(field)
+        name = field.split(".", 2)[0]
+        set_fields.has_key?(name) || pull_fields.has_key?(name) ||
+          (push_fields.keys.count { |item| item =~ /#{name}/ } > 1)
+      end
+
+      # Get the conflicting pull modifications.
+      #
+      # @example Get the conflicting pulls.
+      #   modifiers.conflicting_pulls
+      #
+      # @return [ Hash ] The conflicting pull operations.
+      #
+      # @since 2.2.0
+      def conflicting_pulls
+        conflicts["$pullAll"] ||= {}
+      end
+
+      # Get the conflicting push modifications.
+      #
+      # @example Get the conflicting pushs.
+      #   modifiers.conflicting_pushs
+      #
+      # @return [ Hash ] The conflicting push operations.
+      #
+      # @since 2.2.0
+      def conflicting_pushes
+        conflicts["$pushAll"] ||= {}
+      end
+
+      # Get the conflicting set modifications.
+      #
+      # @example Get the conflicting sets.
+      #   modifiers.conflicting_sets
+      #
+      # @return [ Hash ] The conflicting set operations.
+      #
+      # @since 2.2.0
+      def conflicting_sets
+        conflicts["$set"] ||= {}
+      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[:conflicts] ||= {}
+      end
+
+      # Get the names of the fields that need to be pulled.
+      #
+      # @example Get the pull fields.
+      #   modifiers.pull_fields
+      #
+      # @return [ Array<String> ] The pull fields.
+      #
+      # @since 2.2.0
+      def pull_fields
+        @pull_fields ||= {}
+      end
+
+      # Get the names of the fields that need to be pushed.
+      #
+      # @example Get the push fields.
+      #   modifiers.push_fields
+      #
+      # @return [ Array<String> ] The push fields.
+      #
+      # @since 2.2.0
+      def push_fields
+        @push_fields ||= {}
+      end
+
+      # Get the names of the fields that need to be set.
+      #
+      # @example Get the set fields.
+      #   modifiers.set_fields
+      #
+      # @return [ Array<String> ] The set fields.
+      #
+      # @since 2.2.0
+      def set_fields
+        @set_fields ||= {}
+      end
+
+      # Get the $pullAll operations or intialize a new one.
+      #
+      # @example Get the $pullAll operations.
+      #   modifiers.pull_alls
+      #
+      # @return [ Hash ] The $pullAll operations.
+      #
+      # @since 3.0.0
+      def pull_alls
+        self["$pullAll"] ||= {}
+      end
+
+      # Get the $pull operations or intialize a new one.
+      #
+      # @example Get the $pull operations.
+      #   modifiers.pulls
+      #
+      # @return [ Hash ] The $pull operations.
+      #
+      # @since 3.0.0
+      def pulls
+        self["$pull"] ||= {}
+      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
+
+      # Get the $unset operations or initialize a new one.
+      #
+      # @example Get the $unset operations.
+      #   modifiers.unsets
+      #
+      # @return [ Hash ] The $unset operations.
+      #
+      # @since 2.2.0
+      def unsets
+        self["$unset"] ||= {}
+      end
+    end
+  end
+end

data/lib/mongoid/atomic/paths.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+require "mongoid/atomic/paths/embedded"
+require "mongoid/atomic/paths/root"

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

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require "mongoid/atomic/paths/embedded/one"
+require "mongoid/atomic/paths/embedded/many"
+
+module Mongoid
+  module Atomic
+    module Paths
+
+      # Common functionality between the two different embedded paths.
+      module Embedded
+
+        attr_reader :delete_modifier, :document, :insert_modifier, :parent
+
+        # Get the path to the document in the hierarchy.
+        #
+        # @example Get the path.
+        #   many.path
+        #
+        # @return [ String ] The path to the document.
+        #
+        # @since 2.1.0
+        def path
+          @path ||= position.sub(/\.\d+$/, "")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# encoding: utf-8
+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.
+        class Many
+          include Embedded
+
+          # Create the new path utility.
+          #
+          # @example Create the path util.
+          #   Many.new(document)
+          #
+          # @param [ Document ] document The document to generate the paths for.
+          #
+          # @since 2.1.0
+          def initialize(document)
+            @document, @parent = document, document._parent
+            @insert_modifier, @delete_modifier ="$push", "$pull"
+          end
+
+          # Get the position of the document in the hierarchy. This will
+          # include indexes of 1-n embedded relations that may sit above the
+          # embedded many.
+          #
+          # @example Get the position.
+          #   many.position
+          #
+          # @return [ String ] The position of the document.
+          #
+          # @since 2.1.0
+          def position
+            pos = parent.atomic_position
+            locator = document.new_record? ? "" : ".#{document._index}"
+            "#{pos}#{"." unless pos.blank?}#{document.metadata.store_as}#{locator}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# encoding: utf-8
+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.
+        class One
+          include Embedded
+
+          # Create the new path utility.
+          #
+          # @example Create the path util.
+          #   One.new(document)
+          #
+          # @param [ Document ] document The document to generate the paths for.
+          #
+          # @since 2.1.0
+          def initialize(document)
+            @document, @parent = document, document._parent
+            @insert_modifier, @delete_modifier ="$set", "$unset"
+          end
+
+          # Get the position of the document in the hierarchy. This will
+          # include indexes of 1-n embedded relations that may sit above the
+          # embedded one.
+          #
+          # @example Get the position.
+          #   one.position
+          #
+          # @return [ String ] The position of the document.
+          #
+          # @since 2.1.0
+          def position
+            pos = parent.atomic_position
+            "#{pos}#{"." unless pos.blank?}#{document.metadata.store_as}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module Mongoid
+  module Atomic
+    module Paths
+
+      # This class encapsulates behaviour for locating and updating root
+      # documents atomically.
+      class Root
+
+        attr_reader :document, :path, :position
+
+        # Create the new root path utility.
+        #
+        # @example Create the root path util.
+        #   Root.new(document)
+        #
+        # @param [ Document ] document The document to generate the paths for.
+        #
+        # @since 2.1.0
+        def initialize(document)
+          @document, @path, @position = document, "", ""
+        end
+
+        # Asking for the insert modifier on a document with a root path
+        # indicates a mixed relation most likely happened.
+        #
+        # @example Attempt to get the insert modifier.
+        #   root.insert_modifier
+        #
+        # @raise [ Errors::InvalidPath ] The error for the attempt.
+        #
+        # @since 3.0.14
+        def insert_modifier
+          raise Errors::InvalidPath.new(document.class)
+        end
+      end
+    end
+  end
+end