mongoid 9.0.11 → 9.1.0

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

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/atomic/paths/embedded/one"
-require "mongoid/atomic/paths/embedded/many"
+require 'mongoid/atomic/paths/embedded/one'
+require 'mongoid/atomic/paths/embedded/many'
 
 module Mongoid
   module Atomic
     module Paths
-
       # Common functionality between the two different embedded paths.
       module Embedded
-
         attr_reader :delete_modifier, :document, :insert_modifier, :parent
 
         # Get the path to the document in the hierarchy.
@@ -20,7 +17,7 @@ module Mongoid
         #
         # @return [ String ] The path to the document.
         def path
-          @path ||= position.sub(/\.\d+\z/, "")
+          @path ||= position.sub(/\.\d+\z/, '')
         end
       end
     end

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

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Atomic
     module Paths
-
       # This class encapsulates behavior for locating and updating root
       # documents atomically.
       class Root
-
         attr_reader :document, :path, :position
 
         # Create the new root path utility.
@@ -18,7 +15,7 @@ module Mongoid
         #
         # @param [ Document ] document The document to generate the paths for.
         def initialize(document)
-          @document, @path, @position = document, "", ""
+          @document, @path, @position = document, '', ''
         end
 
         # Asking for the insert modifier on a document with a root path

data/lib/mongoid/atomic/paths.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/atomic/paths/embedded"
-require "mongoid/atomic/paths/root"
+require 'mongoid/atomic/paths/embedded'
+require 'mongoid/atomic/paths/root'

data/lib/mongoid/atomic.rb

@@ -110,9 +110,6 @@ module Mongoid
     #   exactly. Instead, we assume that two updates conflict if the
     #   first component of the two key paths matches.
     #
-    # @example Get the updates that need to occur.
-    #   person.atomic_updates(children)
-    #
     # @return [ Hash ] The updates and their modifiers.
     #
     # rubocop:disable Style/OptionalBooleanParameter

data/lib/mongoid/attributes/dynamic.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Attributes
-
     # This module contains the behavior for dynamic attributes.
     module Dynamic
       extend ActiveSupport::Concern
@@ -88,10 +86,10 @@ module Mongoid
       # @param [ Object ] value The value of the field.
       def process_attribute(name, value)
         responds = respond_to?("#{name}=")
-        if !responds
-          write_attribute(name, value)
-        else
+        if responds
           send("#{name}=", value)
+        else
+          write_attribute(name, value)
         end
       end
 
@@ -102,8 +100,8 @@ module Mongoid
       #
       # @return [ String ] An array of pretty printed dynamic field values.
       def inspect_dynamic_fields
-        keys = attributes.keys - fields.keys - relations.keys - ["_id", self.class.discriminator_key]
-        return keys.map do |name|
+        keys = attributes.keys - fields.keys - relations.keys - [ '_id', self.class.discriminator_key ]
+        keys.map do |name|
           "#{name}: #{attributes[name].inspect}"
         end
       end
@@ -122,6 +120,7 @@ module Mongoid
       def method_missing(name, *args)
         attr = name.to_s
         return super unless attributes.has_key?(attr.reader)
+
         if attr.writer?
           getter = attr.reader
           define_dynamic_writer(getter)

data/lib/mongoid/attributes/nested.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Attributes
-
     # Defines behavior for the Rails nested attributes feature.
     module Nested
       extend ActiveSupport::Concern
@@ -14,8 +12,7 @@ module Mongoid
       end
 
       module ClassMethods
