mongoid 3.1.5 → 8.0.2

data/lib/mongoid/persistence.rb

@@ -1,352 +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
-
-    # 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/railties/document.rb

@@ -1,12 +0,0 @@
-module Mongoid
-  module Document
-    # Used in conjunction with fields_for to build a form element for the
-    # destruction of this association. Always returns false because Mongoid
-    # only supports immediate deletion of associations.
-    #
-    # See ActionView::Helpers::FormHelper::fields_for for more info.
-    def _destroy
-      false
-    end
-  end
-end

data/lib/mongoid/relations/accessors.rb

@@ -1,299 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    # This module contains all the behaviour related to accessing relations
-    # through the getters and setters, and how to delegate to builders to
-    # create new ones.
-    module Accessors
-      extend ActiveSupport::Concern
-
-      # Builds the related document and creates the relation unless the
-      # document is nil, then sets the relation on this document.
-      #
-      # @example Build the relation.
-      #   person.__build__(:addresses, { :id => 1 }, metadata)
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      # @param [ Hash, Moped::BSON::ObjectId ] object The id or attributes to use.
-      # @param [ Metadata ] metadata The relation's metadata.
-      # @param [ true, false ] building If we are in a build operation.
-      #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 2.0.0.rc.1
-      def __build__(name, object, metadata)
-        relation = create_relation(object, metadata)
-        set_relation(name, relation)
-      end
-
-      # Create a relation from an object and metadata.
-      #
-      # @example Create the relation.
-      #   person.create_relation(document, metadata)
-      #
-      # @param [ Document, Array<Document ] object The relation target.
-      # @param [ Metadata ] metadata The relation metadata.
-      #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 2.0.0.rc.1
-      def create_relation(object, metadata)
-        type = @attributes[metadata.inverse_type]
-        target = metadata.builder(self, object).build(type)
-        target ? metadata.relation.new(self, target, metadata) : nil
-      end
-
-      # Determines if the relation exists or not.
-      #
-      # @example Does the relation exist?
-      #   person.relation_exists?(:people)
-      #
-      # @param [ String ] name The name of the relation to check.
-      #
-      # @return [ true, false ] True if set and not nil, false if not.
-      #
-      # @since 2.0.0.rc.1
-      def relation_exists?(name)
-        ivar(name)
-      end
-
-      # Resets the criteria inside the relation proxy. Used by many to many
-      # relations to keep the underlying ids array in sync.
-      #
-      # @example Reset the relation criteria.
-      #   person.reset_relation_criteria(:preferences)
-      #
-      # @param [ Symbol ] name The name of the relation.
-      #
-      # @since 3.0.14
-      def reset_relation_criteria(name)
-        if instance_variable_defined?("@#{name}")
-          send(name).reset_unloaded
-        end
-      end
-
-      # Set the supplied relation to an instance variable on the class with the
-      # provided name. Used as a helper just for code cleanliness.
-      #
-      # @example Set the proxy on the document.
-      #   person.set(:addresses, addresses)
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      # @param [ Proxy ] relation The relation to set.
-      #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 2.0.0.rc.1
-      def set_relation(name, relation)
-        instance_variable_set("@#{name}", relation)
-      end
-
-      private
-
-      # Get the relation. Extracted out from the getter method to avoid
-      # infinite recursion when overriding the getter.
-      #
-      # @api private
-      #
-      # @example Get the relation.
-      #   document.get_relation(:name, metadata)
-      #
-      # @param [ Symbol ] name The name of the relation.
-      # @param [ Metadata ] metadata The relation metadata.
-      # @param [ true, false ] reload If the relation is to be reloaded.
-      #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 3.0.16
-      def get_relation(name, metadata, reload = false)
-        variable = "@#{name}"
-        value = if instance_variable_defined?(variable) && !reload
-          instance_variable_get(variable)
-        else
-          _building do
-            _loading do
-              __build__(name, attributes[metadata.key], metadata)
-            end
-          end
-        end
-        if value.nil? && metadata.autobuilding? && !without_autobuild?
-          send("build_#{name}")
-        else
-          value
-        end
-      end
-
-      # @todo: Durran: Refactor before release, but this fixes the issue with
-      # the extra queries.
-      def get_relation_for_set(name, metadata, object)
-        variable = "@#{name}"
-        value = if instance_variable_defined?(variable)
-          instance_variable_get(variable)
-        else
-          _building do
-            _loading do
-              if needs_no_database_query?(object, metadata)
-                __build__(name, object, metadata)
-              else
-                __build__(name, attributes[metadata.key], metadata)
-              end
-            end
-          end
-        end
-      end
-
-      def needs_no_database_query?(object, metadata)
-        object.is_a?(Document) && !object.embedded? &&
-          object.id == attributes[metadata.key]
-      end
-
-      # Is the current code executing without autobuild functionality?
-      #
-      # @example Is autobuild disabled?
-      #   document.without_autobuild?
-      #
-      # @return [ true, false ] If autobuild is disabled.
-      #
-      # @since 3.0.0
-      def without_autobuild?
-        Threaded.executing?(:without_autobuild)
-      end
-
-      # Yield to the block with autobuild functionality turned off.
-      #
-      # @example Execute without autobuild.
-      #   document.without_autobuild do
-      #     document.name
-      #   end
-      #
-      # @return [ Object ] The result of the yield.
-      #
-      # @since 3.0.0
-      def without_autobuild
-        Threaded.begin_execution("without_autobuild")
-        yield
-      ensure
-        Threaded.exit_execution("without_autobuild")
-      end
-
-      module ClassMethods
-
-        # Adds the existence check for relations.
-        #
-        # @example Add the existence check.
-        #   Person.existence_check(:name, meta)
-        #
-        # @example Check if a relation exists.
-        #   person = Person.new
-        #   person.has_game?
-        #   person.game?
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        # @param [ Metadata ] The metadata.
-        #
-        # @return [ Class ] The model being set up.
-        #
-        # @since 3.0.0
-        def existence_check(name, metadata)
-          module_eval <<-END
-            def #{name}?
-              without_autobuild { !__send__(:#{name}).blank? }
-            end
-            alias :has_#{name}? :#{name}?
-          END
-          self
-        end
-
-        # Defines the getter for the relation. Nothing too special here: just
-        # return the instance variable for the relation if it exists or build
-        # the thing.
-        #
-        # @example Set up the getter for the relation.
-        #   Person.getter("addresses", metadata)
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        # @param [ Metadata ] metadata The metadata for the relation.
-        #
-        # @return [ Class ] The class being set up.
-        #
-        # @since 2.0.0.rc.1
-        def getter(name, metadata)
-          re_define_method(name) do |reload = false|
-            get_relation(name, metadata, reload)
-          end
-          self
-        end
-
-        # Defines the getter for the ids of documents in the relation. Should
-        # be specify only for referenced many relations.
-        #
-        # @example Set up the ids getter for the relation.
-        #   Person.ids_getter("addresses", metadata)
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        # @param [ Metadata] metadata The metadata for the relation.
-        #
-        # @return [ Class ] The class being set up.
-        def ids_getter(name, metadata)
-          ids_method = "#{name.to_s.singularize}_ids"
-          re_define_method(ids_method) do
-            send(name).only(:id).map(&:id)
-          end
-          self
-        end
-
-
-        # Defines the setter for the relation. This does a few things based on
-        # some conditions. If there is an existing association, a target
-        # substitution will take place, otherwise a new relation will be
-        # created with the supplied target.
-        #
-        # @example Set up the setter for the relation.
-        #   Person.setter("addresses", metadata)
-        #
-        # @param [ String, Symbol ] name The name of the relation.
-        # @param [ Metadata ] metadata The metadata for the relation.
-        #
-        # @return [ Class ] The class being set up.
-        #
-        # @since 2.0.0.rc.1
-        def setter(name, metadata)
-          re_define_method("#{name}=") do |object|
-            without_autobuild do
-              if metadata.many?
-                set_relation(name, get_relation(name, metadata).substitute(object.substitutable))
-              elsif value = get_relation_for_set(name, metadata, object)
-                set_relation(name, value.substitute(object.substitutable))
-              else
-                __build__(name, object.substitutable, metadata)
-              end
-            end
-          end
-          self
-        end
-
-        # Defines the setter method that allows you to set documents
-        # in this relation by their ids. The defined setter, finds
-        # documents with given ids and invokes regular relation setter
-        # with found documents. Ids setters should be defined only for
-        # referenced many relations.
-        #
-        # @example Set up the id_setter for the relation.
-        #   Person.ids_setter("addesses", metadata)
-        #
-        #  @param [ String, Symbol ] name The name of the relation.
-        #  @param [ Metadata ] metadata The metadata for the relation.
-        #
-        #  @return [ Class ] The class being set up.
-        def ids_setter(name, metadata)
-          ids_method = "#{name.to_s.singularize}_ids="
-          re_define_method(ids_method) do |ids|
-            send(metadata.setter, metadata.klass.find(ids.reject(&:blank?)))
-          end
-          self
-        end
-      end
-    end
-  end
-end