mongoid 7.0.10 → 7.1.4

data/lib/mongoid/atomic/paths/embedded/one.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Atomic
     module Paths
       module Embedded
 
-        # This class encapsulates behaviour for locating and updating
+        # This class encapsulates behavior for locating and updating
         # documents that are defined as an embedded 1-1.
         class One
           include Embedded
@@ -23,7 +25,7 @@ module Mongoid
           end
 
           # Get the position of the document in the hierarchy. This will
-          # include indexes of 1-n embedded relations that may sit above the
+          # include indexes of 1-n embedded associations that may sit above the
           # embedded one.
           #
           # @example Get the position.

data/lib/mongoid/atomic/paths/root.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Atomic
     module Paths
 
-      # This class encapsulates behaviour for locating and updating root
+      # This class encapsulates behavior for locating and updating root
       # documents atomically.
       class Root
 
@@ -22,7 +24,7 @@ module Mongoid
         end
 
         # Asking for the insert modifier on a document with a root path
-        # indicates a mixed relation most likely happened.
+        # indicates a mixed association most likely happened.
         #
         # @example Attempt to get the insert modifier.
         #   root.insert_modifier

data/lib/mongoid/attributes.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "active_model/attribute_methods"
 require "mongoid/attributes/dynamic"
 require "mongoid/attributes/nested"
@@ -269,7 +271,7 @@ module Mongoid
     #
     # @since 3.0.15
     def hash_dot_syntax?(string)
-      string.include?(".".freeze)
+      string.include?(".")
     end
 
     # Return the typecasted value for a field.
@@ -320,18 +322,17 @@ module Mongoid
       # @since 2.3.0
       def alias_attribute(name, original)
         aliased_fields[name.to_s] = original.to_s
-        class_eval <<-RUBY
-          alias #{name}  #{original}
-          alias #{name}= #{original}=
-          alias #{name}? #{original}?
-          alias #{name}_change   #{original}_change
-          alias #{name}_changed? #{original}_changed?
-          alias reset_#{name}!   reset_#{original}!
-          alias reset_#{name}_to_default!   reset_#{original}_to_default!
-          alias #{name}_was      #{original}_was
-          alias #{name}_will_change! #{original}_will_change!
-          alias #{name}_before_type_cast #{original}_before_type_cast
-        RUBY
+
+        alias_method name, original
+        alias_method "#{name}=", "#{original}="
+        alias_method "#{name}?", "#{original}?"
+        alias_method "#{name}_change", "#{original}_change"
+        alias_method "#{name}_changed?", "#{original}_changed?"
+        alias_method "reset_#{name}!", "reset_#{original}!"
+        alias_method "reset_#{name}_to_default!", "reset_#{original}_to_default!"
+        alias_method "#{name}_was", "#{original}_was"
+        alias_method "#{name}_will_change!", "#{original}_will_change!"
+        alias_method "#{name}_before_type_cast", "#{original}_before_type_cast"
       end
     end
 

data/lib/mongoid/attributes/dynamic.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Attributes
 

data/lib/mongoid/attributes/nested.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Attributes
 
-    # Defines behaviour around that lovel Rails feature nested attributes.
+    # Defines behavior around that lovel Rails feature nested attributes.
     #
     # @since 1.0.0
     module Nested
@@ -19,8 +21,8 @@ module Mongoid
           attributes.all? { |key, value| key == '_destroy' || value.blank? }
         }
 
-        # Used when needing to update related models from a parent relation. Can
-        # be used on embedded or referenced relations.
+        # Used when needing to update related models from a parent association. Can
+        # be used on embedded or referenced associations.
         #
         # @example Defining nested attributes.
         #
@@ -34,7 +36,7 @@ module Mongoid
         #     accepts_nested_attributes_for :addresses, :game, :posts
         #   end
         #
-        # @param [ Array<Symbol>, Hash ] args A list of relation names, followed
+        # @param [ Array<Symbol>, Hash ] args A list of association names, followed
         #   by a hash of options.
         #
         # @option *args [ true, false ] :allow_destroy Can deletion occur?
@@ -70,7 +72,7 @@ module Mongoid
 
         private
 
-        # Add the autosave information for the nested relation.
+        # Add the autosave information for the nested association.
         #
         # @api private
         #

data/lib/mongoid/attributes/processing.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Attributes
 
