mongo 2.13.0 → 2.15.0.alpha

data/lib/mongo/operation/delete/bulk_result.rb

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of results for a delete when part of a bulk write.
       #
       # @since 2.0.0
+      # @api semiprivate
       class BulkResult < Operation::Result
         include Aggregatable
 
@@ -30,6 +31,7 @@ module Mongo
         # @return [ Integer ] The number of documents deleted.
         #
         # @since 2.0.0
+        # @api public
         def n_removed
           return 0 unless acknowledged?
           @replies.reduce(0) do |n, reply|

data/lib/mongo/operation/delete/result.rb

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of results for a delete.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the number of documents deleted.
@@ -29,10 +30,12 @@ module Mongo
         # @return [ Integer ] The deleted count.
         #
         # @since 2.0.0
+        # @api public
         def deleted_count
           n
         end
 
+        # @api public
         def bulk_result
           BulkResult.new(@replies, connection_description)
         end

data/lib/mongo/operation/explain/command.rb

@@ -30,6 +30,10 @@ module Mongo
 
         private
 
+        def selector(connection)
+          super.merge(spec[:explain])
+        end
+
         def message(connection)
           Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end

data/lib/mongo/operation/explain/legacy.rb

@@ -29,6 +29,10 @@ module Mongo
 
         private
 
+        def selector(connection)
+          super.merge(spec[:explain])
+        end
+
         def message(connection)
           Protocol::Query.new(db_name, coll_name, command(connection), options(connection))
         end

data/lib/mongo/operation/explain/op_msg.rb

@@ -25,6 +25,12 @@ module Mongo
         include CausalConsistencySupported
         include ExecutableTransactionLabel
         include PolymorphicResult
+
+        private
+
+        def selector(connection)
+          super.merge(spec[:explain])
+        end
       end
     end
   end

data/lib/mongo/operation/explain/result.rb

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of results in find command with explain.
       #
       # @since 2.5.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the cursor id.
@@ -29,6 +30,7 @@ module Mongo
         # @return [ 0 ] Always 0 because explain doesn't return a cursor.
         #
         # @since 2.5.0
+        # @api private
         def cursor_id
           0
         end
@@ -41,6 +43,7 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.5.0
+        # @api public
         def documents
           reply.documents
         end

data/lib/mongo/operation/find/legacy/result.rb

@@ -20,6 +20,7 @@ module Mongo
         # Defines custom behavior of results for a query.
         #
         # @since 2.1.0
+        # @api semiprivate
         class Result < Operation::Result
           include Operation::Result::UseLegacyErrorParser
 
@@ -31,6 +32,7 @@ module Mongo
           # @return [ true, false ] If the query was successful.
           #
           # @since 2.0.0
+          # @api public
           def successful?
             !query_failure?
           end

data/lib/mongo/operation/find/result.rb

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of results in find command.
       #
       # @since 2.2.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the cursor id.
@@ -29,6 +30,7 @@ module Mongo
         # @return [ Integer ] The cursor id.
         #
         # @since 2.2.0
+        # @api private
         def cursor_id
           cursor_document ? cursor_document[CURSOR_ID] : super
         end
@@ -41,10 +43,21 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.2.0
+        # @api public
         def documents
           cursor_document[FIRST_BATCH]
         end
 
+        # The namespace in which this find command was performed.
+        #
+        # @return [ String ] The namespace, usually in the format
+        #   "database.collection".
+        #
+        # @api private
+        def namespace
+          cursor_document['ns']
+        end
+
         private
 
         def cursor_document

data/lib/mongo/operation/get_more/result.rb

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of results for the get more command.
       #
       # @since 2.2.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the cursor id.
@@ -29,6 +30,7 @@ module Mongo
         # @return [ Integer ] The cursor id.
         #
         # @since 2.2.0
+        # @api private
         def cursor_id
           cursor_document ? cursor_document[CURSOR_ID] : super
         end
@@ -50,6 +52,7 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.2.0
+        # @api public
         def documents
           cursor_document[NEXT_BATCH]
         end

data/lib/mongo/operation/indexes.rb

