mongoid 6.4.4 → 7.1.7

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/storage.rb

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

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.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/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
@@ -43,7 +45,7 @@ module Mongoid
     include Inspectable
     include Matchable
     include Persistable
-    include Relations
+    include Association
     include Reloadable
     include Scopable
     include Selectable
@@ -70,7 +72,7 @@ module Mongoid
       Interceptable,
       Matchable,
       Persistable,
-      Relations,
+      Association,
       Reloadable,
       Scopable,
       Serializable,
@@ -83,14 +85,14 @@ module Mongoid
       Traversable,
       Validatable,
       Equality,
-      Relations::Synchronization,
-      Relations::Macros,
+      Association::Referenced::Syncable,
+      Association::Macros,
       ActiveModel::Model,
       ActiveModel::Validations
     ]
 
     # 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/environment.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Config
 
@@ -6,35 +8,48 @@ module Mongoid
     module Environment
       extend self
 
-      # Get the name of the environment that we are running under. This first
-      # looks for Rails, then Sinatra, then a RACK_ENV environment variable,
-      # and if none of those are found raises an error.
+      # Get the name of the environment that Mongoid is running under.
+      #
+      # Uses the following sources in order:
+      # - If +::Rails+ is defined, +Rails.env+.
+      # - If +::Sinatra+ is defined, +Sinatra::Base.environment+.
+      # - +RACK_ENV+
+      # - +MONGOID_ENV*
       #
       # @example Get the env name.
       #   Environment.env_name
       #
-      # @raise [ Errors::NoEnvironment ] If no environment was set.
+      # @raise [ Errors::NoEnvironment ] If environment name cannot be
+      #   determined because none of the sources was set.
       #
       # @return [ String ] The name of the current environment.
       #
       # @since 2.3.0
+      # @api public
       def env_name
-        return Rails.env if defined?(Rails) && Rails.respond_to?(:env)
-        return Sinatra::Base.environment.to_s if defined?(Sinatra)
-        ENV["RACK_ENV"] || ENV["MONGOID_ENV"] || raise(Errors::NoEnvironment.new)
+        if defined?(::Rails)
+          return ::Rails.env
+        end
+        if defined?(::Sinatra)
+          return ::Sinatra::Base.environment.to_s
+        end
+        ENV["RACK_ENV"] || ENV["MONGOID_ENV"] or raise Errors::NoEnvironment
       end
 
       # Load the yaml from the provided path and return the settings for the
-      # current environment.
+      # specified environment, or for the current Mongoid environment.
       #
       # @example Load the yaml.
       #   Environment.load_yaml("/work/mongoid.yml")
       #
       # @param [ String ] path The location of the file.
+      # @param [ String | Symbol ] environment Optional environment name to
+      #   override the current Mongoid environment.
       #
       # @return [ Hash ] The settings.
       #
       # @since 2.3.0
+      # @api private
       def load_yaml(path, environment = nil)
         env = environment ? environment.to_s : env_name
         YAML.load(ERB.new(File.new(path).read).result)[env]

data/lib/mongoid/config/options.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Config
 
@@ -20,7 +22,7 @@ module Mongoid
       # Define a configuration option with a default.
       #
       # @example Define the option.
-      #   Options.option(:logger, :default => Logger.new($stdout, :warn))
+      #   Options.option(:logger, :default => Logger.new(STDERR, :warn))
       #
       # @param [ Symbol ] name The name of the configuration option.
       # @param [ Hash ] options Extras for the option.
@@ -31,19 +33,22 @@ module Mongoid
       def option(name, options = {})
         defaults[name] = settings[name] = options[:default]
 
