mongo 2.22.0 → 2.24.0

data/lib/mongo/protocol/query.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   module Protocol
-
     # MongoDB Wire protocol Query message.
     #
     # This is a client request message that is sent to the server in order
@@ -64,20 +62,19 @@ module Mongo
       def initialize(database, collection, selector, options = {})
         @database = database
         @namespace = "#{database}.#{collection}"
-        if selector.nil?
-          raise ArgumentError, 'Selector cannot be nil'
-        end
+        raise ArgumentError, 'Selector cannot be nil' if selector.nil?
+
         @selector = selector
         @options = options
         @project = options[:project]
         @limit = determine_limit
-        @skip = options[:skip]  || 0
+        @skip = options[:skip] || 0
         @flags = options[:flags] || []
         @upconverter = Upconverter.new(
           collection,
           BSON::Document.new(selector),
           BSON::Document.new(options),
-          flags,
+          flags
         )
         super
       end
@@ -163,9 +160,9 @@ module Mongo
           doc.to_bson.length > max_bson_size
         end
 
-        if contains_too_large_document
-          raise Error::MaxBSONSize.new('The document exceeds maximum allowed BSON object size after serialization')
-        end
+        return unless contains_too_large_document
+
+        raise Error::MaxBSONSize.new('The document exceeds maximum allowed BSON object size after serialization')
       end
 
       # The operation code required to specify a Query message.
@@ -180,15 +177,15 @@ module Mongo
 
       # Available flags for a Query message.
       # @api private