-
-        REJECT_ALL_BLANK_PROC = ->(attributes){
+        REJECT_ALL_BLANK_PROC = lambda { |attributes|
           attributes.all? { |key, value| key == '_destroy' || value.blank? }
         }
 
@@ -52,16 +49,17 @@ module Mongoid
           options[:reject_if] = REJECT_ALL_BLANK_PROC if options[:reject_if] == :all_blank
           args.each do |name|
             meth = "#{name}_attributes="
-            self.nested_attributes["#{name}_attributes"] = meth
+            nested_attributes["#{name}_attributes"] = meth
             association = relations[name.to_s]
             raise Errors::NestedAttributesMetadataNotFound.new(self, name) unless association
+
             autosave_nested_attributes(association) if options[:autosave]
 
             re_define_method(meth) do |attrs|
               _assigning do
                 if association.polymorphic? and association.inverse_type
                   klass = association.resolver.model_for(send(association.inverse_type))
-                  options = options.merge!(:class_name => klass)
+                  options = options.merge!(class_name: klass)
                 end
                 association.nested_builder(attrs, options).build(self)
               end
@@ -84,10 +82,10 @@ module Mongoid
           # marked as autosave despite the fact that the option isn't present. Because the method
           # Association#autosave? is implemented by checking the autosave option, this is the most
           # straightforward way to mark it.
-          if association.autosave? || (association.options[:autosave].nil? && !association.embedded?)
-            association.options[:autosave] = true
-            Association::Referenced::AutoSave.define_autosave!(association)
-          end
+          return unless association.autosave? || (association.options[:autosave].nil? && !association.embedded?)
+
+          association.options[:autosave] = true
+          Association::Referenced::AutoSave.define_autosave!(association)
         end
       end
     end

data/lib/mongoid/attributes/projector.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Attributes
-
     # This module defines projection helpers.
     #
     # Projection rules are rather non-trivial. See
@@ -32,8 +30,7 @@ module Mongoid
         end
       end
 
-      attr_reader :id_projection_value
-      attr_reader :content_projection
+      attr_reader :id_projection_value, :content_projection
 
       # Determine if the specified attribute, or a dot notation path, is allowed
       # by the configured projection, if any.
@@ -48,11 +45,7 @@ module Mongoid
       def attribute_or_path_allowed?(name)
         # Special handling for _id.
         if name == '_id'
-          result = unless id_projection_value.nil?
-            value_inclusionary?(id_projection_value)
-          else
-            true
-          end
+          result = id_projection_value.nil? || value_inclusionary?(id_projection_value)
           return result
         end
 
@@ -65,24 +58,20 @@ module Mongoid
         # Find an item which matches or is a parent of the requested name/path.
         # This handles the case when, for example, the projection was
         # {foo: true} and we want to know if foo.bar is allowed.
-        item, value = content_projection.detect do |path, value|
+        item, value = content_projection.detect do |path, _value|
           (name + '.').start_with?(path + '.')
         end
-        if item
-          return value_inclusionary?(value)
-        end
+        return value_inclusionary?(value) if item
 
         if content_inclusionary?
           # Find an item which would be a strict child of the requested name/path.
           # This handles the case when, for example, the projection was
           # {"foo.bar" => true} and we want to know if foo is allowed.
           # (It is as a container of bars.)
-          item, value = content_projection.detect do |path, value|
+          item, = content_projection.detect do |path, _value|
             (path + '.').start_with?(name + '.')
           end
-          if item
-            return true
-          end
+          return true if item
         end
 
         !content_inclusionary?
@@ -94,9 +83,7 @@ module Mongoid
       #
       # An empty projection is inclusionary.
       def content_inclusionary?
-        if content_projection.empty?
-          return value_inclusionary?(id_projection_value)
-        end
+        return value_inclusionary?(id_projection_value) if content_projection.empty?
 
         value_inclusionary?(content_projection.values.first)
       end

data/lib/mongoid/attributes/readonly.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Attributes
-
     # This module defines behavior for readonly attributes.
     module Readonly
       extend ActiveSupport::Concern
@@ -30,11 +28,9 @@ module Mongoid
 
       def as_writable_attribute!(name, value = :nil)
         normalized_name = database_field_name(name)
-        if attribute_writable?(normalized_name)
-          yield(normalized_name)
-        else
-          raise Errors::ReadonlyAttribute.new(name, value)
-        end
+        raise Errors::ReadonlyAttribute.new(name, value) unless attribute_writable?(normalized_name)
+
+        yield(normalized_name)
       end
 
       def _loaded?(name)
@@ -47,7 +43,6 @@ module Mongoid
       end
 
       module ClassMethods
-
         # Defines an attribute as readonly. This will ensure that the value for
         # the attribute is only set when the document is new or we are
         # creating. In other cases, the field write will be ignored with the
@@ -68,12 +63,12 @@ module Mongoid
         # parent's readonly attributes at the time of its creation.
         # Updating the parent does not propagate down to child classes after wards.
         def attr_readonly(*names)
-          self.readonly_attributes = self.readonly_attributes.dup
+          self.readonly_attributes = readonly_attributes.dup
           names.each do |name|
-            self.readonly_attributes << database_field_name(name)
+            readonly_attributes << database_field_name(name)
           end
         end
       end
     end
   end
-end
+end

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)