mongo 2.22.0 → 2.24.0

data/lib/mongo/error/unknown_payload_type.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   class Error
-
     # Raised if an unknown payload type is encountered when an OP_MSG is created or read.
     #
     # @since 2.5.0
     class UnknownPayloadType < Error
-
       # The error message.
       #
       # @since 2.5.0

data/lib/mongo/error/unmet_dependency.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Raised if an optional dependency of the driver is not met.
     class UnmetDependency < Error; end
   end

data/lib/mongo/error/unsupported_array_filters.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,43 +16,23 @@
 
 module Mongo
   class Error
-
     # Raised if the array filters option is specified for an operation but the server
     # selected does not support array filters.
     #
     # @since 2.5.0
     #
-    # @deprecated RUBY-2260 In driver version 3.0, this error class will be 
+    # @deprecated RUBY-2260 In driver version 3.0, this error class will be
     #   replaced with UnsupportedOption. To handle this error, catch
     #   Mongo::Error::UnsupportedOption, which will prevent any breaking changes
     #   in your application when upgrading to version 3.0 of the driver.
     class UnsupportedArrayFilters < UnsupportedOption
-
-      # The default error message describing that array filters are not supported.
-      #
-      # @return [ String ] A default message describing that array filters are not supported by the server.
-      #
-      # @since 2.5.0
-      DEFAULT_MESSAGE = "The array_filters option is not a supported feature of the server handling this operation. " +
-          "Operation results may be unexpected.".freeze
-
       # The error message describing that array filters cannot be used when write concern is unacknowledged.
       #
       # @return [ String ] A message describing that array filters cannot be used when write concern is unacknowledged.
       #
       # @since 2.5.0
-      UNACKNOWLEDGED_WRITES_MESSAGE = "The array_filters option cannot be specified when using unacknowledged writes. " +
-        "Either remove the array_filters option or use acknowledged writes (w >= 1).".freeze
-
-      # Create the new exception.
-      #
-      # @example Create the new exception.
-      #   Mongo::Error::UnsupportedArrayFilters.new
-      #
-      # @since 2.5.0
-      def initialize(message = nil)
-        super(message || DEFAULT_MESSAGE)
-      end
+      UNACKNOWLEDGED_WRITES_MESSAGE = 'The array_filters option cannot be specified when using unacknowledged writes. ' +
+                                      'Either remove the array_filters option or use acknowledged writes (w >= 1).'
     end
   end
 end

data/lib/mongo/error/unsupported_collation.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,43 +16,23 @@
 
 module Mongo
   class Error
-
     # Raised if a collation is specified for an operation but the server selected does not
     # support collations.
     #
     # @since 2.4.0
     #
-    # @deprecated RUBY-2260 In driver version 3.0, this error class will be 
+    # @deprecated RUBY-2260 In driver version 3.0, this error class will be
     #   replaced with UnsupportedOption. To handle this error, catch
     #   Mongo::Error::UnsupportedOption, which will prevent any breaking changes
     #   in your application when upgrading to version 3.0 of the driver.
     class UnsupportedCollation < UnsupportedOption
-
-      # The default error message describing that collations is not supported.
-      #
-      # @return [ String ] A default message describing that collations is not supported by the server.
-      #
-      # @since 2.4.0
-      DEFAULT_MESSAGE = "Collations is not a supported feature of the server handling this operation. " +
-          "Operation results may be unexpected."
-
       # The error message describing that collations cannot be used when write concern is unacknowledged.
       #
       # @return [ String ] A message describing that collations cannot be used when write concern is unacknowledged.
       #
       # @since 2.4.0
-      UNACKNOWLEDGED_WRITES_MESSAGE = "A collation cannot be specified when using unacknowledged writes. " +
-        "Either remove the collation option or use acknowledged writes (w >= 1)."
-
-      # Create the new exception.
-      #
-      # @example Create the new exception.
-      #   Mongo::Error::UnsupportedCollation.new
-      #
-      # @since 2.4.0
-      def initialize(message = nil)
-        super(message || DEFAULT_MESSAGE)
-      end
+      UNACKNOWLEDGED_WRITES_MESSAGE = 'A collation cannot be specified when using unacknowledged writes. ' +
+                                      'Either remove the collation option or use acknowledged writes (w >= 1).'
     end
   end
 end

data/lib/mongo/error/unsupported_features.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Raised when the driver does not support the complete set of server
     # features.
     #

data/lib/mongo/error/unsupported_message_type.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Raised when trying to get a message type from the registry that doesn't exist.
     #
     # @since 2.5.0

data/lib/mongo/error/unsupported_option.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Raised if an unsupported option is specified for an operation.
     class UnsupportedOption < Error
       # The error message provided when the user passes the hint option to
