mongo 2.23.0 → 2.24.0

data/lib/mongo/collection/view/writable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,16 +17,14 @@
 module Mongo
   class Collection
     class View
-
       # Defines write related behavior for collection view.
       #
       # @since 2.0.0
       module Writable
-
         # The array filters field constant.
         #
         # @since 2.5.0
-        ARRAY_FILTERS = 'array_filters'.freeze
+        ARRAY_FILTERS = 'array_filters'
 
         # Finds a single document in the database via findAndModify and deletes
         # it, returning the original document.
@@ -64,10 +61,10 @@ module Mongo
         def find_one_and_delete(opts = {})
           with_session(opts) do |session|
             write_concern = if opts[:write_concern]
-              WriteConcern.get(opts[:write_concern])
-            else
-              write_concern_with_session(session)
-            end
+                              WriteConcern.get(opts[:write_concern])
+                            else
+                              write_concern_with_session(session)
+                            end
 
             QueryCache.clear_namespace(collection.namespace)
 
@@ -101,7 +98,7 @@ module Mongo
                 db_name: database.name,
                 write_concern: write_concern,
                 session: session,
-                txn_num: txn_num,
+                txn_num: txn_num
               ).execute_with_connection(connection, context: context)
             end
           end.first&.fetch('value', nil)
@@ -182,10 +179,10 @@ module Mongo
         def find_one_and_update(document, opts = {})
           value = with_session(opts) do |session|
             write_concern = if opts[:write_concern]
-              WriteConcern.get(opts[:write_concern])
-            else
-              write_concern_with_session(session)
-            end
+                              WriteConcern.get(opts[:write_concern])
+                            else
+                              write_concern_with_session(session)
+                            end
 
             QueryCache.clear_namespace(collection.namespace)
 
@@ -215,7 +212,7 @@ module Mongo
               selector: cmd,
               db_name: database.name,
               write_concern: write_concern,
-              session: session,
+              session: session
             )
             value = tracer.trace_operation(operation, context, op_name: 'findOneAndUpdate') do
               write_with_retry(write_concern, context: context) do |connection, txn_num, context|
@@ -223,6 +220,7 @@ module Mongo
                 if !gte_4_4 && opts[:hint] && write_concern && !write_concern.acknowledged?
                   raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
                 end
+
                 operation.txn_num = txn_num
                 operation.execute_with_connection(connection, context: context)
               end
@@ -259,10 +257,10 @@ module Mongo
         def delete_many(opts = {})
           with_session(opts) do |session|
             write_concern = if opts[:write_concern]
-              WriteConcern.get(opts[:write_concern])
-            else
-              write_concern_with_session(session)
-            end
+                              WriteConcern.get(opts[:write_concern])
+                            else
+                              write_concern_with_session(session)
+                            end
 
             QueryCache.clear_namespace(collection.namespace)
 
@@ -285,14 +283,15 @@ module Mongo
               bypass_document_validation: !!opts[:bypass_document_validation],
               session: session,
               let: opts[:let],
-              comment: opts[:comment],
+              comment: opts[:comment]
             )
             tracer.trace_operation(operation, context, op_name: 'deleteMany') do
-              nro_write_with_retry(write_concern, context: context) do |connection, txn_num, context|
+              nro_write_with_retry(write_concern, context: context) do |connection, _txn_num, context|
                 gte_4_4 = connection.server.description.server_version_gte?('4.4')
                 if !gte_4_4 && opts[:hint] && write_concern && !write_concern.acknowledged?
                   raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
                 end
+
                 operation.execute_with_connection(connection, context: context)
               end
             end
@@ -327,10 +326,10 @@ module Mongo
         def delete_one(opts = {})
           with_session(opts) do |session|
             write_concern = if opts[:write_concern]
-              WriteConcern.get(opts[:write_concern])
-            else
-              write_concern_with_session(session)
-            end
+                              WriteConcern.get(opts[:write_concern])
+                            else
+                              write_concern_with_session(session)
+                            end
 
             QueryCache.clear_namespace(collection.namespace)
 
