mongoid 7.1.2 → 7.2.0

data/lib/mongoid/fields.rb

@@ -12,6 +12,8 @@ module Mongoid
   module Fields
     extend ActiveSupport::Concern
 
+    StringifiedSymbol = Mongoid::StringifiedSymbol
+
     # For fields defined with symbols use the correct class.
     #
     # @since 4.0.0
@@ -30,6 +32,7 @@ module Mongoid
       regexp: Regexp,
       set: Set,
       string: String,
+      stringified_symbol: StringifiedSymbol,
       symbol: Symbol,
       time: Time
     }.with_indifferent_access

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

@@ -39,7 +39,8 @@ module Mongoid
         #
         # @since 3.0.0
         def validate(klass, name, options)
-          validate_name(klass, name, options)
+          validate_field_name(klass, name)
+          validate_name_uniqueness(klass, name, options)
           validate_options(klass, name, options)
         end
 
@@ -61,28 +62,40 @@ module Mongoid
           end
         end
 
-        private
-
-        # Determine if the field name is allowed, if not raise an error.
-        #
-        # @api private
+        # Determine if the field name is valid, if not raise an error.
         #
         # @example Check the field name.
-        #   Macro.validate_name(Model, :name)
+        #   Macro.validate_field_name(Model, :name)
         #
         # @param [ Class ] klass The model class.
         # @param [ Symbol ] name The field name.
         #
         # @raise [ Errors::InvalidField ] If the name is not allowed.
         #
-        # @since 3.0.0
-        def validate_name(klass, name, options)
+        # @api private
+        def validate_field_name(klass, name)
           [name, "#{name}?".to_sym, "#{name}=".to_sym].each do |n|
             if Mongoid.destructive_fields.include?(n)
               raise Errors::InvalidField.new(klass, n)
             end
           end
+        end
 
+        private
+
+        # Determine if the field name is unique, if not raise an error.
+        #
+        # @example Check the field name.
+        #   Macro.validate_name_uniqueness(Model, :name, {})
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Symbol ] name The field name.
+        # @param [ Hash ] options The provided options.
+        #
+        # @raise [ Errors::InvalidField ] If the name is not allowed.
+        #
+        # @api private
+        def validate_name_uniqueness(klass, name, options)
           if !options[:overwrite] && klass.fields.keys.include?(name.to_s)
             if Mongoid.duplicate_fields_exception
               raise Errors::InvalidField.new(klass, name)
@@ -113,7 +126,10 @@ module Mongoid
             end
 
             if option == :type && options[option] == Symbol
-              Mongoid.logger.warn(FIELD_TYPE_IS_SYMBOL)
+              @field_type_is_symbol_warned ||= begin
+                Mongoid.logger.warn(FIELD_TYPE_IS_SYMBOL)
+                true
+              end
             end
           end
         end

data/lib/mongoid/findable.rb

@@ -60,6 +60,16 @@ module Mongoid
       with_default_scope.count
     end
 
+    # Returns an estimated count of records in the database.
+    #
+    # @example Get the count of matching documents.
+    #   Person.estimated_count
+    #
+    # @return [ Integer ] The number of matching documents.
+    def estimated_count
+      with_default_scope.estimated_count
+    end
+
     # Returns true if count is zero
     #
     # @example Are there no saved documents for this model?
@@ -81,20 +91,46 @@ module Mongoid
       with_default_scope.exists?
     end
 
