mongoid 3.1.6 → 4.0.2

data/lib/mongoid/persistence/operations/embedded/insert.rb

@@ -1,46 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Operations
-      module Embedded
-
-        # Insert is a persistence command responsible for taking a document that
-        # has not been saved to the database and saving it. This specific class
-        # handles the case when the document is embedded in another.
-        #
-        # The underlying query resembles the following MongoDB query:
-        #
-        #   collection.update(
-        #     { "_id" : 1 },
-        #     { "$push" : { "field" : "value" } },
-        #     false
-        #   );
-        class Insert
-          include Insertion
-          include Operations
-          include Mongoid::Atomic::Positionable
-
-          # Insert the new document in the database. If the document's parent is a
-          # new record, we will call save on the parent, otherwise we will $push
-          # the document onto the parent.
-          #
-          # @example Insert an embedded document.
-          #   Insert.persist
-          #
-          # @return [ Document ] The document to be inserted.
-          def persist
-            prepare do
-              raise Errors::NoParent.new(document.class.name) unless parent
-              if parent.new_record?
-                parent.insert
-              else
-                selector = parent.atomic_selector
-                collection.find(selector).update(positionally(selector, inserts))
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/persistence/operations/embedded/remove.rb

@@ -1,43 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Operations
-      module Embedded
-
-        # Remove is a persistence command responsible for deleting a document from
-        # the database.
-        #
-        # The underlying query resembles the following MongoDB query:
-        #
-        #   collection.remove(
-        #     { "_id" : 1 },
-        #     false
-        #   );
-        class Remove
-          include Deletion
-          include Operations
-          include Mongoid::Atomic::Positionable
-
-          # Remove the document from the database. If the parent is a new record,
-          # it will get removed in Ruby only. If the parent is not a new record
-          # then either an $unset or $set will occur, depending if it's an
-          # embeds_one or embeds_many.
-          #
-          # @example Remove an embedded document.
-          #   RemoveEmbedded.persist
-          #
-          # @return [ true ] Always true.
-          def persist
-            prepare do |doc|
-              parent.remove_child(doc) if notifying_parent?
-              if parent.persisted?
-                selector = parent.atomic_selector
-                collection.find(selector).update(positionally(selector, deletes))
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/persistence/operations/insert.rb

@@ -1,34 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Operations
-
-      # Insert is a persistence command responsible for taking a document that
-      # has not been saved to the database and saving it.
-      #
-      # The underlying query resembles the following MongoDB query:
-      #
-      #   collection.insert(
-      #     { "_id" : 1, "field" : "value" },
-      #     false
-      #   );
-      class Insert
-        include Insertion, Operations
-
-        # Insert the new document in the database. This delegates to the standard
-        # MongoDB collection's insert command.
-        #
-        # @example Insert the document.
-        #   Insert.persist
-        #
-        # @return [ Document ] The document to be inserted.
-        def persist
-          prepare do |doc|
-            collection.insert(doc.as_document)
-            IdentityMap.set(doc)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/persistence/operations/remove.rb

@@ -1,33 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Operations
-
-      # Remove is a persistence command responsible for deleting a document from
-      # the database.
-      #
-      # The underlying query resembles the following MongoDB query:
-      #
-      #   collection.remove(
-      #     { "_id" : 1 },
-      #     false
-      #   );
-      class Remove
-        include Deletion, Operations
-
-        # Remove the document from the database: delegates to the MongoDB
-        # collection remove method.
-        #
-        # @example Remove the document.
-        #   Remove.persist
-        #
-        # @return [ true ] Always true.
-        def persist
-          prepare do |doc|
-            collection.find(doc.atomic_selector).remove
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/persistence/operations/update.rb

@@ -1,59 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Operations
-
-      # Update is a persistence command responsible for taking a document that
-      # has already been saved to the database and saving it, depending on
-      # whether or not the document has been modified.
-      #
-      # Before persisting the command will check via dirty attributes if the
-      # document has changed, if not, it will simply return true. If it has it
-      # will go through the validation steps, run callbacks, and set the changed
-      # fields atomically on the document. The underlying query resembles the
-      # following MongoDB query:
-      #
-      #   collection.update(
-      #     { "_id" : 1,
-      #     { "$set" : { "field" : "value" },
-      #     false,
-      #     false
-      #   );
-      #
-      # For embedded documents it will use the positional locator:
-      #
-      #   collection.update(
-      #     { "_id" : 1, "addresses._id" : 2 },
-      #     { "$set" : { "addresses.$.field" : "value" },
-      #     false,
-      #     false
-      #   );
-      #
-      class Update
-        include Modification
-        include Operations
-        include Mongoid::Atomic::Positionable
-
-        # Persist the document that is to be updated to the database. This will
-        # only write changed fields via MongoDB's $set modifier operation.
-        #
-        # @example Update the document.
-        #   Update.persist
-        #
-        # @return [ true, false ] If the save passed.
-        def persist
-          prepare do
-            unless updates.empty?
-              collection.find(selector).update(positionally(selector, updates))
-              conflicts.each_pair do |key, value|
-                collection.find(selector).update(
-                  positionally(selector, { key => value })
-                )
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/persistence/operations/upsert.rb

