mongoid 3.1.5 → 8.0.2

data/lib/mongoid/validations/uniqueness.rb

@@ -1,330 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Validations
-
-    # Validates whether or not a field is unique against the documents in the
-    # database.
-    #
-    # @example Define the uniqueness validator.
-    #
-    #   class Person
-    #     include Mongoid::Document
-    #     field :title
-    #
-    #     validates_uniqueness_of :title
-    #   end
-    class UniquenessValidator < ActiveModel::EachValidator
-      include Queryable
-
-      attr_reader :klass
-
-      # Unfortunately, we have to tie Uniqueness validators to a class.
-      #
-      # @example Setup the validator.
-      # UniquenessValidator.new.setup(Person)
-      #
-      # @param [ Class ] klass The class getting validated.
-      #
-      # @since 1.0.0
-      def setup(klass)
-        @klass = klass
-      end
-
-      # Validate the document for uniqueness violations.
-      #
-      # @example Validate the document.
-      #   validate_each(person, :title, "Sir")
-      #
-      # @param [ Document ] document The document to validate.
-      # @param [ Symbol ] attribute The field to validate on.
-      # @param [ Object ] value The value of the field.
-      #
-      # @return [ Errors ] The errors.
-      #
-      # @since 1.0.0
-      def validate_each(document, attribute, value)
-        with_query(document) do
-          attrib, val = to_validate(document, attribute, value)
-          return unless validation_required?(document, attrib)
-          if document.embedded?
-            validate_embedded(document, attrib, val)
-          else
-            validate_root(document, attrib, val)
-          end
-        end
-      end
-
-      private
-
-      # Add the error to the document.
-      #
-      # @api private
-      #
-      # @example Add the error.
-      #   validator.add_error(doc, :name, "test")
-      #
-      # @param [ Document ] document The document to validate.
-      # @param [ Symbol ] attribute The name of the attribute.
-      # @param [ Object ] value The value of the object.
-      #
-      # @since 2.4.10
-      def add_error(document, attribute, value)
-        document.errors.add(
-          attribute, :taken, options.except(:case_sensitive, :scope).merge(value: value)
-        )
-      end
-
-      # Should the uniqueness validation be case sensitive?
-      #
-      # @api private
-      #
-      # @example Is the validation case sensitive?
-      #   validator.case_sensitive?
-      #
-      # @return [ true, false ] If the validation is case sensitive.
-      #
-      # @since 2.3.0
-      def case_sensitive?
-        !(options[:case_sensitive] == false)
-      end
-
-      # Create the validation criteria.
-      #
-      # @api private
-      #
-      # @example Create the criteria.
-      #   validator.create_criteria(User, user, :name, "syd")
-      #
-      # @param [ Class, Proxy ] base The base to execute the criteria from.
-      # @param [ Document ] document The document to validate.
-      # @param [ Symbol ] attribute The name of the attribute.
-      # @param [ Object ] value The value of the object.
-      #
-      # @return [ Criteria ] The criteria.
-      #
-      # @since 2.4.10
-      def create_criteria(base, document, attribute, value)
-        criteria = scope(base.unscoped, document, attribute)
-        criteria.selector.update(criterion(document, attribute, value.mongoize))
-        criteria
-      end
-
-      # Get the default criteria for checking uniqueness.
-      #
-      # @api private
-      #
-      # @example Get the criteria.
-      #   validator.criterion(person, :title, "Sir")
-      #
-      # @param [ Document ] document The document to validate.
-      # @param [ Symbol ] attribute The name of the attribute.
-      # @param [ Object ] value The value of the object.
-      #
-      # @return [ Criteria ] The uniqueness criteria.
-      #
-      # @since 2.3.0
-      def criterion(document, attribute, value)
-        field = document.database_field_name(attribute)
-
-        if localized?(document, field)
-          conditions = value.inject([]) { |acc, (k,v)| acc << { "#{field}.#{k}" => filter(v) } }
-          selector = { "$or" => conditions }
-        else
-          selector = { field => filter(value) }
-        end
-
-        if document.persisted? && !document.embedded?
-          selector.merge!(_id: { "$ne" => document.id })
-        end
-        selector
-      end
-
-      # Filter the value based on whether the check is case sensitive or not.
-      #
-      # @api private
-      #
-      # @example Filter the value.
-      #   validator.filter("testing")
-      #
-      # @param [ Object ] value The value to filter.
-      #
-      # @return [ Object, Regexp ] The value, filtered or not.
-      #
-      # @since 2.3.0
-      def filter(value)
-        !case_sensitive? && value ? /\A#{Regexp.escape(value.to_s)}$/i : value
-      end
-
-      # Scope the criteria to the scope options provided.
-      #
-      # @api private
-      #
-      # @example Scope the criteria.
-      #   validator.scope(criteria, document)
-      #
-      # @param [ Criteria ] criteria The criteria to scope.
-      # @param [ Document ] document The document being validated.
-      #
-      # @return [ Criteria ] The scoped criteria.
-      #
-      # @since 2.3.0
-      def scope(criteria, document, attribute)
-        Array.wrap(options[:scope]).each do |item|
-          name = document.database_field_name(item)
-          criteria = criteria.where(item => document.attributes[name])
-        end
-        criteria = criteria.where(deleted_at: nil) if document.paranoid?
-        criteria
-      end
-
-      # Should validation be skipped?
-      #
-      # @api private
-      #
-      # @example Should the validation be skipped?
-      #   validator.skip_validation?(doc)
-      #
-      # @param [ Document ] document The embedded document.
-      #
-      # @return [ true, false ] If the validation should be skipped.
-      #
-      # @since 2.3.0
-      def skip_validation?(document)
-        !document._parent || document.embedded_one?
-      end
-
-      # Scope reference has changed?
-      #
-      # @api private
-      #
-      # @example Has scope reference changed?
-      #   validator.scope_value_changed?(doc)
-      #
-      # @param [ Document ] document The embedded document.
-      #
-      # @return [ true, false ] If the scope reference has changed.
-      #
-      # @since
-      def scope_value_changed?(document)
-        Array.wrap(options[:scope]).any? do |item|
-          document.send("attribute_changed?", item.to_s)
-        end
-      end
-
-      # Get the name of the field and the value to validate. This is for the
-      # case when we validate a relation via the relation name and not the key,
-      # we need to send the key name and value to the db, not the relation
-      # object.
-      #
-      # @api private
-      #
-      # @example Get the name and key to validate.
-      #   validator.to_validate(doc, :parent, Parent.new)
-      #
-      # @param [ Document ] document The doc getting validated.
-      # @param [ Symbol ] attribute The attribute getting validated.
-      # @param [ Object ] value The value of the attribute.
-      #
-      # @return [ Array<Object, Object> ] The field and value.
-      #
-      # @since 2.4.4
-      def to_validate(document, attribute, value)
-        metadata = document.relations[attribute.to_s]
-        if metadata && metadata.stores_foreign_key?
-          [ metadata.foreign_key, value.id ]
-        else
-          [ attribute, value ]
-        end
-      end
-
-      # Validate an embedded document.
-      #
-      # @api private
-      #
-      # @example Validate the embedded document.
-      #   validator.validate_embedded(doc, :name, "test")
-      #
-      # @param [ Document ] document The document.
-      # @param [ Symbol ] attribute The attribute name.
-      # @param [ Object ] value The value.
-      #
-      # @since 2.4.10
-      def validate_embedded(document, attribute, value)
-        return if skip_validation?(document)
-        relation = document._parent.send(document.metadata_name)
-        criteria = create_criteria(relation, document, attribute, value)
-        add_error(document, attribute, value) if criteria.count > 1
-      end
-
-      # Validate a root document.
-      #
-      # @api private
-      #
-      # @example Validate the root document.
-      #   validator.validate_root(doc, :name, "test")
-      #
-      # @param [ Document ] document The document.
-      # @param [ Symbol ] attribute The attribute name.
-      # @param [ Object ] value The value.
-      #
-      # @since 2.4.10
-      def validate_root(document, attribute, value)
-        criteria = create_criteria(klass || document.class, document, attribute, value)
-        if criteria.with(persistence_options(criteria)).exists?
-          add_error(document, attribute, value)
-        end
-      end
-
-      # Are we required to validate the document?
-      #
-      # @example Is validation needed?
-      #   validator.validation_required?(doc, :field)
-      #
-      # @param [ Document ] document The document getting validated.
-      # @param [ Symbol ] attribute The attribute to validate.
-      #
-      # @return [ true, false ] If we need to validate.
-      #
-      # @since 2.4.4
-      def validation_required?(document, attribute)
-        document.new_record? ||
-          document.send("attribute_changed?", attribute.to_s) ||
-          scope_value_changed?(document)
-      end
-
-      # Get the persistence options to perform to check, merging with any
-      # existing.
-      #
-      # @api private
-      #
-      # @example Get the persistence options.
-      #   validator.persistence_options(criteria)
-      #
-      # @param [ Criteria ] criteria The criteria.
-      #
-      # @return [ Hash ] The persistence options.
-      #
-      # @since 3.0.23
-      def persistence_options(criteria)
-        (criteria.klass.persistence_options || {}).merge!(consistency: :strong)
-      end
-
-      # Is the attribute localized?
-      #
-      # @api private
-      #
-      # @example Is the attribute localized?
-      #   validator.localized?(doc, :field)
-      #
-      # @param [ Document ] document The document getting validated.
-      # @param [ Symbol ] attribute The attribute to validate.
-      #
-      # @return [ true, false ] If the attribute is localized.
-      #
-      # @since 4.0.0
-      def localized?(document, attribute)
-        document.fields[document.database_field_name(attribute)].try(:localized?)
-      end
-    end
-  end
-end