-        class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def #{name}
-            settings[#{name.inspect}]
+        class_eval do
+          # log_level accessor is defined specially below
+          unless name.to_sym == :log_level
+            define_method(name) do
+              settings[name]
+            end
           end
 
-          def #{name}=(value)
-            settings[#{name.inspect}] = value
+          define_method("#{name}=") do |value|
+            settings[name] = value
           end
 
-          def #{name}?
-            #{name}
+          define_method("#{name}?") do
+            !!send(name)
           end
-        RUBY
+        end
       end
 
       # Reset the configuration options to the defaults.
@@ -79,9 +84,12 @@ module Mongoid
       #
       # @since 5.1.0
       def log_level
-        if settings[:log_level]
-          level = settings[:log_level].upcase.to_s
-          "Logger::#{level}".constantize
+        if level = settings[:log_level]
+          unless level.is_a?(Integer)
+            level = level.upcase.to_s
+            level = "Logger::#{level}".constantize
+          end
+          level
         end
       end
     end

data/lib/mongoid/config/validators/client.rb

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

data/lib/mongoid/config/validators/option.rb

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

data/lib/mongoid/config/validators.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/config/validators/option"
 require "mongoid/config/validators/client"

data/lib/mongoid/config.rb

@@ -1,32 +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
 
     # Has Mongoid been configured? This is checking that at least a valid
     # client config exists.

data/lib/mongoid/contextual/aggregable/memory.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Contextual
     module Aggregable
-      # Contains behaviour for aggregating values in memory.
+      # Contains behavior for aggregating values in memory.
       module Memory
 
         # Get the average value of the provided field.

data/lib/mongoid/contextual/aggregable/mongo.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Contextual
     module Aggregable
-      # Contains behaviour for aggregating values in Mongo.
+      # Contains behavior for aggregating values in Mongo.
       module Mongo
 
         # Get all the aggregate values for the provided field.

data/lib/mongoid/contextual/atomic.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Contextual
     module Atomic
@@ -17,6 +19,20 @@ module Mongoid
         view.update_many("$addToSet" => collect_operations(adds))
       end
 
+      # Perform an atomic $addToSet/$each on the matching documents.
+      #
+      # @example Add the value to the set.
+      #   context.add_each_to_set(members: ["Dave", "Bill"], genres: ["Electro", "Disco"])
+      #
+      # @param [ Hash ] adds The operations.
+      #
+      # @return [ nil ] Nil.
+      #
+      # @since 7.0.0
+      def add_each_to_set(adds)
+        view.update_many("$addToSet" => collect_each_operations(adds))
+      end
+
       # Perform an atomic $bit operation on the matching documents.
       #
       # @example Perform the bitwise op.
@@ -117,10 +133,7 @@ module Mongoid
       #
       # @since 3.0.0
       def push_all(pushes)
-        push_each_updates = collect_operations(pushes).each.inject({}) do |ops, (field, elements)|
-          ops.merge!(field => {'$each' => elements})
-        end
-        view.update_many("$push" => push_each_updates)
+        view.update_many("$push" => collect_each_operations(pushes))
       end
 
       # Perform an atomic $rename of fields on the matching documents.
@@ -173,9 +186,14 @@ module Mongoid
       private
 
       def collect_operations(ops)
-        ops.inject({}) do |operations, (field, value)|
+        ops.each_with_object({}) do |(field, value), operations|
           operations[database_field_name(field)] = value.mongoize
-          operations
+        end
+      end
+
+      def collect_each_operations(ops)
+        ops.each_with_object({}) do |(field, value), operations|
+          operations[database_field_name(field)] = { "$each" => Array.wrap(value).mongoize }
         end
       end
     end

data/lib/mongoid/contextual/command.rb

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

data/lib/mongoid/contextual/geo_near.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Contextual
     class GeoNear
+      extend Forwardable
       include Enumerable
       include Command
 
-      delegate :[], to: :results
-      delegate :==, :empty?, to: :entries
+      def_delegator :results, :[]
+      def_delegators :entries, :==, :empty?
 
       # Get the average distance for all documents from the point in the
       # command.
@@ -242,7 +245,7 @@ module Mongoid
       # @since 3.0.0
       def documents
         results["results"].map do |attributes|
-          doc = Factory.from_db(criteria.klass, attributes["obj"], criteria.options[:fields])
+          doc = Factory.from_db(criteria.klass, attributes["obj"], criteria)
           doc.attributes["geo_near_distance"] = attributes["dis"]
           doc
         end
@@ -264,4 +267,3 @@ module Mongoid
     end
   end
 end
-