mongo 2.1.0.beta → 2.2.0

data/lib/mongo/operation/commands.rb

@@ -0,0 +1,26 @@
+# Copyright (C) 2014-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.
+
+require 'mongo/operation/commands/command'
+require 'mongo/operation/commands/find'
+require 'mongo/operation/commands/get_more'
+require 'mongo/operation/commands/parallel_scan'
+require 'mongo/operation/commands/aggregate'
+require 'mongo/operation/commands/map_reduce'
+require 'mongo/operation/commands/collections_info'
+require 'mongo/operation/commands/indexes'
+require 'mongo/operation/commands/list_collections'
+require 'mongo/operation/commands/list_indexes'
+require 'mongo/operation/commands/user_query'
+require 'mongo/operation/commands/users_info'

data/lib/mongo/operation/executable.rb

@@ -15,8 +15,8 @@
 module Mongo
   module Operation
 
-    # This module contains common functionality for defining an operation
-    # and executing it, given a certain context.
+    # This module provides the #execute method that many operations use.
+    # It makes sure to instantiate the appropriate Result class for the operation's response.
     #
     # @since 2.0.0
     module Executable
@@ -32,72 +32,8 @@ module Mongo
       # @since 2.0.0
       def execute(context)
         context.with_connection do |connection|
-          connection.dispatch([ message ], operation_id)
-        end
-      end
-
-      # Merge this operation with another operation, returning a new one.
-      # Requires that the collection and database of the two ops are the same.
-      #
-      # @param[ Object ] The other operation.
-      #
-      # @return [ Object ] A new operation merging this one and another.
-      #
-      # @since 2.0.0
-      def merge(other)
-        # @todo: use specific exception
-        raise Exception, "Cannot merge" unless self.class == other.class &&
-            coll_name == other.coll_name &&
-            db_name == other.db_name
-        dup.merge!(other)
-      end
-
-      # Get the full namespace that this operates on.
-      #
-      # @example Get the namespace.
-      #   executable.namespace
-      #
-      # @return [ String ] The namespace.
-      #
-      # @since 2.0.0
-      def namespace
-        "#{db_name}.#{coll_name}"
-      end
-
-      # If an operation including this module doesn't define #merge!, neither
-      # #merge nor #merge! will be allowed.
-      #
-      # @param[ Object ] The other operation.
-      #
-      # @raise [ Exception ] Merging is not supported for this operation.
-      #
-      # @since 2.0.0
-      def merge!(other)
-        raise Exception, "Merging not allowed for this operation type"
-      end
-
-      private
-
-      # If it's ok that this operation be sent to a secondary server.
-      #
-      # @return [ true, false ] Whether it's ok for this op to go to a secondary.
-      #
-      # @since 2.0.0
-      def secondary_ok?
-        true
-      end
-
-      # Gets the legacy get last error command as a wire protocol query.
-      #
-      # @since 2.0.0
-      def gle
-        if gle_message = write_concern.get_last_error
-          Protocol::Query.new(
-            db_name,
-            Database::COMMAND,
-            gle_message,
-            options.merge(limit: -1)
-          )
+          result_class = self.class.const_defined?(:Result, false) ? self.class::Result : Result
+          result_class.new(connection.dispatch([ message(context) ], operation_id)).validate!
         end
       end
     end

data/lib/mongo/operation/kill_cursors.rb

@@ -27,13 +27,13 @@ module Mongo
     #
     # @since 2.0.0
     class KillCursors
-      include Executable
       include Specifiable
+      include Executable
 
       private
 
-      def message
-        Protocol::KillCursors.new(cursor_ids)
+      def message(context)
+        Protocol::KillCursors.new(coll_name, db_name, cursor_ids)
       end
     end
   end

data/lib/mongo/operation/object_id_generator.rb

@@ -0,0 +1,36 @@
+# 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
+
+    # The default generator of ids for documents.
+    #
+    # @since 2.2.0
+    class ObjectIdGenerator
+
+      # Generate a nwe id.
+      #
+      # @example Generate the id.
+      #   object_id_generator.generate
+      #
+      # @return [ BSON::ObjectId ] The new id.
+      #
+      # @since 2.2.0
+      def generate
+        BSON::ObjectId.new
+      end
+    end
+  end
+end

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

