mongoid 7.0.6 → 7.1.2

data/lib/mongoid/persistable/upsertable.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that upsert documents.
+    # Defines behavior for persistence operations that upsert documents.
     #
     # @since 4.0.0
     module Upsertable

data/lib/mongoid/persistence_context.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
 
   # Object encapsulating logic for setting/getting a collection and database name
@@ -107,13 +110,22 @@ module Mongoid
     #
     # @since 6.0.0
     def client
-      client_options = send(:client_options)
-      if client_options[:read].is_a?(Symbol)
-        client_options = client_options.merge(read: {mode: client_options[:read]})
+      @client ||= begin
+        client = Clients.with_name(client_name)
+        if database_name_option
+          client = client.use(database_name)
+        end
+        unless client_options.empty?
+          client = client.with(client_options)
+        end
+        client
       end
-      @client ||= (client = Clients.with_name(client_name)
-                    client = client.use(database_name) if database_name_option
-                    client.with(client_options))
+    end
+
+    def client_name
+      @client_name ||= options[:client] ||
+                         Threaded.client_override ||
+                         storage_options && __evaluate__(storage_options[:client])
     end
 
     # Determine if this persistence context is equal to another.
@@ -133,12 +145,6 @@ module Mongoid
 
     private
 
-    def client_name
-      @client_name ||= options[:client] ||
-                         Threaded.client_override ||
-                         storage_options && __evaluate__(storage_options[:client])
-    end
-
     def set_options!(opts)
       @options ||= opts.each.reduce({}) do |_options, (key, value)|
                      unless VALID_OPTIONS.include?(key.to_sym)
@@ -154,9 +160,15 @@ module Mongoid
     end
 
     def client_options
-      @client_options ||= options.select do |k, v|
-                            Mongo::Client::VALID_OPTIONS.include?(k.to_sym)
-                          end
+      @client_options ||= begin
+        opts = options.select do |k, v|
+                              Mongo::Client::VALID_OPTIONS.include?(k.to_sym)
+                            end
+        if opts[:read].is_a?(Symbol)
+          opts[:read] = {mode: opts[:read]}
+        end
+        opts
+      end
     end
 
     def database_name_option

data/lib/mongoid/positional.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
   # This module is responsible for taking update selectors and switching out

data/lib/mongoid/query_cache.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
   # A cache of database queries on a per-request basis.
@@ -166,14 +168,15 @@ module Mongoid
         @coll_name ||= result.namespace.sub("#{database.name}.", '') if result.namespace
         documents = result.documents
         if @cursor_id.zero? && !@after_first_batch
-          (@cached_documents ||= []).concat(documents)
+          @cached_documents ||= []
+          @cached_documents.concat(documents)
         end
         @after_first_batch = true
         documents
       end
     end
 
-    # Included to add behaviour for clearing out the query cache on certain
+    # Included to add behavior for clearing out the query cache on certain
     # operations.
     #
     # @since 4.0.0
@@ -181,12 +184,10 @@ module Mongoid
 
       def alias_query_cache_clear(*method_names)
         method_names.each do |method_name|
-          class_eval <<-CODE, __FILE__, __LINE__ + 1
-              def #{method_name}_with_clear_cache(*args)
-                QueryCache.clear_cache
-                #{method_name}_without_clear_cache(*args)
-              end
-            CODE
+          define_method("#{method_name}_with_clear_cache") do |*args|
+            QueryCache.clear_cache
+            send("#{method_name}_without_clear_cache", *args)
+          end
 
           alias_method "#{method_name}_without_clear_cache", method_name
           alias_method method_name, "#{method_name}_with_clear_cache"
@@ -262,7 +263,7 @@ module Mongoid
       end
     end
 
-    # Adds behaviour to the query cache for collections.
+    # Adds behavior to the query cache for collections.
     #
     # @since 5.0.0
     module Collection

data/lib/mongoid/railtie.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "rails"
 require "rails/mongoid"
 
@@ -40,7 +42,7 @@ module Rails
       # @example Set up configuration in the Rails app.
       #   module MyApplication
       #     class Application < Rails::Application
-      #       config.mongoid.logger = Logger.new($stdout, :warn)
+      #       config.mongoid.logger = Logger.new(STDERR, :warn)
       #     end
       #   end
       #

data/lib/mongoid/railties/controller_runtime.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Railties
     module ControllerRuntime
@@ -83,4 +86,4 @@ module Mongoid
 
     end
   end
-end
+end

data/lib/mongoid/railties/database.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 load 'mongoid/tasks/database.rake'
 
 namespace :db do
@@ -58,13 +60,20 @@ namespace :db do
   end
 
   unless Rake::Task.task_defined?("db:create_indexes")
+    desc "Create indexes specified in Mongoid models"
     task :create_indexes => "mongoid:create_indexes"
   end
 
   unless Rake::Task.task_defined?("db:remove_indexes")
+    desc "Remove indexes specified in Mongoid models"
     task :remove_indexes => "mongoid:remove_indexes"
   end
 
+  unless Rake::Task.task_defined?("db:shard_collections")
+    desc "Shard collections with shard keys specified in Mongoid models"
+    task :shard_collections => "mongoid:shard_collections"
+  end
+
   namespace :mongoid do
     task :load_models do
       ::Rails.application.eager_load! if defined?(::Rails)

data/lib/mongoid/reloadable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # This module handles reloading behaviour of documents.
+  # This module handles reloading behavior of documents.
   #
   # @since 4.0.0
   module Reloadable
@@ -37,7 +39,7 @@ module Mongoid
     private
 
     # Reload the document, determining if it's embedded or not and what
-    # behaviour to use.
+    # behavior to use.
     #
     # @example Reload the document.
     #   document._reload

data/lib/mongoid/scopable.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
 
 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

data/lib/mongoid/selectable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # Provides behaviour for generating the selector for a specific document.
+  # Provides behavior for generating the selector for a specific document.
   #
   # @since 4.0.0
   module Selectable

data/lib/mongoid/serializable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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
@@ -11,8 +13,16 @@ module Mongoid
     # 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,7 +36,7 @@ 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.
@@ -80,7 +90,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
@@ -107,16 +117,16 @@ module Mongoid
       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.
     #
@@ -135,12 +145,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.
+    # @return [ Array<Symbol> ] The names of the included associations.
     #
     # @since 2.0.0.rc.6
     def relation_names(inclusions)
@@ -150,14 +160,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.
+    # @param [ Symbol ] name The name of the association.
     #
-    # @return [ Hash ] The options for the relation.
+    # @return [ Hash ] The options for the association.
     #
     # @since 2.0.0.rc.6
     def relation_options(inclusions, options, name)

data/lib/mongoid/shardable.rb

@@ -1,15 +1,41 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # This module contains behaviour for adding shard key fields to updates.
+  # This module contains behavior for adding shard key fields to updates.
   #
   # @since 4.0.0
   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.
@@ -53,14 +79,42 @@ 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,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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
 

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