@@ -31,7 +33,7 @@ module Mongoid
 
       private
 
-      # If the key provided is the name of a relation or a nested attribute, we
+      # If the key provided is the name of an association or a nested attribute, we
       # need to wait until all other attributes are set before processing
       # these.
       #
@@ -57,12 +59,12 @@ module Mongoid
         return false
       end
 
-      # Get all the pending relations that need to be set.
+      # Get all the pending associations that need to be set.
       #
-      # @example Get the pending relations.
+      # @example Get the pending associations.
       #   document.pending_relations
       #
-      # @return [ Hash ] The pending relations in key/value pairs.
+      # @return [ Hash ] The pending associations in key/value pairs.
       #
       # @since 2.0.0.rc.7
       def pending_relations
@@ -124,10 +126,10 @@ module Mongoid
         pending_nested.clear and pending_relations.clear
       end
 
-      # Process all the pending relations that needed to wait until ids were set
+      # Process all the pending associations that needed to wait until ids were set
       # to fire off.
       #
-      # @example Process the relations.
+      # @example Process the associations.
       #   document.process_relations
       #
       # @since 2.0.0.rc.7

data/lib/mongoid/attributes/readonly.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Attributes
 
-    # This module defines behaviour for readonly attributes.
+    # This module defines behavior for readonly attributes.
     module Readonly
       extend ActiveSupport::Concern
 

data/lib/mongoid/cacheable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # Encapsulates behaviour around caching.
+  # Encapsulates behavior around caching.
   #
   # @since 6.0.0
   module Cacheable

data/lib/mongoid/changeable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # Defines behaviour for dirty tracking.
+  # Defines behavior for dirty tracking.
   #
   # @since 4.0.0
   module Changeable

data/lib/mongoid/clients.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/clients/factory"
 require "mongoid/clients/validators"
 require "mongoid/clients/storage_options"

data/lib/mongoid/clients/factory.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # encoding: utf-8
 
 module Mongoid
@@ -11,9 +12,9 @@ module Mongoid
       # raised.
       #
       # @example Create the client.
-      #   Factory.create(:secondary)
+      #   Factory.create(:analytics)
       #
-      # @param [ String, Symbol ] name The named client configuration.
+      # @param [ String | Symbol ] name The named client configuration.
       #
       # @raise [ Errors::NoClientConfig ] If no config could be found.
       #

data/lib/mongoid/clients/options.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Clients
     module Options
@@ -7,16 +9,16 @@ module Mongoid
       # Change the persistence context for this object during the block.
       #
       # @example Save the current document to a different collection.
-      #   model.with(collection: "secondary") do |m|
+      #   model.with(collection: "bands") do |m|
       #     m.save
       #   end
       #
       # @param [ Hash, Mongoid::PersistenceContext ] options_or_context
       #   The storage options or a persistence context.
       #
-      # @option options [ String, Symbol ] :collection The collection name.
-      # @option options [ String, Symbol ] :database The database name.
-      # @option options [ String, Symbol ] :client The client name.
+      # @option options [ String | Symbol ] :collection The collection name.
+      # @option options [ String | Symbol ] :database The database name.
+      # @option options [ String | Symbol ] :client The client name.
       #
       # @since 6.0.0
       def with(options_or_context, &block)
@@ -81,15 +83,15 @@ module Mongoid
         # Change the persistence context for this class during the block.
         #
         # @example Save the current document to a different collection.
-        #   Model.with(collection: "secondary") do |m|
+        #   Model.with(collection: "bands") do |m|
         #     m.create
         #   end
         #
         # @param [ Hash ] options The storage options.
         #
-        # @option options [ String, Symbol ] :collection The collection name.
-        # @option options [ String, Symbol ] :database The database name.
-        # @option options [ String, Symbol ] :client The client name.
+        # @option options [ String | Symbol ] :collection The collection name.
+        # @option options [ String | Symbol ] :database The database name.
+        # @option options [ String | Symbol ] :client The client name.
         #
         # @since 6.0.0
         def with(options, &block)

data/lib/mongoid/clients/sessions.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Clients
 

data/lib/mongoid/clients/storage_options.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Clients
     module StorageOptions
@@ -30,20 +32,20 @@ module Mongoid
         # @example Store this model by default in a different client.
         #   class Band
         #     include Mongoid::Document