@@ -38,32 +38,12 @@ module Mongo
       #
       # @since 2.0.0
       class GetMore
-        include Executable
         include Specifiable
-
-        # Execute the get more operation.
-        #
-        # @example Execute the operation.
-        #   operation.execute(context)
-        #
-        # @param [ Mongo::Server::Context ] context The context for this operation.
-        #
-        # @return [ Result ] The operation response, if there is one.
-        #
-        # @since 2.0.0
-        def execute(context)
-          execute_message(context)
-        end
+        include Executable
 
         private
 
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message ]))
-          end
-        end
-
-        def message
+        def message(context)
           Protocol::GetMore.new(db_name, coll_name, to_return, cursor_id)
         end
       end

data/lib/mongo/operation/read/query/result.rb

@@ -0,0 +1,40 @@
+# Copyright (C) 2014-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 Read
+      class Query
+
+        # Defines custom behaviour of results for a query.
+        #
+        # @since 2.1.0
+        class Result < Operation::Result
+
+          # Determine if the query was a success.
+          #
+          # @example Was the query successful?
+          #   result.successful?
+          #
+          # @return [ true, false ] If the query was successful.
+          #
+          # @since 2.0.0
+          def successful?
+            !query_failure?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/read/query.rb

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/operation/read/query/result'
+
 module Mongo
   module Operation
     module Read
@@ -38,31 +40,12 @@ module Mongo
       #
       # @since 2.0.0
       class Query
-        include Executable
         include Specifiable
-        include ReadPreferrable
-
-        # Execute the operation.
-        # The context gets a connection on which the operation
-        # is sent in the block.
-        #
-        # @param [ Server::Context ] context The context for this operation.
-        #
-        # @return [ Result ] The operation response, if there is one.
-        #
-        # @since 2.0.0
-        def execute(context)
-          execute_message(context)
-        end
+        include Executable
+        include ReadPreference
 
         private
 
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message(context) ])).validate!
-          end
-        end
-
         def query_coll
           coll_name
         end

data/lib/mongo/operation/read.rb

@@ -14,7 +14,3 @@
 
 require 'mongo/operation/read/query'
 require 'mongo/operation/read/get_more'
-require 'mongo/operation/read/indexes'
-require 'mongo/operation/read/list_indexes'
-require 'mongo/operation/read/list_collections'
-require 'mongo/operation/read/collections_info'

data/lib/mongo/operation/{read_preferrable.rb → read_preference.rb}

@@ -15,10 +15,11 @@
 module Mongo
   module Operation
 
-    # Adds behaviour for queries that need to take read preference into account.
+    # Adds behaviour for updating the options and the selector for operations
+    # that need to take read preference into account.
     #
     # @since 2.0.0
-    module ReadPreferrable
+    module ReadPreference
 
       # The constant for slave ok flags.
       #

data/lib/mongo/operation/result.rb

@@ -22,6 +22,31 @@ module Mongo
       extend Forwardable
       include Enumerable
 
+      # The field name for the cursor document in an aggregation.
+      #
+      # @since 2.2.0
+      CURSOR = 'cursor'.freeze
+
+      # The cursor id field in the cursor document.
+      #
+      # @since 2.2.0
+      CURSOR_ID = 'id'.freeze
+
+      # The field name for the first batch of a cursor.
+      #
+      # @since 2.2.0
+      FIRST_BATCH = 'firstBatch'.freeze
+
+      # The field name for the next batch of a cursor.
+      #
+      # @since 2.2.0
+      NEXT_BATCH = 'nextBatch'.freeze
+
+      # The namespace field in the cursor document.
+      #
+      # @since 2.2.0
+      NAMESPACE = 'ns'.freeze
+
       # The number of documents updated in the write.
       #
       # @since 2.0.0
@@ -32,6 +57,11 @@ module Mongo
       # @since 2.0.0
       OK = 'ok'.freeze
 
+      # The result field constant.
+      #
+      # @since 2.2.0
+      RESULT = 'result'.freeze
+
       # @return [ Array<Protocol::Reply> ] replies The wrapped wire protocol replies.
       attr_reader :replies
 
