mongoid 3.1.6 → 4.0.0

data/lib/mongoid/persistence.rb

@@ -1,357 +0,0 @@
-# encoding: utf-8
-require "mongoid/persistence/atomic"
-require "mongoid/persistence/deletion"
-require "mongoid/persistence/insertion"
-require "mongoid/persistence/modification"
-require "mongoid/persistence/upsertion"
-require "mongoid/persistence/operations"
-
-module Mongoid
-
-  # The persistence module is a mixin to provide database accessor methods for
-  # the document. These correspond to the appropriate accessors on a
-  # mongo collection and retain the same DSL.
-  #
-  # @example Sample persistence operations.
-  #   document.insert
-  #   document.update
-  #   document.upsert
-  module Persistence
-    extend ActiveSupport::Concern
-    include Atomic
-    include Mongoid::Atomic::Positionable
-
-    # The atomic operations that deal with arrays or sets in the db.
-    #
-    # @since 4.0.0
-    LIST_OPERATIONS = [ "$addToSet", "$push", "$pull", "$pullAll" ].freeze
-
-    # Remove the document from the database with callbacks.
-    #
-    # @example Destroy a document.
-    #   document.destroy
-    #
-    # @param [ Hash ] options Options to pass to destroy.
-    #
-    # @return [ true, false ] True if successful, false if not.
-    def destroy(options = {})
-      self.flagged_for_destroy = true
-      result = run_callbacks(:destroy) do
-        remove(options)
-      end
-      self.flagged_for_destroy = false
-      result
-    end
-
-    # Insert a new document into the database. Will return the document
-    # itself whether or not the save was successful.
-    #
-    # @example Insert a document.
-    #   document.insert
-    #
-    # @param [ Hash ] options Options to pass to insert.
-    #
-    # @return [ Document ] The persisted document.
-    def insert(options = {})
-      Operations.insert(self, options).persist
-    end
-
-    # Remove the document from the database.
-    #
-    # @example Remove the document.
-    #   document.remove
-    #
-    # @param [ Hash ] options Options to pass to remove.
-    #
-    # @return [ TrueClass ] True.
-    def remove(options = {})
-      Operations.remove(self, options).persist
-    end
-    alias :delete :remove
-
-    # Save the document - will perform an insert if the document is new, and
-    # update if not.
-    #
-    # @example Save the document.
-    #   document.save
-    #
-    # @param [ Hash ] options Options to pass to the save.
-    #
-    # @return [ true, false ] True is success, false if not.
-    #
-    # @since 1.0.0
-    def save(options = {})
-      if new_record?
-        !insert(options).new_record?
-      else
-        update(options)
-      end
-    end
-
-    # Save the document - will perform an insert if the document is new, and
-    # update if not. If a validation error occurs an error will get raised.
-    #
-    # @example Save the document.
-    #   document.save!
-    #
-    # @param [ Hash ] options Options to pass to the save.
-    #
-    # @return [ true, false ] True if validation passed.
-    def save!(options = {})
-      unless save(options)
-        self.class.fail_validate!(self) unless errors.empty?
-        self.class.fail_callback!(self, :save!)
-      end
-      return true
-    end
-
-    # Touch the document, in effect updating its updated_at timestamp and
-    # optionally the provided field to the current time. If any belongs_to
-    # relations exist with a touch option, they will be updated as well.
-    #
-    # @example Update the updated_at timestamp.
-    #   document.touch
-    #
-    # @example Update the updated_at and provided timestamps.
-    #   document.touch(:audited)
-    #
-    # @note This will not autobuild relations if those options are set.
-    #
-    # @param [ Symbol ] field The name of an additional field to update.
-    #
-    # @return [ true/false ] false if record is new_record otherwise true.
-    #
-    # @since 3.0.0
-    def touch(field = nil)
-      return false if _root.new_record?
-      current = Time.now
-      field = database_field_name(field)
-      write_attribute(:updated_at, current) if respond_to?("updated_at=")
-      write_attribute(field, current) if field
-
-      touches = touch_atomic_updates(field)
-      unless touches.empty?
-        selector = atomic_selector
-        _root.collection.find(selector).update(positionally(selector, touches))
-      end
-      run_callbacks(:touch, :after)
-      true
-    end
-
-    # Update the document in the database.
-    #
-    # @example Update an existing document.
-    #   document.update
-    #
-    # @param [ Hash ] options Options to pass to update.
-    #
-    # @return [ true, false ] True if succeeded, false if not.
-    def update(options = {})
-      Operations.update(self, options).persist
-    end
-
-    # Update a single attribute and persist the entire document.
-    # This skips validation but fires the callbacks.
-    #
-    # @example Update the attribute.
-    #   person.update_attribute(:title, "Sir")
-    #
-    # @param [ Symbol, String ] name The name of the attribute.
-    # @param [ Object ] value The new value of the attribute.a
-    #
-    # @raise [ Errors::ReadonlyAttribute ] If the field cannot be changed due
-    #   to being flagged as reaodnly.
-    #
-    # @return [ true, false ] True if save was successfull, false if not.
-    #
-    # @since 2.0.0.rc.6
-    def update_attribute(name, value)
-      normalized = name.to_s
-      unless attribute_writable?(normalized)
-        raise Errors::ReadonlyAttribute.new(normalized, value)
-      end
-      write_attribute(database_field_name(normalized), value)
-      save(validate: false)
-    end
-
-    # Update the document attributes in the database.
-    #
-    # @example Update the document's attributes
-    #   document.update_attributes(:title => "Sir")
-    #
-    # @param [ Hash ] attributes The attributes to update.
-    #
-    # @return [ true, false ] True if validation passed, false if not.
-    def update_attributes(attributes = {}, options = {})
-      assign_attributes(attributes, options); save
-    end
-
-    # Update the document attributes in the database and raise an error if
-    # validation failed.
-    #
-    # @example Update the document's attributes.
-    #   document.update_attributes(:title => "Sir")
-    #
-    # @param [ Hash ] attributes The attributes to update.
-    #
-    # @raise [ Errors::Validations ] If validation failed.
-    #
-    # @return [ true, false ] True if validation passed.
-    def update_attributes!(attributes = {}, options = {})
-      result = update_attributes(attributes, options)
-      unless result
-        self.class.fail_validate!(self) unless errors.empty?
-        self.class.fail_callback!(self, :update_attributes!)
-      end
-      result
-    end
-
-    # Perform an upsert of the document. If the document does not exist in the
-    # database, then Mongo will insert a new one, otherwise the fields will get
-    # overwritten with new values on the existing document.
-    #
-    # @example Upsert the document.
-    #   document.upsert
-    #
-    # @param [ Hash ] options The validation options.
-    #
-    # @return [ true ] True.
-    #
-    # @since 3.0.0
-    def upsert(options = {})
-      Operations.upsert(self, options).persist
-    end
-
-    module ClassMethods #:nodoc:
-
-      # Create a new document. This will instantiate a new document and
-      # insert it in a single call. Will always return the document
-      # whether save passed or not.
-      #
-      # @example Create a new document.
-      #   Person.create(:title => "Mr")
-      #
-      # @example Create multiple new documents.
-      #   Person.create({ title: "Mr" }, { title: "Mrs" })
-      #
-      # @param [ Hash, Array ] attributes The attributes to create with, or an
-      #   Array of multiple attributes for multiple documents.
-      # @param [ Hash ] options A mass-assignment protection options. Supports
-      #   :as and :without_protection
-      #
-      # @return [ Document, Array<Document> ] The newly created document(s).
-      #
-      # @since 1.0.0
-      def create(attributes = nil, options = {}, &block)
-        _creating do
-          if attributes.is_a?(::Array)
-            attributes.map { |attrs| create(attrs, options, &block) }
-          else
-            doc = new(attributes, options, &block)
-            doc.save
-            doc
-          end
-        end
-      end
-
-      # Create a new document. This will instantiate a new document and
-      # insert it in a single call. Will always return the document
-      # whether save passed or not, and if validation fails an error will be
-      # raise.
-      #
-      # @example Create a new document.
-      #   Person.create!(:title => "Mr")
-      #
-      # @example Create multiple new documents.
-      #   Person.create!({ title: "Mr" }, { title: "Mrs" })
-      #
-      # @param [ Hash, Array ] attributes The attributes to create with, or an
-      #   Array of multiple attributes for multiple documents.
-      # @param [ Hash ] options A mass-assignment protection options. Supports
-      #   :as and :without_protection
-      #
-      # @return [ Document, Array<Document> ] The newly created document(s).
-      #
-      # @since 1.0.0
-      def create!(attributes = {}, options = {}, &block)
-        _creating do
-          if attributes.is_a?(::Array)
-            attributes.map { |attrs| create!(attrs, options, &block) }
-          else
-            doc = new(attributes, options, &block)
-            fail_validate!(doc) unless doc.insert.errors.empty?
-            fail_callback!(doc, :create!) if doc.new_record?
-            doc
-          end
-        end
-      end
-
-      # Delete all documents given the supplied conditions. If no conditions
-      # are passed, the entire collection will be dropped for performance
-      # benefits. Does not fire any callbacks.
-      #
-      # @example Delete matching documents from the collection.
-      #   Person.delete_all(:conditions => { :title => "Sir" })
-      #
-      # @example Delete all documents from the collection.
-      #   Person.delete_all
-      #
-      # @param [ Hash ] conditions Optional conditions to delete by.
-      #
-      # @return [ Integer ] The number of documents deleted.
-      def delete_all(conditions = nil)
-        conds = conditions || {}
-        selector = conds[:conditions] || conds
-        selector.merge!(_type: name) if hereditary?
-        coll = collection
-        deleted = coll.find(selector).count
-        coll.find(selector).remove_all
-        deleted
-      end
-
-      # Delete all documents given the supplied conditions. If no conditions
-      # are passed, the entire collection will be dropped for performance
-      # benefits. Fires the destroy callbacks if conditions were passed.
-      #
-      # @example Destroy matching documents from the collection.
-      #   Person.destroy_all(:conditions => { :title => "Sir" })
-      #
-      # @example Destroy all documents from the collection.
-      #   Person.destroy_all
-      #
-      # @param [ Hash ] conditions Optional conditions to destroy by.
-      #
-      # @return [ Integer ] The number of documents destroyed.
-      def destroy_all(conditions = nil)
-        conds = conditions || {}
-        documents = where(conds[:conditions] || conds)
-        destroyed = documents.count
-        documents.each { |doc| doc.destroy }
-        destroyed
-      end
-
-      # Raise an error if validation failed.
-      #
-      # @example Raise the validation error.
-      #   Person.fail_validate!(person)
-      #
-      # @param [ Document ] document The document to fail.
-      def fail_validate!(document)
-        raise Errors::Validations.new(document)
-      end
-
-      # Raise an error if a callback failed.
-      #
-      # @example Raise the callback error.
-      #   Person.fail_callback!(person, :create!)
-      #
-      # @param [ Document ] document The document to fail.
-      # @param [ Symbol ] method The method being called.
-      #
-      # @since 2.2.0
-      def fail_callback!(document, method)
-        raise Errors::Callback.new(document.class, method)
-      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

