mongo 2.1.2 → 2.2.0.rc0

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

@@ -14,97 +14,79 @@
 
 module Mongo
   module Operation
-    class ListCollections
+    module Commands
+      class ListCollections
 
-      # Defines custom behaviour of results when using the
-      # listCollections command.
-      #
-      # @since 2.0.0
-      class Result < Operation::Result
-
-        # The field name for the cursor document in a listCollections result.
-        #
-        # @since 2.0.0
-        CURSOR = 'cursor'.freeze
-
-        # The cursor id field in the cursor document.
-        #
-        # @since 2.0.0
-        CURSOR_ID = 'id'.freeze
-
-        # The namespace field in the cursor document.
-        #
-        # @since 2.0.0
-        NAMESPACE = 'ns'.freeze
-
-        # The field name for the first batch of a cursor.
+        # Defines custom behaviour of results when using the
+        # listCollections command.
         #
         # @since 2.0.0
-        FIRST_BATCH = 'firstBatch'.freeze
+        class Result < Operation::Result
 
-        # Get the cursor id for the result.
-        #
-        # @example Get the cursor id.
-        #   result.cursor_id
-        #
-        # @note Even though the wire protocol has a cursor_id field for all
-        #   messages of type reply, it is always zero when using the
-        #   listCollections command and must be retrieved from the cursor
-        #   document itself.
-        #
-        # @return [ Integer ] The cursor id.
-        #
-        # @since 2.0.0
-        def cursor_id
-          cursor_document ? cursor_document[CURSOR_ID] : super
-        end
+          # Get the cursor id for the result.
+          #
+          # @example Get the cursor id.
+          #   result.cursor_id
+          #
+          # @note Even though the wire protocol has a cursor_id field for all
+          #   messages of type reply, it is always zero when using the
+          #   listCollections command and must be retrieved from the cursor
+          #   document itself.
+          #
+          # @return [ Integer ] The cursor id.
+          #
+          # @since 2.0.0
+          def cursor_id
+            cursor_document ? cursor_document[CURSOR_ID] : super
+          end
 
-        # Get the namespace for the cursor.
-        #
-        # @example Get the namespace.
-        #   result.namespace
-        #
-        # @return [ String ] The namespace.
-        #
-        # @since 2.0.0
-        def namespace
-          cursor_document ? cursor_document[NAMESPACE] : super
-        end
+          # Get the namespace for the cursor.
+          #
+          # @example Get the namespace.
+          #   result.namespace
+          #
+          # @return [ String ] The namespace.
+          #
+          # @since 2.0.0
+          def namespace
+            cursor_document ? cursor_document[NAMESPACE] : super
+          end
 
-        # Get the documents for the listCollections result. It is the 'firstBatch'
-        #   field in the 'cursor' field of the first document returned.
-        #
-        # @example Get the documents.
-        #   result.documents
-        #
-        # @return [ Array<BSON::Document> ] The documents.
-        #
-        # @since 2.0.0
-        def documents
-          cursor_document[FIRST_BATCH]
-        end
+          # Get the documents for the listCollections result. It is the 'firstBatch'
+          #   field in the 'cursor' field of the first document returned.
+          #
+          # @example Get the documents.
+          #   result.documents
+          #
+          # @return [ Array<BSON::Document> ] The documents.
+          #
+          # @since 2.0.0
+          def documents
+            cursor_document[FIRST_BATCH]
+          end
 
-        # Validate the result. In the case where an unauthorized client tries
-        # to run the command we need to generate the proper error.
-        #
-        # @example Validate the result.
-        #   result.validate!
-        #
-        # @return [ Result ] Self if successful.
-        #
-        # @since 2.0.0
-        def validate!
-          !successful? ? raise(Error::OperationFailure.new(parser.message)) : self
-        end
+          # Validate the result. In the case where an unauthorized client tries
+          # to run the command we need to generate the proper error.
+          #
+          # @example Validate the result.
+          #   result.validate!
+          #
+          # @return [ Result ] Self if successful.
+          #
+          # @since 2.0.0
+          def validate!
+            !successful? ? raise(Error::OperationFailure.new(parser.message)) : self
+          end
 
-        private
+          private
 
-        def cursor_document
-          @cursor_document ||= first_document[CURSOR]
-        end
+          def cursor_document
+            @cursor_document ||= first_document[CURSOR]
+          end
 
-        def first_document
-          @first_document ||= reply.documents[0]
+          def first_document
+            @first_document ||= reply.documents[0]
+          end
         end
       end
     end

