mongoid 6.4.8 → 7.5.4

data/lib/mongoid/scopable.rb

@@ -1,11 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Mongoid
 
-  # This module contains behaviour for all Mongoid scoping - named scopes,
+  # This module contains behavior for all Mongoid scoping - named scopes,
   # default scopes, and criteria accessors via scoped and unscoped.
-  #
-  # @since 4.0.0
   module Scopable
     extend ActiveSupport::Concern
 
@@ -26,8 +24,6 @@ module Mongoid
     #   document.apply_default_scoping
     #
     # @return [ true, false ] If default scoping was applied.
-    #
-    # @since 4.0.0
     def apply_default_scoping
       if default_scoping
         default_scoping.call.selector.each do |field, value|
@@ -51,8 +47,6 @@ module Mongoid
       #   Band.scopes
       #
       # @return [ Hash ] The scopes defined for this class
-      #
-      # @since 3.1.4
       def scopes
         defined_scopes = {}
         ancestors.reverse.each do |klass|
@@ -85,8 +79,6 @@ module Mongoid
       # @raise [ Errors::InvalidScope ] If the scope is not a proc or criteria.
       #
       # @return [ Proc ] The default scope.
-      #
-      # @since 1.0.0
       def default_scope(value = nil)
         value = Proc.new { yield } if block_given?
         check_scope_validity(value)
@@ -99,8 +91,6 @@ module Mongoid
       #   Band.default_scopable?
       #
       # @return [ true, false ] If the default scope can be applied.
-      #
-      # @since 3.0.0
       def default_scopable?
         default_scoping? && !Threaded.without_default_scope?(self)
       end
@@ -113,8 +103,6 @@ module Mongoid
       #   Model.queryable
       #
       # @return [ Criteria ] The queryable.
-      #
-      # @since 3.0.0
       def queryable
         crit = Threaded.current_scope(self) || Criteria.new(self)
         crit.embedded = true if (crit.klass.embedded? && !crit.klass.cyclic?)
@@ -140,8 +128,6 @@ module Mongoid
       #
       # @raise [ Errors::InvalidScope ] If the scope is not a proc.
       # @raise [ Errors::ScopeOverwrite ] If the scope name already exists.
-      #
-      # @since 1.0.0
       def scope(name, value, &block)
         normalized = name.to_sym
         check_scope_validity(value)
@@ -168,8 +154,6 @@ module Mongoid
       # @option options [ Array ] :sort Optional sorting options.
       #
       # @return [ Criteria ] A scoped criteria.
-      #
-      # @since 3.0.0
       def scoped(options = nil)
         queryable.scoped(options)
       end
@@ -188,8 +172,6 @@ module Mongoid
       #
       # @return [ Criteria, Object ] The unscoped criteria or result of the
       #   block.
-      #
-      # @since 3.0.0
       def unscoped
         if block_given?
           without_default_scope do
@@ -206,8 +188,6 @@ module Mongoid
       #   Model.with_default_scope
       #
       # @return [ Criteria ] The criteria.
-      #
-      # @since 3.0.0
       def with_default_scope
         queryable.with_default_scope
       end
@@ -222,14 +202,17 @@ module Mongoid
       # @param [ Criteria ] criteria The criteria to apply.
       #
       # @return [ Criteria ] The yielded criteria.
-      #
-      # @since 1.0.0
       def with_scope(criteria)
+        previous = Threaded.current_scope(self)
         Threaded.set_current_scope(criteria, self)
         begin
           yield criteria
         ensure
-          Threaded.set_current_scope(nil, self)
+          if Mongoid.broken_scoping
+            Threaded.set_current_scope(nil, self)
+          else
+            Threaded.set_current_scope(previous, self)
+          end
         end
       end
 
@@ -241,8 +224,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The result of the block.
-      #
-      # @since 3.0.0
       def without_default_scope
         Threaded.begin_without_default_scope(self)
         yield
@@ -263,8 +244,6 @@ module Mongoid
       #
       # @raise [ Errors::ScopeOverwrite ] If the name exists and configured to
       #   raise the error.
-      #
-      # @since 2.1.0
       def check_scope_name(name)
         if _declared_scopes[name] || respond_to?(name, true)
           if Mongoid.scope_overwrite_exception
@@ -291,8 +270,6 @@ module Mongoid
       # @param [ Object ] value The intended scope.
       #
       # @raise [ Errors::InvalidScope ] If the scope is not a valid object.
