Fix typos and documentation

Author: estolfo

lib/mongo/collection.rb

@@ -136,8 +136,8 @@ def drop
     # @option options [ Integer ] :limit The max number of docs to return from the query.
     # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the query
     #   to run in milliseconds.
-    # @option options [ Hash ] :modifiers Meta-operators modifying the output or behavior
-    #   of a query.
+    # @option options [ Hash ] :modifiers A document containing meta-operators modifying the
+    #   output or behavior of a query.
     # @option options [ true, false ] :no_cursor_timeout The server normally times out idle
     #   cursors after an inactivity period (10 minutes) to prevent excess memory use.
     #   Set this option to prevent that.
@@ -335,17 +335,17 @@ def delete_many(filter = nil)
     #   collection.replace_one({ name: 'test' }, { name: 'test1' })
     #
     # @param [ Hash ] filter The filter to use.
-    # @param [ Hash ] document The document to replace.
-    # @param [ Hash ] opts The options.
+    # @param [ Hash ] replacement The replacement document..
+    # @param [ Hash ] options The options.
     #
-    # @option opts [ true, false ] :upsert Whether to upsert if the
+    # @option options [ true, false ] :upsert Whether to upsert if the
     #   document doesn't exist.
     #
     # @return [ Result ] The response from the database.
     #
     # @since 2.1.0
-    def replace_one(filter, document, opts = {})
-      find(filter).replace_one(document, opts)
+    def replace_one(filter, replacement, options = {})
+      find(filter).replace_one(replacement, options)
     end
 
     # Update documents in the collection.
@@ -355,16 +355,16 @@ def replace_one(filter, document, opts = {})
     #
     # @param [ Hash ] filter The filter to use.
     # @param [ Hash ] update The update statement.
-    # @param [ Hash ] opts The options.
+    # @param [ Hash ] options The options.
     #
-    # @option opts [ true, false ] :upsert Whether to upsert if the
+    # @option options [ true, false ] :upsert Whether to upsert if the
     #   document doesn't exist.
     #
     # @return [ Result ] The response from the database.
     #
     # @since 2.1.0
-    def update_many(filter, update, opts = {})
-      find(filter).update_many(update, opts)
+    def update_many(filter, update, options = {})
+      find(filter).update_many(update, options)
     end
 
     # Update a single document in the collection.
@@ -374,16 +374,16 @@ def update_many(filter, update, opts = {})
     #
     # @param [ Hash ] filter The filter to use.
     # @param [ Hash ] update The update statement.
-    # @param [ Hash ] opts The options.
+    # @param [ Hash ] options The options.
     #
-    # @option opts [ true, false ] :upsert Whether to upsert if the
+    # @option options [ true, false ] :upsert Whether to upsert if the
     #   document doesn't exist.
     #
     # @return [ Result ] The response from the database.
     #
     # @since 2.1.0
-    def update_one(filter, update, opts = {})
-      find(filter).update_one(update, opts)
+    def update_one(filter, update, options = {})
+      find(filter).update_one(update, options)
     end
 
     # Finds a single document in the database via findAndModify and deletes
@@ -393,75 +393,75 @@ def update_one(filter, update, opts = {})
     #   collection.find_one_and_delete(name: 'test')
     #
     # @param [ Hash ] filter The filter to use.
-    # @param [ Hash ] opts The options.
+    # @param [ Hash ] options The options.
     #
-    # @option opts [ Integer ] :max_time_ms The maximum amount of time to allow the command
+    # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command
     #   to run in milliseconds.
-    # @option options [ Hash ] :projection The fields to include or exclude from each doc
-    #   in the result set.
+    # @option options [ Hash ] :projection The fields to include or exclude in the returned doc.
     # @option options [ Hash ] :sort The key and direction pairs by which the result set
     #   will be sorted.
     #
     # @return [ BSON::Document, nil ] The document, if found.
     #
     # @since 2.1.0
-    def find_one_and_delete(filter, opts = {})
-      find(filter, opts).find_one_and_delete
+    def find_one_and_delete(filter, options = {})
+      find(filter, options).find_one_and_delete
     end
 
-    # Finds a single document via findAndModify and updates it.
+    # Finds a single document via findAndModify and updates it, returning the original doc unless
+    # otherwise specified.
     #
     # @example Find a document and update it, returning the original.
-    #   collection.find_one_and_update({ name: 'test' }, { "$set" => { name: 'test1' }}, :return_document => :before)
+    #   collection.find_one_and_update({ name: 'test' }, { "$set" => { name: 'test1' }})
+    #
+    # @example Find a document and update it, returning the updated document.
+    #   collection.find_one_and_update({ name: 'test' }, { "$set" => { name: 'test1' }}, :return_document => :after)
     #
     # @param [ Hash ] filter The filter to use.
     # @param [ BSON::Document ] update The update statement.