data/lib/mongo/operation/commands/list_indexes.rb

@@ -12,45 +12,37 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/commands/list_indexes/result'
-
 module Mongo
   module Operation
-
-    # A MongoDB listIndexes command operation.
-    #
-    # @example Create the listIndexes command operation.
-    #   Mongo::Operation::Read::ListIndexes.new({ db_name: 'test', coll_name: 'example' })
-    #
-    # @note A command is actually a query on the virtual '$cmd' collection.
-    #
-    # Initialization:
-    #   param [ Hash ] spec The specifications for the command.
-    #
-    #   option spec :coll_name [ Hash ] The name of the collection whose index
-    #     info is requested.
-    #   option spec :db_name [ String ] The name of the database on which
-    #     the command should be executed.
-    #   option spec :options [ Hash ] Options for the command.
-    #
-    # @since 2.0.0
-    class ListIndexes
-      include Specifiable
-      include Limited
-      include Executable
-      include ReadPreference
-
-      private
-
-      def query_coll
-        Database::COMMAND
-      end
-
-      def selector
-        (spec[SELECTOR] || {}).merge(listIndexes: coll_name)
+    module Commands
+
+      # A MongoDB listIndexes command operation.
+      #
+      # @example Create the listIndexes command operation.
+      #   Mongo::Operation::Read::ListIndexes.new({ db_name: 'test', coll_name: 'example' })
+      #
+      # @note A command is actually a query on the virtual '$cmd' collection.
+      #
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the command.
+      #
+      #   option spec :coll_name [ Hash ] The name of the collection whose index
+      #     info is requested.
+      #   option spec :db_name [ String ] The name of the database on which
+      #     the command should be executed.
+      #   option spec :options [ Hash ] Options for the command.
+      #
+      # @since 2.0.0
+      class ListIndexes < Command
+
+        private
+
+        def selector
+          (spec[SELECTOR] || {}).merge(listIndexes: coll_name)
+        end
       end
     end
   end
 end
 
-
+require 'mongo/operation/commands/list_indexes/result'

data/lib/mongo/operation/commands/list_indexes/result.rb

@@ -14,101 +14,83 @@
 
 module Mongo
   module Operation
-    class ListIndexes
+    module Commands
+      class ListIndexes
 
-      # Defines custom behaviour of results when using the
-      # listIndexes command.
-      #
-      # @since 2.0.0
-      class Result < Operation::Result
-
-        # The field name for the cursor document in a listIndexes result.
+        # Defines custom behaviour of results when using the
+        # listIndexes command.
         #
         # @since 2.0.0
-        CURSOR = 'cursor'.freeze
+        class Result < Operation::Result
 
-        # The cursor id field in the cursor document.
-        #
-        # @since 2.0.0
-        CURSOR_ID = 'id'.freeze
+          # Get the cursor id for the result.
+          #
+          # @example Get the cursor id.
+          #   result.cursor_id
+          #
+          # @note Even though the wire protocol has a cursor_id field for all
+          #   messages of type reply, it is always zero when using the
+          #   listIndexes command and must be retrieved from the cursor
+          #   document itself.
+          #
+          # @return [ Integer ] The cursor id.
+          #
+          # @since 2.0.0
+          def cursor_id
+            cursor_document ? cursor_document[CURSOR_ID] : super
+          end
 
-        # The namespace field in the cursor document.
-        #
-        # @since 2.0.0
-        NAMESPACE = 'ns'.freeze
+          # Get the namespace for the cursor.
+          #
+          # @example Get the namespace.
+          #   result.namespace
+          #
+          # @return [ String ] The namespace.
+          #
+          # @since 2.0.0
+          def namespace
+            cursor_document ? cursor_document[NAMESPACE] : super
+          end
 
-        # The field name for the first batch of a cursor.
-        #
-        # @since 2.0.0
-        FIRST_BATCH = 'firstBatch'.freeze
+          # Get the documents for the listIndexes result. This is the 'firstBatch'
+          # field in the 'cursor' field of the first document returned.
+          #
+          # @example Get the documents.
+          #   result.documents
+          #
+          # @return [ Array<BSON::Document> ] The documents.
+          #
+          # @since 2.0.0
+          def documents
+            cursor_document[FIRST_BATCH]
+          end
 