-      #
-      # @since 3.0.0
       def check_scope_validity(value)
         unless value.respond_to?(:call)
           raise Errors::InvalidScope.new(self, value)
@@ -310,19 +287,19 @@ module Mongoid
       # @param [ Symbol ] name The method/scope name.
       #
       # @return [ Method ] The defined method.
-      #
-      # @since 3.0.0
       def define_scope_method(name)
         singleton_class.class_eval do
-          define_method(name) do |*args|
-            scoping = _declared_scopes[name]
-            scope = instance_exec(*args, &scoping[:scope])
-            extension = scoping[:extension]
-            to_merge = scope || queryable
-            criteria = to_merge.empty_and_chainable? ? to_merge : with_default_scope.merge(to_merge)
-            criteria.extend(extension)
-            criteria
-          end
+          ruby2_keywords(
+            define_method(name) do |*args|
+              scoping = _declared_scopes[name]
+              scope = instance_exec(*args, &scoping[:scope])
+              extension = scoping[:extension]
+              to_merge = scope || queryable
+              criteria = to_merge.empty_and_chainable? ? to_merge : with_default_scope.merge(to_merge)
+              criteria.extend(extension)
+              criteria
+            end
+          )
         end
       end
 
@@ -335,8 +312,6 @@ module Mongoid
       #   Model.process_default_scope(value)
       #
       # @param [ Criteria, Proc ] value The default scope value.
-      #
-      # @since 3.0.5
       def process_default_scope(value)
         if existing = default_scoping
           ->{ existing.call.merge(value.to_proc.call) }

data/lib/mongoid/selectable.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # Provides behaviour for generating the selector for a specific document.
-  #
-  # @since 4.0.0
+  # Provides behavior for generating the selector for a specific document.
   module Selectable
     extend ActiveSupport::Concern
 
@@ -15,11 +14,9 @@ module Mongoid
     #   document.atomic_selector
     #
     # @return [ Hash ] The document's selector.
-    #
-    # @since 1.0.0
     def atomic_selector
       @atomic_selector ||=
-        (embedded? ? embedded_atomic_selector : root_atomic_selector)
+        (embedded? ? embedded_atomic_selector : root_atomic_selector_in_db)
     end
 
     private
@@ -32,8 +29,6 @@ module Mongoid
     #   document.embedded_atomic_selector
     #
     # @return [ Hash ] The embedded document selector.
-    #
-    # @since 4.0.0
     def embedded_atomic_selector
       if persisted? && _id_changed?
         _parent.atomic_selector
@@ -42,18 +37,14 @@ module Mongoid
       end
     end
 
-    # Get the atomic selector for a root document.
+    # Get the atomic selector that would match the existing version of the
+    # root document.
     #
     # @api private
     #
-    # @example Get the root atomic selector.
-    #   document.root_atomic_selector
-    #
     # @return [ Hash ] The root document selector.
-    #
-    # @since 4.0.0
-    def root_atomic_selector
-      { "_id" => _id }.merge!(shard_key_selector)
+    def root_atomic_selector_in_db
+      { "_id" => _id }.merge!(shard_key_selector_in_db)
     end
   end
 end

data/lib/mongoid/serializable.rb

@@ -1,18 +1,25 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # This module provides the extra behaviour for including relations in JSON
+  # This module provides the extra behavior for including associations in JSON
   # and XML serialization.
-  #
-  # @since 4.0.0
   module Serializable
     extend ActiveSupport::Concern
 
     # We need to redefine where the JSON configuration is getting defined,
     # similar to +ActiveRecord+.
     included do
-      undef_method :include_root_in_json
-      delegate :include_root_in_json, to: ::Mongoid
+
+      class << self
+        # Note that this intentionally only delegates :include_root_in_json
+        # and not :include_root_in_json? - delegating the latter produces
+        # wrong behavior.
+        # Also note that this intentionally uses the ActiveSupport delegation
+        # functionality and not the Ruby standard library one.
+        # See https://jira.mongodb.org/browse/MONGOID-4849.
+        delegate :include_root_in_json, to: ::Mongoid
+      end
     end
 
     # Gets the document as a serializable hash, used by ActiveModel's JSON
@@ -26,14 +33,12 @@ module Mongoid
     #
     # @param [ Hash ] options The options to pass.
     #
