mongoid 9.0.10 → 9.1.0

data/lib/mongoid/attributes.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "active_model/attribute_methods"
-require "mongoid/attributes/dynamic"
-require "mongoid/attributes/embedded"
-require "mongoid/attributes/nested"
-require "mongoid/attributes/processing"
-require "mongoid/attributes/projector"
-require "mongoid/attributes/readonly"
+require 'active_model/attribute_methods'
+require 'mongoid/attributes/dynamic'
+require 'mongoid/attributes/embedded'
+require 'mongoid/attributes/nested'
+require 'mongoid/attributes/processing'
+require 'mongoid/attributes/projector'
+require 'mongoid/attributes/readonly'
 
 module Mongoid
-
   # This module contains the logic for handling the internal attributes hash,
   # and how to get and set values.
   module Attributes
@@ -20,7 +18,7 @@ module Mongoid
     include Readonly
 
     attr_reader :attributes
-    alias :raw_attributes :attributes
+    alias raw_attributes attributes
 
     # Determine if an attribute is present.
     #
@@ -90,8 +88,7 @@ module Mongoid
       raw = read_raw_attribute(name)
       process_raw_attribute(name.to_s, raw, field)
     end
-    alias :[] :read_attribute
-
+    alias [] read_attribute
 
     # Process the raw attribute values just read from the documents attributes.
     #
@@ -138,7 +135,7 @@ module Mongoid
     # @param [ String | Symbol ] name The name of the attribute to remove.
     #
     # @raise [ Errors::ReadonlyAttribute ] If the field cannot be removed due
-    #   to being flagged as reaodnly.
+    #   to being flagged as readonly.
     def remove_attribute(name)
       validate_writable_field_name!(name.to_s)
       as_writable_attribute!(name) do |access|
@@ -167,9 +164,7 @@ module Mongoid
 
       field_name = database_field_name(name)
 
-      if attribute_missing?(field_name)
-        raise Mongoid::Errors::AttributeNotLoaded.new(self.class, field_name)
-      end
+      raise Mongoid::Errors::AttributeNotLoaded.new(self.class, field_name) if attribute_missing?(field_name)
 
       if attribute_writable?(field_name)
         _assigning do
@@ -202,7 +197,7 @@ module Mongoid
         # TODO: MONGOID-5072
       end
     end
-    alias :[]= :write_attribute
+    alias []= write_attribute
 
     # Allows you to set all the attributes for a particular mass-assignment security role
     # by passing in a hash of attributes with keys matching the attribute names
@@ -236,7 +231,7 @@ module Mongoid
     def write_attributes(attrs = nil)
       assign_attributes(attrs)
     end
-    alias :attributes= :write_attributes
+    alias attributes= write_attributes
 
     # Determine if the attribute is missing from the document, due to loading
     # it from the database with missing fields.
@@ -258,7 +253,7 @@ module Mongoid
     #
     # @return [ Object ] The hash with keys and values of the type-casted attributes.
     def typed_attributes
-      attribute_names.map { |name| [name, send(name)] }.to_h
+      attribute_names.map { |name| [ name, send(name) ] }.to_h
     end
 
     private
@@ -272,7 +267,7 @@ module Mongoid
     #
     # @return [ true | false ] If the string contains a "."
     def hash_dot_syntax?(string)
-      string.include?(".")
+      string.include?('.')
     end
 
     # Return the typecasted value for a field.
@@ -288,14 +283,10 @@ module Mongoid
       fields.key?(key) ? fields[key].mongoize(value) : value.mongoize
     end
 
-    private
-
     def read_raw_attribute(name)
       normalized = database_field_name(name.to_s)
 
-      if attribute_missing?(normalized)
-        raise Mongoid::Errors::AttributeNotLoaded.new(self.class, name)
-      end
+      raise Mongoid::Errors::AttributeNotLoaded.new(self.class, name) if attribute_missing?(normalized)
 
       if hash_dot_syntax?(normalized)
         if fields.key?(normalized)
@@ -309,7 +300,6 @@ module Mongoid
     end
 
     module ClassMethods
-
       # Alias the provided name to the original field. This will provide an
       # aliased getter, setter, existence check, and all dirty attribute
       # methods.
@@ -342,9 +332,7 @@ module Mongoid
       #
       # @param [ Symbol ] name The aliased field name to remove.
       def unalias_attribute(name)
