mongoid 5.4.1 → 7.4.0

data/lib/mongoid/clients/storage_options.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Clients
     module StorageOptions
@@ -30,24 +31,22 @@ 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.
-        #
-        # @since 3.0.0
         def store_in(options)
           Validators::Storage.validate(self, options)
           storage_options.merge!(options)
@@ -57,10 +56,9 @@ module Mongoid
         #
         # @example Reset the store_in options
         #   Model.reset_storage_options!
-        #
-        # @since 4.0.0
         def reset_storage_options!
           self.storage_options = storage_options_defaults.dup
+          PersistenceContext.clear(self)
         end
 
         # Get the default storage options.
@@ -69,82 +67,12 @@ module Mongoid
         #   Model.storage_options_defaults
         #
         # @return [ Hash ] Default storage options.
-        #
-        # @since 4.0.0
         def storage_options_defaults
           {
             collection: name.collectionize.to_sym,
-            client: :default,
-            database: -> { configured_database }
+            client: :default
           }
         end
-
-        # Get the name of the collection this model persists to.
-        #
-        # @example Get the collection name.
-        #   Model.collection_name
-        #
-        # @return [ Symbol ] The name of the collection.
-        #
-        # @since 3.0.0
-        def collection_name
-          __evaluate__(storage_options[:collection])
-        end
-
-        # Get the client name for the model.
-        #
-        # @example Get the client name.
-        #   Model.client_name
-        #
-        # @return [ Symbol ] The name of the client.
-        #
-        # @since 3.0.0
-        def client_name
-          __evaluate__(storage_options[:client])
-        end
-
-        # Get the database name for the model.
-        #
-        # @example Get the database name.
-        #   Model.database_name
-        #
-        # @return [ Symbol ] The name of the client.
-        #
-        # @since 4.0.0
-        def database_name
-          __evaluate__(storage_options[:database])
-        end
-
-        private
-
-        # Eval the provided value, either byt calling it if it responds to call
-        # or returning the value itself.
-        #
-        # @api private
-        #
-        # @example Evaluate the name.
-        #   Model.__evaluate__(:name)
-        #
-        # @param [ String, Symbol, Proc ] name The name.
-        #
-        # @return [ Symbol ] The value as a symbol.
-        #
-        # @since 3.1.0
-        def __evaluate__(name)
-          return nil unless name
-          name.respond_to?(:call) ? name.call.to_sym : name.to_sym
-        end
-
-        def configured_database
-          client = Mongoid.clients[client_name]
-          if db = client[:database]
-            db
-          elsif uri = client[:uri]
-            client[:database] = Mongo::URI.get(uri).database
-          else
-            nil
-          end
-        end
       end
     end
   end

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Clients
     module Validators
@@ -8,8 +9,6 @@ module Mongoid
         extend self
 
         # The valid options for storage.
-        #
-        # @since 3.0.0
         VALID_OPTIONS = [ :collection, :database, :client ].freeze
 
         # Validate the options provided to :store_in.
@@ -19,8 +18,6 @@ module Mongoid
         #
         # @param [ Class ] klass The model class.
         # @param [ Hash, String, Symbol ] options The provided options.
-        #
-        # @since 3.0.0
         def validate(klass, options)
           valid_keys?(options) or raise Errors::InvalidStorageOptions.new(klass, options)
           valid_parent?(klass) or raise Errors::InvalidStorageParent.new(klass)
@@ -35,8 +32,6 @@ module Mongoid
         # @param [ Class ] klass
         #
         # @return [ true, false ] If the class is valid
-        #
-        # @since 4.0.0
         def valid_parent?(klass)
           !klass.superclass.include?(Mongoid::Document)
         end
@@ -51,8 +46,6 @@ module Mongoid
         # @param [ Hash ] options The options hash.
         #
         # @return [ true, false ] If all keys are valid.
