Spelling and grammar corrections (mongodb#3023)

* Fix various spelling and grammar issues

* typo was masking a duplicate spec; fixing the typo exposed the bad spec

Author: jamis

lib/mongo/auth/aws/credentials_retriever.rb

@@ -137,7 +137,7 @@ def credentials_from_environment
         #
         # @raise Auth::InvalidConfiguration if a source contains an invalid set
         #   of credentials.
-        # @ raise Error::TimeoutError if credentials cannot be retrieved within
+        # @raise Error::TimeoutError if credentials cannot be retrieved within
         #   the timeout defined on the operation context.
         def obtain_credentials_from_endpoints(timeout_holder = nil)
           if (credentials = web_identity_credentials(timeout_holder)) && credentials_valid?(credentials,
@@ -159,7 +159,7 @@ def obtain_credentials_from_endpoints(timeout_holder = nil)
         #
         # @return [ Auth::Aws::Credentials | nil ] A set of credentials, or nil
         #   if retrieval failed.
-        # @ raise Error::TimeoutError if credentials cannot be retrieved within
+        # @raise Error::TimeoutError if credentials cannot be retrieved within
         #   the timeout.
         def ec2_metadata_credentials(timeout_holder = nil)
           timeout_holder&.check_timeout!
@@ -207,7 +207,7 @@ def ec2_metadata_credentials(timeout_holder = nil)
         #
         # @return [ Auth::Aws::Credentials | nil ] A set of credentials, or nil
         #   if retrieval failed.
-        # @ raise Error::TimeoutError if credentials cannot be retrieved within
+        # @raise Error::TimeoutError if credentials cannot be retrieved within
         #   the timeout defined on the operation context.
         def ecs_metadata_credentials(timeout_holder = nil)
           timeout_holder&.check_timeout!
@@ -290,7 +290,7 @@ def prepare_web_identity_inputs
         # @return [ Net::HTTPResponse | nil ] AWS API response if successful,
         #   otherwise nil.
         #
-        # @ raise Error::TimeoutError if credentials cannot be retrieved within
+        # @raise Error::TimeoutError if credentials cannot be retrieved within
         #   the timeout defined on the operation context.
         def request_web_identity_credentials(token, role_arn, role_session_name, timeout_holder)
           timeout_holder&.check_timeout!
@@ -384,7 +384,7 @@ def credentials_valid?(credentials, source)
         #
         # @param [ CsotTimeoutHolder | nil ] timeout_holder CSOT timeout.
         #
-        # @ raise Error::TimeoutError if deadline exceeded.
+        # @raise Error::TimeoutError if deadline exceeded.
         def with_timeout(timeout_holder, &block)
           timeout = timeout_holder&.remaining_timeout_sec! || METADATA_TIMEOUT
           exception_class = (Error::TimeoutError if timeout_holder&.csot?)

lib/mongo/auth/gssapi/conversation.rb

@@ -17,7 +17,7 @@
 module Mongo
   module Auth
     class Gssapi
-      # Defines behaviour around a single Kerberos conversation between the
+      # Defines behavior around a single Kerberos conversation between the
       # client and the server.
       #
       # @api private

lib/mongo/auth/scram_conversation_base.rb

@@ -52,7 +52,7 @@ def initialize(user, connection, client_nonce: nil)
       #
       # @see https://jira.mongodb.org/browse/SECURITY-621
       #
-      # @return [ true | fase ] Whether the server's signature was verified.
+      # @return [ true | false ] Whether the server's signature was verified.
       def server_verified?
         !!@server_verified
       end

lib/mongo/background_thread.rb

@@ -134,7 +134,7 @@ def wait_for_stop
       rescue ::Timeout::Error
       end
 
-      # Some driver objects can be reconnected, for backwards compatibiilty
+      # Some driver objects can be reconnected, for backwards compatibility
       # reasons. Clear the thread instance variable to support this cleanly.
       if @thread.alive?
         log_warn("Failed to stop the background thread in #{self} in #{(Utils.monotonic_time - start_time).to_i} seconds: #{@thread.inspect} (thread status: #{@thread.status})")

lib/mongo/bulk_write/transformable.rb

@@ -85,7 +85,7 @@ module Transformable
         doc
       }
 
-      # Proc to transfor replace one ops.
+      # Proc to transform replace one ops.
       #
       # @since 2.1.0
       REPLACE_ONE_TRANSFORM = lambda { |doc|

lib/mongo/client.rb

@@ -45,7 +45,7 @@ class Client
       # the cluster is initialized it no longer uses this timeout.
       # Unfortunately server selector reads server selection timeout out of
       # the cluster, and this behavior is required by Cluster#next_primary
-      # which takes no arguments. When next_primary is removed we can revsit
+      # which takes no arguments. When next_primary is removed we can revisit
       # using the same cluster object with different server selection timeouts.
     ].freeze
 
@@ -612,7 +612,7 @@ def initialize(addresses_or_uri, options = nil)
         begin
           @cluster.close
         rescue StandardError => e
-          log_warn("Eror closing cluster in client constructor's exception handler: #{e.class}: #{e}")
+          log_warn("Error closing cluster in client constructor's exception handler: #{e.class}: #{e}")
           # Drop this exception so that the original exception is raised
         end
         raise

lib/mongo/cluster.rb

@@ -142,7 +142,7 @@ def initialize(seeds, monitoring, options = Options::Redacted.new)
       @server_selection_semaphore = Semaphore.new
       @topology = Topology.initial(self, monitoring, options)
       # State change lock is similar to the sdam flow lock, but is designed
-      # to serialize state changes initated by consumers of Cluster
+      # to serialize state changes initiated by consumers of Cluster
       # (e.g. application connecting or disconnecting the cluster), so that
       # e.g. an application calling disconnect-connect-disconnect rapidly
       # does not put the cluster into an inconsistent state.
@@ -829,13 +829,13 @@ def add(host, add_options = nil)
       return if addresses.include?(address)
 
       opts = options.merge(monitor: false)
-      # If we aren't starting the montoring threads, we also don't want to
+      # If we aren't starting the monitoring threads, we also don't want to
       # start the pool's populator thread.
       opts.merge!(populator_io: false) unless options.fetch(:monitoring_io, true)
       # Note that in a load-balanced topology, every server must be a
       # load balancer (load_balancer: true is specified in the options)
       # but this option isn't set here because we are required by the
-      # specifications to pretent the server started out as an unknown one
+      # specifications to pretend the server started out as an unknown one
       # and publish server description change event into the load balancer
       # one. The actual correct description for this server will be set
       # by the fabricate_lb_sdam_events_and_set_server_type method.

lib/mongo/cluster/reapers/cursor_reaper.rb

@@ -95,7 +95,7 @@ def unregister_cursor(id)
 
       # Read and decode scheduled kill cursors operations.
       #
-      # This method mutates instance variables without locking, so is is not
+      # This method mutates instance variables without locking, so it is not
       # thread safe. Generally, it should not be called itself, this is a helper
       # for `kill_cursor` method.
       #

lib/mongo/cluster/sdam_flow.rb

@@ -167,8 +167,8 @@ def server_description_changed
           # is is imperative to NOT pass updated_desc's RS name to
           # topology constructor here.
           # During processing we may remove the server whose updated_desc
-          # we are be processing (e.g. the RS name mismatch case again),
-          # in which case topoogy type will go back to RS without primary
+          # we are processing (e.g. the RS name mismatch case again),
+          # in which case topology type will go back to RS without primary
           # in the check_if_has_primary step.
           @topology = Topology::ReplicaSetWithPrimary.new(
             # Do not pass updated_desc's RS name here

lib/mongo/cluster/topology/load_balanced.rb

@@ -84,7 +84,7 @@ def sharded?
 
         # Returns whether this topology is Single.
         #
-        # @return [ true ] Always false.
+        # @return [ false ] Always false.
         def single?
           false
         end