@@ -190,12 +220,24 @@ module Mongo
       def successful?
         return true if !acknowledged?
         if first_document.has_key?(OK)
-          first_document[OK] == 1 && parser.message.empty?
+          ok? && parser.message.empty?
         else
           !query_failure? && parser.message.empty?
         end
       end
 
+      # Check the first document's ok field.
+      #
+      # @example Check the ok field.
+      #   result.ok?
+      #
+      # @return [ true, false ] If the command returned ok.
+      #
+      # @since 2.1.0
+      def ok?
+        first_document[OK] == 1
+      end
+
       # Validate the result by checking for any errors.
       #
       # @note This only checks for errors with writes since authentication is

data/lib/mongo/operation/specifiable.rb

@@ -86,6 +86,11 @@ module Mongo
       # @since 2.0.0
       OPTIONS = :options.freeze
 
+      # The read concern option.
+      #
+      # @since 2.2.0
+      READ_CONCERN = :read_concern.freeze
+
       # The field for a selector.
       #
       # @since 2.0.0
@@ -126,6 +131,11 @@ module Mongo
       # @since 2.0.0
       READ = :read.freeze
 
+      # Whether to bypass document level validation.
+      #
+      # @since 2.2.0
+      BYPASS_DOC_VALIDATION = :bypass_document_validation.freeze
+
       # @return [ Hash ] spec The specification for the operation.
       attr_reader :spec
 
@@ -317,6 +327,30 @@ module Mongo
         spec[OPTIONS] || {}
       end
 
+      # Get the read concern from the spec.
+      #
+      # @example Get the read concern.
+      #   specifiable.read_concern
+      #
+      # @return [ Hash ] The read concern.
+      #
+      # @since 2.2.0
+      def read_concern
+        spec[READ_CONCERN]
+      end
+
+      # Whether or not to bypass document level validation.
+      #
+      # @example Get the bypass_document_validation option.
+      #   specifiable.bypass_documentation_validation.
+      #
+      # @return [ true, false ] Whether to bypass document level validation.
+      #
+      # @since 2.2.0
+      def bypass_document_validation
+        spec[BYPASS_DOC_VALIDATION]
+      end
+
       # The selector for from the specification.
       #
       # @example Get a selector specification.
@@ -396,7 +430,7 @@ module Mongo
       #
       # @since 2.0.0
       def write_concern
-        @spec[WRITE_CONCERN] || WriteConcern.get(WriteConcern::DEFAULT)
+        @spec[WRITE_CONCERN]
       end
 
       # The read preference for this operation.
@@ -410,6 +444,30 @@ module Mongo
       def read
         @spec[READ] || ServerSelector.get
       end
+
+      # Whether the operation is ordered.
+      #
+      # @example Get the ordered value, true is the default.
+      #   specifiable.ordered?
+      #
+      # @return [ true, false ] Whether the operation is ordered.
+      #
+      # @since 2.1.0
+      def ordered?
+        !!(@spec.fetch(:ordered, true))
+      end
+
+      # The namespace, consisting of the db name and collection name.
+      #
+      # @example Get the namespace.
+      #   specifiable.namespace
+      #
+      # @return [ String ] The namespace.
+      #
+      # @since 2.1.0
+      def namespace
+        "#{db_name}.#{coll_name}"
+      end
     end
   end
 end

data/lib/mongo/operation/write/bulk/bulkable.rb

