mongoid_heroku_stable 4.0.0

data/lib/mongoid/unit_of_work.rb

@@ -0,0 +1,61 @@
+# 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/validatable.rb

@@ -0,0 +1,180 @@
+# encoding: utf-8
+require "mongoid/validatable/macros"
+require "mongoid/validatable/localizable"
+require "mongoid/validatable/associated"
+require "mongoid/validatable/format"
+require "mongoid/validatable/length"
+require "mongoid/validatable/queryable"
+require "mongoid/validatable/presence"
+require "mongoid/validatable/uniqueness"
+
+module Mongoid
+
+  # This module provides additional validations that ActiveModel does not
+  # provide: validates_associated and validates_uniqueness_of.
+  module Validatable
+    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
+
+    # Given the provided options, are we performing validations?
+    #
+    # @example Are we performing validations?
+    #   document.performing_validations?(validate: true)
+    #
+    # @param [ Hash ] options The options to check.
+    #
+    # @return [ true, false ] If we are validating.
+    #
+    # @since 4.0.0
+    def performing_validations?(options = {})
+      options[:validate].nil? ? true : options[:validate]
+    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 = attr.to_s
+      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/validatable/associated.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+module Mongoid
+  module Validatable
+
+    # Validates whether or not an association is valid or not. Will correctly
+    # handle has one and has many associations.
+    #
+    # @example Set up the association validations.
+    #
+    #   class Person
+    #     include Mongoid::Document
+    #     embeds_one :name
+    #     embeds_many :addresses
+    #
+    #     validates_associated :name, :addresses
+    #   end
+    class AssociatedValidator < ActiveModel::EachValidator
+
+      # Validates that the associations provided are either all nil or all
+      # valid. If neither is true then the appropriate errors will be added to
+      # the parent document.
+      #
+      # @example Validate the association.
+      #   validator.validate_each(document, :name, name)
+      #
+      # @param [ Document ] document The document to validate.
+      # @param [ Symbol ] attribute The relation to validate.
+      # @param [ Object ] value The value of the relation.
+      #
+      # @since 2.0.0
+      def validate_each(document, attribute, value)
+        begin
+          document.begin_validate
+          valid = Array.wrap(value).collect do |doc|
+            if doc.nil?
+              true
+            else
+              doc.validated? ? true : doc.valid?
+            end
+          end.all?
+        ensure
+          document.exit_validate
+        end
+        document.errors.add(attribute, :invalid, options) unless valid
+      end
+    end
+  end
+end

data/lib/mongoid/validatable/format.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module Mongoid
+  module Validatable
+
+    # Validates that the specified attributes do or do not match a certain
+    # regular expression.
+    #
+    # @example Set up the format validator.
+    #
+    #   class Person
+    #     include Mongoid::Document
+    #     field :website
+    #
+    #     validates_format_of :website, :with => URI.regexp
+    #   end
+    class FormatValidator < ActiveModel::Validations::FormatValidator
+      include Localizable
+    end
+  end
+end

data/lib/mongoid/validatable/length.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module Mongoid
+  module Validatable
+
+    # Validates that the specified attributes do or do not match a certain
+    # length.
+    #
+    # @example Set up the length validator.
+    #
+    #   class Person
+    #     include Mongoid::Document
+    #     field :website
+    #
+    #     validates_length_of :website, in: 1..10
+    #   end
+    class LengthValidator < ActiveModel::Validations::LengthValidator
+      include Localizable
+    end
+  end
+end

data/lib/mongoid/validatable/localizable.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module Mongoid
+  module Validatable
+
+    # Adds localization support to validations.
+    module Localizable
+
+      # Validates each for localized fields.
+      #
+      # @example Validate localized fields.
+      #   validator.validate_each(model, :name, "value")
+      #
+      # @param [ Document ] document The document.
+      # @param [ Symbol, String ] attribute The attribute to validate.
+      # @param [ Object ] value The attribute value.
+      #
+      # @since 2.4.2
+      def validate_each(document, attribute, value)
+        field = document.fields[attribute.to_s]
+        if field.try(:localized?) && !value.blank?
+          value.values.each do |_value|
+            super(document, attribute, _value)
+          end
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/validatable/macros.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+module Mongoid
+  module Validatable
+    module Macros
+      extend ActiveSupport::Concern
+
+      # Validates whether or not an association is valid or not. Will correctly
+      # handle has one and has many associations.
+      #
+      # @example
+      #
+      #   class Person
+      #     include Mongoid::Document
+      #     embeds_one :name
+      #     embeds_many :addresses
+      #
+      #     validates_associated :name, :addresses
+      #   end
+      #
+      # @param [ Array ] *args The arguments to pass to the validator.
+      def validates_associated(*args)
+        validates_with(AssociatedValidator, _merge_attributes(args))
+      end
+
+      # Validates whether or not a field is unique against the documents in the
+      # database.
+      #
+      # @example
+      #
+      #   class Person
+      #     include Mongoid::Document
+      #     field :title
+      #
+      #     validates_uniqueness_of :title
+      #   end
+      #
+      # @param [ Array ] *args The arguments to pass to the validator.
+      def validates_uniqueness_of(*args)
+        validates_with(UniquenessValidator, _merge_attributes(args))
+      end
+
+      # Validates the format of a field.
+      #
+      # @example
+      #   class Person
+      #     include Mongoid::Document
+      #     field :title
+      #
+      #     validates_format_of :title, with: /^[a-z0-9 \-_]*$/i
+      #   end
+      #
+      # @param [ Array ] args The names of the fields to validate.
+      #
+      # @since 2.4.0
+      def validates_format_of(*args)
+        validates_with(FormatValidator, _merge_attributes(args))
+      end
+
+      # Validates the length of a field.
+      #
+      # @example
+      #   class Person
+      #     include Mongoid::Document
+      #     field :title
+      #
+      #     validates_length_of :title, minimum: 100
+      #   end
+      #
+      # @param [ Array ] args The names of the fields to validate.
+      #
+      # @since 2.4.0
+      def validates_length_of(*args)
+        validates_with(LengthValidator, _merge_attributes(args))
+      end
+
+      # Validates whether or not a field is present - meaning nil or empty.
+      #
+      # @example
+      #   class Person
+      #     include Mongoid::Document
+      #     field :title
+      #
+      #     validates_presence_of :title
+      #   end
+      #
+      # @param [ Array ] args The names of the fields to validate.
+      #
+      # @since 2.4.0
+      def validates_presence_of(*args)
+        validates_with(PresenceValidator, _merge_attributes(args))
+      end
+    end
+  end
+end