@@ -361,7 +360,7 @@ module Mongo
                 session: session,
                 txn_num: txn_num,
                 let: opts[:let],
-                comment: opts[:comment],
+                comment: opts[:comment]
               ).execute_with_connection(connection, context: context)
             end
           end
@@ -405,10 +404,10 @@ module Mongo
         def replace_one(replacement, opts = {})
           with_session(opts) do |session|
             write_concern = if opts[:write_concern]
-              WriteConcern.get(opts[:write_concern])
-            else
-              write_concern_with_session(session)
-            end
+                              WriteConcern.get(opts[:write_concern])
+                            else
+                              write_concern_with_session(session)
+                            end
             validate_replacement_documents!(replacement)
 
             QueryCache.clear_namespace(collection.namespace)
@@ -421,9 +420,7 @@ module Mongo
               collation: opts[:collation] || opts['collation'] || collation,
               sort: opts[:sort] || opts['sort'],
             }.compact
-            if opts[:upsert]
-              update_doc['upsert'] = true
-            end
+            update_doc['upsert'] = true if opts[:upsert]
 
             context = Operation::Context.new(
               client: client,
@@ -445,7 +442,7 @@ module Mongo
                 session: session,
                 txn_num: txn_num,
                 let: opts[:let],
-                comment: opts[:comment],
+                comment: opts[:comment]
               ).execute_with_connection(connection, context: context)
             end
           end
@@ -486,10 +483,10 @@ module Mongo
         def update_many(spec, opts = {})
           with_session(opts) do |session|
             write_concern = if opts[:write_concern]
-              WriteConcern.get(opts[:write_concern])
-            else
-              write_concern_with_session(session)
-            end
+                              WriteConcern.get(opts[:write_concern])
+                            else
+                              write_concern_with_session(session)
+                            end
             validate_update_documents!(spec)
 
             QueryCache.clear_namespace(collection.namespace)
@@ -502,16 +499,14 @@ module Mongo
               hint: opts[:hint],
               collation: opts[:collation] || opts['collation'] || collation,
             }.compact
-            if opts[:upsert]
-              update_doc['upsert'] = true
-            end
+            update_doc['upsert'] = true if opts[:upsert]
 
             context = Operation::Context.new(
               client: client,
               session: session,
               operation_timeouts: operation_timeouts(opts)
             )
-            nro_write_with_retry(write_concern, context: context) do |connection, txn_num, context|
+            nro_write_with_retry(write_concern, context: context) do |connection, _txn_num, context|
               gte_4_2 = connection.server.description.server_version_gte?('4.2')
               if !gte_4_2 && opts[:hint] && write_concern && !write_concern.acknowledged?
                 raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
@@ -525,7 +520,7 @@ module Mongo
                 bypass_document_validation: !!opts[:bypass_document_validation],
                 session: session,
                 let: opts[:let],
-                comment: opts[:comment],
+                comment: opts[:comment]
               ).execute_with_connection(connection, context: context)
             end
           end
@@ -571,10 +566,10 @@ module Mongo
         def update_one(spec, opts = {})
           with_session(opts) do |session|
             write_concern = if opts[:write_concern]
-              WriteConcern.get(opts[:write_concern])
-            else
-              write_concern_with_session(session)
-            end
+                              WriteConcern.get(opts[:write_concern])
+                            else
+                              write_concern_with_session(session)
+                            end
             validate_update_documents!(spec)
 
             QueryCache.clear_namespace(collection.namespace)
@@ -587,9 +582,7 @@ module Mongo
               collation: opts[:collation] || opts['collation'] || collation,
               sort: opts[:sort] || opts['sort'],
             }.compact