-      FLAGS = [
-        :reserved,
-        :tailable_cursor,
-        :secondary_ok,
-        :oplog_replay,
-        :no_cursor_timeout,
-        :await_data,
-        :exhaust,
-        :partial
+      FLAGS = %i[
+        reserved
+        tailable_cursor
+        secondary_ok
+        oplog_replay
+        no_cursor_timeout
+        await_data
+        exhaust
+        partial
       ]
 
       # @!attribute
@@ -215,20 +212,19 @@ module Mongo
       # @return [Hash] The projection.
       field :project, Document
 
-      # Converts legacy query messages to the appropriare OP_COMMAND style
+      # Converts legacy query messages to the appropriate OP_COMMAND style
       # message.
       #
       # @since 2.1.0
       class Upconverter
-
         # Mappings of the options to the find command options.
         #
         # @since 2.1.0
         OPTION_MAPPINGS = {
-          :project => 'projection',
-          :skip => 'skip',
-          :limit => 'limit',
-          :batch_size => 'batchSize'
+          project: 'projection',
+          skip: 'skip',
+          limit: 'limit',
+          batch_size: 'batchSize'
         }.freeze
 
         SPECIAL_FIELD_MAPPINGS = {
@@ -250,11 +246,11 @@ module Mongo
         #
         # @since 2.1.0
         FLAG_MAPPINGS = {
-          :tailable_cursor => 'tailable',
-          :oplog_replay => 'oplogReplay',
-          :no_cursor_timeout => 'noCursorTimeout',
-          :await_data => 'awaitData',
-          :partial => 'allowPartialResults'
+          tailable_cursor: 'tailable',
+          oplog_replay: 'oplogReplay',
+          no_cursor_timeout: 'noCursorTimeout',
+          await_data: 'awaitData',
+          partial: 'allowPartialResults'
         }.freeze
 
         # @return [ String ] collection The name of the collection.
@@ -284,12 +280,9 @@ module Mongo
           # Although the docstring claims both hashes and BSON::Documents
           # are acceptable, this class expects the filter and options to
           # contain symbol keys which isn't what the operation layer produces.
-          unless BSON::Document === filter
-            raise ArgumentError, 'Filter must provide indifferent access'
-          end
-          unless BSON::Document === options
-            raise ArgumentError, 'Options must provide indifferent access'
-          end
+          raise ArgumentError, 'Filter must provide indifferent access' unless filter.is_a?(BSON::Document)
+          raise ArgumentError, 'Options must provide indifferent access' unless options.is_a?(BSON::Document)
+
           @collection = collection
           @filter = filter
           @options = options
@@ -342,16 +335,14 @@ module Mongo
         def find_command
           document = BSON::Document.new(
             find: collection,
-            filter: query_filter,
+            filter: query_filter
           )
           OPTION_MAPPINGS.each do |legacy, option|
             document.store(option, options[legacy]) unless options[legacy].nil?
           end
           if Lint.enabled?
-            filter.each do |k, v|
-              unless String === k
-                raise Error::LintError, "All keys in filter must be strings: #{filter.inspect}"
-              end
+            filter.each do |k, _v|
+              raise Error::LintError, "All keys in filter must be strings: #{filter.inspect}" unless k.is_a?(String)
             end
           end
           Lint.validate_camel_case_read_preference(filter['readPreference'])

data/lib/mongo/protocol/registry.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
@@ -16,9 +15,7 @@
 # limitations under the License.
 
 module Mongo
-
   module Protocol
-
     # Provides a registry for looking up a message class based on op code.
     #
     # @since 2.5.0
@@ -38,7 +35,7 @@ module Mongo
       # @return [ Class ] The corresponding Ruby class for the message type.
       #
       # @since 2.5.0
-      def get(op_code, message = nil)
+      def get(op_code, _message = nil)
         if type = MAPPINGS[op_code]
           type
         else
@@ -65,7 +62,7 @@ module Mongo
       private
 
       def define_type_reader(type)
-        type.module_eval <<-MOD
+        type.module_eval <<-MOD, __FILE__, __LINE__ + 1
           def op_code; OP_CODE; end
         MOD
       end

data/lib/mongo/protocol/reply.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   module Protocol
-
     # The MongoDB wire protocol message representing a reply
     #
     # @example
@@ -28,7 +26,6 @@ module Mongo
     #
     # @api semipublic
     class Reply < Message
-
       # Determine if the reply had a query failure flag.
       #
       # @example Did the reply have a query failure.
@@ -81,15 +78,13 @@ module Mongo
       OP_CODE = 1
 
       # Available flags for a Reply message.
-      FLAGS = [
-        :cursor_not_found,
-        :query_failure,
-        :shard_config_stale,
-        :await_capable
+      FLAGS = %i[
+        cursor_not_found
+        query_failure
+        shard_config_stale
+        await_capable
       ]
 
-      public
-
       # @!attribute
       # @return [Array<Symbol>] The flags for this reply.
       #
@@ -118,26 +113,25 @@ module Mongo
       #
       # @since 2.1.0
       class Upconverter
-
         # Next batch constant.
         #
         # @since 2.1.0
-        NEXT_BATCH = 'nextBatch'.freeze
+        NEXT_BATCH = 'nextBatch'
 
         # First batch constant.
         #
         # @since 2.1.0
-        FIRST_BATCH = 'firstBatch'.freeze
+        FIRST_BATCH = 'firstBatch'
 
         # Cursor field constant.
         #
         # @since 2.1.0
-        CURSOR = 'cursor'.freeze
+        CURSOR = 'cursor'
 
         # Id field constant.
         #
         # @since 2.1.0
-        ID = 'id'.freeze
+        ID = 'id'
 
         # Initialize the new upconverter.
         #
@@ -179,7 +173,7 @@ module Mongo
         private
 
         def batch_field
-          starting_from > 0 ? NEXT_BATCH : FIRST_BATCH
+          (starting_from > 0) ? NEXT_BATCH : FIRST_BATCH
         end
 
         def command?

data/lib/mongo/protocol/serializers.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,13 +16,12 @@
 
 module Mongo
   module Protocol
-
     # Container for various serialization strategies
     #
-    # Each strategy must have a serialization method named +serailize+
+    # Each strategy must have a serialization method named +serialize+
     # and a deserialization method named +deserialize+
     #
-    # Serialize methods must take buffer and value arguements and
+    # Serialize methods must take buffer and value arguments and
     # serialize the value into the buffer
     #
     # Deserialize methods must take an IO stream argument and
@@ -31,14 +29,11 @@ module Mongo
     #
     # @api private
     module Serializers
-
-      private
-
-      ZERO = 0.freeze
+      ZERO = 0
       NULL = 0.chr.freeze
-      INT32_PACK = 'l<'.freeze
-      INT64_PACK = 'q<'.freeze
-      HEADER_PACK = 'l<l<l<l<'.freeze
+      INT32_PACK = 'l<'
+      INT64_PACK = 'q<'
+      HEADER_PACK = 'l<l<l<l<'
 
       # MongoDB wire protocol serialization strategy for message headers.
       #
@@ -46,7 +41,6 @@ module Mongo
       # of the length of the message, the request id, the response id,
       # and the op code for the operation.
       module Header
-
         # Serializes the header value into the buffer
         #
         # @param buffer [ String ] Buffer to receive the serialized value.
@@ -55,7 +49,7 @@ module Mongo
         #   This option is deprecated and will not be used. It will removed in version 3.0.
         #
         # @return [ String ] Buffer with serialized value.
-        def self.serialize(buffer, value, validating_keys = nil)
+        def self.serialize(buffer, value, _validating_keys = nil)
           buffer.put_bytes(value.pack(HEADER_PACK))
         end
 
@@ -66,7 +60,7 @@ module Mongo
         #
         # @return [ Array<Fixnum> ] Array consisting of the deserialized
         #   length, request id, response id, and op code.
-        def self.deserialize(buffer, options = {})
+        def self.deserialize(buffer, _options = {})
           buffer.get_bytes(16).unpack(HEADER_PACK)
         end
       end
@@ -75,14 +69,13 @@ module Mongo
       #
       # Serializes and de-serializes C style strings (null terminated).
       module CString
-
         # Serializes a C style string into the buffer
         #
         # @param buffer [ String ] Buffer to receive the serialized CString.
         # @param value [ String ] The string to be serialized.
         #
         # @return [ String ] Buffer with serialized value.
-        def self.serialize(buffer, value, validating_keys = nil)
+        def self.serialize(buffer, value, _validating_keys = nil)
           buffer.put_cstring(value)
         end
       end
@@ -91,14 +84,13 @@ module Mongo
       #
       # Serializes and de-serializes one 32-bit Zero.
       module Zero
-
         # Serializes a 32-bit Zero into the buffer
         #
         # @param buffer [ String ] Buffer to receive the serialized Zero.
         # @param value [ Fixnum ] Ignored value.
         #
         # @return [ String ] Buffer with serialized value.
-        def self.serialize(buffer, value, validating_keys = nil)
+        def self.serialize(buffer, _value, _validating_keys = nil)
           buffer.put_int32(ZERO)
         end
       end
@@ -107,21 +99,20 @@ module Mongo
       #
       # Serializes and de-serializes one 32-bit integer.
       module Int32
-
         # Serializes a number to a 32-bit integer
         #
         # @param buffer [ String ] Buffer to receive the serialized Int32.
         # @param value [ Integer | BSON::Int32 ] 32-bit integer to be serialized.
         #
         # @return [String] Buffer with serialized value.
-        def self.serialize(buffer, value, validating_keys = nil)
+        def self.serialize(buffer, value, _validating_keys = nil)
           if value.is_a?(BSON::Int32)
-            if value.respond_to?(:value)
-              # bson-ruby >= 4.6.0
-              value = value.value
-            else
-              value = value.instance_variable_get('@integer')
-            end
+            value = if value.respond_to?(:value)
+                      # bson-ruby >= 4.6.0
+                      value.value
+                    else
+                      value.instance_variable_get(:@integer)
+                    end
           end
           buffer.put_int32(value)
         end
@@ -132,7 +123,7 @@ module Mongo
         # @param [ Hash ] options This method currently accepts no options.
         #
         # @return [ Fixnum ] Deserialized Int32
-        def self.deserialize(buffer, options = {})
+        def self.deserialize(buffer, _options = {})
           buffer.get_int32
         end
       end
@@ -141,21 +132,20 @@ module Mongo
       #
       # Serializes and de-serializes one 64-bit integer.
       module Int64
-
         # Serializes a number to a 64-bit integer
         #
         # @param buffer [ String ] Buffer to receive the serialized Int64.
         # @param value [ Integer | BSON::Int64 ] 64-bit integer to be serialized.
         #
         # @return [ String ] Buffer with serialized value.
-        def self.serialize(buffer, value, validating_keys = nil)
+        def self.serialize(buffer, value, _validating_keys = nil)
           if value.is_a?(BSON::Int64)
-            if value.respond_to?(:value)
-              # bson-ruby >= 4.6.0
-              value = value.value
-            else
-              value = value.instance_variable_get('@integer')
-            end
+            value = if value.respond_to?(:value)
+                      # bson-ruby >= 4.6.0
+                      value.value
+                    else
+                      value.instance_variable_get(:@integer)
+                    end
           end
           buffer.put_int64(value)
         end
@@ -166,7 +156,7 @@ module Mongo
         # @param [ Hash ] options This method currently accepts no options.
         #
         # @return [Fixnum] Deserialized Int64.
-        def self.deserialize(buffer, options = {})
+        def self.deserialize(buffer, _options = {})
           buffer.get_int64
         end
       end
@@ -177,7 +167,6 @@ module Mongo
       #
       # @since 2.5.0
       module Sections
-
         # Serializes the sections of an OP_MSG, payload type 0 or 1.
         #
         # @param [ BSON::ByteBuffer ] buffer Buffer to receive the serialized Sections.
@@ -189,7 +178,7 @@ module Mongo
         # @return [ BSON::ByteBuffer ] Buffer with serialized value.
         #
         # @since 2.5.0
-        def self.serialize(buffer, value, max_bson_size = nil, validating_keys = nil)
+        def self.serialize(buffer, value, max_bson_size = nil, _validating_keys = nil)
           value.each do |section|
             case section[:type]
             when PayloadZero::TYPE
@@ -217,7 +206,7 @@ module Mongo
         #
         # @since 2.5.0
         def self.deserialize(buffer, options = {})
-          end_length = (@flag_bits & Msg::FLAGS.index(:checksum_present)) == 1 ? 32 : 0
+          end_length = ((@flag_bits & Msg::FLAGS.index(:checksum_present)) == 1) ? 32 : 0
           sections = []
           until buffer.length == end_length
             case byte = buffer.get_byte
@@ -245,7 +234,6 @@ module Mongo
         #
         # @since 2.5.0
         module PayloadZero
-
           # The byte identifier for this payload type.
           #
           # @since 2.5.0
@@ -267,7 +255,7 @@ module Mongo
           # @return [ BSON::ByteBuffer ] Buffer with serialized value.
           #
           # @since 2.5.0
-          def self.serialize(buffer, value, max_bson_size = nil, validating_keys = nil)
+          def self.serialize(buffer, value, max_bson_size = nil, _validating_keys = nil)
             buffer.put_byte(TYPE_BYTE)
             Serializers::Document.serialize(buffer, value, max_bson_size)
           end
@@ -286,7 +274,7 @@ module Mongo
           # @since 2.5.0
           def self.deserialize(buffer, options = {})
             mode = options[:deserialize_as_bson] ? :bson : nil
-            BSON::Document.from_bson(buffer, **{ mode: mode })
+            BSON::Document.from_bson(buffer, mode: mode)
           end
         end
 
@@ -294,7 +282,6 @@ module Mongo
         #
         # @since 2.5.0
         module PayloadOne
-
           # The byte identifier for this payload type.
           #
           # @since 2.5.0
@@ -316,7 +303,7 @@ module Mongo
           # @return [ BSON::ByteBuffer ] Buffer with serialized value.
           #
           # @since 2.5.0
-          def self.serialize(buffer, value, max_bson_size = nil, validating_keys = nil)
+          def self.serialize(buffer, value, max_bson_size = nil, _validating_keys = nil)
             buffer.put_byte(TYPE_BYTE)
             start = buffer.length
             buffer.put_int32(0) # hold for size
@@ -342,9 +329,7 @@ module Mongo
             end_size = start_size - section_size
             buffer.get_cstring # get the identifier
             documents = []
-            until buffer.length == end_size
-              documents << BSON::Document.from_bson(buffer)
-            end
+            documents << BSON::Document.from_bson(buffer) until buffer.length == end_size
             documents
           end
         end
@@ -354,21 +339,20 @@ module Mongo
       #
       # Serializes and de-serializes a single document.
       module Document
-
         # Serializes a document into the buffer
         #
         # @param buffer [ String ] Buffer to receive the BSON encoded document.
         # @param value [ Hash ] Document to serialize as BSON.
         #
         # @return [ String ] Buffer with serialized value.
-        def self.serialize(buffer, value, max_bson_size = nil, validating_keys = nil)
+        def self.serialize(buffer, value, max_bson_size = nil, _validating_keys = nil)
           start_size = buffer.length
           value.to_bson(buffer)
           serialized_size = buffer.length - start_size
-          if max_bson_size && serialized_size > max_bson_size
-            raise Error::MaxBSONSize,
-              "The document exceeds maximum allowed BSON object size after serialization. Serialized size: #{serialized_size} bytes, maximum allowed size: #{max_bson_size} bytes"
-          end
+          return unless max_bson_size && serialized_size > max_bson_size
+
+          raise Error::MaxBSONSize,
+                "The document exceeds maximum allowed BSON object size after serialization. Serialized size: #{serialized_size} bytes, maximum allowed size: #{max_bson_size} bytes"
         end
 
         # Deserializes a document from the IO stream
@@ -383,7 +367,7 @@ module Mongo
         # @return [ Hash ] The decoded BSON document.
         def self.deserialize(buffer, options = {})
           mode = options[:deserialize_as_bson] ? :bson : nil
-          BSON::Document.from_bson(buffer, **{ mode: mode })
+          BSON::Document.from_bson(buffer, mode: mode)
         end
 
         # Whether there can be a size limit on this type after serialization.
@@ -400,7 +384,6 @@ module Mongo
       #
       # Writes and fetches a single byte from the byte buffer.
       module Byte
-
         # Writes a byte into the buffer.
         #
         # @param [ BSON::ByteBuffer ] buffer Buffer to receive the single byte.
@@ -411,7 +394,7 @@ module Mongo
         # @return [ BSON::ByteBuffer ] Buffer with serialized value.
         #
         # @since 2.5.0
-        def self.serialize(buffer, value, validating_keys = nil)
+        def self.serialize(buffer, value, _validating_keys = nil)
           buffer.put_byte(value)
         end
 
@@ -423,7 +406,7 @@ module Mongo
         # @return [ String ] The byte.
         #
         # @since 2.5.0
-        def self.deserialize(buffer, options = {})
+        def self.deserialize(buffer, _options = {})
           buffer.get_byte
         end
       end
@@ -432,7 +415,6 @@ module Mongo
       #
       # Writes and fetches bytes from the byte buffer.
       module Bytes
-
         # Writes bytes into the buffer.
         #
         # @param [ BSON::ByteBuffer ] buffer Buffer to receive the bytes.
@@ -443,7 +425,7 @@ module Mongo
         # @return [ BSON::ByteBuffer ] Buffer with serialized value.
         #
         # @since 2.5.0
-        def self.serialize(buffer, value, validating_keys = nil)
+        def self.serialize(buffer, value, _validating_keys = nil)
           buffer.put_bytes(value)
         end
 

data/lib/mongo/protocol.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Wire Protocol Base
 require 'mongo/protocol/serializers'

data/lib/mongo/query_cache.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB, Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module QueryCache
     class << self
-
       # Set whether the cache is enabled.
       #
       # @example Set if the cache is enabled.
@@ -26,7 +24,7 @@ module Mongo
       #
       # @param [ true, false ] value The enabled value.
       def enabled=(value)
-        Thread.current["[mongo]:query_cache:enabled"] = value
+        Thread.current['[mongo]:query_cache:enabled'] = value
       end
 
       # Is the query cache enabled on the current thread?
@@ -36,7 +34,7 @@ module Mongo
       #
       # @return [ true, false ] If the cache is enabled.
       def enabled?
-        !!Thread.current["[mongo]:query_cache:enabled"]
+        !!Thread.current['[mongo]:query_cache:enabled']
       end
 
       # Execute the block while using the query cache.
@@ -78,7 +76,7 @@ module Mongo
       #
       # @return [ Hash ] The hash of cached queries.
       private def cache_table
-        Thread.current["[mongo]:query_cache"] ||= {}
+        Thread.current['[mongo]:query_cache'] ||= {}
       end
 
       # Clear the query cache.
@@ -88,7 +86,7 @@ module Mongo
       #
       # @return [ nil ] Always nil.
       def clear
-        Thread.current["[mongo]:query_cache"] = nil
+        Thread.current['[mongo]:query_cache'] = nil
       end
 
       # Clear the section of the query cache storing cursors with results
@@ -205,8 +203,6 @@ module Mongo
           caching_cursor
         elsif limit.nil? && caching_cursor_limit.nil?
           caching_cursor
-        else
-          nil
         end
       end
 
@@ -214,6 +210,7 @@ module Mongo
         return nil unless limit
         # For the purposes of caching, a limit of 0 means no limit, as mongo treats it as such.
         return nil if limit == 0
+
         # For the purposes of caching, a negative limit is the same as as a positive limit.
         limit.abs
       end
@@ -221,12 +218,8 @@ module Mongo
       private
 
       def cache_key(**opts)
-        unless opts[:namespace]
-          raise ArgumentError.new("Cannot generate cache key without namespace")
-        end
-        unless opts[:selector]
-          raise ArgumentError.new("Cannot generate cache key without selector")
-        end
+        raise ArgumentError.new('Cannot generate cache key without namespace') unless opts[:namespace]
+        raise ArgumentError.new('Cannot generate cache key without selector') unless opts[:selector]
 
         [
           opts[:namespace],
@@ -254,7 +247,6 @@ module Mongo
 
     # Rack middleware that activates the query cache for each request.
     class Middleware
-
       # Instantiate the middleware.
       #
       # @example Create the new middleware.