-        #
-        # @since 3.0.0
         def valid_keys?(options)
           return false unless options.is_a?(::Hash)
           options.keys.all? do |key|

data/lib/mongoid/clients/validators.rb

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

data/lib/mongoid/clients.rb

@@ -1,16 +1,17 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/clients/factory"
 require "mongoid/clients/validators"
 require "mongoid/clients/storage_options"
-require "mongoid/clients/thread_options"
 require "mongoid/clients/options"
+require "mongoid/clients/sessions"
 
 module Mongoid
   module Clients
     extend ActiveSupport::Concern
     include StorageOptions
-    include ThreadOptions
     include Options
+    include Sessions
 
     class << self
 
@@ -20,8 +21,6 @@ module Mongoid
       #   Mongoid::Clients.clear
       #
       # @return [ Array ] The empty clients.
-      #
-      # @since 3.0.0
       def clear
         clients.clear
       end
@@ -32,10 +31,8 @@ module Mongoid
       #   Mongoid::Clients.default
       #
       # @return [ Mongo::Client ] The default client.
-      #
-      # @since 3.0.0
       def default
-        clients[:default] ||= Clients::Factory.default
+        with_name(:default)
       end
 
       # Disconnect all active clients.
@@ -44,8 +41,6 @@ module Mongoid
       #   Mongoid::Clients.disconnect
       #
       # @return [ true ] True.
-      #
-      # @since 3.1.0
       def disconnect
         clients.values.each do |client|
           client.close
@@ -57,13 +52,15 @@ module Mongoid
       # @example Get a client with the name.
       #   Mongoid::Clients.with_name(:replica)
       #
-      # @param [ Symbol ] name The name of the client.
+      # @param [ String | Symbol ] name The name of the client.
       #
       # @return [ Mongo::Client ] The named client.
-      #
-      # @since 3.0.0
       def with_name(name)
-        clients[name.to_sym] ||= Clients::Factory.create(name)
+        name_as_symbol = name.to_sym
+        return clients[name_as_symbol] if clients[name_as_symbol]
+        CREATE_LOCK.synchronize do
+          clients[name_as_symbol] ||= Clients::Factory.create(name)
+        end
       end
 
       def set(name, client)
@@ -73,67 +70,10 @@ module Mongoid
       def clients
         @clients ||= {}
       end
-    end
-
-    # Get the collection for this model from the client. Will check for an
-    # overridden collection name from the store_in macro or the collection
-    # with a pluralized model name.
-    #
-    # @example Get the model's collection.
-    #   Model.collection
-    #
-    # @return [ Mongo::Collection ] The collection.
-    #
-    # @since 3.0.0
-    def collection
-      mongo_client[collection_name]
-    end
-
-    def mongo_client
-      super || self.class.mongo_client
-    end
-
-    def collection_name
-      super || self.class.collection_name
-    end
-
-    module ClassMethods
 
-      # Get the client for this model. This is determined in the following order:
-      #
-      #   1. Any custom configuration provided by the 'store_in' macro.
-      #   2. The 'default' client as provided in the mongoid.yml
-      #
-      # @example Get the client.
-      #   Model.mongo_client
-      #
-      # @return [ Mongo::Client ] The default mongo client.
-      #
-      # @since 3.0.0
-      def mongo_client
-        return client_with_options if client_with_options
-        client = Clients.with_name(client_name)
-        opts = self.persistence_options ? self.persistence_options.dup : {}
-        if defined?(Mongo::Client::VALID_OPTIONS)
-          opts.reject! { |k, v| !Mongo::Client::VALID_OPTIONS.include?(k.to_sym) }
-        end
-        opts.merge!(database: database_name) unless client.database.name.to_sym == database_name.to_sym
-        client.with(opts)
-      end
+      private
 