-    # @option options [ Symbol ] :include What relations to include.
+    # @option options [ Symbol ] :include What associations to include.
     # @option options [ Symbol ] :only Limit the fields to only these.
     # @option options [ Symbol ] :except Dont include these fields.
     # @option options [ Symbol ] :methods What methods to include.
     #
     # @return [ Hash ] The document, ready to be serialized.
-    #
-    # @since 2.0.0.rc.6
     def serializable_hash(options = nil)
       options ||= {}
       attrs = {}
@@ -63,14 +68,12 @@ module Mongoid
     #   document.send(:field_names)
     #
     # @return [ Array<String> ] The names of the fields.
-    #
-    # @since 3.0.0
     def field_names(options)
       names = (as_attributes.keys + attribute_names).uniq.sort
 
       only = Array.wrap(options[:only]).map(&:to_s)
       except = Array.wrap(options[:except]).map(&:to_s)
-      except |= ['_type'] unless Mongoid.include_type_for_serialization
+      except |= [self.class.discriminator_key] unless Mongoid.include_type_for_serialization
 
       if !only.empty?
         names &= only
@@ -80,7 +83,7 @@ module Mongoid
       names
     end
 
-    # Serialize a single attribute. Handles relations, fields, and dynamic
+    # Serialize a single attribute. Handles associations, fields, and dynamic
     # attributes.
     #
     # @api private
@@ -94,39 +97,35 @@ module Mongoid
     # @param [ Hash ] options The options.
     #
     # @return [ Object ] The attribute.
-    #
-    # @since 3.0.0
     def serialize_attribute(attrs, name, names, options)
       if relations.key?(name)
         value = send(name)
         attrs[name] = value ? value.serializable_hash(options) : nil
       elsif names.include?(name) && !fields.key?(name)
-        attrs[name] = read_attribute(name)
+        attrs[name] = read_raw_attribute(name)
       elsif !attribute_missing?(name)
         attrs[name] = send(name)
       end
     end
 
-    # For each of the provided include options, get the relation needed and
+    # For each of the provided include options, get the association needed and
     # provide it in the hash.
     #
-    # @example Serialize the included relations.
+    # @example Serialize the included associations.
     #   document.serialize_relations({}, :include => :addresses)
     #
     # @param [ Hash ] attributes The attributes to serialize.
     # @param [ Hash ] options The serialization options.
     #
-    # @option options [ Symbol ] :include What relations to include
+    # @option options [ Symbol ] :include What associations to include
     # @option options [ Symbol ] :only Limit the fields to only these.
     # @option options [ Symbol ] :except Dont include these fields.
-    #
-    # @since 2.0.0.rc.6
     def serialize_relations(attributes = {}, options = {})
       inclusions = options[:include]
       relation_names(inclusions).each do |name|
-        metadata = relations[name.to_s]
-        if metadata && relation = send(metadata.name)
-          attributes[metadata.name.to_s] =
+        association = relations[name.to_s]
+        if association && relation = send(association.name)
+          attributes[association.name.to_s] =
             relation.serializable_hash(relation_options(inclusions, options, name))
         end
       end
@@ -135,14 +134,12 @@ module Mongoid
     # Since the inclusions can be a hash, symbol, or array of symbols, this is
     # provided as a convenience to parse out the names.
     #
-    # @example Get the relation names.
+    # @example Get the association names.
     #   document.relation_names(:include => [ :addresses ])
     #
     # @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.
     #
-    # @return [ Array<Symbol> ] The names of the included relations.
-    #
-    # @since 2.0.0.rc.6
+    # @return [ Array<Symbol> ] The names of the included associations.
     def relation_names(inclusions)
       inclusions.is_a?(Hash) ? inclusions.keys : Array.wrap(inclusions)
     end
@@ -150,16 +147,14 @@ module Mongoid
     # Since the inclusions can be a hash, symbol, or array of symbols, this is
     # provided as a convenience to parse out the options.
     #
-    # @example Get the relation options.
+    # @example Get the association options.
     #   document.relation_names(:include => [ :addresses ])
     #
     # @param [ Hash, Symbol, Array<Symbol> ] inclusions The inclusions.
     # @param [ Hash ] options The options.
-    # @param [ Symbol ] name The name of the relation.
-    #
-    # @return [ Hash ] The options for the relation.
+    # @param [ Symbol ] name The name of the association.
     #
-    # @since 2.0.0.rc.6
+    # @return [ Hash ] The options for the association.
     def relation_options(inclusions, options, name)
       if inclusions.is_a?(Hash)
         inclusions[name]