-    # Find a +Document+ in several different ways.
-    #
-    # If a +String+ is provided, it will be assumed that it is a
-    # representation of a Mongo::ObjectID and will attempt to find a single
-    # +Document+ based on that id. If a +Symbol+ and +Hash+ is provided then
-    # it will attempt to find either a single +Document+ or multiples based
-    # on the conditions provided and the first parameter.
-    #
-    # @example Find a single document by an id.
-    #   Person.find(BSON::ObjectId)
-    #
-    # @param [ Array ] args An assortment of finder options.
-    #
-    # @return [ Document, nil, Criteria ] A document or matching documents.
+    # Finds a +Document+ or multiple documents by their _id values.
+    #
+    # If a single non-Array argument is given, this argument is interpreted
+    # as the _id value of a document to find. If there is a matching document
+    # in the database, this document is returned; otherwise, if the
+    # +raise_not_found_error+ Mongoid configuration option is truthy
+    # (which is the default), +Errors::DocumentNotFound+ is raised, and if
+    # +raise_not_found_error+ is falsy, +find+ returns +nil+.
+    #
+    # If multiple arguments are given, or an Array argument is given, the
+    # array is flattened and each array element is interpreted as the _id
+    # value of the document to find. Mongoid then attempts to retrieve all
+    # documents with the provided _id values. The return value is an array
+    # of found documents. Each document appears one time in the returned array,
+    # even if its _id is given multiple times in the argument to +find+.
+    # If the +raise_not_found_error+ Mongoid configuration option is truthy,
+    # +Errors::DocumentNotFound+ exception is raised if any of the specified
+    # _ids were not found in the database. If the ++raise_not_found_error+
+    # Mongoid configuration option is falsy, only those documents which are
+    # found are returned; if no documents are found, the return value is an
+    # empty array.
+    #
+    # Note that MongoDB does not allow the _id field to be an array.
+    #
+    # The argument undergoes customary Mongoid type conversions based on
+    # the type declared for the _id field. By default the _id field is a
+    # +BSON::ObjectId+; this allows strings to be passed to +find+ and the
+    # strings will be transparently converted to +BSON::ObjectId+ instances
+    # during query construction.
+    #
+    # The +find+ method takes into account the default scope defined on the
+    # model class, if any.
+    #
+    # @param [ Object | Array<Object> ] args The _id values to find or an
+    #   array thereof.
+    #
+    # @return [ Document | Array<Document> | nil ] A document or matching documents.
+    #
+    # @raise Errors::DocumentNotFound If not all documents are found and
+    #   the +raise_not_found_error+ Mongoid configuration option is truthy.
     def find(*args)
       with_default_scope.find(*args)
     end

data/lib/mongoid/indexable.rb

@@ -82,8 +82,8 @@ module Mongoid
       #
       # @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

data/lib/mongoid/matchable.rb

@@ -1,24 +1,6 @@
 # frozen_string_literal: true
 # encoding: utf-8
 
-require "mongoid/matchable/default"
-require "mongoid/matchable/all"
-require "mongoid/matchable/and"
-require "mongoid/matchable/elem_match"
-require "mongoid/matchable/eq"
-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/nor"
-require "mongoid/matchable/or"
-require "mongoid/matchable/regexp"
-require "mongoid/matchable/size"
-
 module Mongoid
 
   # This module contains all the behavior for Ruby implementations of MongoDB
@@ -28,27 +10,6 @@ module Mongoid
   module Matchable
     extend ActiveSupport::Concern
 