-    # @param [ Hash ] opts The options.
+    # @param [ Hash ] options The options.
     #
-    # @option opts [ Integer ] :max_time_ms The maximum amount of time to allow the command
+    # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command
     #   to run in milliseconds.
-    # @option options [ Hash ] :projection The fields to include or exclude from each doc
-    #   in the result set.
+    # @option options [ Hash ] :projection The fields to include or exclude in the returned doc.
     # @option options [ Hash ] :sort The key and direction pairs by which the result set
     #   will be sorted.
-    # @option opts [ Symbol ] :return_document Either :before or :after.
-    # @option opts [ true, false ] :upsert Whether to upsert if the
-    #   document doesn't exist.
+    # @option options [ Symbol ] :return_document Either :before or :after.
+    # @option options [ true, false ] :upsert Whether to upsert if the document doesn't exist.
     #
     # @return [ BSON::Document ] The document.
     #
     # @since 2.1.0
-    def find_one_and_update(filter, update, opts = {})
-      find(filter, opts).find_one_and_update(update, opts)
+    def find_one_and_update(filter, update, options = {})
+      find(filter, options).find_one_and_update(update, options)
     end
 
-    # Finds a single document and replaces it.
+    # Finds a single document and replaces it, returning the original doc unless
+    # otherwise specified.
     #
     # @example Find a document and replace it, returning the original.
-    #   collection.find_one_and_replace({ name: 'test' }, { name: 'test1' }, :return_document => :before)
+    #   collection.find_one_and_replace({ name: 'test' }, { name: 'test1' })
     #
     # @example Find a document and replace it, returning the new document.
     #   collection.find_one_and_replace({ name: 'test' }, { name: 'test1' }, :return_document => :after)
     #
     # @param [ Hash ] filter The filter to use.
     # @param [ BSON::Document ] replacement The replacement document.
-    # @param [ Hash ] opts The options.
+    # @param [ Hash ] options The options.
     #
-    # @option opts [ Integer ] :max_time_ms The maximum amount of time to allow the command
+    # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command
     #   to run in milliseconds.
-    # @option options [ Hash ] :projection The fields to include or exclude from each doc
-    #   in the result set.
+    # @option options [ Hash ] :projection The fields to include or exclude in the returned doc.
     # @option options [ Hash ] :sort The key and direction pairs by which the result set
     #   will be sorted.
-    # @option opts [ Symbol ] :return_document Either :before or :after.
-    # @option opts [ true, false ] :upsert Whether to upsert if the
-    #   document doesn't exist.
+    # @option options [ Symbol ] :return_document Either :before or :after.
+    # @option options [ true, false ] :upsert Whether to upsert if the document doesn't exist.
     #
     # @return [ BSON::Document ] The document.
     #
     # @since 2.1.0
-    def find_one_and_replace(filter, replacement, opts = {})
-      find(filter, opts).find_one_and_update(replacement, opts)
+    def find_one_and_replace(filter, replacement, options = {})
+      find(filter, options).find_one_and_update(replacement, options)
     end
 
     # Get the fully qualified namespace of the collection.

lib/mongo/collection/view/readable.rb

@@ -40,7 +40,7 @@ module Readable
         # Options to cursor flags mapping.
         #
         # @since 2.1.0
