mongoid 3.1.6 → 4.0.2

data/lib/mongoid/persistence/atomic.rb

@@ -1,231 +0,0 @@
-# encoding: utf-8
-require "mongoid/persistence/atomic/operation"
-require "mongoid/persistence/atomic/add_to_set"
-require "mongoid/persistence/atomic/bit"
-require "mongoid/persistence/atomic/inc"
-require "mongoid/persistence/atomic/pop"
-require "mongoid/persistence/atomic/pull"
-require "mongoid/persistence/atomic/pull_all"
-require "mongoid/persistence/atomic/push"
-require "mongoid/persistence/atomic/push_all"
-require "mongoid/persistence/atomic/rename"
-require "mongoid/persistence/atomic/sets"
-require "mongoid/persistence/atomic/unset"
-
-module Mongoid
-  module Persistence
-
-    # This module provides the explicit atomic operations helpers on the
-    # document itself.
-    module Atomic
-
-      # Performs an atomic $addToSet of the provided value on the supplied field.
-      # If the field does not exist it will be initialized as an empty array.
-      #
-      # If the value already exists on the array it will not be added.
-      #
-      # @example Add only a unique value on the field.
-      #   person.add_to_set(:aliases, "Bond")
-      #
-      # @example Add only the unique values to the field.
-      #   person.add_to_set(:aliases, [ "Bond", "James" ])
-      #
-      # @param [ Symbol ] field The name of the field.
-      # @param [ Object, Array<Object> ] value The value or values to add.
-      # @param [ Hash ] options The mongo persistence options.
-      #
-      # @return [ Array<Object> ] The new value of the field.
-      #
-      # @since 2.0.0
-      def add_to_set(field, value, options = {})
-        AddToSet.new(self, field, value, options).persist
-      end
-
-      # Performs an atomic $bit operation on the field with the provided hash
-      # of bitwise ops to execute in order.
-      #
-      # @example Execute a bitwise and on the field.
-      #   person.bit(:age, { :and => 12 })
-      #
-      # @example Execute a bitwise or on the field.
-      #   person.bit(:age, { :or => 12 })
-      #
-      # @example Execute a chain of bitwise operations.
-      #   person.bit(:age, { :and => 10, :or => 12 })
-      #
-      # @param [ Symbol ] field The name of the field.
-      # @param [ Hash ] value The bitwise operations to perform.
-      # @param [ Hash ] options The mongo persistence options.
-      #
-      # @return [ Integer ] The new value of the field.
-      #
-      # @since 2.1.0
-      def bit(field, value, options = {})
-        Bit.new(self, field, value, options).persist
-      end
-
-      # Performs an atomic $inc of the provided value on the supplied
-      # field. If the field does not exist it will be initialized as
-      # the provided value.
-      #
-      # @example Increment a field.
-      #   person.inc(:score, 2)
-      #
-      # @param [ Symbol ] field The name of the field.
-      # @param [ Numeric ] value The value to increment.
-      # @param [ Hash ] options The mongo persistence options.
-      #
-      # @return [ Array<Object> ] The new value of the field.
-      #
-      # @since 2.0.0
-      def inc(field, value, options = {})
-        Inc.new(self, field, value, options).persist
-      end
-
-      # Performs an atomic $pop of the provided value on the supplied
-      # field.
-      #
-      # @example Pop the last value from the array.
-      #   person.pop(:aliases, 1)
-      #
-      # @example Pop the first value from the array.
-      #   person.pop(:aliases, -1)
-      #
-      # @param [ Symbol ] field The name of the field.
-      # @param [ Integer ] value Whether to pop the first or last.
-      # @param [ Hash ] options The mongo persistence options.
-      #
-      # @return [ Array<Object> ] The new value of the field.
-      #
-      # @since 2.1.0
-      def pop(field, value, options = {})
-        Pop.new(self, field, value, options).persist
-      end
-
-      # Performs an atomic $pull of the provided value on the supplied
-      # field.
-      #
-      # @note Support for a $pull with an expression is not yet supported.
-      #
-      # @example Pull the value from the field.
-      #   person.pull(:aliases, "Bond")
-      #
-      # @param [ Symbol ] field The name of the field.
-      # @param [ Object ] value The value to pull.
-      # @param [ Hash ] options The mongo persistence options.
-      #
-      # @return [ Array<Object> ] The new value of the field.
-      #
-      # @since 2.1.0
-      def pull(field, value, options = {})
-        Pull.new(self, field, value, options).persist
-      end
-
-      # Performs an atomic $pullAll of the provided value on the supplied
-      # field. If the field does not exist it will be initialized as an
-      # empty array.
-      #
-      # @example Pull the values from the field.
-      #   person.pull_all(:aliases, [ "Bond", "James" ])
-      #
-      # @param [ Symbol ] field The name of the field.
-      # @param [ Array<Object> ] value The values to pull.
-      # @param [ Hash ] options The mongo persistence options.
-      #
-      # @return [ Array<Object> ] The new value of the field.
-      #
-      # @since 2.0.0
-      def pull_all(field, value, options = {})
-        PullAll.new(self, field, value, options).persist
-      end
-
-      # Performs an atomic $push of the provided value on the supplied field. If
-      # the field does not exist it will be initialized as an empty array.
-      #
-      # @example Push a value on the field.
-      #   person.push(:aliases, "Bond")
-      #
-      # @param [ Symbol ] field The name of the field.
-      # @param [ Object ] value The value to push.
-      # @param [ Hash ] options The mongo persistence options.
-      #
-      # @return [ Array<Object> ] The new value of the field.
-      #
-      # @since 2.0.0
-      def push(field, value, options = {})
-        Push.new(self, field, value, options).persist
-      end
-
-      # Performs an atomic $pushAll of the provided value on the supplied field. If
-      # the field does not exist it will be initialized as an empty array.
-      #
-      # @example Push the values onto the field.
-      #   person.push_all(:aliases, [ "Bond", "James" ])
-      #
-      # @param [ Symbol ] field The name of the field.
-      # @param [ Array<Object> ] value The values to push.
-      # @param [ Hash ] options The mongo persistence options.
-      #
-      # @return [ Array<Object> ] The new value of the field.
-      #
-      # @since 2.1.0
-      def push_all(field, value, options = {})
-        PushAll.new(self, field, value, options).persist
-      end
-
-      # Performs the atomic $rename from the old field to the new field name.
-      #
-      # @example Rename the field.
-      #   person.rename(:age, :years)
-      #
-      # @param [ Symbol ] field The old field name.
-      # @param [ Symbol ] value The new field name.
-      # @param [ Hash ] options The mongo persistence options.
-      #
-      # @return [ Object ] The value of the new field.
-      #
-      # @since 2.1.0
-      def rename(field, value, options = {})
-        Rename.new(self, field, value, options).persist
-      end
-
-      # Performs an atomic $set of the provided value on the supplied
-      # field. If the field does not exist it will be initialized as
-      # the provided value.
-      #
-      # @example Set a field.
-      #   person.set(:score, 2)
-      #
-      # @param [ Symbol ] field The name of the field.
-      # @param [ Integer ] value The value to set.
-      # @param [ Hash ] options The mongo persistence options.
-      #
-      # @return [ Array<Object> ] The new value of the field.
-      #
-      # @since 2.1.0
-      def set(field, value = nil, options = {})
-        Sets.new(self, field, value, options).persist
-      end
-
-      # Performs the atomic $unset on the supplied field.
-      #
-      # @example
-      #   Remove the field.
-      #     person.unset(:age)
-      #   Remove fields age and score.
-      #     person.unset([:age, :score])
-      #
-      # @param [ Symbol, Array<Object> ] fields The fields name.
-      # @param [ Hash ] options The mongo persistence options.
-      #
-      # @return [ nil ] Always nil.
-      #
-      # @since 2.1.0
-      def unset(*args)
-        fields = args.__find_args__
-        options = fields[-1].is_a?(Hash) ? fields.delete_at(-1) : {}
-        Unset.new(self, fields, true, options).persist
-      end
-    end
-  end
-end