@@ -0,0 +1,83 @@
+# Copyright (C) 2014-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 Write
+      module Bulk
+
+        # Provides common behavior for bulk write operations.
+        # Note that #validate! is not called on operation results because they are merged
+        # at a higher level.
+        #
+        # @since 2.1.0
+        module Bulkable
+
+          # Execute the bulk operation.
+          #
+          # @example Execute the operation.
+          #   operation.execute(context)
+          #
+          # @param [ Mongo::Server::Context ] context The context for this operation.
+          #
+          # @return [ Result ] The operation result.
+          #
+          # @since 2.0.0
+          def execute(context)
+            if context.features.write_command_enabled?
+              execute_write_command(context)
+            else
+              execute_message(context)
+            end
+          end
+
+          private
+
+          def execute_message(context)
+            replies = messages.map do |m|
+              context.with_connection do |connection|
+                result = self.class::LegacyResult.new(connection.dispatch([ m, gle ].compact, operation_id))
+                if stop_sending?(result)
+                  return result
+                else
+                  result.reply
+                end
+              end
+            end
+            self.class::LegacyResult.new(replies.compact.empty? ? nil : replies)
+          end
+
+          def stop_sending?(result)
+            ordered? && !result.successful?
+          end
+
+          def gle
+            wc = write_concern ||  WriteConcern.get(WriteConcern::DEFAULT)
+            gle_message = ( ordered? && wc.get_last_error.nil? ) ?
+                Mongo::WriteConcern.get(Mongo::WriteConcern::DEFAULT).get_last_error :
+                wc.get_last_error
+            if gle_message
+              Protocol::Query.new(
+                  db_name,
+                  Database::COMMAND,
+                  gle_message,
+                  options.merge(limit: -1)
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# Copyright (C) 2014-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 Write
+      module Bulk
+        class Delete
+
+          # Defines common r_removed aggreation behaviour.
+          #
+          # @since 2.2.0
+          module Aggregatable
+
+            # Gets the number of documents deleted.
+            #
+            # @example Get the deleted count.
+            #   result.n_removed
+            #
+            # @return [ Integer ] The number of documents deleted.
+            #
+            # @since 2.0.0
+            def n_removed
+              return 0 unless acknowledged?
+              @replies.reduce(0) do |n, reply|
+                n += reply.documents.first[Result::N]
+              end
+            end
+          end
+
+          # Defines custom behaviour of results when deleting.
+          #
+          # @since 2.0.0
+          class Result < Operation::Result
+            include Mergable
+            include Aggregatable
+
+            # The aggregate number of deleted docs reported in the replies.
+            #
+            # @since 2.0.0
+            REMOVED = 'nRemoved'.freeze
+          end
+
+          # Defines custom behaviour of results when deleting.
+          # For server versions < 2.5.5 (that don't use write commands).
+          #
+          # @since 2.0.0
+          class LegacyResult < Operation::Result
+            include LegacyMergable
+            include Aggregatable
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/bulk/delete.rb

@@ -0,0 +1,71 @@
+# Copyright (C) 2014-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.
+
+require 'mongo/operation/write/bulk/delete/result'
+
+module Mongo
+  module Operation
+    module Write
+      module Bulk
+
+        # A MongoDB bulk delete operation.
+        #
+        # @note If a server with version >= 2.5.5 is selected, a write command
+        #   operation will be created and sent instead.
+        #
+        # @example Create the delete operation.
+        #   Write::Bulk::Delete.new({
+        #     :deletes => [{ :q => { :foo => 1 }, :limit => 1 }],
+        #     :db_name => 'test',
+        #     :coll_name => 'test_coll',
+        #     :write_concern => write_concern
+        #   })
+        #
+        # Initialization:
+        #   param [ Hash ] spec The specifications for the delete.
+        #
+        #   option spec :deletes [ Array ] The delete documents.
+        #   option spec :db_name [ String ] The name of the database on which
+        #     the delete should be executed.
+        #   option spec :coll_name [ String ] The name of the collection on which
+        #     the delete should be executed.
+        #   option spec :write_concern [ Mongo::WriteConcern ] The write concern
+        #     for this operation.
+        #   option spec :ordered [ true, false ] Whether the operations should be
+        #     executed in order.
+        #   option spec :options [Hash] Options for the command, if it ends up being a
+        #     write command.
+        #
+        # @since 2.0.0
+        class Delete
+          include Bulkable
+          include Specifiable
+
+          private
+
+          def execute_write_command(context)
+            Result.new(Command::Delete.new(spec).execute(context))
+          end
+
+          def messages
+            deletes.collect do |del|
+              opts = ( del[Operation::LIMIT] || 0 ) <= 0 ? {} : { :flags => [ :single_remove ] }
+              Protocol::Delete.new(db_name, coll_name, del[Operation::Q], opts)
+            end
+          end
+        end
+      end
+    end
+  end
+end