@@ -25,38 +23,38 @@ module Mongo
       # option and does not provide option validation.
       #
       # @api private
-      HINT_MESSAGE = "The MongoDB server handling this request does not support " \
-        "the hint option on this command. The hint option is supported on update " \
-        "commands on MongoDB server versions 4.2 and later and on findAndModify " \
-        "and delete commands on MongoDB server versions 4.4 and later"
+      HINT_MESSAGE = 'The MongoDB server handling this request does not support ' \
+                     'the hint option on this command. The hint option is supported on update ' \
+                     'commands on MongoDB server versions 4.2 and later and on findAndModify ' \
+                     'and delete commands on MongoDB server versions 4.4 and later'
 
       # The error message provided when the user passes the hint option to
       # an unacknowledged write operation.
       #
       # @api private
-      UNACKNOWLEDGED_HINT_MESSAGE = "The hint option cannot be specified on " \
-        "an unacknowledged write operation. Remove the hint option or perform " \
-        "this operation with a write concern of at least { w: 1 }"
+      UNACKNOWLEDGED_HINT_MESSAGE = 'The hint option cannot be specified on ' \
+                                    'an unacknowledged write operation. Remove the hint option or perform ' \
+                                    'this operation with a write concern of at least { w: 1 }'
 
       # The error message provided when the user passes the allow_disk_use
       # option to a find operation against a server that does not support the
       # allow_disk_use operation and does not provide option validation.
       #
       # @api private
-      ALLOW_DISK_USE_MESSAGE = "The MongoDB server handling this request does " \
-        "not support the allow_disk_use option on this command. The " \
-        "allow_disk_use option is supported on find commands on MongoDB " \
-        "server versions 4.4 and later"
+      ALLOW_DISK_USE_MESSAGE = 'The MongoDB server handling this request does ' \
+                               'not support the allow_disk_use option on this command. The ' \
+                               'allow_disk_use option is supported on find commands on MongoDB ' \
+                               'server versions 4.4 and later'
 
       # The error message provided when the user passes the commit_quorum option
       # to a createIndexes operation against a server that does not support
       # that option.
       #
       # @api private
-      COMMIT_QUORUM_MESSAGE = "The MongoDB server handling this request does " \
-        "not support the commit_quorum option on this command. The commit_quorum " \
-        "option is supported on createIndexes commands on MongoDB server versions " \
-        "4.4 and later"
+      COMMIT_QUORUM_MESSAGE = 'The MongoDB server handling this request does ' \
+                              'not support the commit_quorum option on this command. The commit_quorum ' \
+                              'option is supported on createIndexes commands on MongoDB server versions ' \
+                              '4.4 and later'
 
       # Raise an error about an unsupported hint option.
       #
@@ -72,10 +70,10 @@ module Mongo
         unacknowledged_write = options[:unacknowledged_write] || false
 
         error_message = if unacknowledged_write
-          UNACKNOWLEDGED_HINT_MESSAGE
-        else
-          HINT_MESSAGE
-        end
+                          UNACKNOWLEDGED_HINT_MESSAGE
+                        else
+                          HINT_MESSAGE
+                        end
 
         new(error_message)
       end

data/lib/mongo/error/write_retryable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # A module signifying the error is always write retryable.
     #
     # @since 2.6.0

data/lib/mongo/error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -29,53 +28,41 @@ module Mongo
     # The error code field.
     #
     # @since 2.0.0
-    CODE = 'code'.freeze
+    CODE = 'code'
 
-    # An error field, MongoDB < 2.6
+    # The standard error message field
     #
     # @since 2.0.0
     # @deprecated
-    ERR = '$err'.freeze
-
-    # An error field, MongoDB < 2.4
-    #
-    # @since 2.0.0
-    # @deprecated
-    ERROR = 'err'.freeze
-
-    # The standard error message field, MongoDB 3.0+
-    #
-    # @since 2.0.0
-    # @deprecated
-    ERRMSG = 'errmsg'.freeze
+    ERRMSG = 'errmsg'
 
     # The constant for the writeErrors array.
     #
     # @since 2.0.0
     # @deprecated
-    WRITE_ERRORS = 'writeErrors'.freeze
+    WRITE_ERRORS = 'writeErrors'
 
     # The constant for a write concern error.
     #
     # @since 2.0.0
     # @deprecated
-    WRITE_CONCERN_ERROR = 'writeConcernError'.freeze
+    WRITE_CONCERN_ERROR = 'writeConcernError'
 
     # The constant for write concern errors.
     #
     # @since 2.1.0
     # @deprecated