@@ -1,28 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Operations
-
-      # Wraps behaviour for performing upserts in Mongodb. No matter if the
-      # document has been modified or not, it will be sent to the db and Mongo
-      # will determin whether or not to insert or update.
-      class Upsert
-        include Upsertion, Operations
-
-        # Persist the upsert operation.
-        #
-        # @example Execute the upsert.
-        #   operation.persist
-        #
-        # @return [ true ] Always true.
-        #
-        # @since 3.0.0
-        def persist
-          prepare do
-            collection.find(selector).update(document.as_document, [ :upsert ])
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/persistence/upsertion.rb

@@ -1,31 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-
-    # Contains common logic for upsert operations.
-    module Upsertion
-
-      # Wrap all the common upsert logic for root docments.
-      #
-      # @example Execute common upsert logic.
-      #   prepare do |doc|
-      #     collection.find({ :_id => 1 }).upsert({ name: "test" }, [ :upsert ])
-      #   end
-      #
-      # @param [ Proc ] block The block to call.
-      #
-      # @return [ true, false ] If the save passed or not.
-      #
-      # @since 3.0.0
-      def prepare(&block)
-        return false if validating? && document.invalid?(:upsert)
-        result = document.run_callbacks(:upsert) do
-          yield(document); true
-        end
-        document.post_persist unless result == false
-        document.new_record = false
-        result
-      end
-    end
-  end
-end

data/lib/mongoid/unit_of_work.rb

@@ -1,61 +0,0 @@
-# encoding: utf-8
-module Mongoid
-
-  # This module handles unit of work functionality with regards to the identity
-  # map.
-  module UnitOfWork
-
-    # 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
-    #
-    # @example Process with identity map disabled on the current thread.
-    #   Mongoid.unit_of_work(disable: :current) do
-    #     Person.create(title: "Sir")
-    #   end
-    #
-    # @example Process with identity map disabled on all threads.
-    #   Mongoid.unit_of_work(disable: :all) do
-    #     Person.create(title: "Sir")
-    #   end
-    #
-    # @param [ Hash ] options The disabling options.
-    #
-    # @option [ Symbol ] :disable Either :all or :current to indicate whether
-    #   to temporarily disable the identity map on the current thread or all
-    #   threads.
-    #
-    # @return [ Object ] The result of the block.
-    #
-    # @since 2.1.0
-    def unit_of_work(options = {})
-      disable = options[:disable]
-      begin
-        Threaded.disable_identity_map(disable) if disable
-        yield if block_given?
-      ensure
-        if disable
-          Threaded.enable_identity_map(disable)
-        else
-          IdentityMap.clear
-        end
-      end
-    end
-
-    # Are we currently using the identity map?
-    #
-    # @example Is the identity map currently enabled?
-    #   Mongoid.using_identity_map?
-    #
-    # @return [ true, false ] If the identity map is in use.
-    #
-    # @since 3.0.0
-    def using_identity_map?
-      Mongoid.identity_map_enabled? && Threaded.identity_map_enabled?
-    end
-  end
-end

data/lib/mongoid/versioning.rb