-        CURSOR_FLAGS = {
+        CURSOR_FLAGS_MAP = {
           :allow_partial_results => [ :partial ],
           :oplog_replay => [ :oplog_replay ],
           :no_cursor_timeout => [ :no_cursor_timeout ],
@@ -392,12 +392,11 @@ def default_read(read = nil)
         end
 
         def flags
-          @flags ||= (!primary? ? [ :slave_ok ] : []).tap do |flags|
-            CURSOR_FLAGS.each do |key, value|
-              if options[key] || (options[:cursor_type] && options[:cursor_type] == key)
-                flags.push(*value)
-              end
+          @flags ||= CURSOR_FLAGS_MAP.each.reduce([]) do |flags, (key, value)|
+            if options[key] || (options[:cursor_type] && options[:cursor_type] == key)
+              flags.push(*value)
             end
+            flags
           end
         end
 
@@ -406,10 +405,6 @@ def has_special_fields?
               show_disk_loc || snapshot || explained? || cluster.sharded?
         end
 
-        def primary?
-          read.name == :primary
-        end
-
         def query_options
           { :project => projection, :skip => skip, :limit => to_return, :flags => flags }
         end

lib/mongo/collection/view/writable.rb

@@ -114,7 +114,7 @@ def delete_one
         # @example Replace a single document.
         #   collection_view.replace_one({ name: 'test' })
         #
-        # @param [ Hash ] document The document to replace.
+        # @param [ Hash ] replacement The replacement document.
         # @param [ Hash ] opts The options.
         #
         # @option opts [ true, false ] :upsert Whether to upsert if the
@@ -123,8 +123,8 @@ def delete_one
         # @return [ Result ] The response from the database.
         #
         # @since 2.0.0
-        def replace_one(document, opts = {})
-          update(document, false, opts)
+        def replace_one(replacement, opts = {})
+          update(replacement, false, opts)
         end
 
         # Update documents in the collection.

lib/mongo/event/description_changed.rb

@@ -42,7 +42,7 @@ def initialize(cluster)
       # @example Handle the event.
       #   server_added.handle('127.0.0.1:27018')
       #
-      # @param [ Address ] address The added host.
+      # @param [ Server::Description ] updated The changed description.
       #
       # @since 2.0.0
       def handle(updated)

lib/mongo/operation/parallel_scan.rb

@@ -26,13 +26,14 @@ module Operation
     #     :cursor_count => 5
     #   })
     #
-    # @param [ Hash ] spec The specifications for the operation.
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the operation.
     #
-    # @option spec :db_name [ String ] The name of the database on which
-    #   the operation should be executed.
-    # @option spec :coll_name [ String ] The collection to scan.
-    # @option spec :cursor_count [ Integer ] The number of cursors to use.
-    # @option spec :options [ Hash ] Options for the command.
+    #   option spec :db_name [ String ] The name of the database on which
+    #     the operation should be executed.
+    #   option spec :coll_name [ String ] The collection to scan.
+    #   option spec :cursor_count [ Integer ] The number of cursors to use.
+    #   option spec :options [ Hash ] Options for the command.
     #
     # @since 2.0.0
     class ParallelScan
@@ -46,7 +47,7 @@ class ParallelScan
       # @example Execute the operation.
       #   operation.execute(context)
       #
-      # @params [ Mongo::Server::Context ] The context for this operation.
+      # @param [ Mongo::Server::Context ] context The context for this operation.
       #
       # @return [ Result ] The operation response, if there is one.
       #

spec/mongo/collection/view_spec.rb

@@ -254,6 +254,10 @@
             { :snapshot => true }
           end
 
+          before do
+            expect(view).to receive(:special_selector).and_call_original
+          end
+
           it 'creates a special query selector' do
             expect(query_spec[:selector][:$snapshot]).to eq(options[:snapshot])
           end
@@ -271,6 +275,10 @@
             { :max_scan => 100 }
           end
 
+          before do
+            expect(view).to receive(:special_selector).and_call_original
+          end
+
           it 'creates a special query selector' do
             expect(query_spec[:selector][:$maxScan]).to eq(options[:max_scan])
           end
@@ -288,6 +296,10 @@
             { :max_time_ms => 100 }
           end
 
+          before do
+            expect(view).to receive(:special_selector).and_call_original
+          end
+
           it 'creates a special query selector' do
             expect(query_spec[:selector][:$maxTimeMS]).to eq(options[:max_time_ms])
           end
@@ -305,6 +317,10 @@
             { :show_disk_loc => true }
           end
 
+          before do
+            expect(view).to receive(:special_selector).and_call_original
+          end
+
           it 'creates a special query selector' do
             expect(query_spec[:selector][:$showDiskLoc]).to eq(options[:show_disk_loc])
           end
@@ -323,6 +339,10 @@
           { :sort => {'x' => Mongo::Index::ASCENDING }}
         end
 
+        before do
+          expect(view).to receive(:special_selector).and_call_original
+        end
+
         it 'creates a special query selector' do
           expect(query_spec[:selector][:$orderby]).to eq(options[:sort])
         end
@@ -358,6 +378,10 @@
           { :comment => 'query1' }
         end
 
+        before do
+          expect(view).to receive(:special_selector).and_call_original
+        end
+
         it 'creates a special query selector' do
           expect(query_spec[:selector][:$comment]).to eq(options[:comment])
         end
@@ -392,6 +416,10 @@
           }
         end
 
+        before do
+          expect(view).to receive(:special_selector).and_call_original
+        end
+
         it 'creates a special query selector' do
           expect(query_spec[:selector][:$orderby]).to eq(options[:modifiers][:$orderby])
         end

spec/support/crud/read.rb

@@ -105,7 +105,7 @@ def aggregate(collection)
         end
 
         def distinct(collection)
-          collection.distinct(field_name, filter)
+          collection.distinct(field_name, filter, options)
         end
 
         def find(collection)

spec/support/crud/write.rb

@@ -158,7 +158,7 @@ def find_one_and_delete(collection)
         end
 
         def find_one_and_replace(collection)
-          collection.find_one_and_replace(filter, replacement,options)
+          collection.find_one_and_replace(filter, replacement, options)
         end
 
         def find_one_and_update(collection)