-    WRITE_CONCERN_ERRORS = 'writeConcernErrors'.freeze
+    WRITE_CONCERN_ERRORS = 'writeConcernErrors'
 
     # Constant for an unknown error.
     #
     # @since 2.0.0
-    UNKNOWN_ERROR = 8.freeze
+    UNKNOWN_ERROR = 8
 
     # Constant for a bad value error.
     #
     # @since 2.0.0
-    BAD_VALUE = 2.freeze
+    BAD_VALUE = 2
 
     # Constant for a Cursor not found error.
     #
@@ -100,14 +87,14 @@ module Mongo
     #
     # @since 2.6.0
     # @deprecated
-    UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL = 'UnknownTransactionCommitResult'.freeze
+    UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL = 'UnknownTransactionCommitResult'
 
     # Error label describing errors that will likely not occur if a transaction is manually retried
     # from the start.
     #
     # @since 2.6.0
     # @deprecated
-    TRANSIENT_TRANSACTION_ERROR_LABEL = 'TransientTransactionError'.freeze
+    TRANSIENT_TRANSACTION_ERROR_LABEL = 'TransientTransactionError'
 
     def initialize(msg = nil)
       super
@@ -215,7 +202,6 @@ require 'mongo/error/missing_resume_token'
 require 'mongo/error/missing_scram_server_signature'
 require 'mongo/error/missing_service_id'
 require 'mongo/error/server_api_conflict'
-require 'mongo/error/server_api_not_supported'
 require 'mongo/error/server_not_usable'
 require 'mongo/error/server_timeout_error'
 require 'mongo/error/transactions_not_supported'

data/lib/mongo/event/base.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   module Event
-
     # Base class for all events.
     #
     # @since 2.6.0

data/lib/mongo/event/listeners.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   module Event
-
     # The queue of events getting processed in the client.
     #
     # @since 2.0.0
     class Listeners
-
       # Initialize the event listeners.
       #
       # @example Initialize the event listeners.

data/lib/mongo/event/publisher.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   module Event
-
     # This module is included for objects that need to publish events.
     #
     # @since 2.0.0
     module Publisher
-
       # @return [ Event::Listeners ] event_listeners The listeners.
       attr_reader :event_listeners
 

data/lib/mongo/event/subscriber.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   module Event
-
     # Adds convenience methods for adding listeners to event publishers.
     #
     # @since 2.0.0
     module Subscriber
-
       # @return [ Event::Listeners ] event_listeners The listeners.
       attr_reader :event_listeners
 
@@ -41,4 +38,3 @@ module Mongo
     end
   end
 end
-

data/lib/mongo/event.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,30 +16,29 @@
 
 module Mongo
   module Event
-
     # When a standalone is discovered.
     #
     # @since 2.0.6
     # @deprecated Will be removed in 3.0
-    STANDALONE_DISCOVERED = 'standalone_discovered'.freeze
+    STANDALONE_DISCOVERED = 'standalone_discovered'
 
     # When a server is elected primary.
     #
     # @since 2.0.0
     # @deprecated Will be removed in 3.0
-    PRIMARY_ELECTED = 'primary_elected'.freeze
+    PRIMARY_ELECTED = 'primary_elected'
 
     # When a server is discovered to be a member of a topology.
     #
     # @since 2.4.0
     # @deprecated Will be removed in 3.0
-    MEMBER_DISCOVERED = 'member_discovered'.freeze
+    MEMBER_DISCOVERED = 'member_discovered'
 
     # When a server is to be removed from a cluster.
     #
     # @since 2.0.6
     # @deprecated Will be removed in 3.0
-    DESCRIPTION_CHANGED = 'description_changed'.freeze
+    DESCRIPTION_CHANGED = 'description_changed'
   end
 end
 

data/lib/mongo/grid/file/chunk.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,21 +17,19 @@
 module Mongo
   module Grid
     class File
-
       # Encapsulates behavior around GridFS chunks of file data.
       #
       # @since 2.0.0
       class Chunk
-
         # Name of the chunks collection.
         #
         # @since 2.0.0
-        COLLECTION = 'chunks'.freeze
+        COLLECTION = 'chunks'
 
         # Default size for chunks of data.
         #
         # @since 2.0.0
-        DEFAULT_SIZE = (255 * 1024).freeze
+        DEFAULT_SIZE = (255 * 1024)
 
         # @return [ BSON::Document ] document The document to store for the
         #   chunk.
@@ -50,6 +47,7 @@ module Mongo
         # @since 2.0.0
         def ==(other)
           return false unless other.is_a?(Chunk)
+
           document == other.document
         end
 
@@ -123,10 +121,10 @@ module Mongo
         #
         # @since 2.0.0
         def initialize(document)