@@ -1,217 +0,0 @@
-# encoding: utf-8
-module Mongoid
-
-  # Include this module to get automatic versioning of root level documents.
-  # This will add a version field to the +Document+ and a has_many association
-  # with all the versions contained in it.
-  module Versioning
-    extend ActiveSupport::Concern
-
-    included do
-      field :version, type: Integer, default: 1
-
-      embeds_many \
-        :versions,
-        class_name: self.name,
-        validate: false,
-        cyclic: true,
-        inverse_of: nil,
-        versioned: true
-
-      set_callback :save, :before, :revise, if: :revisable?
-
-      class_attribute :version_max
-      self.cyclic = true
-    end
-
-    # Create a new version of the +Document+. This will load the previous
-    # document from the database and set it as the next version before saving
-    # the current document. It then increments the version number. If a #max_versions
-    # limit is set in the model and it's exceeded, the oldest version gets discarded.
-    #
-    # @example Revise the document.
-    #   person.revise
-    #
-    # @since 1.0.0
-    def revise
-      previous = previous_revision
-      if previous && versioned_attributes_changed?
-        new_version = versions.build(
-          previous.versioned_attributes, without_protection: true
-        )
-        new_version._id = nil
-        if version_max.present? && versions.length > version_max
-          deleted = versions.first
-          if deleted.paranoid?
-            versions.delete_one(deleted)
-            collection.find(atomic_selector).
-              update({ "$pull" => { "versions" => { "version" => deleted.version }}})
-          else
-            versions.delete(deleted)
-          end
-        end
-        self.version = (version || 1 ) + 1
-      end
-    end
-
-    # Forces the creation of a new version of the +Document+, regardless of
-    # whether a change was actually made.
-    #
-    # @example Revise the document.
-    #   person.revise!
-    #
-    # @since 2.2.1
-    def revise!
-      versions.build(
-        (previous_revision || self).versioned_attributes, without_protection: true
-      )
-      versions.shift if version_max.present? && versions.length > version_max
-      self.version = (version || 1 ) + 1
-      save
-    end
-
-    # Filters the results of +changes+ by removing any fields that should
-    # not be versioned.
-    #
-    # @return [ Hash ] A hash of versioned changed attributes.
-    #
-    # @since 2.1.0
-    def versioned_changes
-      only_versioned_attributes(changes.except("updated_at"))
-    end
-
-    # Filters the results of +attributes+ by removing any fields that should
-    # not be versioned.
-    #
-    # @return [ Hash ] A hash of versioned attributes.
-    #
-    # @since 2.1.0
-    def versioned_attributes
-      only_versioned_attributes(attributes)
-    end
-
-    # Check if any versioned fields have been modified. This is similar
-    # to +changed?+, except this method also ignores fields set to be
-    # ignored by versioning.
-    #
-    # @return [ Boolean ] Whether fields that will be versioned have changed.
-    #
-    # @since 2.1.0
-    def versioned_attributes_changed?
-      !versioned_changes.empty?
-    end
-
-    # Executes a block that temporarily disables versioning. This is for cases
-    # where you do not want to version on every save.
-    #
-    # @example Execute a save without versioning.
-    #   person.versionless(&:save)
-    #
-    # @return [ Object ] The document or result of the block execution.
-    #
-    # @since 2.0.0
-    def versionless
-      @versionless = true
-      result = yield(self) if block_given?
-      @versionless = false
-      result || self
-    end
-
-    private
-
-    # Find the previous version of this document in the database, or if the
-    # document had been saved without versioning return the persisted one.
-    #
-    # @example Find the last version.
-    #   document.find_last_version
-    #
-    # @return [ Document, nil ] The previously saved document.
-    #
-    # @since 2.0.0
-    def previous_revision
-      _loading_revision do
-        self.class.unscoped.
-          where(_id: id).
-          any_of({ version: version }, { version: nil }).first
-      end
-    end
-
-    # Is the document able to be revised? This is true if the document has
-    # changed and we have not explicitly told it not to version.
-    #
-    # @example Is the document revisable?
-    #   document.revisable?
-    #
-    # @return [ true, false ] If the document is revisable.
-    #
-    # @since 2.0.0
-    def revisable?
-      versioned_attributes_changed? && !versionless?
-    end
-
-    # Are we in versionless mode? This is true if in a versionless block on the
-    # document.
-    #
-    # @example Is the document in versionless mode?
-    #   document.versionless?
-    #
-    # @return [ true, false ] Is the document not currently versioning.
-    #
-    # @since 2.0.0
-    def versionless?
-      @versionless ||= false
-    end
-
-    # Filters fields that should not be versioned out of an attributes hash.
-    # Dynamic attributes are always versioned.
-    #
-    # @param [ Hash ] A hash with field names as keys.
-    #
-    # @return [ Hash ] The hash without non-versioned columns.
-    #
-    # @since 2.1.0
-    def only_versioned_attributes(hash)
-      versioned = {}
-      hash.except("versions").each_pair do |name, value|
-        add_versioned_attribute(versioned, name, value)
-      end
-      versioned
-    end
-
-    # Add the versioned attribute. Will work now for localized fields.
-    #
-    # @api private
-    #
-    # @example Add the versioned attribute.
-    #   model.add_versioned_attribute({}, "name", "test")
-    #
-    # @param [ Hash ] versioned The versioned attributes.
-    # @param [ String ] name The name of the field.
-    # @param [ Object ] value The value for the field.
-    #
-    # @since 3.0.10
-    def add_versioned_attribute(versioned, name, value)
-      field = fields[name]
-      if field && field.localized?
-        versioned["#{name}_translations"] = value
-      else
-        versioned[name] = value if !field || field.versioned?
-      end
-    end
-
-    module ClassMethods
-
-      # Sets the maximum number of versions to store.
-      #
-      # @example Set the maximum.
-      #   Person.max_versions(5)
-      #
-      # @param [ Integer ] number The maximum number to store.
-      #
-      # @return [ Integer ] The max number of versions.
-      def max_versions(number)
-        self.version_max = number.to_i
-      end
-    end
-  end
-end