-        # Get the cursor id for the result.
-        #
-        # @example Get the cursor id.
-        #   result.cursor_id
-        #
-        # @note Even though the wire protocol has a cursor_id field for all
-        #   messages of type reply, it is always zero when using the
-        #   listIndexes command and must be retrieved from the cursor
-        #   document itself.
-        #
-        # @return [ Integer ] The cursor id.
-        #
-        # @since 2.0.0
-        def cursor_id
-          cursor_document ? cursor_document[CURSOR_ID] : super
-        end
+          # Validate the result. In the case where the database or collection
+          # does not exist on the server we will get an error, and it's better
+          # to raise a meaningful exception here than the ambiguous one when
+          # the error occurs.
+          #
+          # @example Validate the result.
+          #   result.validate!
+          #
+          # @raise [ NoNamespace ] If the ns doesn't exist.
+          #
+          # @return [ Result ] Self if successful.
+          #
+          # @since 2.0.0
+          def validate!
+            !successful? ? raise(Error::OperationFailure.new(parser.message)) : self
+          end
 
-        # Get the namespace for the cursor.
-        #
-        # @example Get the namespace.
-        #   result.namespace
-        #
-        # @return [ String ] The namespace.
-        #
-        # @since 2.0.0
-        def namespace
-          cursor_document ? cursor_document[NAMESPACE] : super
-        end
-
-        # Get the documents for the listIndexes result. This is the 'firstBatch'
-        # field in the 'cursor' field of the first document returned.
-        #
-        # @example Get the documents.
-        #   result.documents
-        #
-        # @return [ Array<BSON::Document> ] The documents.
-        #
-        # @since 2.0.0
-        def documents
-          cursor_document[FIRST_BATCH]
-        end
-
-        # Validate the result. In the case where the database or collection
-        # does not exist on the server we will get an error, and it's better
-        # to raise a meaningful exception here than the ambiguous one when
-        # the error occurs.
-        #
-        # @example Validate the result.
-        #   result.validate!
-        #
-        # @raise [ NoNamespace ] If the ns doesn't exist.
-        #
-        # @return [ Result ] Self if successful.
-        #
-        # @since 2.0.0
-        def validate!
-          !successful? ? raise(Error::OperationFailure.new(parser.message)) : self
-        end
+          private
 
-        private
-
-        def cursor_document
-          @cursor_document ||= first_document[CURSOR]
-        end
+          def cursor_document
+            @cursor_document ||= first_document[CURSOR]
+          end
 
-        def first_document
-          @first_document ||= reply.documents[0]
+          def first_document
+            @first_document ||= reply.documents[0]
+          end
         end
       end
     end

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

@@ -12,46 +12,38 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/commands/map_reduce/result'
-
 module Mongo
   module Operation
-    # A MongoDB map reduce operation.
-    #
-    # @note A map/reduce operation can behave like a read and
-    #   return a result set, or can behave like a write operation and
-    #   output results to a user-specified collection.
-    #
-    # @example Create the map/reduce operation.
-    #   MapReduce.new({
-    #     :selector => {
-    #       :mapreduce => 'test_coll',
-    #       :map => '',
-    #       :reduce => ''
-    #     },
-    #     :db_name  => 'test_db'
-    #   })
-    #
-    # Initialization:
-    #   param [ Hash ] spec The specifications for the operation.
-    #
-    #   option spec :selector [ Hash ] The map reduce selector.
-    #   option spec :db_name [ String ] The name of the database on which
-    #     the operation should be executed.
-    #   option spec :options [ Hash ] Options for the map reduce command.
-    #
-    # @since 2.0.0
-    class MapReduce
-      include Specifiable
-      include Limited
-      include ReadPreference
-      include Executable
-
-      private
+    module Commands
 
-      def query_coll
-        Database::COMMAND
-      end
+      # A MongoDB map reduce operation.
+      #
+      # @note A map/reduce operation can behave like a read and
+      #   return a result set, or can behave like a write operation and
+      #   output results to a user-specified collection.
+      #
+      # @example Create the map/reduce operation.
+      #   MapReduce.new({
+      #     :selector => {
+      #       :mapreduce => 'test_coll',
+      #       :map => '',
+      #       :reduce => ''
+      #     },
+      #     :db_name  => 'test_db'
+      #   })
+      #
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the operation.
+      #
+      #   option spec :selector [ Hash ] The map reduce selector.
+      #   option spec :db_name [ String ] The name of the database on which
+      #     the operation should be executed.
+      #   option spec :options [ Hash ] Options for the map reduce command.
+      #
+      # @since 2.0.0
+      class MapReduce < Command; end
     end
   end
 end
+
+require 'mongo/operation/commands/map_reduce/result'