-          @document = BSON::Document.new(:_id => BSON::ObjectId.new).merge(document)
+          @document = BSON::Document.new(_id: BSON::ObjectId.new).merge(document)
         end
 
-        # Conver the chunk to BSON for storage.
+        # Convert the chunk to BSON for storage.
         #
         # @example Convert the chunk to BSON.
         #   chunk.to_bson
@@ -138,12 +136,11 @@ module Mongo
         # @return [ String ] The raw BSON data.
         #
         # @since 2.0.0
-        def to_bson(buffer = BSON::ByteBuffer.new, validating_keys = nil)
+        def to_bson(buffer = BSON::ByteBuffer.new, _validating_keys = nil)
           document.to_bson(buffer)
         end
 
         class << self
-
           # Takes an array of chunks and assembles them back into the full
           # piece of raw data.
           #
@@ -157,7 +154,7 @@ module Mongo
           # @since 2.0.0
           # @api private
           def assemble(chunks)
-            chunks.reduce(+''){ |data, chunk| data << chunk.data.data }
+            chunks.reduce(+'') { |data, chunk| data << chunk.data.data }
           end
 
           # Split the provided data into multiple chunks.

data/lib/mongo/grid/file/info.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module Grid
     class File
-
       # Encapsulates behavior around GridFS files collection file document.
       #
       # @since 2.0.0
@@ -26,31 +24,30 @@ module Mongo
       # @deprecated Please use the 'stream' API on a FSBucket instead.
       #   Will be removed in driver version 3.0.
       class Info
-
         # Name of the files collection.
         #
         # @since 2.0.0
-        COLLECTION = 'files'.freeze
+        COLLECTION = 'files'
 
         # Mappings of user supplied fields to db specification.
         #
         # @since 2.0.0
         MAPPINGS = {
-          :chunk_size => :chunkSize,
-          :content_type => :contentType,
-          :filename => :filename,
-          :_id => :_id,
-          :md5 => :md5,
-          :length => :length,
-          :metadata => :metadata,
-          :upload_date => :uploadDate,
-          :aliases => :aliases
+          chunk_size: :chunkSize,
+          content_type: :contentType,
+          filename: :filename,
+          _id: :_id,
+          md5: :md5,
+          length: :length,
+          metadata: :metadata,
+          upload_date: :uploadDate,
+          aliases: :aliases
         }.freeze
 
         # Default content type for stored files.
         #
         # @since 2.0.0
-        DEFAULT_CONTENT_TYPE = 'binary/octet-stream'.freeze
+        DEFAULT_CONTENT_TYPE = 'binary/octet-stream'
 
         # @return [ BSON::Document ] document The files collection document.
         attr_reader :document
@@ -67,6 +64,7 @@ module Mongo
         # @since 2.0.0
         def ==(other)
           return false unless other.is_a?(Info)
+
           document == other.document
         end
 
@@ -141,7 +139,7 @@ module Mongo
           # document contains a mix of user options and keys added
           # internally by the driver, like session.
           # Remove the keys that driver adds but keep user options.
-          document = document.reject do |key, value|
+          document = document.reject do |key, _value|
             key.to_s == 'session'
           end
           @document = default_document.merge(Options::Mapper.transform(document, MAPPINGS))
@@ -171,7 +169,7 @@ module Mongo
         def length
           document[:length]
         end
-        alias :size :length
+        alias size length
 
         # Get the additional metadata from the file information document.
         #
@@ -233,10 +231,8 @@ module Mongo
         # @return [ String ] The raw BSON data.
         #
         # @since 2.0.0
-        def to_bson(buffer = BSON::ByteBuffer.new, validating_keys = nil)
-          if @client_md5 && !document[:md5]
-            document[:md5] = @client_md5.hexdigest
-          end
+        def to_bson(buffer = BSON::ByteBuffer.new, _validating_keys = nil)
+          document[:md5] = @client_md5.hexdigest if @client_md5 && !document[:md5]
           document.to_bson(buffer)
         end
 
@@ -256,11 +252,11 @@ module Mongo
 
         def default_document
           BSON::Document.new(
-            :_id => BSON::ObjectId.new,
-            :chunkSize => Chunk::DEFAULT_SIZE,
+            _id: BSON::ObjectId.new,
+            chunkSize: Chunk::DEFAULT_SIZE,
             # MongoDB stores times with millisecond precision
-            :uploadDate => Time.now.utc.round(3),
-            :contentType => DEFAULT_CONTENT_TYPE
+            uploadDate: Time.now.utc.round(3),
+            contentType: DEFAULT_CONTENT_TYPE
           )
         end
       end