mongoid 5.4.1 → 7.4.0

data/lib/mongoid/indexable.rb

@@ -1,13 +1,12 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/indexable/specification"
 require "mongoid/indexable/validators/options"
 require "ostruct"
 
 module Mongoid
 
-  # Encapsulates behaviour around defining indexes.
-  #
-  # @since 4.0.0
+  # Encapsulates behavior around defining indexes.
   module Indexable
     extend ActiveSupport::Concern
 
@@ -24,17 +23,19 @@ module Mongoid
       #   Person.create_indexes
       #
       # @return [ true ] If the operation succeeded.
-      #
-      # @since 1.0.0
       def create_indexes
         return unless index_specifications
+
+        default_options = {background: Config.background_indexing}
+
         index_specifications.each do |spec|
-          key, options = spec.key, spec.options
+          key, options = spec.key, default_options.merge(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(session: _session).create_one(key, options.except(:database))
+            end
           else
-            collection.indexes.create_one(key, options)
+            collection.indexes(session: _session).create_one(key, options)
           end
         end and true
       end
@@ -46,22 +47,21 @@ module Mongoid
       #   Person.remove_indexes
       #
       # @return [ true ] If the operation succeeded.
-      #
-      # @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(session: _session).each do |spec|
+                unless spec["name"] == "_id_"
+                  klass.collection.indexes(session: _session).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
 
@@ -72,11 +72,9 @@ module Mongoid
       #   Person.add_indexes
       #
       # @return [ true ] If the operation succeeded.
-      #
-      # @since 1.0.0
       def add_indexes
-        if hereditary? && !index_keys.include?(_type: 1)
-          index({ _type: 1 }, unique: false, background: true)
+        if hereditary? && !index_keys.include?(self.discriminator_key.to_sym => 1)
+          index({ self.discriminator_key.to_sym => 1 }, unique: false, background: true)
         end
         true
       end
@@ -90,12 +88,10 @@ module Mongoid
       #     index({ name: 1 }, { background: true })
       #   end
       #
-      # @param [ Symbol ] spec The index spec.
+      # @param [ Hash ] spec The index spec.
       # @param [ Hash ] options The index options.
       #
       # @return [ Hash ] The index options.
-      #
-      # @since 1.0.0
       def index(spec, options = nil)
         specification = Specification.new(self, spec, options)
         if !index_specifications.include?(specification)
@@ -112,8 +108,6 @@ module Mongoid
       # @param [ String ] index_name The index name.
       #
       # @return [ Specification ] The found specification.
-      #
-      # @since 4.0.0
       def index_specification(index_hash, index_name = nil)
         index = OpenStruct.new(fields: index_hash.keys, key: index_hash)
         index_specifications.detect do |spec|
@@ -132,8 +126,6 @@ module Mongoid
       #   Model.indexed_database_names
       #
       # @return [ Array<String> ] The names.
-      #
-      # @since 3.1.0
       def indexed_database_names
         index_specifications.map do |spec|
           spec.options[:database] || database_name
@@ -148,8 +140,6 @@ module Mongoid
       #   Model.index_keys
       #
       # @return [ Array<Hash> ] The specification keys.
-      #
-      # @since 4.0.0
       def index_keys
         index_specifications.map(&:key)
       end

data/lib/mongoid/inspectable.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # Contains the bahviour around inspecting documents via inspect.
-  #
-  # @since 4.0.0
+  # Contains the behavior around inspecting documents via inspect.
   module Inspectable
 
     # Returns the class name plus its attributes. If using dynamic fields will
@@ -13,12 +12,10 @@ module Mongoid
     #   person.inspect
     #
     # @return [ String ] A nice pretty string to look at.
-    #
-    # @since 1.0.0
     def inspect
       inspection = []
       inspection.concat(inspect_fields).concat(inspect_dynamic_fields)
-      "#<#{self.class.name} _id: #{id}, #{inspection * ', '}>"
+      "#<#{self.class.name} _id: #{_id}, #{inspection * ', '}>"
     end
 
     private
@@ -31,8 +28,6 @@ module Mongoid
     #   document.inspect_fields
     #
     # @return [ String ] An array of pretty printed field values.
-    #
-    # @since 1.0.0
     def inspect_fields
       fields.map do |name, field|
         unless name == "_id"
@@ -50,8 +45,6 @@ module Mongoid
     #   document.inspect_dynamic_fields
     #
     # @return [ String ] An array of pretty printed dynamic field values.
-    #
-    # @since 1.0.0
     def inspect_dynamic_fields
       []
     end

data/lib/mongoid/interceptable.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
   # This module contains all the callback hooks for Mongoid.
-  #
-  # @since 4.0.0
   module Interceptable
     extend ActiveSupport::Concern
 
@@ -49,8 +48,6 @@ module Mongoid
     # @param [ Symbol ] kind The type of callback.
     #
     # @return [ true, false ] If the callback can be executed.
-    #
-    # @since 3.0.6
     def callback_executable?(kind)
       respond_to?("_#{kind}_callbacks")
     end
@@ -64,15 +61,13 @@ module Mongoid
     # @param [ Symbol ] kind The callback kind.
     #
     # @return [ true, false ] If the document is in a callback state.
-    #
-    # @since 3.1.0
     def in_callback_state?(kind)
       [ :create, :destroy ].include?(kind) || new_record? || flagged_for_destroy? || changed?
     end
 
     # Run only the after callbacks for the specific event.
     #
-    # @note ActiveSupport does not allow this type of behaviour by default, so
+    # @note ActiveSupport does not allow this type of behavior by default, so
     #   Mongoid has to get around it and implement itself.
     #
     # @example Run only the after save callbacks.
@@ -81,8 +76,6 @@ module Mongoid
     # @param [ Array<Symbol> ] kinds The events that are occurring.
     #
     # @return [ Object ] The result of the chain executing.
-    #
-    # @since 3.0.0
     def run_after_callbacks(*kinds)
       kinds.each do |kind|
         run_targeted_callbacks(:after, kind)
@@ -91,7 +84,7 @@ module Mongoid
 
     # Run only the before callbacks for the specific event.
     #
-    # @note ActiveSupport does not allow this type of behaviour by default, so
+    # @note ActiveSupport does not allow this type of behavior by default, so
     #   Mongoid has to get around it and implement itself.
     #
     # @example Run only the before save callbacks.
@@ -100,8 +93,6 @@ module Mongoid
     # @param [ Array<Symbol> ] kinds The events that are occurring.
     #
     # @return [ Object ] The result of the chain executing.
-    #
-    # @since 3.0.0
     def run_before_callbacks(*kinds)
       kinds.each do |kind|
         run_targeted_callbacks(:before, kind)
@@ -121,21 +112,17 @@ module Mongoid
     # @param [ Array ] args Any options.
     #
     # @return [ Document ] The document
-    #
-    # @since 2.3.0
-    def run_callbacks(kind, *args, &block)
+    ruby2_keywords def run_callbacks(kind, *args, &block)
       cascadable_children(kind).each do |child|
-        # This is returning false for some destroy tests on 4.1.0.beta1,
-        # causing them to fail since 4.1.0 expects a block to be passed if the
-        # callbacks for the type are empty. If no block is passed then the nil
-        # return value gets interpreted as false and halts the chain.
-        #
-        # @see https://github.com/rails/rails/blob/master/activesupport/lib/active_support/callbacks.rb#L79
         if child.run_callbacks(child_callback_type(kind, child), *args) == false
           return false
         end
       end
-      callback_executable?(kind) ? super(kind, *args, &block) : true
+      if callback_executable?(kind)
+        super(kind, *args, &block)
+      else
+        true
+      end
     end
 
     private
@@ -149,8 +136,6 @@ module Mongoid
     #   document.before_callback_halted?
     #
     # @return [ true, false ] If a before callback was halted.
-    #
-    # @since 3.0.3
     def before_callback_halted?
       !!@before_callback_halted
     end
@@ -163,11 +148,9 @@ module Mongoid
     # @param [ Symbol ] kind The type of callback.
     #
     # @return [ Array<Document> ] The children.
-    #
-    # @since 2.3.0
     def cascadable_children(kind, children = Set.new)
-      embedded_relations.each_pair do |name, metadata|
-        next unless metadata.cascading_callbacks?
+      embedded_relations.each_pair do |name, association|
+        next unless association.cascading_callbacks?
         without_autobuild do
           delayed_pulls = delayed_atomic_pulls[name]
           delayed_unsets = delayed_atomic_unsets[name]
@@ -176,7 +159,7 @@ module Mongoid
           relation = send(name)
           Array.wrap(relation).each do |child|
             next if children.include?(child)
-            children.add(child) if cascadable_child?(kind, child, metadata)
+            children.add(child) if cascadable_child?(kind, child, association)
             child.send(:cascadable_children, kind, children)
           end
         end
@@ -193,11 +176,9 @@ module Mongoid
     # @param [ Document ] child The child document.
     #
     # @return [ true, false ] If the child should fire the callback.
-    #
-    # @since 2.3.0
-    def cascadable_child?(kind, child, metadata)
-      return false if kind == :initialize || kind == :find
-      return false if kind == :validate && metadata.validate?
+    def cascadable_child?(kind, child, association)
+      return false if kind == :initialize || kind == :find || kind == :touch
+      return false if kind == :validate && association.validate?
       child.callback_executable?(kind) ? child.in_callback_state?(kind) : false
     end
 
@@ -213,8 +194,6 @@ module Mongoid
     # @param [ Document ] child The child document
     #
     # @return [ Symbol ] The name of the callback.
-    #
-    # @since 2.3.0
     def child_callback_type(kind, child)
       if kind == :update
         return :create if child.new_record?
@@ -234,9 +213,9 @@ module Mongoid
     #   document.halted_callback_hook(filter)
     #
     # @param [ Symbol ] filter The callback that halted.
-    #
-    # @since 3.0.3
-    def halted_callback_hook(filter)
+    # @param [ Symbol ] name The name of the callback that was halted
+    #   (requires Rails 6.1+)
+    def halted_callback_hook(filter, name = nil)
       @before_callback_halted = true
     end
 
@@ -250,8 +229,6 @@ module Mongoid
     # @param [ Symbol ] kind The type of callback, :save, :create, :update.
     #
     # @return [ Object ] The result of the chain execution.
-    #
-    # @since 3.0.0
     def run_targeted_callbacks(place, kind)
       name = "_run__#{place}__#{kind}__callbacks"
       unless respond_to?(name)
@@ -259,22 +236,15 @@ 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
+          env = ActiveSupport::Callbacks::Filters::Environment.new(self, false, nil)
+          sequence = chain.compile
+          sequence.invoke_before(env)
+          env.value = !env.halted
+          sequence.invoke_after(env)
+          env.value
         end
-
+        self.class.send :protected, name
       end
       send(name)
     end

data/lib/mongoid/loggable.rb

@@ -1,20 +1,19 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # Contains logging behaviour.
+  # Contains logging behavior.
   module Loggable
 
     # Get the logger.
     #
     # @note Will try to grab Rails' logger first before creating a new logger
-    #   with stdout.
+    #   with stderr.
     #
     # @example Get the logger.
     #   Loggable.logger
     #
     # @return [ Logger ] The logger.
-    #
-    # @since 3.0.0
     def logger
       return @logger if defined?(@logger)
       @logger = rails_logger || default_logger
@@ -23,20 +22,18 @@ module Mongoid
     # Set the logger.
     #
     # @example Set the logger.
-    #   Loggable.logger = Logger.new($stdout)
+    #   Loggable.logger = Logger.new(STDERR)
     #
     # @param [ Logger ] logger The logger to set.
     #
     # @return [ Logger ] The new logger.
-    #
-    # @since 3.0.0
     def logger=(logger)
       @logger = logger
     end
 
     private
 
-    # Gets the default Mongoid logger - stdout.
+    # Gets the default Mongoid logger - stderr.
     #
     # @api private
     #
@@ -44,15 +41,13 @@ module Mongoid
     #   Loggable.default_logger
     #
     # @return [ Logger ] The default logger.
-    #
-    # @since 3.0.0
     def default_logger
-      logger = Logger.new($stdout)
+      logger = Logger.new(STDERR)
       logger.level = Mongoid::Config.log_level
       logger
     end
 
-    # Get the Rails logger if it's defined.
+    # Get the Rails logger if loaded in a Rails application, otherwise nil.
     #
     # @api private
     #
@@ -60,10 +55,12 @@ module Mongoid
     #   Loggable.rails_logger
     #
     # @return [ Logger ] The Rails logger.
-    #
-    # @since 3.0.0
     def rails_logger
-      defined?(::Rails) && ::Rails.respond_to?(:logger) && ::Rails.logger
+      if defined?(::Rails)
+        ::Rails.logger
+      else
+        nil
+      end
     end
   end
 end

data/lib/mongoid/matchable.rb

@@ -1,164 +1,23 @@
-# encoding: utf-8
-require "mongoid/matchable/default"
-require "mongoid/matchable/all"
-require "mongoid/matchable/and"
-require "mongoid/matchable/exists"
-require "mongoid/matchable/gt"
-require "mongoid/matchable/gte"
-require "mongoid/matchable/in"
-require "mongoid/matchable/lt"
-require "mongoid/matchable/lte"
-require "mongoid/matchable/ne"
-require "mongoid/matchable/nin"
-require "mongoid/matchable/or"
-require "mongoid/matchable/size"
-require "mongoid/matchable/regexp"
+# frozen_string_literal: true
 
 module Mongoid
 
-  # This module contains all the behavior for ruby implementations of MongoDB
+  # This module contains all the behavior for Ruby implementations of MongoDB
   # selectors.
-  #
-  # @since 4.0.0
   module Matchable
     extend ActiveSupport::Concern
 
-    # Hash lookup for the matcher for a specific operation.
-    #
-    # @since 1.0.0
-    MATCHERS = {
-      "$all" => All,
-      "$and" => And,
-      "$exists" => Exists,
-      "$gt" => Gt,
-      "$gte" => Gte,
-      "$in" => In,
-      "$lt" => Lt,
-      "$lte" => Lte,
-      "$ne" => Ne,
-      "$nin" => Nin,
-      "$or" => Or,
-      "$size" => Size
-    }.with_indifferent_access.freeze
-
     # Determines if this document has the attributes to match the supplied
     # MongoDB selector. Used for matching on embedded associations.
     #
     # @example Does the document match?
-    #   document.matches?(:title => { "$in" => [ "test" ] })
+    #   document._matches?(:title => { "$in" => [ "test" ] })
     #
     # @param [ Hash ] selector The MongoDB selector.
     #
     # @return [ true, false ] True if matches, false if not.
-    #
-    # @since 1.0.0
-    def matches?(selector)
-      selector.each_pair do |key, value|
-        if value.is_a?(Hash)
-          value.each do |item|
-            if item[0].to_s == "$not".freeze
-              item = item[1]
-              return false if matcher(self, key, item).matches?(item)
-            else
-              return false unless matcher(self, key, Hash[*item]).matches?(Hash[*item])
-            end
-          end
-        else
-          return false unless matcher(self, key, value).matches?(value)
-        end
-      end
-      true
-    end
-
-    private
-
-    # Get the matcher for the supplied key and value. Will determine the class
-    # name from the key.
-    #
-    # @api private
-    #
-    # @example Get the matcher.
-    #   document.matcher(:title, { "$in" => [ "test" ] })
-    #
-    # @param [ Document ] document The document to check.
-    # @param [ Symbol, String ] key The field name.
-    # @param [ Object, Hash ] value The value or selector.
-    #
-    # @return [ Matcher ] The matcher.
-    #
-    # @since 2.0.0.rc.7
-    def matcher(document, key, value)
-      Matchable.matcher(document, key, value)
-    end
-
-    class << self
-
-      # Get the matcher for the supplied key and value. Will determine the class
-      # name from the key.
-      #
-      # @api private
-      #
-      # @example Get the matcher.
-      #   document.matcher(:title, { "$in" => [ "test" ] })
-      #
-      # @param [ Document ] document The document to check.
-      # @param [ Symbol, String ] key The field name.
-      # @param [ Object, Hash ] value The value or selector.
-      #
-      # @return [ Matcher ] The matcher.
-      #
-      # @since 2.0.0.rc.7
-      def matcher(document, key, value)
-        if value.is_a?(Hash)
-          matcher = MATCHERS[value.keys.first]
-          if matcher
-            matcher.new(extract_attribute(document, key))
-          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)
-            when "$and" then And.new(value, document)
-            else Default.new(extract_attribute(document, key))
-          end
-        end
-      end
-
-      private
-
-      # Extract the attribute from the key, being smarter about dot notation.
-      #
-      # @api private
-      #
-      # @example Extract the attribute.
-      #   strategy.extract_attribute(doc, "info.field")
-      #
-      # @param [ Document ] document The document.
-      # @param [ String ] key The key.
-      #
-      # @return [ Object ] The value of the attribute.
-      #
-      # @since 2.2.1
-      def extract_attribute(document, key)
-        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
-            else
-              _attribs.try(:[], _key)
-            end
-          end
-        else
-          document.attributes[key_string]
-        end
-      end
+    def _matches?(selector)
+      Matcher::Expression.matches?(self, selector)
     end
   end
 end

data/lib/mongoid/matcher/all.rb

@@ -0,0 +1,22 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module All
+      module_function def matches?(exists, value, condition)
+        unless Array === condition
+          raise Errors::InvalidQuery, "$all argument must be an array: #{Errors::InvalidQuery.truncate_expr(condition)}"
+        end
+
+        !condition.empty? && condition.all? do |c|
+          case c
+          when ::Regexp, BSON::Regexp::Raw
+            Regex.matches_array_or_scalar?(value, c)
+          else
+            EqImpl.matches?(true, value, c, '$all')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/and.rb

@@ -0,0 +1,21 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module And
+      module_function def matches?(document, expr)
+        unless expr.is_a?(Array)
+          raise Errors::InvalidQuery, "$and argument must be an array: #{Errors::InvalidQuery.truncate_expr(expr)}"
+        end
+
+        if expr.empty?
+          raise Errors::InvalidQuery, "$and argument must be a non-empty array: #{Errors::InvalidQuery.truncate_expr(expr)}"
+        end
+
+        expr.all? do |sub_expr|
+          Expression.matches?(document, sub_expr)
+        end
+      end
+    end
+  end
+end