mongo 2.1.2 → 2.2.0.rc0

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

@@ -14,24 +14,26 @@
 
 module Mongo
   module Operation
-    class CollectionsInfo
+    module Commands
+      class CollectionsInfo
 
-      # Defines custom behaviour of results when query the system.namespaces
-      # collection.
-      #
-      # @since 2.1.0
-      class Result < Operation::Result
-
-        # Get the namespace for the cursor.
-        #
-        # @example Get the namespace.
-        #   result.namespace
-        #
-        # @return [ String ] The namespace.
+        # Defines custom behaviour of results when query the system.namespaces
+        # collection.
         #
         # @since 2.1.0
-        def namespace
-          Database::NAMESPACES
+        class Result < Operation::Result
+
+          # Get the namespace for the cursor.
+          #
+          # @example Get the namespace.
+          #   result.namespace
+          #
+          # @return [ String ] The namespace.
+          #
+          # @since 2.1.0
+          def namespace
+            Database::NAMESPACES
+          end
         end
       end
     end

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

@@ -14,31 +14,33 @@
 
 module Mongo
   module Operation
+    module Commands
 
-    # A MongoDB command operation.
-    #
-    # @example Create the command operation.
-    #   Mongo::Operation::Command.new({ :selector => { :isMaster => 1 } })
-    #
-    # Initialization:
-    #   param [ Hash ] spec The specifications for the command.
-    #
-    #   option spec :selector [ Hash ] The command selector.
-    #   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 Command
-      include Specifiable
-      include Limited
-      include ReadPreference
-      include Executable
+      # A MongoDB command operation.
+      #
+      # @example Create the command operation.
+      #   Mongo::Operation::Command.new({ :selector => { :isMaster => 1 } })
+      #
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the command.
+      #
+      #   option spec :selector [ Hash ] The command selector.
+      #   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 Command
+        include Specifiable
+        include Limited
+        include ReadPreference
+        include Executable
 
-      private
+        private
 
-      def query_coll
-        Database::COMMAND
+        def query_coll
+          Database::COMMAND
+        end
       end
     end
   end

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

@@ -0,0 +1,27 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Operation
+    module Commands
+
+      # Encapsulates behaviour for executing a find command.
+      #
+      # @since 2.2.0
+      class Find < Command; end
+    end
+  end
+end
+
+require 'mongo/operation/commands/find/result'

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

@@ -0,0 +1,62 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Operation
+    module Commands
+      class Find
+
+        # Defines custom behaviour of results in find command.
+        #
+        # @since 2.2.0
+        class Result < Operation::Result
+
+          # Get the cursor id.
+          #
+          # @example Get the cursor id.
+          #   result.cursor_id
+          #
+          # @return [ Integer ] The cursor id.
+          #
+          # @since 2.2.0
+          def cursor_id
+            cursor_document ? cursor_document[CURSOR_ID] : super
+          end
+
+          # Get the documents in the result.
+          #
+          # @example Get the documents.
+          #   result.documents
+          #
+          # @return [ Array<BSON::Document> ] The documents.
+          #
+          # @since 2.2.0
+          def documents
+            cursor_document[FIRST_BATCH]
+          end
+
+          private
+
+          def cursor_document
+            @cursor_document ||= reply.documents[0][CURSOR]
+          end
+
+          def first_document
+            @first_document ||= reply.documents[0]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Operation
+    module Commands
+
+      # Encapsulates behaviour for executing a getmore command.
+      #
+      # @since 2.2.0
+      class GetMore < Command; end
+    end
+  end
+end
+
+require 'mongo/operation/commands/get_more/result'

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

@@ -0,0 +1,62 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Operation
+    module Commands
+      class GetMore
+
+        # Defines custom behaviour of results for the get more command.
+        #
+        # @since 2.2.0
+        class Result < Operation::Result
+
+          # Get the cursor id.
+          #
+          # @example Get the cursor id.
+          #   result.cursor_id
+          #
+          # @return [ Integer ] The cursor id.
+          #
+          # @since 2.2.0
+          def cursor_id
+            cursor_document ? cursor_document[CURSOR_ID] : super
+          end
+
+          # Get the documents in the result.
+          #
+          # @example Get the documents.
+          #   result.documents
+          #
+          # @return [ Array<BSON::Document> ] The documents.
+          #
+          # @since 2.2.0
+          def documents
+            cursor_document[NEXT_BATCH]
+          end
+
+          private
+
+          def cursor_document
+            @cursor_document ||= reply.documents[0][CURSOR]
+          end
+
+          def first_document
+            @first_document ||= reply.documents[0]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,56 +14,58 @@
 
 module Mongo
   module Operation