data/lib/mongoid/persistence/atomic/add_to_set.rb

@@ -1,47 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Atomic
-
-      # This class provides the ability to perform an explicit $addToSet
-      # modification on a specific field.
-      class AddToSet
-        include Operation
-
-        # Sends the atomic $addToSet operation to the database.
-        #
-        # @example Persist the new values.
-        #   addToSet.persist
-        #
-        # @return [ Object ] The new array value.
-        #
-        # @since 2.0.0
-        def persist
-          prepare do
-            document[field] = [] unless document[field]
-            values = document.send(field)
-            Array.wrap(value).each do |val|
-              values.push(val) unless values.include?(val)
-            end
-            execute("$addToSet")
-            values
-          end
-        end
-
-        # Get the atomic operation to perform.
-        #
-        # @example Get the operation.
-        #   add_to_set.operation("$addToSet")
-        #
-        # @param [ String ] modifier The modifier to use.
-        #
-        # @return [ Hash ] The atomic operation for the field and addition.
-        #
-        # @since 2.0.0
-        def operation(modifier)
-          { modifier => { path => value.is_a?(Array) ? { "$each" => value } : value}}
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/persistence/atomic/bit.rb

@@ -1,35 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Atomic
-
-      # This operation is for performing $bit atomic operations against the
-      # database.
-      class Bit
-        include Operation
-
-        # Execute the bitwise operation. This correlates to a $bit in MongoDB.
-        #
-        # @example Execute the op.
-        #   bit.persist
-        #
-        # @return [ Integer ] The new value.
-        #
-        # @since 2.1.0
-        def persist
-          prepare do
-            current = document[field]
-            return nil unless current
-            document[field] = value.inject(current) do |result, (bit, val)|
-              result = result & val if bit.to_s == "and"
-              result = result | val if bit.to_s == "or"
-              result
-            end
-            execute("$bit")
-            document[field]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/persistence/atomic/inc.rb