-            if opts[:upsert]
-              update_doc['upsert'] = true
-            end
+            update_doc['upsert'] = true if opts[:upsert]
 
             context = Operation::Context.new(
               client: client,
@@ -604,7 +597,7 @@ module Mongo
               bypass_document_validation: !!opts[:bypass_document_validation],
               session: session,
               let: opts[:let],
-              comment: opts[:comment],
+              comment: opts[:comment]
             )
             tracer.trace_operation(operation, context) do
               write_with_retry(write_concern, context: context) do |connection, txn_num, context|
@@ -612,6 +605,7 @@ module Mongo
                 if !gte_4_2 && opts[:hint] && write_concern && !write_concern.acknowledged?
                   raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
                 end
+
                 operation.txn_num = txn_num
                 operation.execute_with_connection(connection, context: context)
               end
@@ -630,17 +624,12 @@ module Mongo
         # @raise [ Error::InvalidUpdateDocument ] if the first key in the
         #   document does not start with a $.
         def validate_update_documents!(spec)
-          if update = spec.is_a?(Array) ? spec&.first : spec
-            if key = update.keys&.first
-              unless key.to_s.start_with?("$")
-                if Mongo.validate_update_replace
-                  raise Error::InvalidUpdateDocument.new(key: key)
-                else
-                  Error::InvalidUpdateDocument.warn(Logger.logger, key)
-                end
-              end
-            end
-          end
+          return unless update = spec.is_a?(Array) ? spec&.first : spec
+          return unless key = update.keys&.first
+          return if key.to_s.start_with?('$')
+          raise Error::InvalidUpdateDocument.new(key: key) if Mongo.validate_update_replace
+
+          Error::InvalidUpdateDocument.warn(Logger.logger, key)
         end
 
         # Check the replacement documents to make sure they don't have atomic
@@ -652,17 +641,12 @@ module Mongo
         # @raise [ Error::InvalidUpdateDocument ] if the first key in the
         #   document does not start with a $.
         def validate_replacement_documents!(spec)
-          if replace = spec.is_a?(Array) ? spec&.first : spec
-            if key = replace.keys&.first
-              if key.to_s.start_with?("$")
-                if Mongo.validate_update_replace
-                  raise Error::InvalidReplacementDocument.new(key: key)
-                else
-                  Error::InvalidReplacementDocument.warn(Logger.logger, key)
-                end
-              end
-            end
-          end
+          return unless replace = spec.is_a?(Array) ? spec&.first : spec
+          return unless key = replace.keys&.first
+          return unless key.to_s.start_with?('$')
+          raise Error::InvalidReplacementDocument.new(key: key) if Mongo.validate_update_replace
+
+          Error::InvalidReplacementDocument.warn(Logger.logger, key)
         end
       end
     end

data/lib/mongo/collection/view.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -27,7 +26,6 @@ require 'mongo/collection/view/writable'
 
 module Mongo
   class Collection
-
     # Representation of a query and options producing a result set of documents.
     #
     # A +View+ can be modified using helpers. Helpers can be chained,
@@ -74,7 +72,7 @@ module Mongo
 
       def_delegators :client, :tracer
 
-      alias :selector :filter
+      alias selector filter
 
       # @return [ Integer | nil | The timeout_ms value that was passed as an
       #   option to the view.
@@ -93,11 +91,12 @@ module Mongo
       # @since 2.0.0
       def ==(other)
         return false unless other.is_a?(View)
+
         collection == other.collection &&
-            filter == other.filter &&
-            options == other.options
+          filter == other.filter &&
+          options == other.options
       end
-      alias_method :eql?, :==
+      alias eql? ==
 
       # A hash value for the +View+ composed of the collection namespace,
       # hash of the options and hash of the filter.
@@ -208,7 +207,7 @@ module Mongo
       # @since 2.0.0
       def inspect
         "#<Mongo::Collection::View:0x#{object_id} namespace='#{collection.namespace}'" +
-            " @filter=#{filter.to_s} @options=#{options.to_s}>"
+          " @filter=#{filter} @options=#{options}>"
       end
 
       # Get the write concern on this +View+.
