mongoid-multi-db 3.0.0

data/lib/mongoid/threaded/lifecycle.rb

@@ -0,0 +1,192 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Threaded #:nodoc:
+
+    # This module contains convenience methods for document lifecycle that
+    # resides on thread locals.
+    module Lifecycle
+      extend ActiveSupport::Concern
+
+      private
+
+      # Begin the assignment of attributes. While in this block embedded
+      # documents will not autosave themselves in order to allow the document to
+      # be in a valid state.
+      #
+      # @example Execute the assignment.
+      #   _assigning do
+      #     person.attributes = { :addresses => [ address ] }
+      #   end
+      #
+      # @return [ Object ] The yielded value.
+      #
+      # @since 2.2.0
+      def _assigning
+        Threaded.begin_assign
+        yield
+      ensure
+        Threaded.exit_assign
+      end
+
+      # Is the current thread in assigning mode?
+      #
+      # @example Is the current thread in assigning mode?
+      #   proxy._assigning?
+      #
+      # @return [ true, false ] If the thread is assigning.
+      #
+      # @since 2.1.0
+      def _assigning?
+        Threaded.assigning?
+      end
+
+      # Execute a block in binding mode.
+      #
+      # @example Execute in binding mode.
+      #   binding do
+      #     relation.push(doc)
+      #   end
+      #
+      # @return [ Object ] The return value of the block.
+      #
+      # @since 2.1.0
+      def _binding
+        Threaded.begin_bind
+        yield
+      ensure
+        Threaded.exit_bind
+      end
+
+      # Is the current thread in binding mode?
+      #
+      # @example Is the current thread in binding mode?
+      #   proxy.binding?
+      #
+      # @return [ true, false ] If the thread is binding.
+      #
+      # @since 2.1.0
+      def _binding?
+        Threaded.binding?
+      end
+
+      # Execute a block in building mode.
+      #
+      # @example Execute in building mode.
+      #   _building do
+      #     relation.push(doc)
+      #   end
+      #
+      # @return [ Object ] The return value of the block.
+      #
+      # @since 2.1.0
+      def _building
+        Threaded.begin_build
+        yield
+      ensure
+        Threaded.exit_build
+      end
+
+      # Is the current thread in building mode?
+      #
+      # @example Is the current thread in building mode?
+      #   proxy._building?
+      #
+      # @return [ true, false ] If the thread is building.
+      #
+      # @since 2.1.0
+      def _building?
+        Threaded.building?
+      end
+
+      # Is the current thread in creating mode?
+      #
+      # @example Is the current thread in creating mode?
+      #   proxy.creating?
+      #
+      # @return [ true, false ] If the thread is creating.
+      #
+      # @since 2.1.0
+      def _creating?
+        Threaded.creating?
+      end
+
+      # Execute a block in loading mode.
+      #
+      # @example Execute in loading mode.
+      #   _loading do
+      #     relation.push(doc)
+      #   end
+      #
+      # @return [ Object ] The return value of the block.
+      #
+      # @since 2.3.2
+      def _loading
+        Threaded.begin_load
+        yield
+      ensure
+        Threaded.exit_load
+      end
+
+      # Is the current thread in loading mode?
+      #
+      # @example Is the current thread in loading mode?
+      #   proxy._loading?
+      #
+      # @return [ true, false ] If the thread is loading.
+      #
+      # @since 2.3.2
+      def _loading?
+        Threaded.loading?
+      end
+
+      # Execute a block in loading revision mode.
+      #
+      # @example Execute in loading revision mode.
+      #   _loading_revision do
+      #     load_revision
+      #   end
+      #
+      # @return [ Object ] The return value of the block.
+      #
+      # @since 2.3.4
+      def _loading_revision
+        Threaded.begin_load_revision
+        yield
+      ensure
+        Threaded.exit_load_revision
+      end
+
+      module ClassMethods #:nodoc:
+
+        # Execute a block in creating mode.
+        #
+        # @example Execute in creating mode.
+        #   creating do
+        #     relation.push(doc)
+        #   end
+        #
+        # @return [ Object ] The return value of the block.
+        #
+        # @since 2.1.0
+        def _creating
+          Threaded.begin_create
+          yield
+        ensure
+          Threaded.exit_create
+        end
+
+        # Is the current thread in loading revision mode?
+        #
+        # @example Is the current thread in loading revision mode?
+        #   proxy._loading_revision?
+        #
+        # @return [ true, false ] If the thread is loading a revision.
+        #
+        # @since 2.3.4
+        def _loading_revision?
+          Threaded.loading_revision?
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/timestamps.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require "mongoid/timestamps/created"
+require "mongoid/timestamps/updated"
+require "mongoid/timestamps/timeless"
+
+module Mongoid #:nodoc:
+
+  # This module handles the behaviour for setting up document created at and
+  # updated at timestamps.
+  module Timestamps
+    extend ActiveSupport::Concern
+    include Created
+    include Updated
+  end
+end

