mongoid 3.1.7 → 4.0.2

data/lib/mongoid/multi_parameter_attributes.rb

@@ -1,105 +0,0 @@
-# encoding: utf-8
-module Mongoid
-
-  # Adds Rails' multi-parameter attribute support to Mongoid.
-  #
-  # @todo: Durran: This module needs an overhaul.
-  module MultiParameterAttributes
-
-    module Errors
-
-      # Raised when an error occurred while doing a mass assignment to an
-      # attribute through the <tt>attributes=</tt> method. The exception
-      # has an +attribute+ property that is the name of the offending attribute.
-      class AttributeAssignmentError < Mongoid::Errors::MongoidError
-        attr_reader :exception, :attribute
-
-        def initialize(message, exception, attribute)
-          @exception = exception
-          @attribute = attribute
-          @message = message
-        end
-      end
-
-      # Raised when there are multiple errors while doing a mass assignment
-      # through the +attributes+ method. The exception has an +errors+
-      # property that contains an array of AttributeAssignmentError
-      # objects, each corresponding to the error while assigning to an
-      # attribute.
-      class MultiparameterAssignmentErrors < Mongoid::Errors::MongoidError
-        attr_reader :errors
-
-        def initialize(errors)
-          @errors = errors
-        end
-      end
-    end
-
-    # Process the provided attributes casting them to their proper values if a
-    # field exists for them on the document. This will be limited to only the
-    # attributes provided in the suppied +Hash+ so that no extra nil values get
-    # put into the document's attributes.
-    #
-    # @example Process the attributes.
-    #   person.process_attributes(:title => "sir", :age => 40)
-    #
-    # @param [ Hash ] attrs The attributes to set.
-    # @param [ Symbol ] role A role for scoped mass assignment.
-    # @param [ Boolean ] guard_protected_attributes False to skip mass assignment protection.
-    #
-    # @since 2.0.0.rc.7
-    def process_attributes(attrs = nil, role = :default, guard_protected_attributes = true)
-      if attrs
-        errors = []
-        attributes = attrs.class.new
-        attributes.permitted = true if attrs.respond_to?(:permitted?) && attrs.permitted?
-        multi_parameter_attributes = {}
-
-        attrs.each_pair do |key, value|
-          if key =~ /\A([^\(]+)\((\d+)([if])\)$/
-            key, index = $1, $2.to_i
-            (multi_parameter_attributes[key] ||= {})[index] = value.empty? ? nil : value.send("to_#{$3}")
-          else
-            attributes[key] = value
-          end
-        end
-
-        multi_parameter_attributes.each_pair do |key, values|
-          begin
-            values = (values.keys.min..values.keys.max).map { |i| values[i] }
-            field = self.class.fields[database_field_name(key)]
-            attributes[key] = instantiate_object(field, values)
-          rescue => e
-            errors << Errors::AttributeAssignmentError.new(
-              "error on assignment #{values.inspect} to #{key}", e, key
-            )
-          end
-        end
-
-        unless errors.empty?
-          raise Errors::MultiparameterAssignmentErrors.new(errors),
-            "#{errors.size} error(s) on assignment of multiparameter attributes"
-        end
-        
-        super attributes, role, guard_protected_attributes
-      else
-        super
-      end
-    end
-
-    protected
-
-    def instantiate_object(field, values_with_empty_parameters)
-      return nil if values_with_empty_parameters.all? { |v| v.nil? }
-      values = values_with_empty_parameters.collect { |v| v.nil? ? 1 : v }
-      klass = field.type
-      if klass == DateTime || klass == Date || klass == Time
-        field.mongoize(values)
-      elsif klass
-        klass.new(*values)
-      else
-        values
-      end
-    end
-  end
-end

data/lib/mongoid/nested_attributes.rb

@@ -1,78 +0,0 @@
-# encoding: utf-8
-module Mongoid
-
-  # Mongoid's implementation of Rails' nested attributes.
-  module NestedAttributes
-    extend ActiveSupport::Concern
-
-    included do
-      class_attribute :nested_attributes
-      self.nested_attributes = {}
-    end
-
-    module ClassMethods
-
-      REJECT_ALL_BLANK_PROC = ->(attributes){
-        attributes.all? { |key, value| key == '_destroy' || value.blank? }
-      }
-
-      # Used when needing to update related models from a parent relation. Can
-      # be used on embedded or referenced relations.
-      #
-      # @example Defining nested attributes.
-      #
-      #   class Person
-      #     include Mongoid::Document
-      #
-      #     embeds_many :addresses
-      #     embeds_one :game
-      #     references_many :posts
-      #
-      #     accepts_nested_attributes_for :addresses, :game, :posts
-      #   end
-      #
-      # @param [ Array<Symbol>, Hash ] *args A list of relation names, followed
-      #   by a hash of options.
-      #
-      # @option *args [ true, false ] :allow_destroy Can deletion occur?
-      # @option *args [ Proc, Symbol ] :reject_if Block or symbol pointing
-      #   to a class method to reject documents with.
-      # @option *args [ Integer ] :limit The max number to create.
-      # @option *args [ true, false ] :update_only Only update existing docs.
-      def accepts_nested_attributes_for(*args)
-        options = args.extract_options!
-        options[:reject_if] = REJECT_ALL_BLANK_PROC if options[:reject_if] == :all_blank
-        args.each do |name|
-          meth = "#{name}_attributes="
-          self.nested_attributes["#{name}_attributes"] = meth
-          metadata = relations[name.to_s]
-          raise Errors::NestedAttributesMetadataNotFound.new(self, name) unless metadata
-          autosave_nested_attributes(metadata)
-          re_define_method(meth) do |attrs|
-            _assigning do
-              metadata.nested_builder(attrs, options).build(self, mass_assignment_options)
-            end
-          end
-        end
-      end
-
-      private
-
-      # Add the autosave information for the nested relation.
-      #
-      # @api private
-      #
-      # @example Add the autosave if appropriate.
-      #   Person.autosave_nested_attributes(metadata)
-      #
-      # @param [ Metadata ] metadata The existing relation metadata.
-      #
-      # @since 3.1.4
-      def autosave_nested_attributes(metadata)
-        unless metadata.autosave == false
-          autosave(metadata.merge!(autosave: true))
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/observer.rb

@@ -1,192 +0,0 @@
-# encoding: utf-8
-module Mongoid
-
-  # Observer classes respond to life cycle callbacks to implement trigger-like
-  # behavior outside the original class. This is a great way to reduce the
-  # clutter that normally comes when the model class is burdened with
-  # functionality that doesn't pertain to the core responsibility of the
-  # class. Mongoid's observers work similar to ActiveRecord's. Example:
-  #
-  #   class CommentObserver < Mongoid::Observer
-  #     def after_save(comment)
-  #       Notifications.comment(
-  #         "admin@do.com", "New comment was posted", comment
-  #       ).deliver
-  #     end
-  #   end
-  #
-  # This Observer sends an email when a Comment#save is finished.
-  #
-  #   class ContactObserver < Mongoid::Observer
-  #     def after_create(contact)
-  #       contact.logger.info('New contact added!')
-  #     end
-  #
-  #     def after_destroy(contact)
-  #       contact.logger.warn("Contact with an id of #{contact.id} was destroyed!")
-  #     end
-  #   end
-  #
-  # This Observer uses logger to log when specific callbacks are triggered.
-  #
-  # == Observing a class that can't be inferred
-  #
-  # Observers will by default be mapped to the class with which they share a
-  # name. So CommentObserver will be tied to observing Comment,
-  # ProductManagerObserver to ProductManager, and so on. If you want to
-  # name your observer differently than the class you're interested in
-  # observing, you can use the Observer.observe class method which takes
-  # either the concrete class (Product) or a symbol for that class (:product):
-  #
-  #   class AuditObserver < Mongoid::Observer
-  #     observe :account
-  #
-  #     def after_update(account)
-  #       AuditTrail.new(account, "UPDATED")
-  #     end
-  #   end
-  #
-  # If the audit observer needs to watch more than one kind of object,
-  # this can be specified with multiple arguments:
-  #
-  #   class AuditObserver < Mongoid::Observer
-  #     observe :account, :balance
-  #
-  #     def after_update(record)
-  #       AuditTrail.new(record, "UPDATED")
-  #     end
-  #   end
-  #
-  # The AuditObserver will now act on both updates to Account and Balance
-  # by treating them both as records.
-  #
-  # == Available callback methods
-  #
-  # * after_initialize
-  # * before_validation
-  # * after_validation
-  # * before_create
-  # * around_create
-  # * after_create
-  # * before_update
-  # * around_update
-  # * after_update
-  # * before_upsert
-  # * around_upsert
-  # * after_upsert
-  # * before_save
-  # * around_save
-  # * after_save
-  # * before_destroy
-  # * around_destroy
-  # * after_destroy
-  #
-  # == Storing Observers in Rails
-  #
-  # If you're using Mongoid within Rails, observer classes are usually stored
-  # in +app/models+ with the naming convention of +app/models/audit_observer.rb+.
-  #
-  # == Configuration
-  #
-  # In order to activate an observer, list it in the +config.mongoid.observers+
-  # configuration setting in your +config/application.rb+ file.
-  #
-  #   config.mongoid.observers = :comment_observer, :signup_observer
-  #
-  # Observers will not be invoked unless you define them in your
-  # application configuration.
-  #
-  # == Loading
-  #
-  # Observers register themselves with the model class that they observe,
-  # since it is the class that notifies them of events when they occur.
-  # As a side-effect, when an observer is loaded, its corresponding model
-  # class is loaded.
-  #
-  # Observers are loaded after the application initializers, so that
-  # observed models can make use of extensions. If by any chance you are
-  # using observed models in the initialization, you can
-  # still load their observers by calling +ModelObserver.instance+ before.
-  # Observers are singletons and that call instantiates and registers them.
-  class Observer < ActiveModel::Observer
-
-    private
-
-    # Adds the specified observer to the class.
-    #
-    # @example Add the observer.
-    #   observer.add_observer!(Document)
-    #
-    # @param [ Class ] klass The child observer to add.
-    #
-    # @since 2.0.0.rc.8
-    def add_observer!(klass)
-      super and define_callbacks(klass)
-    end
-
-    # Defines all the callbacks for each observer of the model.
-    #
-    # @example Define all the callbacks.
-    #   observer.define_callbacks(Document)
-    #
-    # @param [ Class ] klass The model to define them on.
-    #
-    # @since 2.0.0.rc.8
-    def define_callbacks(klass)
-      observer = self
-      observer_name = observer.class.name.underscore.gsub('/', '__')
-      Mongoid::Callbacks.observables.each do |callback|
-        next unless respond_to?(callback)
-        callback_meth = :"_notify_#{observer_name}_for_#{callback}"
-        unless klass.respond_to?(callback_meth)
-          klass.send(:define_method, callback_meth) do |&block|
-            if value = observer.update(callback, self, &block)
-              value
-            else
-              block.call if block
-            end
-          end
-          klass.send(callback, callback_meth)
-        end
-      end
-      self
-    end
-
-    # Are the observers disabled for the object?
-    #
-    # @api private
-    #
-    # @example If the observer disabled?
-    #   Observer.disabled_for(band)
-    #
-    # @param [ Document ] object The model instance.
-    #
-    # @return [ true, false ] If the observer is disabled.
-    def disabled_for?(object)
-      klass = object.class
-      return false unless klass.respond_to?(:observers)
-      klass.observers.disabled_for?(self) || Mongoid.observers.disabled_for?(self)
-    end
-
-    class << self
-
-      # Attaches the observer to the specified classes.
-      #
-      # @example Attach the BandObserver to the class Artist.
-      #   class BandObserver < Mongoid::Observer
-      #     observe :artist
-      #   end
-      #
-      # @param [ Array<Symbol> ] models The names of the models.
-      #
-      # @since 3.0.15
-      def observe(*models)
-        models.flatten!
-        models.collect! do |model|
-          model.respond_to?(:to_sym) ? model.to_s.camelize.constantize : model
-        end
-        singleton_class.redefine_method(:observed_classes) { models }
-      end
-    end
-  end
-end

data/lib/mongoid/paranoia.rb

@@ -1,136 +0,0 @@
-# encoding: utf-8
-module Mongoid
-
-  # Include this module to get soft deletion of root level documents.
-  # This will add a deleted_at field to the +Document+, managed automatically.
-  # Potentially incompatible with unique indices. (if collisions with deleted items)
-  #
-  # @example Make a document paranoid.
-  #   class Person
-  #     include Mongoid::Document
-  #     include Mongoid::Paranoia
-  #   end
-  module Paranoia
-    extend ActiveSupport::Concern
-
-    included do
-      field :deleted_at, type: Time
-      self.paranoid = true
-
-      default_scope where(deleted_at: nil)
-      scope :deleted, ne(deleted_at: nil)
-    end
-
-    # Delete the paranoid +Document+ from the database completely. This will
-    # run the destroy callbacks.
-    #
-    # @example Hard destroy the document.
-    #   document.destroy!
-    #
-    # @return [ true, false ] If the operation succeeded.
-    #
-    # @since 1.0.0
-    def destroy!
-      run_callbacks(:destroy) { delete! }
-    end
-
-    # Delete the paranoid +Document+ from the database completely.
-    #
-    # @example Hard delete the document.
-    #   document.delete!
-    #
-    # @return [ true, false ] If the operation succeeded.
-    #
-    # @since 1.0.0
-    def delete!
-      Persistence::Operations.remove(self).persist
-    end
-
-    # Delete the +Document+, will set the deleted_at timestamp and not actually
-    # delete it.
-    #
-    # @example Soft remove the document.
-    #   document.remove
-    #
-    # @param [ Hash ] options The database options.
-    #
-    # @return [ true ] True.
-    #
-    # @since 1.0.0
-    def remove(options = {})
-      cascade!
-      time = self.deleted_at = Time.now
-      paranoid_collection.find(atomic_selector).
-        update({ "$set" => { paranoid_field => time }})
-      @destroyed = true
-      IdentityMap.remove(self)
-      true
-    end
-    alias :delete :remove
-
-    # Determines if this document is destroyed.
-    #
-    # @example Is the document destroyed?
-    #   person.destroyed?
-    #
-    # @return [ true, false ] If the document is destroyed.
-    #
-    # @since 1.0.0
-    def destroyed?
-      (@destroyed ||= false) || !!deleted_at
-    end
-    alias :deleted? :destroyed?
-
-    def persisted?
-      !new_record? && !(@destroyed ||= false)
-    end
-
-    # Restores a previously soft-deleted document. Handles this by removing the
-    # deleted_at flag.
-    #
-    # @example Restore the document from deleted state.
-    #   document.restore
-    #
-    # @return [ Time ] The time the document had been deleted.
-    #
-    # @since 1.0.0
-    def restore
-      paranoid_collection.find(atomic_selector).
-        update({ "$unset" => { paranoid_field => true }})
-      attributes.delete("deleted_at")
-      @destroyed = false
-      true
-    end
-
-    # Returns a string representing the documents's key suitable for use in URLs.
-    def to_param
-      new_record? ? nil : to_key.join('-')
-    end
-
-    private
-
-    # Get the collection to be used for paranoid operations.
-    #
-    # @example Get the paranoid collection.
-    #   document.paranoid_collection
-    #
-    # @return [ Collection ] The root collection.
-    #
-    # @since 2.3.1
-    def paranoid_collection
-      embedded? ? _root.collection : self.collection
-    end
-
-    # Get the field to be used for paranoid operations.
-    #
-    # @example Get the paranoid field.
-    #   document.paranoid_field
-    #
-    # @return [ String ] The deleted at field.
-    #
-    # @since 2.3.1
-    def paranoid_field
-      embedded? ? "#{atomic_position}.deleted_at" : "deleted_at"
-    end
-  end
-end

data/lib/mongoid/persistence/atomic/add_to_set.rb

@@ -1,47 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Atomic
-
-      # This class provides the ability to perform an explicit $addToSet
-      # modification on a specific field.
-      class AddToSet
-        include Operation
-
-        # Sends the atomic $addToSet operation to the database.
-        #
-        # @example Persist the new values.
-        #   addToSet.persist
-        #
-        # @return [ Object ] The new array value.
-        #
-        # @since 2.0.0
-        def persist
-          prepare do
-            document[field] = [] unless document[field]
-            values = document.send(field)
-            Array.wrap(value).each do |val|
-              values.push(val) unless values.include?(val)
-            end
-            execute("$addToSet")
-            values
-          end
-        end
-
-        # Get the atomic operation to perform.
-        #
-        # @example Get the operation.
-        #   add_to_set.operation("$addToSet")
-        #
-        # @param [ String ] modifier The modifier to use.
-        #
-        # @return [ Hash ] The atomic operation for the field and addition.
-        #
-        # @since 2.0.0
-        def operation(modifier)
-          { modifier => { path => value.is_a?(Array) ? { "$each" => value } : value}}
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/persistence/atomic/bit.rb

@@ -1,35 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Atomic
-
-      # This operation is for performing $bit atomic operations against the
-      # database.
-      class Bit
-        include Operation
-
-        # Execute the bitwise operation. This correlates to a $bit in MongoDB.
-        #
-        # @example Execute the op.
-        #   bit.persist
-        #
-        # @return [ Integer ] The new value.
-        #
-        # @since 2.1.0
-        def persist
-          prepare do
-            current = document[field]
-            return nil unless current
-            document[field] = value.inject(current) do |result, (bit, val)|
-              result = result & val if bit.to_s == "and"
-              result = result | val if bit.to_s == "or"
-              result
-            end
-            execute("$bit")
-            document[field]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/persistence/atomic/inc.rb

@@ -1,45 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Persistence
-    module Atomic
-
-      # This class provides atomic $inc behaviour.
-      class Inc
-        include Operation
-
-        # Sends the atomic $inc operation to the database.
-        #
-        # @example Persist the new values.
-        #   inc.persist
-        #
-        # @return [ Object ] The new numeric value.
-        #
-        # @since 2.0.0
-        def persist
-          prepare do
-            current = document[field] || 0
-            document[field] = current + value
-            execute("$inc")
-            document[field]
-          end
-        end
-
-        private
-
-        # In case we need to cast going to the database.
-        #
-        # @api private
-        #
-        # @example Cast the value.
-        #   operation.cast_value
-        #
-        # @return [ Integer, Float ] The value casted.
-        #
-        # @since 3.0.3
-        def cast_value
-          value.__to_inc__
-        end
-      end
-    end
-  end
-end