data/lib/mongoid/shardable.rb

@@ -1,15 +1,38 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # This module contains behaviour for adding shard key fields to updates.
-  #
-  # @since 4.0.0
+  # This module contains behavior for adding shard key fields to updates.
   module Shardable
     extend ActiveSupport::Concern
 
     included do
+      # Returns the list of shard key fields, if shard key was declared on
+      # this model. If no shard key was declared, returns an empty array.
+      #
+      # @return [ Array<Symbol> ] List of shard key fields.
+      # @api public
       cattr_accessor :shard_key_fields
       self.shard_key_fields = []
+
+      # Returns the shard configuration, which is a hash with the following
+      # (symbol) keys:
+      #
+      # - keys: A hash mapping (symbol) field names to values, defining the
+      #   shard key. Values can be either the integer 1 for ranged sharding
+      #   or the string "hashed" for hashed sharding.
+      # - options: A hash containing options for shardCollections command.
+      #
+      # If shard key was not declared via the +shard_key+ macro, +shard_config+
+      # attribute is nil.
+      #
+      # @example Get the shard configuration.
+      #   Model.shard_config
+      #   # => {key: {foo: 1, bar: 1}, options: {unique: true}}
+      #
+      # @return [ Hash | nil ] Shard configuration.
+      # @api public
+      cattr_accessor :shard_config
     end
 
     # Get the shard key fields.
@@ -20,26 +43,64 @@ module Mongoid
     #   model.shard_key_fields
     #
     # @return [ Array<String> ] The shard key field names.
-    #
-    # @since 1.0.0
     def shard_key_fields
       self.class.shard_key_fields
     end
 
-    # Get the document selector with the defined shard keys.
+    # Returns the selector that would match the defined shard keys. If
+    # `prefer_persisted` is false (the default), it uses the current values
+    # of the specified shard keys, otherwise, it will try to use whatever value
+    # was most recently persisted.
+    #
+    # @param [ true | false ] prefer_persisted Whether to use the current
+    #   value of the shard key fields, or to use their most recently persisted
+    #   values.
+    #
+    # @return [ Hash ] The shard key selector.
+    #
+    # @api private
+    def shard_key_selector(prefer_persisted: false)
+      shard_key_fields.each_with_object({}) do |field, selector|
+        selector[field.to_s] = shard_key_field_value(field.to_s, prefer_persisted: prefer_persisted)
+      end
+    end
+
+    # Returns the selector that would match the existing version of this
+    # document in the database.
     #
-    # @example Get the selector for the shard keys.
-    #   person.shard_key_selector
+    # If the document is not persisted, this method uses the current values
+    # of the shard key fields. If the document is persisted, this method
+    # uses the values retrieved from the database.
     #
     # @return [ Hash ] The shard key selector.
     #
-    # @since 2.0.0
-    def shard_key_selector
-      selector = {}
-      shard_key_fields.each do |field|
-        selector[field.to_s] = send(field)
+    # @api private
+    def shard_key_selector_in_db
+      shard_key_selector(prefer_persisted: true)
+    end
+
+    # Returns the value for the named shard key. If the field identifies
+    # an embedded document, the key will be parsed and recursively evaluated.
+    # If `prefer_persisted` is true, the value last persisted to the database
+    # will be returned, regardless of what the current value of the attribute
+    # may be.
+    #
+    # @param [String] field The name of the field to evaluate
+    # @param [ true|false ] prefer_persisted Whether or not to prefer the
+    #   persisted value over the current value.
+    #
+    # @return [ Object ] The value of the named field.
+    #
+    # @api private
+    def shard_key_field_value(field, prefer_persisted:)
+      if field.include?(".")
+        relation, remaining = field.split(".", 2)
+        send(relation)&.shard_key_field_value(remaining, prefer_persisted: prefer_persisted)
+      elsif prefer_persisted && !new_record?
+        attribute_was(field)
+      else
+        send(field)
       end
-      selector
     end
 
     module ClassMethods
@@ -53,14 +114,40 @@ module Mongoid
       #     field :first_name, :type => String
       #     field :last_name, :type => String
       #
-      #     shard_key :first_name, :last_name
+      #     shard_key first_name: 1, last_name: 1
       #   end