data/lib/rack/mongoid/middleware/identity_map.rb

@@ -1,39 +0,0 @@
-# encoding: utf-8
-module Rack
-  module Mongoid
-    module Middleware
-
-      # This middleware contains the behaviour needed to properly use the
-      # identity map in Rack based applications. This middleware will properly
-      # handle Rails or Rack streaming responses.
-      class IdentityMap
-
-        # Initialize the new middleware.
-        #
-        # @example Init the middleware.
-        #   IdentityMap.new(app)
-        #
-        # @param [ Object ] app The application.
-        #
-        # @since 2.1.0
-        def initialize(app)
-          @app = app
-        end
-
-        # Make the request with the provided environment.
-        #
-        # @example Make the request.
-        #   identity_map.call(env)
-        #
-        # @param [ Object ] env The environment.
-        #
-        # @return [ Array ] The status, headers, and response.
-        #
-        # @since 2.1.0
-        def call(env)
-          ::Mongoid.unit_of_work { @app.call(env) }
-        end
-      end
-    end
-  end
-end

data/lib/rack/mongoid.rb

@@ -1,2 +0,0 @@
-# encoding: utf-8
-require "rack/mongoid/middleware/identity_map"

data/lib/rails/generators/mongoid/observer/observer_generator.rb

@@ -1,17 +0,0 @@
-# encoding: utf-8
-require "rails/generators/mongoid_generator"
-
-module Mongoid
-  module Generators
-    class ObserverGenerator < Base
-
-      check_class_collision suffix: "Observer"
-
-      def create_observer_file
-        template 'observer.rb.tt', File.join('app/models', class_path, "#{file_name}_observer.rb")
-      end
-
-      hook_for :test_framework
-    end
-  end
-end

data/lib/rails/generators/mongoid/observer/templates/observer.rb.tt

@@ -1,4 +0,0 @@
-<% module_namespacing do -%>
-class <%= class_name %>Observer < Mongoid::Observer
-end
-<% end -%>