@@ -27,7 +27,21 @@ module Mongo
     # @since 2.0.0
     class Indexes
       include Specifiable
-      include OpMsgOrListIndexesCommand
+      include PolymorphicOperation
+      include PolymorphicLookup
+
+      private
+
+      def final_operation(connection)
+        cls = if connection.features.op_msg_enabled?
+          polymorphic_class(self.class.name, :OpMsg)
+        elsif connection.features.list_indexes_enabled?
+          polymorphic_class(self.class.name, :Command)
+        else
+          polymorphic_class(self.class.name, :Legacy)
+        end
+        cls.new(spec)
+      end
     end
   end
 end

data/lib/mongo/operation/indexes/result.rb

@@ -20,6 +20,7 @@ module Mongo
       # listIndexes command.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the cursor id for the result.
@@ -35,6 +36,7 @@ module Mongo
         # @return [ Integer ] The cursor id.
         #
         # @since 2.0.0
+        # @api private
         def cursor_id
           cursor_document ? cursor_document[CURSOR_ID] : super
         end
@@ -47,6 +49,7 @@ module Mongo
         # @return [ String ] The namespace.
         #
         # @since 2.0.0
+        # @api private
         def namespace
           cursor_document ? cursor_document[NAMESPACE] : super
         end
@@ -60,6 +63,7 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.0.0
+        # @api public
         def documents
           cursor_document[FIRST_BATCH]
         end
@@ -77,6 +81,7 @@ module Mongo
         # @return [ Result ] Self if successful.
         #
         # @since 2.0.0
+        # @api private
         def validate!
           !successful? ? raise_operation_failure : self
         end

data/lib/mongo/operation/insert/bulk_result.rb

@@ -19,12 +19,14 @@ module Mongo
       # Defines custom behavior of results for an insert when sent as part of a bulk write.
       #
       # @since 2.0.0
+      # @api semiprivate
       class BulkResult < Operation::Result
         include Aggregatable
 
         # Get the ids of the inserted documents.
         #
         # @since 2.0.0
+        # @api public
         attr_reader :inserted_ids
 
         # Initialize a new result.
@@ -39,6 +41,7 @@ module Mongo
         # @param [ Array<Object> ] ids The ids of the inserted documents.
         #
         # @since 2.0.0
+        # @api private
         def initialize(replies, connection_description, ids)
           @replies = [*replies] if replies
           @connection_description = connection_description
@@ -83,6 +86,7 @@ module Mongo
         # @return [ Integer ] The number of documents inserted.
         #
         # @since 2.0.0
+        # @api public
         def n_inserted
           written_count
         end
@@ -95,6 +99,7 @@ module Mongo
         # @return [ Object ] The id of the document inserted.
         #
         # @since 2.0.0
+        # @api public
         def inserted_id
           inserted_ids.first
         end

data/lib/mongo/operation/insert/command.rb

@@ -32,9 +32,9 @@ module Mongo
 
         private
 
-        def get_result(connection, client, options = {})
+        def get_result(connection, context, options = {})
           # This is a Mongo::Operation::Insert::Result
-          Result.new(*dispatch_message(connection, client), @ids)
+          Result.new(*dispatch_message(connection, context), @ids)
         end
 
         def selector(connection)

data/lib/mongo/operation/insert/legacy.rb

@@ -30,9 +30,9 @@ module Mongo
 
         private
 
-        def get_result(connection, client, options = {})
+        def get_result(connection, context, options = {})
           # This is a Mongo::Operation::Insert::Result
-          Result.new(*dispatch_message(connection, client), @ids)
+          Result.new(*dispatch_message(connection, context), @ids)
         end
 
         def selector

data/lib/mongo/operation/insert/op_msg.rb

@@ -30,9 +30,9 @@ module Mongo
 
         private
 
-        def get_result(connection, client, options = {})
+        def get_result(connection, context, options = {})
           # This is a Mongo::Operation::Insert::Result
-          Result.new(*dispatch_message(connection, client), @ids)
+          Result.new(*dispatch_message(connection, context), @ids)
         end
 
         def selector(connection)