@@ -250,7 +249,9 @@ module Mongo
         View.new(collection, filter, options)
       end
 
-      def view; self; end
+      def view
+        self
+      end
 
       def with_session(opts = {}, &block)
         client.with_session(@options.merge(opts), &block)

data/lib/mongo/collection.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -21,7 +20,6 @@ require 'mongo/collection/helpers'
 require 'mongo/collection/queryable_encryption'
 
 module Mongo
-
   # Represents a collection in the database and operations that can directly be
   # applied to one.
   #
@@ -35,12 +33,12 @@ module Mongo
     # The capped option.
     #
     # @since 2.1.0
-    CAPPED = 'capped'.freeze
+    CAPPED = 'capped'
 
     # The ns field constant.
     #
     # @since 2.1.0
-    NS = 'ns'.freeze
+    NS = 'ns'
 
     # @return [ Mongo::Database ] The database the collection resides in.
     attr_reader :database
@@ -62,19 +60,19 @@ module Mongo
     # Options that can be updated on a new Collection instance via the #with method.
     #
     # @since 2.1.0
-    CHANGEABLE_OPTIONS = [ :read, :read_concern, :write, :write_concern ].freeze
+    CHANGEABLE_OPTIONS = %i[read read_concern write write_concern].freeze
 
     # Options map to transform create collection options.
     #
     # @api private
     CREATE_COLLECTION_OPTIONS = {
-      :time_series => :timeseries,
-      :expire_after => :expireAfterSeconds,
-      :clustered_index => :clusteredIndex,
-      :change_stream_pre_and_post_images => :changeStreamPreAndPostImages,
-      :encrypted_fields => :encryptedFields,
-      :validator => :validator,
-      :view_on => :viewOn
+      time_series: :timeseries,
+      expire_after: :expireAfterSeconds,
+      clustered_index: :clusteredIndex,
+      change_stream_pre_and_post_images: :changeStreamPreAndPostImages,
+      encrypted_fields: :encryptedFields,
+      validator: :validator,
+      view_on: :viewOn
     }
 
     # Check if a collection is equal to another object. Will check the name and
@@ -90,6 +88,7 @@ module Mongo
     # @since 2.0.0
     def ==(other)
       return false unless other.is_a?(Collection)
+
       name == other.name && database == other.database && options == other.options
     end
 
@@ -166,17 +165,17 @@ module Mongo
       if options[:write] && options[:write_concern] && options[:write] != options[:write_concern]
         raise ArgumentError, "If :write and :write_concern are both given, they must be identical: #{options.inspect}"
       end
+
       @database = database
       @name = name.to_s.freeze
       @options = options.dup
       @timeout_ms = options.delete(:timeout_ms)
-=begin WriteConcern object support
-      if @options[:write_concern].is_a?(WriteConcern::Base)
-        # Cache the instance so that we do not needlessly reconstruct it.
-        @write_concern = @options[:write_concern]
-        @options[:write_concern] = @write_concern.options
-      end
-=end
+      # WriteConcern object support
+      #       if @options[:write_concern].is_a?(WriteConcern::Base)
+      #         # Cache the instance so that we do not needlessly reconstruct it.
+      #         @write_concern = @options[:write_concern]
+      #         @options[:write_concern] = @write_concern.options
+      #       end
       @options.freeze
     end
 
@@ -238,7 +237,8 @@ module Mongo
     # @since 2.0.0
     def write_concern
       @write_concern ||= WriteConcern.get(
-        options[:write_concern] || options[:write] || database.write_concern)
+        options[:write_concern] || options[:write] || database.write_concern
+      )
     end
 
     # Get the write concern to use for an operation on this collection,
@@ -254,12 +254,10 @@ module Mongo
     # @api private
     def write_concern_with_session(session)
       wc = write_concern