-        unless aliased_fields.delete(name.to_s)
-          raise AttributeError, "Field #{name} is not an aliased field"
-        end
+        raise AttributeError, "Field #{name} is not an aliased field" unless aliased_fields.delete(name.to_s)
 
         remove_method name
         remove_method "#{name}="
@@ -359,12 +347,8 @@ module Mongoid
       end
     end
 
-    private
-
     def lookup_attribute_presence(name, value)
-      if localized_fields.has_key?(name) && value
-        value = localized_fields[name].send(:lookup, value)
-      end
+      value = localized_fields[name].send(:lookup, value) if localized_fields.has_key?(name) && value
       value.present?
     end
 

data/lib/mongoid/cacheable.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # Encapsulates behavior around caching.
   module Cacheable
     extend ActiveSupport::Concern
@@ -15,20 +13,40 @@ module Mongoid
     # Print out the cache key. This will append different values on the
     # plural model name.
     #
-    # If new_record?     - will append /new
-    # If not             - will append /id-updated_at.to_formatted_s(cache_timestamp_format)
-    # Without updated_at - will append /id
+    # If new_record? - will append /new
+    # Non-nil cache_version? - append /id
+    # Non-nil updated_at - append /id-updated_at.to_formatted_s(cache_timestamp_format)
+    # Otherwise - append /id
     #
     # This is usually called inside a cache() block
     #
     # @example Returns the cache key
     #   document.cache_key
     #
-    # @return [ String ] the string with or without updated_at
+    # @return [ String ] the generated cache key
     def cache_key
       return "#{model_key}/new" if new_record?
+      return "#{model_key}/#{_id}" if cache_version
       return "#{model_key}/#{_id}-#{updated_at.utc.to_formatted_s(cache_timestamp_format)}" if try(:updated_at)
+
       "#{model_key}/#{_id}"
     end
+
+    # Return the cache version for this model. By default, it returns the updated_at
+    # field (if present) formatted as a string, or nil if the model has no
+    # updated_at field. Models with different needs may override this method to
+    # suit their desired behavior.
+    #
+    # @return [ String | nil ] the cache version value
+    #
+    # TODO: we can test this by using a MemoryStore, putting something in
+    # it, then updating the timestamp on the record and trying to read the
+    # value from the memory store. It shouldn't find it, because the version
+    # has changed.
+    def cache_version
+      return unless has_attribute?('updated_at') && updated_at.present?
+
+      updated_at.utc.to_formatted_s(cache_timestamp_format)
+    end
   end
 end

data/lib/mongoid/clients/factory.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Clients
-
     # Factory used to create database clients.
     module Factory
       extend self
@@ -24,8 +22,10 @@ module Mongoid
       # @return [ Mongo::Client ] The new client.
       def create(name = nil)
         return default unless name
+
         config = Mongoid.clients[name]
         raise Errors::NoClientConfig.new(name) unless config
+
         create_client(config)
       end
 
@@ -56,6 +56,7 @@ module Mongoid
       # @return [ Mongo::Client ] The client.
       def create_client(configuration)
         raise Errors::NoClientsConfig.new unless configuration
+
         config = configuration.dup
         uri = config.delete(:uri)
         database = config.delete(:database) || Mongo::URI.get(uri).database
@@ -64,9 +65,7 @@ module Mongoid
         if opts.key?(:auto_encryption_options)
           opts[:auto_encryption_options] = build_auto_encryption_options(opts, database)
         end
-        unless config.empty?
-          default_logger.warn("Unknown config options detected: #{config}.")
-        end
+        default_logger.warn("Unknown config options detected: #{config}.") unless config.empty?
         if uri
           Mongo::Client.new(uri, options(opts))
         else
@@ -109,7 +108,7 @@ module Mongoid
 
       MONGOID_WRAPPING_LIBRARY = {
         name: 'Mongoid',
-        version: VERSION,
+        version: VERSION
       }.freeze
 
       def driver_version
@@ -126,19 +125,17 @@ module Mongoid
         options = opts.dup
         options[:platform] = PLATFORM_DETAILS
         options[:app_name] = Mongoid::Config.app_name if Mongoid::Config.app_name
-        if (driver_version <=> [2, 13]) >= 0
+        if (driver_version <=> [ 2, 13 ]) >= 0
           wrap_lib = if options[:wrapping_libraries]