@@ -1,45 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Atomic
-
-      # This class provides atomic $inc behaviour.
-      class Inc
-        include Operation
-
-        # Sends the atomic $inc operation to the database.
-        #
-        # @example Persist the new values.
-        #   inc.persist
-        #
-        # @return [ Object ] The new numeric value.
-        #
-        # @since 2.0.0
-        def persist
-          prepare do
-            current = document[field] || 0
-            document[field] = current + value
-            execute("$inc")
-            document[field]
-          end
-        end
-
-        private
-
-        # In case we need to cast going to the database.
-        #
-        # @api private
-        #
-        # @example Cast the value.
-        #   operation.cast_value
-        #
-        # @return [ Integer, Float ] The value casted.
-        #
-        # @since 3.0.3
-        def cast_value
-          value.__to_inc__
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/persistence/atomic/operation.rb

@@ -1,154 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Atomic
-
-      # This is the included module for all atomic operation objects.
-      module Operation
-        include Mongoid::Atomic::Positionable
-
-        attr_accessor :document, :fields, :value, :options
-
-        # Get the collection to be used for persistence.
-        #
-        # @example Get the collection.
-        #   operation.collection
-        #
-        # @return [ Collection ] The root collection.
-        #
-        # @since 2.1.0
-        def collection
-          document._root.collection
-        end
-
-        # Initialize the new pullAll operation.
-        #
-        # @example Create a new pullAll operation.
-        #   PullAll.new(document, :aliases, [ "Bond" ])
-        #
-        # @param [ Document ] document The document to pullAll onto.
-        # @param [ Symbol ] field The name of the array field.
-        # @param [ Object ] value The value to pullAll.
-        # @param [ Hash ] options The persistence options.
-        #
-        # @since 2.0.0
-        def initialize(document, fields, value, options = {})
-          @document, @value = document, value
-          @options = options
-
-          @fields = Array.wrap(fields).collect do |field|
-            document.database_field_name(field.to_s)
-          end
-
-          self.class.send(:define_method, :field) do
-            @fields.first
-          end if @fields.length == 1
-
-        end
-
-        # Get the atomic operation to perform.
-        #
-        # @example Get the operation.
-        #   inc.operation
-        #
-        # @param [ String ] modifier The modifier to use.
-        #
-        # @return [ Hash ] The atomic operation for the field and addition.
-        #
-        # @since 2.0.0
-        def operation(modifier)
-          hash = Hash[fields.collect do |field|
-            [path(field), cast_value]
-          end]
-          { modifier => hash }
-        end
-
-        # Get the path to the field that is getting atomically updated.
-        #
-        # @example Get the path.
-        #   operation.path
-        #
-        # @return [ String, Symbol ] The path to the field.
-        #
-        # @since 2.1.0
-        def path(field = field)
-          position = document.atomic_position
-          position.blank? ? field : "#{position}.#{field}"
-        end
-
-        # All atomic operations use this with a block to ensure saftey options
-        # clear out after the execution.
-        #
-        # @example Prepare the operation.
-        #   prepare do
-        #     collection.update
-        #   end
-        #
-        # @return [ Object ] The yielded value.
-        #
-        # @since 2.1.0
-        def prepare
-          yield(document)
-        end
-
-        private
-
-        # In case we need to cast going to the database.
-        #
-        # @api private
-        #
-        # @example Cast the value.
-        #   operation.cast_value
-        #
-        # @return [ Object ] The value.
-        #
-        # @since 3.0.3
-        def cast_value
-          value.mongoize
-        end
-
-        # Executes the common functionality between operations.
-        #
-        # @api private
-        #
-        # @example Execute the operation.
-        #   operation.execute("$push")
-        #
-        # @param [ String ] name The name of the operation.
-        #
-        # @since 3.0.0
-        def execute(name)
-          unless document.new_record?
-            selector = document.atomic_selector
-            collection.find(selector).update(positionally(selector, operation(name)))
-            if fields.length > 1
-              document.remove_change(fields)
-            else
-              document.remove_change(field)
-            end
-          end
-        end
-
-        # Appends items to an array and executes the corresponding $push or
-        # $pushAll operation.
-        #
-        # @api private
-        #
-        # @example Execute the append.
-        #   operation.append_with("$push")
-        #
-        # @param [ String ] name The name of the operation - $push or $pushAll.
-        #
-        # @since 3.0.0
-        def append_with(name)
-          prepare do
-            document[field] = [] unless document[field]
-            docs = document.send(field).concat(value.__array__)
-            execute(name)
-            docs
-          end
-        end
-      end
-    end
-  end
-end