mongoid 5.4.1 → 6.0.0.beta

data/lib/mongoid/errors/inverse_not_found.rb

@@ -12,7 +12,7 @@ module Mongoid
       #
       # @param [ Class ] base The base class.
       # @param [ Symbol ] name The name of the relation.
-      # @param [ Class ] klass The child class.
+      # @param [ Class ] The child class.
       # @param [ Symbol ] inverse The attempted inverse key.
       #
       # @since 3.0.0

data/lib/mongoid/errors/mongoid_error.rb

@@ -19,7 +19,7 @@ module Mongoid
       # @return [ String ] The composed message.
       #
       # @since 3.0.0
-      def compose_message(key, attributes = {})
+      def compose_message(key, attributes)
         @problem = translate_problem(key, attributes)
         @summary = translate_summary(key, attributes)
         @resolution = translate_resolution(key, attributes)

data/lib/mongoid/evolvable.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Mongoid
 
-  # Contains behaviour specific to evolving for origin queries.
+  # Contains behaviour specific to evolving for queryable queries.
   module Evolvable
 
     # Evolve the document into an object id.

data/lib/mongoid/extensions.rb

@@ -3,9 +3,6 @@ class BSON::ObjectId
   def as_json(options = nil)
     { "$oid" => to_s }
   end
-  def to_xml(options = nil)
-    ActiveSupport::XmlMini.to_tag(options[:root], self.to_s, options)
-  end
 end
 
 class Symbol
@@ -30,7 +27,6 @@ require "mongoid/extensions/big_decimal"
 require "mongoid/extensions/boolean"
 require "mongoid/extensions/date"
 require "mongoid/extensions/date_time"
-require "mongoid/extensions/decimal128"
 require "mongoid/extensions/false_class"
 require "mongoid/extensions/float"
 require "mongoid/extensions/hash"
@@ -39,7 +35,6 @@ require "mongoid/extensions/module"
 require "mongoid/extensions/nil_class"
 require "mongoid/extensions/object"
 require "mongoid/extensions/object_id"
-require "mongoid/extensions/origin/regexp_raw"
 require "mongoid/extensions/range"
 require "mongoid/extensions/regexp"
 require "mongoid/extensions/set"

data/lib/mongoid/extensions/big_decimal.rb

@@ -28,6 +28,18 @@ module Mongoid
         to_s
       end
 
+      # Is the BigDecimal a number?
+      #
+      # @example Is the object a number?.
+      #   object.numeric?
+      #
+      # @return [ true ] Always true.
+      #
+      # @since 6.0.0
+      def numeric?
+        true
+      end
+
       module ClassMethods
 
         # Convert the object from its mongo friendly ruby type to this type.
@@ -37,28 +49,25 @@ module Mongoid
         #
         # @param [ Object ] object The object to demongoize.
         #
-        # @return [ Object ] The object.
+        # @return [ BigDecimal, nil ] A BigDecimal derived from the object or nil.
         #
         # @since 3.0.0
         def demongoize(object)
-          if object
-            object.numeric? ? ::BigDecimal.new(object.to_s) : object
-          end
+          object && object.numeric? ? ::BigDecimal.new(object.to_s) : nil
         end
 
-        # Mongoize an object of any type to how it's stored in the db as a big
-        # decimal.
+        # Mongoize an object of any type to how it's stored in the db as a String.
         #
         # @example Mongoize the object.
         #   BigDecimal.mongoize(123)
         #
         # @param [ Object ] object The object to Mongoize
         #
-        # @return [ String ] The mongoized object.
+        # @return [ String, nil ] A String representing the object or nil.
         #
         # @since 3.0.7
         def mongoize(object)
-          object ? object.to_s : object
+          object && object.numeric? ? object.to_s : nil
         end
       end
     end

data/lib/mongoid/extensions/date.rb

@@ -4,6 +4,9 @@ module Mongoid
     module Date
 
       # Constant for epoch - used when passing invalid times.
+      #
+      # @deprecated No longer used as a return value from #mongoize passed
+      #   an invalid date string.
       EPOCH = ::Date.new(1970, 1, 1)
 
       # Convert the date into a time.
@@ -64,7 +67,7 @@ module Mongoid
               time = object.__mongoize_time__
               ::Time.utc(time.year, time.month, time.day)
             rescue ArgumentError