-            [MONGOID_WRAPPING_LIBRARY] + options[:wrapping_libraries]
-          else
-            [MONGOID_WRAPPING_LIBRARY]
-          end.tap do |wrap|
-            if defined?(::Rails) && ::Rails.respond_to?(:version)
-              wrap << { name: 'Rails', version: ::Rails.version }
-            end
+                       [ MONGOID_WRAPPING_LIBRARY ] + options[:wrapping_libraries]
+                     else
+                       [ MONGOID_WRAPPING_LIBRARY ]
+                     end.tap do |wrap|
+            wrap << { name: 'Rails', version: ::Rails.version } if defined?(::Rails) && ::Rails.respond_to?(:version)
           end
           options[:wrapping_libraries] = wrap_lib
         end
-        options.reject{ |k, _v| k == :hosts }.to_hash.symbolize_keys!
+        options.reject { |k, _v| k == :hosts }.to_hash.symbolize_keys!
       end
     end
   end

data/lib/mongoid/clients/options.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Clients
-
     # Mixin module included into Mongoid::Document which gives
     # the ability to manage the database context for persistence
     # and query operations. For example, this includes saving
@@ -25,7 +23,7 @@ module Mongoid
       # @option options [ String | Symbol ] :collection The collection name.
       # @option options [ String | Symbol ] :database The database name.
       # @option options [ String | Symbol ] :client The client name.
-      def with(options_or_context, &block)
+      def with(options_or_context)
         original_context = PersistenceContext.get(self)
         original_cluster = persistence_context.cluster
         set_persistence_context(options_or_context)
@@ -134,7 +132,6 @@ module Mongoid
       end
 
       module ClassMethods
-
         # Get the database client name for the current persistence context
         # of the document class.
         #
@@ -207,7 +204,7 @@ module Mongoid
         # @option options [ String | Symbol ] :collection The collection name.
         # @option options [ String | Symbol ] :database The database name.
         # @option options [ String | Symbol ] :client The client name.
-        def with(options, &block)
+        def with(options)
           original_context = PersistenceContext.get(self)
           original_cluster = persistence_context.cluster
           PersistenceContext.set(self, options)

data/lib/mongoid/clients/sessions.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Clients
-
     # Encapsulates behavior for using sessions and transactions.
     module Sessions
-
       # Add class method mixin functionality.
       #
       # @todo Replace with ActiveSupport::Concern
@@ -15,10 +12,9 @@ module Mongoid
       end
 
       module ClassMethods
-
         # Actions that can be used to trigger transactional callbacks.
         # @api private
-        CALLBACK_ACTIONS = [:create, :destroy, :update]
+        CALLBACK_ACTIONS = %i[create destroy update]
 
         # Execute a block within the context of a session.
         #
@@ -40,24 +36,21 @@ module Mongoid
         #
         # @yieldparam [ Mongo::Session ] The session being used for the block.
         def with_session(options = {})
-          if Threaded.get_session(client: persistence_context.client)
-            raise Mongoid::Errors::InvalidSessionNesting.new
-          end
+          raise Mongoid::Errors::InvalidSessionNesting.new if Threaded.get_session(client: persistence_context.client)
+
           session = persistence_context.client.start_session(options)
           Threaded.set_session(session, client: persistence_context.client)
           yield(session)
-        rescue Mongo::Error::InvalidSession => ex
-          if Mongo::Error::SessionsNotSupported === ex
-            raise Mongoid::Errors::SessionsNotSupported.new
-          else
-            raise ex
-          end
-        rescue Mongo::Error::OperationFailure => ex
-          if (ex.code == 40415 && ex.server_message =~ /startTransaction/) ||
-             (ex.code == 20 && ex.server_message =~ /Transaction/)
+        rescue Mongo::Error::InvalidSession => e
+          raise Mongoid::Errors::SessionsNotSupported.new if e.is_a?(Mongo::Error::SessionsNotSupported)
+
+          raise e
+        rescue Mongo::Error::OperationFailure => e
+          if (e.code == 40_415 && e.server_message =~ /startTransaction/) ||
+             (e.code == 20 && e.server_message =~ /Transaction/)
             raise Mongoid::Errors::TransactionsNotSupported.new
           else
-            raise ex
+            raise e
           end
         rescue *transactions_not_supported_exceptions
           raise Mongoid::Errors::TransactionsNotSupported
@@ -87,26 +80,22 @@ module Mongoid
         #   by MongoDB deployment or MongoDB driver.
         #
         # @yield Provided block will be executed inside a transaction.