-      # Get the collection for this model from the client. Will check for an
-      # overridden collection name from the store_in macro or the collection
-      # with a pluralized model name.
-      #
-      # @example Get the model's collection.
-      #   Model.collection
-      #
-      # @return [ Mongo::Collection ] The collection.
-      #
-      # @since 3.0.0
-      def collection
-        mongo_client[collection_name]
-      end
+      CREATE_LOCK = Mutex.new
     end
   end
 end

data/lib/mongoid/composable.rb

@@ -1,9 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/changeable"
 require "mongoid/findable"
 require "mongoid/indexable"
 require "mongoid/inspectable"
 require "mongoid/interceptable"
+require "mongoid/matcher"
 require "mongoid/matchable"
 require "mongoid/persistable"
 require "mongoid/reloadable"
@@ -12,14 +14,13 @@ require "mongoid/scopable"
 require "mongoid/serializable"
 require "mongoid/shardable"
 require "mongoid/stateful"
+require "mongoid/cacheable"
 require "mongoid/traversable"
 require "mongoid/validatable"
 
 module Mongoid
 
-  # This module provides inclusions of all behaviour in a Mongoid document.
-  #
-  # @since 4.0.0
+  # This module provides inclusions of all behavior in a Mongoid document.
   module Composable
     extend ActiveSupport::Concern
 
@@ -32,7 +33,6 @@ module Mongoid
     include ActiveModel::Model
     include ActiveModel::ForbiddenAttributesProtection
     include ActiveModel::Serializers::JSON
-    include ActiveModel::Serializers::Xml
     include Atomic
     include Changeable
     include Clients
@@ -43,13 +43,14 @@ module Mongoid
     include Inspectable
     include Matchable
     include Persistable
-    include Relations
+    include Association
     include Reloadable
     include Scopable
     include Selectable
     include Serializable
     include Shardable
     include Stateful
+    include Cacheable
     include Threaded::Lifecycle
     include Traversable
     include Validatable
@@ -69,21 +70,45 @@ module Mongoid
       Interceptable,
       Matchable,
       Persistable,
-      Relations,
+      Association,
       Reloadable,
       Scopable,
       Serializable,
       Clients,
+      Clients::Options,
       Shardable,
       Stateful,
+      Cacheable,
       Threaded::Lifecycle,
       Traversable,
       Validatable,
       Equality,
+      Association::Referenced::Syncable,
+      Association::Macros,
       ActiveModel::Model,
       ActiveModel::Validations
     ]
 
+    # These are methods names defined in included blocks that may conflict
+    # 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.
+    #
+    # @return [ Array<Symbol> ] A list of reserved method names.
+    RESERVED_METHOD_NAMES = [ :fields,
+                              :aliased_fields,
+                              :localized_fields,
+                              :index_specifications,
+                              :shard_key_fields,
+                              :nested_attributes,
+                              :readonly_attributes,
+                              :storage_options,
+                              :cascades,
+                              :cyclic,
+                              :cache_timestamp_format
+                            ]
+
     class << self
 
       # Get a list of methods that would be a bad idea to define as field names
@@ -93,12 +118,10 @@ module Mongoid
       #   Mongoid::Components.prohibited_methods
       #
       # @return [ Array<Symbol> ]
-      #
-      # @since 2.1.8
       def prohibited_methods
         @prohibited_methods ||= MODULES.flat_map do |mod|
           mod.instance_methods.map(&:to_sym)
-        end
+        end + RESERVED_METHOD_NAMES
       end
     end
   end

data/lib/mongoid/config/environment.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Config
 
@@ -6,38 +7,59 @@ 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]
+        contents = File.new(path).read
+        if contents.empty?
+          raise Mongoid::Errors::EmptyConfigFile.new(path)
+        end
+        data = if RUBY_VERSION.start_with?("2.5")
+          YAML.safe_load(ERB.new(contents).result, [Symbol], [], true)
+        else
+          YAML.safe_load(ERB.new(contents).result, permitted_classes: [Symbol], aliases: true)
+        end
+        unless data.is_a?(Hash)
+          raise Mongoid::Errors::InvalidConfigFile.new(path)
+        end
+        data[env]
       end
     end
   end