data/lib/mongoid/validations.rb

@@ -1,166 +0,0 @@
-# encoding: utf-8
-require "mongoid/validations/macros"
-require "mongoid/validations/localizable"
-require "mongoid/validations/associated"
-require "mongoid/validations/format"
-require "mongoid/validations/length"
-require "mongoid/validations/queryable"
-require "mongoid/validations/presence"
-require "mongoid/validations/uniqueness"
-
-module Mongoid
-
-  # This module provides additional validations that ActiveModel does not
-  # provide: validates_associated and validates_uniqueness_of.
-  module Validations
-    extend ActiveSupport::Concern
-    include ActiveModel::Validations
-
-    included do
-      extend Macros
-      include Macros
-    end
-
-    # Begin the associated validation.
-    #
-    # @example Begin validation.
-    #   document.begin_validate
-    #
-    # @since 2.1.9
-    def begin_validate
-      Threaded.begin_validate(self)
-    end
-
-    # Exit the associated validation.
-    #
-    # @example Exit validation.
-    #   document.exit_validate
-    #
-    # @since 2.1.9
-    def exit_validate
-      Threaded.exit_validate(self)
-    end
-
-    # Overrides the default ActiveModel behaviour since we need to handle
-    # validations of relations slightly different than just calling the
-    # getter.
-    #
-    # @example Read the value.
-    #   person.read_attribute_for_validation(:addresses)
-    #
-    # @param [ Symbol ] attr The name of the field or relation.
-    #
-    # @return [ Object ] The value of the field or the relation.
-    #
-    # @since 2.0.0.rc.1
-    def read_attribute_for_validation(attr)
-      attribute = database_field_name(attr)
-      if relations.has_key?(attribute)
-        begin_validate
-        relation = without_autobuild { send(attr) }
-        exit_validate
-        relation.do_or_do_not(:in_memory) || relation
-      elsif fields[attribute].try(:localized?)
-        attributes[attribute]
-      else
-        send(attr)
-      end
-    end
-
-    # Determine if the document is valid.
-    #
-    # @example Is the document valid?
-    #   person.valid?
-    #
-    # @example Is the document valid in a context?
-    #   person.valid?(:create)
-    #
-    # @param [ Symbol ] context The optional validation context.
-    #
-    # @return [ true, false ] True if valid, false if not.
-    #
-    # @since 2.0.0.rc.6
-    def valid?(context = nil)
-      super context ? context : (new_record? ? :create : :update)
-    end
-
-    # Used to prevent infinite loops in associated validations.
-    #
-    # @example Is the document validated?
-    #   document.validated?
-    #
-    # @return [ true, false ] Has the document already been validated?
-    #
-    # @since 2.0.0.rc.2
-    def validated?
-      Threaded.validated?(self)
-    end
-
-    # Are we currently performing a validation that has a query?
-    #
-    # @example Are we validating with a query?
-    #   document.validating_with_query?
-    #
-    # @return [ true, false ] If we are validating with a query.
-    #
-    # @since 3.0.2
-    def validating_with_query?
-      self.class.validating_with_query?
-    end
-
-    module ClassMethods
-
-      # Adds an associated validator for the relation if the validate option
-      # was not provided or set to true.
-      #
-      # @example Set up validation.
-      #   Person.validates_relation(metadata)
-      #
-      # @param [ Metadata ] metadata The relation metadata.
-      #
-      # @since 2.0.0.rc.1
-      def validates_relation(metadata)
-        if metadata.validate?
-          validates_associated(metadata.name)
-        end
-      end
-
-      # Add validation with the supplied validators forthe provided fields
-      # with options.
-      #
-      # @example Validate with a specific validator.
-      #   validates_with MyValidator, on: :create
-      #
-      # @param [ Class<Array>, Hash ] *args The validator classes and options.
-      #
-      # @note See ActiveModel::Validations::With for full options. This is
-      #   overridden to add autosave functionality when presence validation is
-      #   added.
-      #
-      # @since 3.0.0
-      def validates_with(*args, &block)
-        if args.first == PresenceValidator
-          args.last[:attributes].each do |name|
-            metadata = relations[name.to_s]
-            if metadata && metadata[:autosave] != false
-              autosave(metadata.merge!(autosave: true))
-            end
-          end
-        end
-        super
-      end
-
-      # Are we currently performing a validation that has a query?
-      #
-      # @example Are we validating with a query?
-      #   Model.validating_with_query?
-      #
-      # @return [ true, false ] If we are validating with a query.
-      #
-      # @since 3.0.2
-      def validating_with_query?
-        Threaded.executing?("#{name}-validate-with-query")
-      end
-    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