-      #
-      # @since 2.0.0
-      def shard_key(*names)
-        names.each do |name|
-          self.shard_key_fields << self.database_field_name(name).to_sym
+      def shard_key(*args)
+        unless args.first.is_a?(Hash)
+          # Shorthand syntax
+          if args.last.is_a?(Hash)
+            raise ArgumentError, 'Shorthand shard_key syntax does not permit options'
+          end
+
+          spec = Hash[args.map do |name|
+            [name, 1]
+          end]
+
+          return shard_key(spec)
+        end
+
+        if args.length > 2
+          raise ArgumentError, 'Full shard_key syntax requires 1 or 2 arguments'
         end
+
+        spec, options = args
+
+        spec = Hash[spec.map do |name, value|
+          if value.is_a?(Symbol)
+            value = value.to_s
+          end
+          [database_field_name(name).to_sym, value]
+        end]
+
+        self.shard_key_fields = spec.keys
+        self.shard_config = {
+          key: spec.freeze,
+          options: (options || {}).dup.freeze,
+        }.freeze
       end
     end
   end

data/lib/mongoid/stateful.rb

@@ -1,7 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # This module contains the behaviour for getting the various states a
+  # This module contains the behavior for getting the various states a
   # document can transition through.
   module Stateful
 
@@ -37,8 +38,6 @@ module Mongoid
     #   document.flagged_for_destroy?
     #
     # @return [ true, false ] If the document is flagged.
-    #
-    # @since 2.3.2
     def flagged_for_destroy?
       @flagged_for_destroy ||= false
     end
@@ -76,8 +75,6 @@ module Mongoid
     #   document.readonly?
     #
     # @return [ true, false ] If the document is readonly.
-    #
-    # @since 4.0.0
     def readonly?
       __selected_fields != nil
     end
@@ -88,8 +85,6 @@ module Mongoid
     #   person.settable?
     #
     # @return [ true, false ] Is this document a new embeds one?
-    #
-    # @since 2.1.0
     def settable?
       new_record? && embedded_one? && _parent.persisted?
     end
@@ -100,8 +95,6 @@ module Mongoid
     #   person.updateable?
     #
     # @return [ true, false ] If the document is changed and persisted.
-    #
-    # @since 2.1.0
     def updateable?
       persisted? && changed?
     end

data/lib/mongoid/stringified_symbol.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# A class which sends values to the database as Strings but returns them to the user as Symbols.
+module Mongoid
+  class StringifiedSymbol
+
+    class << self
+
+      # Convert the object from its mongo friendly ruby type to this type.
+      #
+      # @example Demongoize the object.
+      #   Mongoid::StringifiedSymbol.demongoize(object)
+      #
+      # @param [ Object ] object The object to demongoize.
+      #
+      # @return [ Symbol ] The object.
+      #
+      # @api private
+      def demongoize(object)
+        if object.nil?
+          object
+        else
+          object.to_s.to_sym
+        end
+      end
+
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   Mongoid::StringifiedSymbol.mongoize("123.11")
+      #
+      # @param [ Object ] object The object to mongoize.
+      #
+      # @return [ Symbol ] The object mongoized.
+      #
+      # @api private
+      def mongoize(object)
+         if object.nil?
+           object
+         else
+           object.to_s
+         end
+      end
+
+      # @api private
+      def evolve(object)
+        mongoize(object)
+      end
+    end
+  end
+end

data/lib/mongoid/tasks/database.rake

@@ -1,29 +1,36 @@
+# frozen_string_literal: true
+
 namespace :db do
   namespace :mongoid do
     task :load_models do
     end
 
-    desc "Create the indexes defined on your mongoid models"
+    desc "Create indexes specified in Mongoid models"
     task :create_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.create_indexes
     end
 
-    desc "Remove indexes that exist in the database but aren't specified on the models"
+    desc "Remove indexes that exist in the database but are not specified in Mongoid models"
     task :remove_undefined_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.remove_undefined_indexes
     end
 
-    desc "Remove the indexes defined on your mongoid models without questions!"
+    desc "Remove indexes specified in Mongoid models"
     task :remove_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.remove_indexes
     end
 
-    desc "Drops the default client database"
+    desc "Shard collections with shard keys specified in Mongoid models"
+    task :shard_collections => [:environment, :load_models] do
+      ::Mongoid::Tasks::Database.shard_collections
+    end
+
+    desc "Drop the database of the default Mongoid client"
     task :drop => :environment do
       ::Mongoid::Clients.default.database.drop
     end
 
-    desc "Drop all collections except the system collections"
+    desc "Drop all non-system collections"
     task :purge => :environment do
       ::Mongoid.purge!
     end