mongoid_heroku_stable 4.0.0

data/lib/mongoid/validatable/presence.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+module Mongoid
+  module Validatable
+
+    # Validates that the specified attributes are not blank (as defined by
+    # Object#blank?).
+    #
+    # @example Define the presence validator.
+    #
+    #   class Person
+    #     include Mongoid::Document
+    #     field :title
+    #
+    #     validates_presence_of :title
+    #   end
+    class PresenceValidator < ActiveModel::EachValidator
+
+      # Validate the document for the attribute and value.
+      #
+      # @example Validate the document.
+      #   validator.validate_each(doc, :title, "")
+      #
+      # @param [ Document ] document The document to validate.
+      # @param [ Symbol ] attribute The attribute name.
+      # @param [ Object ] value The current value of the field.
+      #
+      # @since 2.4.0
+      def validate_each(document, attribute, value)
+        field = document.fields[attribute.to_s]
+        if field.try(:localized?) && !value.blank?
+          value.each_pair do |_locale, _value|
+            document.errors.add(
+              attribute,
+              :blank_in_locale,
+              options.merge(location: _locale)
+            ) if not_present?(_value)
+          end
+        elsif document.relations.has_key?(attribute.to_s)
+          if relation_or_fk_missing?(document, attribute, value)
+            document.errors.add(attribute, :blank, options)
+          end
+        else
+          document.errors.add(attribute, :blank, options) if not_present?(value)
+        end
+      end
+
+      private
+
+      # Returns true if the relation is blank or the foreign key is blank.
+      #
+      # @api private
+      #
+      # @example Check is the relation or fk is blank.
+      #   validator.relation_or_fk_mising(doc, :name, "")
+      #
+      # @param [ Document ] doc The document.
+      # @param [ Symbol ] attr The attribute.
+      # @param [ Object ] value The value.
+      #
+      # @return [ true, false ] If the doc is missing.
+      #
+      # @since 3.0.0
+      def relation_or_fk_missing?(doc, attr, value)
+        return true if value.blank? && doc.send(attr).blank?
+        metadata = doc.relations[attr.to_s]
+        metadata.stores_foreign_key? && doc.send(metadata.foreign_key).blank?
+      end
+
+      # For guarding against false values.
+      #
+      # @api private
+      #
+      # @example Is the value not present?
+      #   validator.not_present?(value)
+      #
+      # @param [ Object ] value The value.
+      #
+      # @return [ true, false ] If the value is not present.
+      #
+      # @since 3.0.5
+      def not_present?(value)
+        value.blank? && value != false
+      end
+    end
+  end
+end

data/lib/mongoid/validatable/queryable.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module Mongoid
+  module Validatable
+    module Queryable
+
+      # Wrap the validation inside the an execution block that alert's the
+      # session not to clear its persistence options.
+      #
+      # @example Execute the validation with a query.
+      #   with_query(document) do
+      #     #...
+      #   end
+      #
+      # @param [ Document ] document The document being validated.
+      #
+      # @return [ Object ] The result of the yield.
+      #
+      # @since 3.0.2
+      def with_query(document)
+        klass = document.class
+        begin
+          Threaded.begin_execution("#{klass.name}-validate-with-query")
+          yield
+        ensure
+          Threaded.exit_execution("#{klass.name}-validate-with-query")
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/validatable/uniqueness.rb

@@ -0,0 +1,330 @@
+# encoding: utf-8
+module Mongoid
+  module Validatable
+
+    # 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.with(document.persistence_options)
+        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.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[attribute.to_s].try(:localized?)
+      end
+    end
+  end
+end

data/lib/mongoid/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module Mongoid
+  VERSION = "4.0.0"
+end