data/lib/mongoid/config/options.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Config
 
@@ -11,8 +12,6 @@ module Mongoid
       #   options.defaults
       #
       # @return [ Hash ] The default options.
-      #
-      # @since 2.3.0
       def defaults
         @defaults ||= {}
       end
@@ -20,30 +19,31 @@ 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.
       #
       # @option options [ Object ] :default The default value.
-      #
-      # @since 2.0.0.rc.1
       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.
@@ -52,8 +52,6 @@ module Mongoid
       #   config.reset
       #
       # @return [ Hash ] The defaults.
-      #
-      # @since 2.3.0
       def reset
         settings.replace(defaults)
       end
@@ -64,8 +62,6 @@ module Mongoid
       #   options.settings
       #
       # @return [ Hash ] The setting options.
-      #
-      # @since 2.3.0
       def settings
         @settings ||= {}
       end
@@ -76,12 +72,13 @@ module Mongoid
       #   config.log_level
       #
       # @return [ Integer ] The log level.
-      #
-      # @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,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Config
     module Validators
@@ -8,8 +9,6 @@ module Mongoid
         extend self
 
         # Standard configuration options.
-        #
-        # @since 3.0.0
         STANDARD = [ :database, :hosts, :username, :password ].freeze
 
         # Validate the client configuration.
@@ -18,8 +17,6 @@ module Mongoid
         #   Client.validate({ default: { hosts: [ "localhost:27017" ] }})
         #
         # @param [ Hash ] clients The clients config.
-        #
-        # @since 3.0.0
         def validate(clients)
           unless clients.has_key?(:default)
             raise Errors::NoDefaultClient.new(clients.keys)
@@ -42,8 +39,6 @@ module Mongoid
         #
         # @param [ String, Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
-        #
-        # @since 3.0.0
         def validate_client_database(name, config)
           if no_database_or_uri?(config)
             raise Errors::NoClientDatabase.new(name, config)
@@ -59,8 +54,6 @@ module Mongoid
         #
         # @param [ String, Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
-        #
-        # @since 3.0.0
         def validate_client_hosts(name, config)
           if no_hosts_or_uri?(config)
             raise Errors::NoClientHosts.new(name, config)
@@ -77,8 +70,6 @@ module Mongoid
         #
         # @param [ String, Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
-        #
-        # @since 3.0.0
         def validate_client_uri(name, config)
           if both_uri_and_standard?(config)
             raise Errors::MixedClientConfiguration.new(name, config)
@@ -96,8 +87,6 @@ module Mongoid
         # @param [ Hash ] config The configuration options.
         #
         # @return [ true, false ] If no database or uri is defined.
-        #
-        # @since 3.0.0
         def no_database_or_uri?(config)
           !config.has_key?(:database) && !config.has_key?(:uri)
         end
@@ -113,8 +102,6 @@ module Mongoid
         # @param [ Hash ] config The configuration options.
         #
         # @return [ true, false ] If no hosts or uri is defined.
-        #
-        # @since 3.0.0
         def no_hosts_or_uri?(config)
           !config.has_key?(:hosts) && !config.has_key?(:uri)
         end
@@ -130,8 +117,6 @@ module Mongoid
         # @param [ Hash ] config The configuration options.
         #
         # @return [ true, false ] If both standard and uri are defined.
-        #
-        # @since 3.0.0
         def both_uri_and_standard?(config)
           config.has_key?(:uri) && config.keys.any? do |key|
             STANDARD.include?(key.to_sym)

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Config
     module Validators
@@ -12,8 +13,6 @@ module Mongoid
         # @example Validate a configuration option.
         #
         # @param [ String ] option The name of the option.
-        #
-        # @since 3.0.0
         def validate(option)
           unless Config.settings.keys.include?(option.to_sym)
             raise Errors::InvalidConfigOption.new(option)