-        #     store_in client: "secondary"
+        #     store_in client: "analytics"
         #   end
         #
         # @example Store this model with a combination of options.
         #   class Band
         #     include Mongoid::Document
-        #     store_in collection: "artists", database: "secondary"
+        #     store_in collection: "artists", database: "music"
         #   end
         #
         # @param [ Hash ] options The storage options.
         #
-        # @option options [ String, Symbol ] :collection The collection name.
-        # @option options [ String, Symbol ] :database The database name.
-        # @option options [ String, Symbol ] :client The client name.
+        # @option options [ String | Symbol ] :collection The collection name.
+        # @option options [ String | Symbol ] :database The database name.
+        # @option options [ String | Symbol ] :client The client name.
         #
         # @return [ Class ] The model class.
         #

data/lib/mongoid/clients/validators.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/clients/validators/storage"

data/lib/mongoid/clients/validators/storage.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Clients
     module Validators

data/lib/mongoid/composable.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/changeable"
 require "mongoid/findable"
 require "mongoid/indexable"
@@ -18,7 +20,7 @@ require "mongoid/validatable"
 
 module Mongoid
 
-  # This module provides inclusions of all behaviour in a Mongoid document.
+  # This module provides inclusions of all behavior in a Mongoid document.
   #
   # @since 4.0.0
   module Composable
@@ -90,7 +92,7 @@ module Mongoid
     ]
 
     # These are methods names defined in included blocks that may conflict
-    # with user-defined relation or field names.
+    # with user-defined association or field names.
     # They won't be in the list of Module.instance_methods on which the
     # #prohibited_methods code below is dependent so we must track them
     # separately.

data/lib/mongoid/config.rb

@@ -1,33 +1,76 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/config/environment"
 require "mongoid/config/options"
 require "mongoid/config/validators"
 
 module Mongoid
 
-  # This module defines all the configuration options for Mongoid, including the
-  # database connections.
+  # This module defines all the configuration options for Mongoid, including
+  # the database connections.
   module Config
-    extend self
+    extend Forwardable
     extend Options
+    extend self
 
-    delegate :logger=, to: ::Mongoid
-    delegate :logger, to: ::Mongoid
+    def_delegators ::Mongoid, :logger, :logger=
 
     LOCK = Mutex.new
 
+    # Application name that is printed to the mongodb logs upon establishing
+    # a connection in server versions >= 3.4. Note that the name cannot
+    # exceed 128 bytes. It is also used as the database name if the
+    # database name is not explicitly defined.
+    option :app_name, default: nil
+
+    # Create indexes in background by default.
+    option :background_indexing, default: false
+
+    # Mark belongs_to associations as required by default, so that saving a
+    # model with a missing belongs_to association will trigger a validation
+    # error.
+    option :belongs_to_required_by_default, default: true
+
+    # Raise an exception when a field is redefined.
+    option :duplicate_fields_exception, default: false
+
+    # Include the root model name in json serialization.
     option :include_root_in_json, default: false
+
+    # # Include the _type field in serialization.
     option :include_type_for_serialization, default: false
+
+    # Whether to join nested persistence contexts for atomic operations
+    # to parent contexts by default.
+    option :join_contexts, default: false
+
+    # The log level.
+    #
+    # It must be set prior to referencing clients or Mongo.logger,
+    # changes to this option are not be propagated to any clients and
+    # loggers that already exist.
+    #
+    # Additionally, only when the clients are configured via the
+    # configuration file is the log level given by this option honored.
+    option :log_level, default: :info
+
+    # Preload all models in development, needed when models use inheritance.
     option :preload_models, default: false
+
+    # Raise an error when performing a #find and the document is not found.
     option :raise_not_found_error, default: true
+
+    # Raise an error when defining a scope with the same name as an
+    # existing method.
     option :scope_overwrite_exception, default: false
-    option :duplicate_fields_exception, default: false
+
+    # Use ActiveSupport's time zone in time operations instead of the
+    # Ruby default time zone.
     option :use_activesupport_time_zone, default: true
+
+    # Return stored times as UTC.
     option :use_utc, default: false
-    option :log_level, default: :info
-    option :belongs_to_required_by_default, default: true
-    option :app_name, default: nil
-    option :background_indexing, default: false
 
     # Has Mongoid been configured? This is checking that at least a valid
     # client config exists.