-      if session && session.in_transaction?
-        if wc && !wc.acknowledged?
-          opts = wc.options.dup
-          opts.delete(:w)
-          return WriteConcern.get(opts)
-        end
+      if session && session.in_transaction? && wc && !wc.acknowledged?
+        opts = wc.options.dup
+        opts.delete(:w)
+        return WriteConcern.get(opts)
       end
       wc
     end
@@ -303,12 +301,8 @@ module Mongo
         raise Error::UnchangeableCollectionOption.new(k) unless CHANGEABLE_OPTIONS.include?(k)
       end
       options = @options.dup
-      if options[:write] && new_options[:write_concern]
-        options.delete(:write)
-      end
-      if options[:write_concern] && new_options[:write]
-        options.delete(:write_concern)
-      end
+      options.delete(:write) if options[:write] && new_options[:write_concern]
+      options.delete(:write_concern) if options[:write_concern] && new_options[:write]
       Collection.new(database, name, options.update(new_options))
     end
 
@@ -322,8 +316,8 @@ module Mongo
     # @since 2.0.0
     def capped?
       database.list_collections(filter: { name: name })
-        .first
-        &.dig('options', CAPPED) || false
+              .first
+              &.dig('options', CAPPED) || false
     end
 
     # Force the collection to be created in the database.
@@ -389,24 +383,22 @@ module Mongo
       # serialization.
       # TODO put the list of read options in a class-level constant when
       # we figure out what the full set of them is.
-      options = Hash[self.options.merge(opts).reject do |key, value|
-        %w(read read_preference read_concern session).include?(key.to_s)
+      options = Hash[self.options.merge(opts).reject do |key, _value|
+        %w[read read_preference read_concern session].include?(key.to_s)
       end]
       # Converting Ruby options to server style.
       CREATE_COLLECTION_OPTIONS.each do |ruby_key, server_key|
-        if options.key?(ruby_key)
-          options[server_key] = options.delete(ruby_key)
-        end
+        options[server_key] = options.delete(ruby_key) if options.key?(ruby_key)
       end
-      operation = { :create => name }.merge(options)
+      operation = { create: name }.merge(options)
       operation.delete(:write)
       operation.delete(:write_concern)
       client.send(:with_session, opts) do |session|
         write_concern = if opts[:write_concern]
-          WriteConcern.get(opts[:write_concern])
-        else
-          self.write_concern
-        end
+                          WriteConcern.get(opts[:write_concern])
+                        else
+                          self.write_concern
+                        end
 
         context = Operation::Context.new(
           client: client,
@@ -420,7 +412,7 @@ module Mongo
           # Note that these are collection options, collation isn't
           # taken from options passed to the create method.
           collation: options[:collation] || options['collation'],
-          validator: options[:validator],
+          validator: options[:validator]
         )
         tracer.trace_operation(operation, context, op_name: 'createCollection') do
           maybe_create_qe_collections(opts[:encrypted_fields], client, session) do |encrypted_fields|
@@ -470,11 +462,11 @@ module Mongo
                           temp_write_concern
                         end
         operation = Operation::Drop.new({
-          selector: { :drop => name },
-          db_name: database.name,
-          write_concern: write_concern,
-          session: session,
-        })
+                                          selector: { drop: name },
+                                          db_name: database.name,
+                                          write_concern: write_concern,
+                                          session: session,
+                                        })
         tracer.trace_operation(operation, context, op_name: 'dropCollection') do
           maybe_drop_emm_collections(opts[:encrypted_fields], client, session) do
             do_drop(operation, session, context)
@@ -576,10 +568,8 @@ module Mongo
       View.new(self, {}, options).aggregate(pipeline, options)
     end
 
-    # As of version 3.6 of the MongoDB server, a ``$changeStream`` pipeline
-    # stage is supported in the aggregation framework. This stage allows users
-    # to request that notifications are sent for all changes to a particular
-    # collection.
+    # Allows users to request that notifications are sent for all changes
+    # to a particular collection.
     #
     # @example Get change notifications for a given collection.
     #   collection.watch([{ '$match' => { operationType: { '$in' => ['insert', 'replace'] } } }])