-        def transaction(options = {}, session_options: {})
+        def transaction(options = {}, session_options: {}, &block)
           with_session(session_options) do |session|
-            begin
-              session.with_transaction(options) do
-                yield
-              end.tap { run_commit_callbacks(session) }
-            rescue *transactions_not_supported_exceptions
-              raise Mongoid::Errors::TransactionsNotSupported
-            rescue Mongoid::Errors::Rollback
-              run_abort_callbacks(session)
-            rescue Mongoid::Errors::InvalidSessionNesting
-              # Session should be ended here.
-              raise Mongoid::Errors::InvalidTransactionNesting.new
-            rescue Mongo::Error::InvalidSession, Mongo::Error::InvalidTransactionOperation => e
-              run_abort_callbacks(session)
-              raise Mongoid::Errors::TransactionError.new(e)
-            rescue StandardError => e
-              run_abort_callbacks(session)
-              raise e
-            end
+            session.with_transaction(options, &block).tap { run_commit_callbacks(session) }
+          rescue *transactions_not_supported_exceptions
+            raise Mongoid::Errors::TransactionsNotSupported
+          rescue Mongoid::Errors::Rollback
+            run_abort_callbacks(session)
+          rescue Mongoid::Errors::InvalidSessionNesting
+            # Session should be ended here.
+            raise Mongoid::Errors::InvalidTransactionNesting.new
+          rescue Mongo::Error::InvalidSession, Mongo::Error::InvalidTransactionOperation => e
+            run_abort_callbacks(session)
+            raise Mongoid::Errors::TransactionError.new(e)
+          rescue StandardError => e
+            run_abort_callbacks(session)
+            raise e
           end
         end
 
@@ -123,7 +112,7 @@ module Mongoid
 
         # Shortcut for +after_commit :hook, on: [ :create, :update ]+
         def after_save_commit(*args, &block)
-          set_options_for_callbacks!(args, on: [ :create, :update ])
+          set_options_for_callbacks!(args, on: %i[create update])
           set_callback(:commit, :after, *args, &block)
         end
 
@@ -216,14 +205,14 @@ module Mongoid
           options = args.extract_options!.merge(enforced_options)
           args << options
 
-          if options[:on]
-            fire_on = Array(options[:on])
-            assert_valid_transaction_action(fire_on)
-            options[:if] = [
-              -> { transaction_include_any_action?(fire_on) },
-              *options[:if]
-            ]
-          end
+          return unless options[:on]
+
+          fire_on = Array(options[:on])
+          assert_valid_transaction_action(fire_on)
+          options[:if] = [
+            -> { transaction_include_any_action?(fire_on) },
+            *options[:if]
+          ]
         end
 
         # Asserts that the given actions are valid for after_commit
@@ -232,9 +221,10 @@ module Mongoid
         # @param [ Array<Symbol> ] actions Actions to be checked.
         # @raise [ ArgumentError ] If any of the actions is not valid.
         def assert_valid_transaction_action(actions)
-          if (actions - CALLBACK_ACTIONS).any?
-            raise ArgumentError, ":on conditions for after_commit and after_rollback callbacks have to be one of #{CALLBACK_ACTIONS}"
-          end
+          return unless (actions - CALLBACK_ACTIONS).any?
+
+          raise ArgumentError,
+                ":on conditions for after_commit and after_rollback callbacks have to be one of #{CALLBACK_ACTIONS}"
         end
 
         def transaction_include_any_action?(actions)
@@ -274,17 +264,17 @@ module Mongoid
         # a model within a transaction, where the model is not itself
         # controlled by that transaction. this is potentially a bug, so
         # let's tell them about it.
-        if session.nil?
-          # This is hacky; we're hijacking Mongoid::Errors::MongoidError in
-          # order to get the spiffy error message translation. If we later
-          # decide to raise an error instead of just writing a message, we can
-          # subclass MongoidError and raise that exception here.
-          message = Errors::MongoidError.new.compose_message(
-            'client_session_mismatch',
-            model: self.class.name
-          )
-          logger.info(message)
-        end
+        return unless session.nil?
+
+        # This is hacky; we're hijacking Mongoid::Errors::MongoidError in
+        # order to get the spiffy error message translation. If we later
+        # decide to raise an error instead of just writing a message, we can
+        # subclass MongoidError and raise that exception here.
+        message = Errors::MongoidError.new.compose_message(
+          'client_session_mismatch',
+          model: self.class.name
+        )
+        logger.info(message)
       end
     end
   end