-              EPOCH
+              nil
             end
           end
         end

data/lib/mongoid/extensions/hash.rb

@@ -161,11 +161,10 @@ module Mongoid
       # @api private
       #
       # @example Mongoize for the klass, field and value.
-      #   {}.mongoize_for("$push", Band, "name", "test")
+      #   {}.mongoize_for(Band, "name", "test")
       #
-      # @param [ String ] operator The operator.
       # @param [ Class ] klass The model class.
-      # @param [ String, Symbol ] key The field key.
+      # @param [ String, Symbol ] The field key.
       # @param [ Object ] value The value to mongoize.
       #
       # @return [ Object ] The mongoized value.

data/lib/mongoid/extensions/object.rb

@@ -94,7 +94,7 @@ module Mongoid
       #   object.do_or_do_not(:use, "The Force")
       #
       # @param [ String, Symbol ] name The method name.
-      # @param [ Array ] args The arguments.
+      # @param [ Array ] *args The arguments.
       #
       # @return [ Object, nil ] The result of the method call or nil if the
       #   method does not exist.
@@ -209,7 +209,7 @@ module Mongoid
       #   object.you_must(:use, "The Force")
       #
       # @param [ String, Symbol ] name The method name.
-      # @param [ Array ] args The arguments.
+      # @param [ Array ] *args The arguments.
       #
       # @return [ Object, nil ] The result of the method call or nil if the
       #   method does not exist. Nil if the object is frozen.

data/lib/mongoid/extensions/string.rb

@@ -72,7 +72,8 @@ module Mongoid
         self =~ /\A(|_)id$/
       end
 
-      # Is the string a number?
+      # Is the string a number? The literals "NaN", "Infinity", and "-Infinity"
+      # are counted as numbers.
       #
       # @example Is the string a number.
       #   "1234.23".numeric?
@@ -81,7 +82,7 @@ module Mongoid
       #
       # @since 3.0.0
       def numeric?
-        true if Float(self) rescue (self == "NaN")
+        true if Float(self) rescue (self =~ /^NaN|\-?Infinity$/)
       end
 
       # Get the string as a getter string.
@@ -117,7 +118,7 @@ module Mongoid
       #
       # @since 3.0.15
       def valid_method_name?