data/lib/mongoid/timestamps/created.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Timestamps
+    # This module handles the behaviour for setting up document created at
+    # timestamp.
+    module Created
+      extend ActiveSupport::Concern
+
+      included do
+        field :created_at, :type => Time
+        set_callback :create, :before, :set_created_at, :if => :timestamping?
+      end
+
+      # Update the created_at field on the Document to the current time. This is
+      # only called on create.
+      #
+      # @example Set the created at time.
+      #   person.set_created_at
+      def set_created_at
+        self.created_at = Time.now.utc if !created_at
+      end
+    end
+  end
+end

data/lib/mongoid/timestamps/timeless.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Timestamps
+
+    # This module adds behaviour for turning off timestamping in single or
+    # multiple calls.
+    module Timeless
+      extend ActiveSupport::Concern
+
+      # Begin an execution that should skip timestamping.
+      #
+      # @example Save a document but don't timestamp.
+      #   person.timeless.save
+      #
+      # @return [ Document ] The document this was called on.
+      #
+      # @since 2.3.0
+      def timeless
+        tap { Threaded.timeless = true }
+      end
+
+      # Are we currently timestamping?
+      #
+      # @example Should timestamps be applied?
+      #   person.timestamping?
+      #
+      # @return [ true, false ] If the current thread is timestamping.
+      #
+      # @since 2.3.0
+      def timestamping?
+        Threaded.timestamping?
+      end
+
+      module ClassMethods #:nodoc
+
+        # Begin an execution that should skip timestamping.
+        #
+        # @example Create a document but don't timestamp.
+        #   Person.timeless.create(:title => "Sir")
+        #
+        # @return [ Class ] The class this was called on.
+        #
+        # @since 2.3.0
+        def timeless
+          tap { Threaded.timeless = true }
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/timestamps/updated.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Timestamps
+    # This module handles the behaviour for setting up document updated at
+    # timestamp.
+    module Updated
+      extend ActiveSupport::Concern
+
+      included do
+        field :updated_at, :type => Time, :versioned => false
+        set_callback :save, :before, :set_updated_at, :if => Proc.new { |doc|
+          doc.timestamping? && (doc.new_record? || doc.changed?)
+        }
+      end
+
+      # Update the updated_at field on the Document to the current time.
+      # This is only called on create and on save.
+      #
+      # @example Set the updated at time.
+      #   person.set_updated_at
+      def set_updated_at
+        self.updated_at = Time.now.utc unless updated_at_changed?
+      end
+    end
+  end
+end

data/lib/mongoid/validations.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+require "mongoid/validations/associated"
+require "mongoid/validations/uniqueness"
+
+module Mongoid #:nodoc:
+
+  # This module provides additional validations that ActiveModel does not
+  # provide: validates_associated and validates_uniqueness_of.
+  module Validations
+    extend ActiveSupport::Concern
+    include ActiveModel::Validations
+
+    # 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)
+      if relations[attr.to_s]
+        begin_validate
+        relation = send(attr)
+        exit_validate
+        relation.do_or_do_not(:in_memory) || relation
+      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? ? :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
+
+    module ClassMethods #:nodoc:
+
+      # 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
+
+      protected
+
+      # 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
+    end
+  end
+end