mongoid 2.4.10 → 3.0.0

data/lib/mongoid/errors/too_many_nested_attribute_records.rb

@@ -1,5 +1,5 @@
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # This error is raised when trying to create set nested records above the
     # specified :limit
@@ -9,9 +9,9 @@ module Mongoid #:nodoc
     class TooManyNestedAttributeRecords < MongoidError
       def initialize(association, limit)
         super(
-          translate(
+          compose_message(
             "too_many_nested_attribute_records",
-            { :association => association, :limit => limit }
+            { association: association, limit: limit }
           )
         )
       end

data/lib/mongoid/errors/unknown_attribute.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to set a value in Mongoid that is not
+    # already set with dynamic attributes or the field is not defined.
+    class UnknownAttribute < MongoidError
+
+      # Create the new error.
+      #
+      # @example Instantiate the error.
+      #   UnknownAttribute.new(Person, "gender")
+      #
+      # @param [ Class ] klass The model class.
+      # @param [ String, Symbol ] name The name of the attribute.
+      #
+      # @since 3.0.0
+      def initialize(klass, name)
+        super(
+          compose_message("unknown_attribute", { klass: klass.name, name: name })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/unsaved_document.rb

@@ -1,20 +1,16 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # Raised when attempting to call create or create! through a
     # references_many when the parent document has not been saved. This
     # prevents the child from getting presisted and immediately being orphaned.
     class UnsavedDocument < MongoidError
-
-      attr_reader :base, :document
-
       def initialize(base, document)
-        @base, @document = base, document
         super(
-          translate(
+          compose_message(
             "unsaved_document",
-            { :base => base.class.name, :document => document.class.name }
+            { base: base.class.name, document: document.class.name }
           )
         )
       end

data/lib/mongoid/errors/unsupported_javascript.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # Raised when Javascript criteria selector is passed for embedded document.
+    class UnsupportedJavascript < MongoidError
+
+      # Create the new error caused by using Javascript in embedded document criteria selector.
+      #
+      # @example Create the error.
+      #   UnsupportedJavascriptSelector.new(Album, "this.name == '101'")
+      #
+      # @param [ Class ] klass The embedded document class.
+      # @param [ String ] javascript The javascript expression.
+      #
+      # @since 3.0.0
+      def initialize(klass, javascript)
+        super(
+          compose_message(
+            "unsupported_javascript",
+            { klass: klass, javascript: javascript }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/unsupported_version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # Raised when the database version is not supported by Mongoid.
     #
@@ -9,9 +9,9 @@ module Mongoid #:nodoc
     class UnsupportedVersion < MongoidError
       def initialize(version)
         super(
-          translate(
+          compose_message(
             "unsupported_version",
-            { :version => version, :mongo_version => Mongoid::MONGODB_VERSION }
+            { version: version, mongo_version: Mongoid::MONGODB_VERSION }
           )
         )
       end

data/lib/mongoid/errors/validations.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # Raised when a persistence method ending in ! fails validation. The message
     # will contain the full error messages from the +Document+ in question.
@@ -8,13 +8,14 @@ module Mongoid #:nodoc
     # @example Create the error.
     #   Validations.new(person.errors)
     class Validations < MongoidError
-      attr_reader :document
       def initialize(document)
-        @document = document
         super(
-          translate(
+          compose_message(
             "validations",
-            { :errors => document.errors.full_messages.join(", ") }
+            {
+              document: document.class,
+              errors: document.errors.full_messages.join(", ")
+            }
           )
         )
       end

data/lib/mongoid/errors/versioning_not_on_root.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when attempting to version an embedded document.
+    class VersioningNotOnRoot < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   VersioningNotOnRoot.new(Address)
+      #
+      # @param [ Class ] klass The embedded class.
+      #
+      # @since 3.0.0
+      def initialize(klass)
+        super(
+          compose_message("versioning_not_on_root", { klass: klass })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors.rb

@@ -1,19 +1,41 @@
 # encoding: utf-8
 require "mongoid/errors/mongoid_error"
+require "mongoid/errors/ambiguous_relationship"
 require "mongoid/errors/callback"
 require "mongoid/errors/document_not_found"
 require "mongoid/errors/eager_load"
 require "mongoid/errors/invalid_collection"
+require "mongoid/errors/invalid_config_option"
 require "mongoid/errors/invalid_database"
 require "mongoid/errors/invalid_field"
+require "mongoid/errors/invalid_field_option"
 require "mongoid/errors/invalid_find"
+require "mongoid/errors/invalid_index"
 require "mongoid/errors/invalid_options"
+require "mongoid/errors/invalid_scope"
+require "mongoid/errors/invalid_set_polymorphic_relation"
+require "mongoid/errors/invalid_storage_options"
 require "mongoid/errors/invalid_time"
-require "mongoid/errors/invalid_type"
+require "mongoid/errors/inverse_not_found"
 require "mongoid/errors/mixed_relations"
+require "mongoid/errors/mixed_session_configuration"
+require "mongoid/errors/nested_attributes_metadata_not_found"
+require "mongoid/errors/no_default_session"
 require "mongoid/errors/no_environment"
+require "mongoid/errors/no_map_reduce_output"
+require "mongoid/errors/no_metadata"
+require "mongoid/errors/no_parent"
+require "mongoid/errors/no_session_config"
+require "mongoid/errors/no_sessions_config"
+require "mongoid/errors/no_session_database"
+require "mongoid/errors/no_session_hosts"
+require "mongoid/errors/readonly_attribute"
 require "mongoid/errors/scope_overwrite"
 require "mongoid/errors/too_many_nested_attribute_records"
+require "mongoid/errors/unknown_attribute"
 require "mongoid/errors/unsaved_document"
+require "mongoid/errors/unsupported_javascript"
 require "mongoid/errors/unsupported_version"
 require "mongoid/errors/validations"
+require "mongoid/errors/versioning_not_on_root"
+require "mongoid/errors/delete_restriction"

data/lib/mongoid/evolvable.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Mongoid
+
+  # Contains behaviour specific to evolving for origin queries.
+  module Evolvable
+
+    # Evolve the document into an object id.
+    #
+    # @example Evolve the document.
+    #   document.__evolve_object_id__
+    #
+    # @return [ Object ] The document's id.
+    #
+    # @since 3.0.0
+    def __evolve_object_id__
+      id
+    end
+  end
+end

data/lib/mongoid/extensions/array.rb

@@ -0,0 +1,164 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module Array
+
+      # Evolve the array into an array of object ids.
+      #
+      # @example Evolve the array to object ids.
+      #   [ id ].__evolve_object_id__
+      #
+      # @return [ Array<Moped::BSON::ObjectId> ] The converted array.
+      #
+      # @since 3.0.0
+      def __evolve_object_id__
+        map!(&:__evolve_object_id__)
+        self
+      end
+
+      # Get the array of args as arguments for a find query.
+      #
+      # @example Get the array as find args.
+      #   [ 1, 2, 3 ].__find_args__
+      #
+      # @return [ Array ] The array of args.
+      #
+      # @since 3.0.0
+      def __find_args__
+        flat_map{ |a| a.__find_args__ }.uniq_by{ |a| a.to_s }
+      end
+
+      # Mongoize the array into an array of object ids.
+      #
+      # @example Evolve the array to object ids.
+      #   [ id ].__mongoize_object_id__
+      #
+      # @return [ Array<Moped::BSON::ObjectId> ] The converted array.
+      #
+      # @since 3.0.0
+      def __mongoize_object_id__
+        map!(&:__mongoize_object_id__).compact!
+        self
+      end
+
+      # Converts the array for storing as a time.
+      #
+      # @example Convert the array to a time.
+      #   [ 2010, 1, 1 ].__mongoize_time__
+      #
+      # @return [ Time ] The time.
+      #
+      # @since 3.0.0
+      def __mongoize_time__
+        ::Time.configured.local(*self)
+      end
+
+      # Is the array a set of multiple arguments in a method?
+      #
+      # @example Is this multi args?
+      #   [ 1, 2, 3 ].multi_arged?
+      #
+      # @return [ true, false ] If the array is multi args.
+      #
+      # @since 3.0.0
+      def multi_arged?
+        first.resizable? || size > 1
+      end
+
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   object.mongoize
+      #
+      # @return [ Array ] The object.
+      #
+      # @since 3.0.0
+      def mongoize
+        ::Array.mongoize(self)
+      end
+
+      # Delete the first object in the array that is equal to the supplied
+      # object and return it. This is much faster than performing a standard
+      # delete for large arrays ince it attempt to delete multiple in the
+      # other.
+      #
+      # @example Delete the first object.
+      #   [ "1", "2", "1" ].delete_one("1")
+      #
+      # @param [ Object ] object The object to delete.
+      #
+      # @return [ Object ] The deleted object.
+      #
+      # @since 2.1.0
+      def delete_one(object)
+        position = index(object)
+        position ? delete_at(position) : nil
+      end
+
+      # Is the object's size changable?
+      #
+      # @example Is the object resizable?
+      #   object.resizable?
+      #
+      # @return [ true ] true.
+      #
+      # @since 3.0.0
+      def resizable?
+        true
+      end
+
+      module ClassMethods
+
+        # Convert the provided object to a propery array of foreign keys.
+        #
+        # @example Mongoize the object.
+        #   Array.__mongoize_fk__(constraint, object)
+        #
+        # @param [ Constraint ] constraint The metadata constraint.
+        # @param [ Object ] object The object to convert.
+        #
+        # @return [ Array ] The array of ids.
+        #
+        # @since 3.0.0
+        def __mongoize_fk__(constraint, object)
+          if object.resizable?
+            object.blank? ? object : constraint.convert(object)
+          else
+            object.blank? ? [] : constraint.convert(Array(object))
+          end
+        end
+
+        # Turn the object from the ruby type we deal with to a Mongo friendly
+        # type.
+        #
+        # @example Mongoize the object.
+        #   Array.mongoize([ 1, 2, 3 ])
+        #
+        # @param [ Object ] object The object to mongoize.
+        #
+        # @return [ Array ] The object mongoized.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          evolve(object)
+        end
+
+        # Is the object's size changable?
+        #
+        # @example Is the object resizable?
+        #   Array.resizable?
+        #
+        # @return [ true ] true.
+        #
+        # @since 3.0.0
+        def resizable?
+          true
+        end
+      end
+    end
+  end
+end
+
+::Array.__send__(:include, Mongoid::Extensions::Array)
+::Array.__send__(:extend, Mongoid::Extensions::Array::ClassMethods)

data/lib/mongoid/extensions/big_decimal.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module BigDecimal
+
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   object.mongoize
+      #
+      # @return [ Object ] The object.
+      #
+      # @since 3.0.0
+      def mongoize
+        to_s
+      end
+
+      module ClassMethods
+
+        # Convert the object from it's mongo friendly ruby type to this type.
+        #
+        # @example Demongoize the object.
+        #   Object.demongoize(object)
+        #
+        # @param [ Object ] object The object to demongoize.
+        #
+        # @return [ Object ] The object.
+        #
+        # @since 3.0.0
+        def demongoize(object)
+          if object
+            object.numeric? ? ::BigDecimal.new(object.to_s) : object
+          end
+        end
+      end
+    end
+  end
+end
+
+::BigDecimal.__send__(:include, Mongoid::Extensions::BigDecimal)
+::BigDecimal.__send__(:extend, Mongoid::Extensions::BigDecimal::ClassMethods)

data/lib/mongoid/extensions/boolean.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module Boolean
+      module ClassMethods
+
+        # Turn the object from the ruby type we deal with to a Mongo friendly
+        # type.
+        #
+        # @example Mongoize the object.
+        #   Boolean.mongoize("123.11")
+        #
+        # @return [ String ] The object mongoized.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          evolve(object)
+        end
+      end
+    end
+  end
+end
+
+::Boolean.__send__(:extend, Mongoid::Extensions::Boolean::ClassMethods)

data/lib/mongoid/extensions/date.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module Date
+
+      # Convert the date into a time.
+      #
+      # @example Convert the date to a time.
+      #   date.__mongoize_time__
+      #
+      # @return [ Time ] The converted time.
+      #
+      # @since 3.0.0
+      def __mongoize_time__
+        ::Time.configured.local(year, month, day)
+      end
+
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   date.mongoize
+      #
+      # @return [ Time ] The object mongoized.
+      #
+      # @since 3.0.0
+      def mongoize
+        ::Date.mongoize(self)
+      end
+
+      module ClassMethods
+
+        # Convert the object from it's mongo friendly ruby type to this type.
+        #
+        # @example Demongoize the object.
+        #   Date.demongoize(object)
+        #
+        # @param [ Time ] object The time from Mongo.
+        #
+        # @return [ Date ] The object as a date.
+        #
+        # @since 3.0.0
+        def demongoize(object)
+          ::Date.new(object.year, object.month, object.day) if object
+        end
+
+        # Turn the object from the ruby type we deal with to a Mongo friendly
+        # type.
+        #
+        # @example Mongoize the object.
+        #   Date.mongoize("2012-1-1")
+        #
+        # @param [ Object ] object The object to mongoize.
+        #
+        # @return [ Time ] The object mongoized.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          unless object.blank?
+            time = object.__mongoize_time__
+            ::Time.utc(time.year, time.month, time.day)
+          end
+        end
+      end
+    end
+  end
+end
+
+::Date.__send__(:include, Mongoid::Extensions::Date)
+::Date.__send__(:extend, Mongoid::Extensions::Date::ClassMethods)

data/lib/mongoid/extensions/date_time.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module DateTime
+
+      # Mongoize the date time into a time.
+      #
+      # @example Mongoize the date time.
+      #   date_time.__mongoize_time__
+      #
+      # @return [ Time ] The mongoized time.
+      #
+      # @since 3.0.0
+      def __mongoize_time__
+        return self if utc? && Mongoid.use_utc?
+        if Mongoid.use_activesupport_time_zone?
+          in_time_zone(::Time.zone)
+        else
+          time = to_time
+          time.respond_to?(:getlocal) ? time.getlocal : time
+        end
+      end
+
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   date_time.mongoize
+      #
+      # @return [ Time ] The object mongoized.
+      #
+      # @since 3.0.0
+      def mongoize
+        ::DateTime.mongoize(self)
+      end
+
+      module ClassMethods
+
+        # Convert the object from it's mongo friendly ruby type to this type.
+        #
+        # @example Demongoize the object.
+        #   DateTime.demongoize(object)
+        #
+        # @param [ Time ] object The time from Mongo.
+        #
+        # @return [ DateTime ] The object as a date.
+        #
+        # @since 3.0.0
+        def demongoize(object)
+          ::Time.demongoize(object).try(:to_datetime)
+        end
+
+        # Turn the object from the ruby type we deal with to a Mongo friendly
+        # type.
+        #
+        # @example Mongoize the object.
+        #   DateTime.mongoize("2012-1-1")
+        #
+        # @param [ Object ] object The object to convert.
+        #
+        # @return [ Time ] The object mongoized.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          ::Time.mongoize(object)
+        end
+      end
+    end
+  end
+end
+
+::DateTime.__send__(:include, Mongoid::Extensions::DateTime)
+::DateTime.__send__(:extend, Mongoid::Extensions::DateTime::ClassMethods)

data/lib/mongoid/extensions/false_class.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module FalseClass
+
+      # Get the value of the object as a mongo friendy sort value.
+      #
+      # @example Get the object as sort criteria.
+      #   object.__sortable__
+      #
+      # @return [ Integer ] 0.
+      #
+      # @since 3.0.0
+      def __sortable__
+        0
+      end
+
+      # Is the passed value a boolean?
+      #
+      # @example Is the value a boolean type?
+      #   false.is_a?(Boolean)
+      #
+      # @param [ Class ] other The class to check.
+      #
+      # @return [ true, false ] If the other is a boolean.
+      #
+      # @since 1.0.0
+      def is_a?(other)
+        if other == ::Boolean || other.class == ::Boolean
+          return true
+        end
+        super(other)
+      end
+    end
+  end
+end
+
+::FalseClass.__send__(:include, Mongoid::Extensions::FalseClass)