-        /[@$"]/ !~ self
+        /[@$"-]/ !~ self
       end
 
       # Does the string end with _before_type_cast?

data/lib/mongoid/extensions/time.rb

@@ -4,6 +4,9 @@ module Mongoid
     module Time
 
       # Constant for epoch - used when passing invalid times.
+      #
+      # @deprecated No longer used as a return value from #mongoize passed
+      #   an invalid time string.
       EPOCH = ::Time.utc(1970, 1, 1, 0, 0, 0)
 
       # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -27,7 +30,7 @@ module Mongoid
         # @example Get the configured time.
         #   ::Time.configured
         #
-        # @return [ Time ] The configured time.
+        # @retun [ Time ] The configured time.
         #
         # @since 3.0.0
         def configured
@@ -76,7 +79,7 @@ module Mongoid
               ::Time.at(time.to_i, time.usec).utc
             end
           rescue ArgumentError
-            EPOCH
+            nil
           end
         end
       end

data/lib/mongoid/factory.rb

@@ -14,6 +14,7 @@ module Mongoid
     #
     # @param [ Class ] klass The class to instantiate from if _type is not present.
     # @param [ Hash ] attributes The document attributes.
+    # @param [ Hash ] options The mass assignment scoping options.
     #
     # @return [ Document ] The instantiated document.
     def build(klass, attributes = nil)

data/lib/mongoid/fields/foreign_key.rb

@@ -14,8 +14,8 @@ module Mongoid
       # @param [ String ] name The name of the field.
       # @param [ String ] key The atomic location of the field.
       # @param [ Hash ] mods The current modifications.
-      # @param [ Array ] new_elements The new elements to add.
-      # @param [ Array ] old_elements The old elements getting removed.
+      # @param [ Array ] new The new elements to add.
+      # @param [ Array ] old The old elements getting removed.
       #
       # @since 2.4.0
       def add_atomic_changes(document, name, key, mods, new_elements, old_elements)

data/lib/mongoid/fields/localized.rb

@@ -77,14 +77,9 @@ module Mongoid
       # @since 3.0.0
       def lookup(object)
         locale = ::I18n.locale
-
-        value = if object.key?(locale.to_s)
-          object[locale.to_s]
-        elsif object.key?(locale)
-          object[locale]
-        end
-        return value unless value.nil?
-        if fallbacks? && ::I18n.respond_to?(:fallbacks)
+        if value = object[locale.to_s]
+          value
+        elsif fallbacks? && ::I18n.respond_to?(:fallbacks)
           object[::I18n.fallbacks[locale].map(&:to_s).find{ |loc| object.has_key?(loc) }]
         end
       end

data/lib/mongoid/fields/validators/macro.rb

@@ -36,6 +36,24 @@ module Mongoid
           validate_options(klass, name, options)
         end
 
+        # Validate the relation definition.
+        #
+        # @example Validate the relation definition.
+        #   Macro.validate(Model, :name)
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Symbol ] name The field name.
+        # @param [ Hash ] options The provided options.
+        #
+        # @since 6.0.0
+        def validate_relation(klass, name, options = {})
+          [name, "#{name}?".to_sym, "#{name}=".to_sym].each do |n|
+            if Mongoid.destructive_fields.include?(n)
+              raise Errors::InvalidRelation.new(klass, n)
+            end
+          end
+        end
+
         private
 
         # Determine if the field name is allowed, if not raise an error.

data/lib/mongoid/findable.rb

@@ -6,12 +6,12 @@ module Mongoid
   #
   # @since 4.0.0
   module Findable
-    extend Origin::Forwardable
+    extend Mongoid::Criteria::Queryable::Forwardable
 
     select_with :with_default_scope
 
     # These are methods defined on the criteria that should also be accessible
-    # directly from the the class level.
+    # directly from the class level.
     delegate \
       :aggregates,
       :avg,
@@ -71,7 +71,7 @@ module Mongoid
     # @example Do any documents exist for the conditions?
     #   Person.exists?
     #
-    # @return [ true, false ] If any documents exist for the conditions.
+    # @param [ Array ] args The conditions.
     def exists?
       with_default_scope.exists?
     end

data/lib/mongoid/indexable.rb

@@ -31,8 +31,9 @@ module Mongoid
         index_specifications.each do |spec|
           key, options = spec.key, spec.options
           if database = options[:database]
-            with(database: database).
-              collection.indexes.create_one(key, options.except(:database))
+            with(database: database) do |klass|
+              klass.collection.indexes.create_one(key, options.except(:database))
+            end
           else
             collection.indexes.create_one(key, options)
           end
@@ -50,18 +51,19 @@ module Mongoid
       # @since 3.0.0
       def remove_indexes
         indexed_database_names.each do |database|
-          collection = with(database: database).collection
-          begin
-            collection.indexes.each do |spec|
-              unless spec["name"] == "_id_"
-                collection.indexes.drop_one(spec["key"])
-                logger.info(
-                  "MONGOID: Removed index '#{spec["name"]}' on collection " +
-                  "'#{collection.name}' in database '#{database}'."
-                )
+          with(database: database) do |klass|
+            begin
+              klass.collection.indexes.each do |spec|
+                unless spec["name"] == "_id_"
+                  klass.collection.indexes.drop_one(spec["key"])
+                  logger.info(
+                    "MONGOID: Removed index '#{spec["name"]}' on collection " +
+                    "'#{klass.collection.name}' in database '#{database}'."
+                  )
+                end
               end
-            end
-          rescue Mongo::Error::OperationFailure; end
+            rescue Mongo::Error::OperationFailure; end
+          end
         end and true
       end
 
@@ -90,7 +92,7 @@ module Mongoid
       #     index({ name: 1 }, { background: true })
       #   end
       #
-      # @param [ Symbol ] spec The index spec.
+      # @param [ Symbol ] name The name of the field.
       # @param [ Hash ] options The index options.
       #
       # @return [ Hash ] The index options.
@@ -108,8 +110,7 @@ module Mongoid
       # @example Get the index specification.
       #   Model.index_specification(name: 1)
       #
-      # @param [ Hash ] index_hash The index key/direction pair.
-      # @param [ String ] index_name The index name.
+      # @param [ Hash ] key The index key/direction pair.
       #
       # @return [ Specification ] The found specification.
       #

data/lib/mongoid/indexable/specification.rb

@@ -99,7 +99,7 @@ module Mongoid
       # @example Normalize the index options.
       #   specification.normalize_options(drop_dups: true)
       #
-      # @param [ Hash ] opts The index options.
+      # @param [ Hash ] options The index options.
       #
       # @return [ Hash ] The normalized options.
       #

data/lib/mongoid/indexable/validators/options.rb

@@ -27,8 +27,7 @@ module Mongoid
           :sphere_version,
           :text_version,
           :version,
-          :partial_filter_expression,
-          :collation
+          :partial_filter_expression
         ]
 
         VALID_TYPES = [

data/lib/mongoid/interceptable.rb

@@ -46,7 +46,7 @@ module Mongoid
     # @example Is the callback executable?
     #   document.callback_executable?(:save)
     #
-    # @param [ Symbol ] kind The type of callback.
+    # @param [ Symbol ] kin The type of callback.
     #
     # @return [ true, false ] If the callback can be executed.
     #
@@ -118,7 +118,7 @@ module Mongoid
     #   end
     #
     # @param [ Symbol ] kind The type of callback to execute.
-    # @param [ Array ] args Any options.
+    # @param [ Array ] *args Any options.
     #
     # @return [ Document ] The document
     #
@@ -259,22 +259,11 @@ module Mongoid
         send("_#{kind}_callbacks").each do |callback|
           chain.append(callback) if callback.kind == place
         end
-
-        if Gem::Version.new("4.1.0") <= Gem::Version.new(ActiveSupport::VERSION::STRING)
-          self.class.send :define_method, name do
-            runner = ActiveSupport::Callbacks::Filters::Environment.new(self, false, nil)
-            chain.compile.call(runner).value
-          end
-          self.class.send :protected, name
-        else
-          class_eval <<-EOM
-            def #{name}()
-              #{chain.compile}
-            end
-            protected :#{name}
-          EOM
+        self.class.send :define_method, name do
+          runner = ActiveSupport::Callbacks::Filters::Environment.new(self, false, nil)
+          chain.compile.call(runner).value
         end
-
+        self.class.send :protected, name
       end
       send(name)
     end

data/lib/mongoid/loggable.rb

@@ -25,7 +25,7 @@ module Mongoid
     # @example Set the logger.
     #   Loggable.logger = Logger.new($stdout)
     #
-    # @param [ Logger ] logger The logger to set.
+    # @param [ Logger ] The logger to set.
     #
     # @return [ Logger ] The new logger.
     #

data/lib/mongoid/matchable.rb

@@ -12,7 +12,6 @@ require "mongoid/matchable/ne"
 require "mongoid/matchable/nin"
 require "mongoid/matchable/or"
 require "mongoid/matchable/size"
-require "mongoid/matchable/regexp"
 
 module Mongoid
 
@@ -82,7 +81,7 @@ module Mongoid
     #
     # @param [ Document ] document The document to check.
     # @param [ Symbol, String ] key The field name.
-    # @param [ Object, Hash ] value The value or selector.
+    # @param [ Object, Hash ] The value or selector.
     #
     # @return [ Matcher ] The matcher.
     #
@@ -103,7 +102,7 @@ module Mongoid
       #
       # @param [ Document ] document The document to check.
       # @param [ Symbol, String ] key The field name.
-      # @param [ Object, Hash ] value The value or selector.
+      # @param [ Object, Hash ] The value or selector.
       #
       # @return [ Matcher ] The matcher.
       #
@@ -116,8 +115,6 @@ module Mongoid
           else
             Default.new(extract_attribute(document, key))
           end
-        elsif value.regexp?
-          Regexp.new(extract_attribute(document, key))
         else
           case key.to_s
             when "$or" then Or.new(value, document)
@@ -146,11 +143,7 @@ module Mongoid
         if (key_string = key.to_s) =~ /.+\..+/
           key_string.split('.').inject(document.as_document) do |_attribs, _key|
             if _attribs.is_a?(::Array)
-              if _key =~ /\A\d+\z/ && _attribs.none? {|doc| doc.is_a?(Hash)}
-                _attribs.try(:[], _key.to_i)
-              else
-                _attribs.map { |doc| doc.try(:[], _key) }
-              end
+              _attribs.map { |doc| doc.try(:[], _key) }
             else
               _attribs.try(:[], _key)
             end