data/lib/mongo/operation/insert/result.rb

@@ -22,11 +22,13 @@ module Mongo
       # is optional. It can be added to this class later, if needed.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the ids of the inserted documents.
         #
         # @since 2.0.0
+        # @api public
         attr_reader :inserted_ids
 
         # Initialize a new result.
@@ -41,6 +43,7 @@ module Mongo
         # @param [ Array<Object> ] ids The ids of the inserted documents.
         #
         # @since 2.0.0
+        # @api private
         def initialize(replies, connection_description, ids)
           super(replies, connection_description)
           @inserted_ids = ids
@@ -54,10 +57,12 @@ module Mongo
         # @return [ Object ] The id of the document inserted.
         #
         # @since 2.0.0
+        # @api public
         def inserted_id
           inserted_ids.first
         end
 
+        # @api public
         def bulk_result
           BulkResult.new(@replies, connection_description, @inserted_ids)
         end

data/lib/mongo/operation/list_collections/result.rb

@@ -20,6 +20,7 @@ module Mongo
       # listCollections command.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the cursor id for the result.
@@ -35,6 +36,7 @@ module Mongo
         # @return [ Integer ] The cursor id.
         #
         # @since 2.0.0
+        # @api private
         def cursor_id
           cursor_document ? cursor_document[CURSOR_ID] : super
         end
@@ -47,6 +49,7 @@ module Mongo
         # @return [ String ] The namespace.
         #
         # @since 2.0.0
+        # @api private
         def namespace
           cursor_document ? cursor_document[NAMESPACE] : super
         end
@@ -60,6 +63,7 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.0.0
+        # @api public
         def documents
           cursor_document[FIRST_BATCH]
         end
@@ -73,6 +77,7 @@ module Mongo
         # @return [ Result ] Self if successful.
         #
         # @since 2.0.0
+        # @api private
         def validate!
           if successful?
             self
@@ -83,7 +88,10 @@ module Mongo
               code: parser.code,
               code_name: parser.code_name,
               labels: parser.labels,
-              wtimeout: parser.wtimeout)
+              wtimeout: parser.wtimeout,
+              document: parser.document,
+              server_message: parser.server_message,
+            )
           end
         end
 

data/lib/mongo/operation/map_reduce/result.rb

@@ -19,21 +19,25 @@ module Mongo
       # Defines custom behavior of results for a map reduce operation.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # The counts field for the map/reduce.
         #
         # @since 2.0.0
+        # @api private
         COUNTS = 'counts'.freeze
 
         # The field name for a result without a cursor.
         #
         # @since 2.0.0
+        # @api private
         RESULTS = 'results'.freeze
 
         # The time the operation took constant.
         #
         # @since 2.0.0
+        # @api private
         TIME = 'timeMillis'.freeze
 
         # Gets the map/reduce counts from the reply.
@@ -44,6 +48,7 @@ module Mongo
         # @return [ Hash ] A hash of the result counts.
         #
         # @since 2.0.0
+        # @api public
         def counts
           reply.documents[0][COUNTS]
         end
@@ -56,6 +61,7 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.0.0
+        # @api public
         def documents
           reply.documents[0][RESULTS] || reply.documents[0][RESULT]
         end
@@ -72,6 +78,7 @@ module Mongo
         # @return [ true, false ] If the command was successful.
         #
         # @since 2.0.0
+        # @api public
         def successful?
           !documents.nil?
         end
@@ -84,6 +91,7 @@ module Mongo
         # @return [ Integer ] The executing time in milliseconds.
         #
         # @since 2.0.0
+        # @api public
         def time
           reply.documents[0][TIME]
         end
@@ -102,6 +110,7 @@ module Mongo
         # @return [ Result ] The result if verification passed.
         #
         # @since 2.0.0
+        # @api private
         def validate!
           documents.nil? ? raise_operation_failure : self
         end
@@ -114,6 +123,7 @@ module Mongo
         # @return [ Integer ] Always 0 because map reduce doesn't return a cursor.
         #
         # @since 2.5.0
+        # @api private
         def cursor_id
           0
         end