@@ -627,7 +617,6 @@ module Mongo
     # @option options [ BSON::Timestamp ] :start_at_operation_time Only return
     #   changes that occurred at or after the specified timestamp. Any command run
     #   against the server will return a cluster time that can be used here.
-    #   Only recognized by server versions 4.0+.
     # @option options [ Object ] :comment A user-provided
     #   comment to attach to this command.
     # @option options [ Boolean ] :show_expanded_events Enables the server to
@@ -686,7 +675,7 @@ module Mongo
     #
     # @deprecated Use #count_documents or estimated_document_count instead. However, note that the
     #   following operators will need to be substituted when switching to #count_documents:
-    #     * $where should be replaced with $expr (only works on 3.6+)
+    #     * $where should be replaced with $expr
     #     * $near should be replaced with $geoWithin with $center
     #     * $nearSphere should be replaced with $geoWithin with $centerSphere
     def count(filter = nil, options = {})
@@ -706,7 +695,7 @@ module Mongo
     #
     # @option options :skip [ Integer ] The number of documents to skip.
     # @option options :hint [ Hash ] Override default index selection and force
-    #   MongoDB to use a specific index for the query. Requires server version 3.6+.
+    #   MongoDB to use a specific index for the query.
     # @option options :limit [ Integer ] Max number of docs to count.
     # @option options :max_time_ms [ Integer ] The maximum amount of time to allow the
     #   command to run.
@@ -858,31 +847,29 @@ module Mongo
 
       client.with_session(opts) do |session|
         write_concern = if opts[:write_concern]
-          WriteConcern.get(opts[:write_concern])
-        else
-          write_concern_with_session(session)
-        end
+                          WriteConcern.get(opts[:write_concern])
+                        else
+                          write_concern_with_session(session)
+                        end
 
-        if document.nil?
-          raise ArgumentError, "Document to be inserted cannot be nil"
-        end
+        raise ArgumentError, 'Document to be inserted cannot be nil' if document.nil?
 
         context = Operation::Context.new(
           client: client,
           session: session,
           operation_timeouts: operation_timeouts(opts)
-          )
+        )
         operation = Operation::Insert.new(
-              :documents => [ document ],
-              :db_name => database.name,
-              :coll_name => name,
-              :write_concern => write_concern,
-              :bypass_document_validation => !!opts[:bypass_document_validation],
-              :options => opts,
-              :id_generator => client.options[:id_generator],
-              :session => session,
-              :comment => opts[:comment]
-            )
+          documents: [ document ],
+          db_name: database.name,
+          coll_name: name,
+          write_concern: write_concern,
+          bypass_document_validation: !!opts[:bypass_document_validation],
+          options: opts,
+          id_generator: client.options[:id_generator],
+          session: session,
+          comment: opts[:comment]
+        )
         tracer.trace_operation(operation, context) do
           write_with_retry(write_concern, context: context) do |connection, txn_num, context|
             operation.txn_num = txn_num
@@ -920,7 +907,7 @@ module Mongo
     def insert_many(documents, options = {})
       QueryCache.clear_namespace(namespace)
 
-      inserts = documents.map{ |doc| { :insert_one => doc }}
+      inserts = documents.map { |doc| { insert_one: doc } }
       bulk_write(inserts, options)
     end
 

data/lib/mongo/condition_variable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -32,6 +31,7 @@ module Mongo
     def wait(timeout = nil)
       raise_unless_locked!
       return false if timeout && timeout < 0
+
       @cv.wait(@lock, timeout)
     end
 
@@ -50,9 +50,9 @@ module Mongo
     private
 
     def raise_unless_locked!
-      unless @lock.owned?
-        raise ArgumentError, "the lock must be owned when calling this method"
-      end
+      return if @lock.owned?
+
+      raise ArgumentError, 'the lock must be owned when calling this method'
     end
   end
 end