-    # Hash lookup for the matcher for a specific operation.
-    #
-    # @since 1.0.0
-    MATCHERS = {
-      "$all" => All,
-      "$and" => And,
-      "$elemMatch" => ElemMatch,
-      "$eq" => Eq,
-      "$exists" => Exists,
-      "$gt" => Gt,
-      "$gte" => Gte,
-      "$in" => In,
-      "$lt" => Lt,
-      "$lte" => Lte,
-      "$ne" => Ne,
-      "$nin" => Nin,
-      "$nor" => Nor,
-      "$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.
     #
@@ -61,116 +22,7 @@ module Mongoid
     #
     # @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(key, item)._matches?(item)
-            else
-              return false unless matcher(key, Hash[*item])._matches?(Hash[*item])
-            end
-          end
-        else
-          return false unless matcher(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.
-    #
-    # @example Get the matcher.
-    #   document.matcher(:title, { "$in" => [ "test" ] })
-    #
-    # @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
-    # @api private
-    def matcher(key, value)
-      Matchable.matcher(self, 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.
-      #   Matchable.matcher(document, :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)
-            when "$nor" then Nor.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
-      # @api private
-      def extract_attribute(document, key)
-        if (key_string = key.to_s) =~ /.+\..+/
-          key_string.split('.').inject(document.send(:as_attributes)) 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
-          if document.is_a?(Hash)
-            document[key_string]
-          else
-            document.attributes[key_string]
-          end
-        end
-      end
+      Matcher::Expression.matches?(self, selector)
     end
   end
 end

data/lib/mongoid/matcher.rb

@@ -0,0 +1,127 @@
+module Mongoid
+
+  # @api private
+  module Matcher
+
+    # Extracts field values in the document at the specified key.
+    #
+    # The document can be a Hash or a model instance.
+    #
+    # The key is a valid MongoDB dot notation key. The following use cases are
+    # supported:
+    #
+    # - Simple field traversal (`foo`) - retrieves the field `foo` in the
+    #   current document.
+    # - Hash/embedded document field traversal (`foo.bar`) - retrieves the
+    #   field `foo` in the current document, then retrieves the field `bar`
+    #   from the value of `foo`. Each path segment could descend into an
+    #   embedded document or a hash field.
+    # - Array element retrieval (`foo.N`) - retrieves the Nth array element
+    #   from the field `foo` which must be an array. N must be a non-negative
+    #   integer.
+    # - Array traversal (`foo.bar`) - if `foo` is an array field, and
+    #   the elements of `foo` are hashes or embedded documents, this returns
+    #   an array of values of the `bar` field in each of the hashes in the
+    #   `foo` array.
+    #
+    # The return value is a two-element array. The first element is the value
+    # retrieved, or an array of values. The second element is a boolean flag
+    # indicating whether an array was expanded at any point during the key
+    # traversal (because the respective document field was an array).
+    #
+    # @param [ Document | Hash ] document The document to extract from.
+    # @param [ String ] key The key path to extract.
+    #
+    # @return [ Array<true | false, Object | Array, true | false> ]
+    #   Whether the value existed in the document, the extracted value
+    #   and the array expansion flag.
+    module_function def extract_attribute(document, key)
+      if document.respond_to?(:as_attributes, true)
+        # If a document has hash fields, as_attributes would keep those fields
+        # as Hash instances which do not offer indifferent access.
+        # Convert to BSON::Document to get indifferent access on hash fields.
+        document = BSON::Document.new(document.send(:as_attributes))
+      end
+
+      src = document
+      expanded = false
+      exists = true
+
+      key.to_s.split('.').each do |field|
+        if (index = field.to_i).to_s == field
+          # Array indexing
+          if Array === src
+            exists = index < src.length
+            src = src[index]
+          else
+            # Trying to index something that is not an array
+            exists = false
+            src = nil
+          end
+        else
+          case src
+          when nil
+            exists = false
+          when Hash
+            exists = src.key?(field)
+            src = src[field]
+          when Array
+            expanded = true
+            exists = false
+            new = []
+            src.each do |doc|
+              case doc
+              when Hash
+                if doc.key?(field)
+                  v = doc[field]
+                  case v
+                  when Array
+                    new += v
+                  else
+                    new += [v]
+                  end
+                  exists = true
+                end
+              else
+                # Trying to hash index into a value that is not a hash
+              end
+            end
+            src = new
+          else
+            # Trying to descend into a field that is not a hash using
+            # dot notation.
+            exists = false
+            src = nil
+          end
+        end
+      end
+
+      [exists, src, expanded]
+    end
+  end
+end
+
+require 'mongoid/matcher/all'
+require 'mongoid/matcher/and'
+require 'mongoid/matcher/elem_match'
+require 'mongoid/matcher/elem_match_expression'
+require 'mongoid/matcher/eq'
+require 'mongoid/matcher/eq_impl'
+require 'mongoid/matcher/eq_impl_with_regexp'
+require 'mongoid/matcher/exists'
+require 'mongoid/matcher/expression'
+require 'mongoid/matcher/field_expression'
+require 'mongoid/matcher/gt'
+require 'mongoid/matcher/gte'
+require 'mongoid/matcher/in'
+require 'mongoid/matcher/lt'
+require 'mongoid/matcher/lte'
+require 'mongoid/matcher/ne'
+require 'mongoid/matcher/nin'
+require 'mongoid/matcher/nor'
+require 'mongoid/matcher/not'
+require 'mongoid/matcher/or'
+require 'mongoid/matcher/regex'
+require 'mongoid/matcher/size'
+require 'mongoid/matcher/expression_operator'
+require 'mongoid/matcher/field_operator'