+    module Commands
 
-    # A MongoDB get indexes operation.
-    #
-    # Initialize the get indexes operation.
-    #
-    # @example Instantiate the operation.
-    #   Read::Indexes.new(:db_name => 'test', :coll_name => 'test_coll')
-    #
-    # Initialization:
-    #   param [ Hash ] spec The specifications for the insert.
-    #
-    #   option spec :db_name [ String ] The name of the database.
-    #   option spec :coll_name [ String ] The name of the collection.
-    #
-    # @since 2.0.0
-    class Indexes
-      include Specifiable
-      include ReadPreference
-
-      # Execute the operation.
-      # The context gets a connection on which the operation
-      # is sent in the block.
+      # A MongoDB get indexes operation.
+      #
+      # Initialize the get indexes operation.
+      #
+      # @example Instantiate the operation.
+      #   Read::Indexes.new(:db_name => 'test', :coll_name => 'test_coll')
       #
-      # @param [ Mongo::Server::Context ] context The context for this operation.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the insert.
       #
-      # @return [ Result ] The indexes operation response.
+      #   option spec :db_name [ String ] The name of the database.
+      #   option spec :coll_name [ String ] The name of the collection.
       #
       # @since 2.0.0
-      def execute(context)
-        if context.features.list_indexes_enabled?
-          ListIndexes.new(spec).execute(context)
-        else
-          execute_message(context)
+      class Indexes
+        include Specifiable
+        include ReadPreference
+
+        # Execute the operation.
+        # The context gets a connection on which the operation
+        # is sent in the block.
+        #
+        # @param [ Mongo::Server::Context ] context The context for this operation.
+        #
+        # @return [ Result ] The indexes operation response.
+        #
+        # @since 2.0.0
+        def execute(context)
+          if context.features.list_indexes_enabled?
+            ListIndexes.new(spec).execute(context)
+          else
+            execute_message(context)
+          end
         end
-      end
 
-      private
+        private
 
-      def execute_message(context)
-        context.with_connection do |connection|
-          Result.new(connection.dispatch([ message(context) ]))
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message(context) ]))
+          end
         end
-      end
 
-      def selector
-        { ns: namespace }
-      end
+        def selector
+          { ns: namespace }
+        end
 
-      def query_coll
-        Index::COLLECTION
+        def query_coll
+          Index::COLLECTION
+        end
       end
     end
   end

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

@@ -12,43 +12,37 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/commands/list_collections/result'
-
 module Mongo
   module Operation
+    module Commands
 
-    # A MongoDB listCollections command operation.
-    #
-    # @example Create the listCollections command operation.
-    #   Mongo::Operation::Read::ListCollections.new(db_name: 'test')
-    #
-    # @note A command is actually a query on the virtual '$cmd' collection.
-    #
-    # Initialization:
-    #   param [ Hash ] spec The specifications for the command.
-    #
-    #   option spec :db_name [ String ] The name of the database whose list of
-    #     collection names is requested.
-    #   option spec :options [ Hash ] Options for the command.
-    #
-    # @since 2.0.0
-    class ListCollections
-      include Specifiable
-      include Limited
-      include Executable
-      include ReadPreference
-
-      private
+      # A MongoDB listCollections command operation.
+      #
+      # @example Create the listCollections command operation.
+      #   Mongo::Operation::Read::ListCollections.new(db_name: 'test')
+      #
+      # @note A command is actually a query on the virtual '$cmd' collection.
+      #
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the command.
+      #
+      #   option spec :db_name [ String ] The name of the database whose list of
+      #     collection names is requested.
+      #   option spec :options [ Hash ] Options for the command.
+      #
+      # @since 2.0.0
+      class ListCollections < Command
 
-      def query_coll
-        Database::COMMAND
-      end
+        private
 
-      def selector
-        (spec[SELECTOR] || {}).merge(
-          listCollections: 1, filter: { name: { '$not' => /system\.|\$/ }}
-        )
+        def selector
+          (spec[SELECTOR] || {}).merge(
+            listCollections: 1, filter: { name: { '$not' => /system\.|\$/ }}
+          )
+        end
       end
     end
   end
 end
+
+require 'mongo/operation/commands/list_collections/result'