data/lib/mongoid/clients/storage_options.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Clients
-
     # Mixin module included into Mongoid::Document which adds
     # the ability to set the collection in which to store the
     # document by default.
@@ -46,7 +44,6 @@ module Mongoid
       end
 
       module ClassMethods
-
         # Give this model specific custom default storage options.
         #
         # @example Store this model by default in "artists"
@@ -82,7 +79,7 @@ module Mongoid
         # @return [ Class ] The model class.
         def store_in(options)
           Validators::Storage.validate(self, options)
-          self.storage_options = self.storage_options.merge(options)
+          self.storage_options = storage_options.merge(options)
         end
 
         # Reset the store_in options

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

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Clients
     module Validators
-
       # Validates the options passed to :store_in.
       module Storage
         extend self
 
         # The valid options for storage.
-        VALID_OPTIONS = [ :collection, :collection_options, :database, :client ].freeze
+        VALID_OPTIONS = %i[collection collection_options database client].freeze
 
         # Validate the options provided to :store_in.
         #
@@ -37,6 +35,7 @@ module Mongoid
         # @return [ true | false ] If all keys are valid.
         def valid_keys?(options)
           return false unless options.is_a?(::Hash)
+
           options.keys.all? do |key|
             VALID_OPTIONS.include?(key)
           end

data/lib/mongoid/clients/validators.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/clients/validators/storage"
+require 'mongoid/clients/validators/storage'

data/lib/mongoid/clients.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/clients/factory"
-require "mongoid/clients/validators"
-require "mongoid/clients/storage_options"
-require "mongoid/clients/options"
-require "mongoid/clients/sessions"
+require 'mongoid/clients/factory'
+require 'mongoid/clients/validators'
+require 'mongoid/clients/storage_options'
+require 'mongoid/clients/options'
+require 'mongoid/clients/sessions'
 
 module Mongoid
-
   # Mixin module included into Mongoid::Document which adds
   # database client connection functionality. Also contains
   # singleton class methods related to managing database clients.
@@ -19,7 +17,6 @@ module Mongoid
     include Sessions
 
     class << self
-
       # Clear all clients from the current thread.
       #
       # @example Clear all clients.
@@ -75,8 +72,10 @@ module Mongoid
       def with_name(name)
         name_as_symbol = name.to_sym
         return clients[name_as_symbol] if clients[name_as_symbol]
+
         CREATE_LOCK.synchronize do
-          if (key_vault_client = Mongoid.clients.dig(name_as_symbol, :options, :auto_encryption_options, :key_vault_client))
+          if (key_vault_client = Mongoid.clients.dig(name_as_symbol, :options, :auto_encryption_options,
+                                                     :key_vault_client))
             clients[key_vault_client.to_sym] ||= Clients::Factory.create(key_vault_client)
           end
           clients[name_as_symbol] ||= Clients::Factory.create(name)
@@ -103,8 +102,6 @@ module Mongoid
         @clients ||= {}
       end
 
-      private
-
       CREATE_LOCK = Mutex.new
     end
   end

data/lib/mongoid/collection_configurable.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # Encapsulates behavior around defining collections.
   module CollectionConfigurable
     extend ActiveSupport::Concern
@@ -26,22 +24,20 @@ module Mongoid
           # This is most probably an anonymous class, we ignore them.
           return
         end
-        if collection_name.match(/^system\./)
+        if /^system\./.match?(collection_name)
           # We do not do anything with system collections.
           return
         end
-        if force
-          collection.drop
-        end
+
+        collection.drop if force
         if coll_options = collection.database.list_collections(filter: { name: collection_name.to_s }).first
-          if force
-            raise Errors::DropCollectionFailure.new(collection_name)
-          else
-            logger.debug(
-              "MONGOID: Collection '#{collection_name}' already exists " +
-              "in database '#{database_name}' with options '#{coll_options}'."
-            )
-          end
+          raise Errors::DropCollectionFailure.new(collection_name) if force
+
+          logger.debug(
+            "MONGOID: Collection '#{collection_name}' already exists " +
+            "in database '#{database_name}' with options '#{coll_options}'."
+          )
+
         else
           begin
             collection.database[collection_name, storage_options.fetch(:collection_options, {})].create