mongo 2.1.0.beta → 2.1.0.rc0

data/lib/mongo/bulk_write/result.rb

@@ -13,13 +13,66 @@
 # limitations under the License.
 
 module Mongo
-  module BulkWrite
+  class BulkWrite
 
     # Wraps a series of bulk write operations in a result object.
     #
     # @since 2.0.6
     class Result
 
+      # Constant for number removed.
+      #
+      # @since 2.1.0
+      REMOVED_COUNT = 'n_removed'.freeze
+
+      # Constant for number inserted.
+      #
+      # @since 2.1.0
+      INSERTED_COUNT = 'n_inserted'.freeze
+
+      # Constant for inserted ids.
+      #
+      # @since 2.1.0
+      INSERTED_IDS = 'inserted_ids'.freeze
+
+      # Constant for number matched.
+      #
+      # @since 2.1.0
+      MATCHED_COUNT = 'n_matched'.freeze
+
+      # Constant for number modified.
+      #
+      # @since 2.1.0
+      MODIFIED_COUNT = 'n_modified'.freeze
+
+      # Constant for upserted.
+      #
+      # @since 2.1.0
+      UPSERTED = 'upserted'.freeze
+
+      # Constant for number upserted.
+      #
+      # @since 2.1.0
+      UPSERTED_COUNT = 'n_upserted'.freeze
+
+      # Constant for upserted ids.
+      #
+      # @since 2.1.0
+      UPSERTED_IDS = 'upserted_ids'.freeze
+
+      # The fields contained in the result document returned from executing the
+      # operations.
+      #
+      # @since 2.1.0.
+      FIELDS = [
+        INSERTED_COUNT,
+        REMOVED_COUNT,
+        MODIFIED_COUNT,
+        UPSERTED_COUNT,
+        MATCHED_COUNT,
+        Operation::Result::N
+      ].freeze
+
       # Returns the number of documents deleted.
       #
       # @example Get the number of deleted documents.
@@ -29,7 +82,7 @@ module Mongo
       #
       # @since 2.1.0
       def deleted_count
-        @results[BulkWritable::REMOVED_COUNT]
+        @results[REMOVED_COUNT]
       end
 
       # Create the new result object from the results document.
@@ -53,7 +106,7 @@ module Mongo
       #
       # @since 2.1.0
       def inserted_count
-        @results[BulkWritable::INSERTED_COUNT]
+        @results[INSERTED_COUNT]
       end
 
       # Get the inserted document ids, if the operation has inserts.
@@ -65,7 +118,7 @@ module Mongo
       #
       # @since 2.1.0
       def inserted_ids
-        @results[BulkWritable::INSERTED_IDS]
+        @results[INSERTED_IDS]
       end
 
       # Returns the number of documents matched.
@@ -77,7 +130,7 @@ module Mongo
       #
       # @since 2.1.0
       def matched_count
-        @results[BulkWritable::MATCHED_COUNT]
+        @results[MATCHED_COUNT]
       end
 
       # Returns the number of documents modified.
@@ -89,7 +142,7 @@ module Mongo
       #
       # @since 2.1.0
       def modified_count
-        @results[BulkWritable::MODIFIED_COUNT]
+        @results[MODIFIED_COUNT]
       end
 
       # Returns the number of documents upserted.
@@ -101,7 +154,7 @@ module Mongo
       #
       # @since 2.1.0
       def upserted_count
-        @results[BulkWritable::UPSERTED_COUNT]
+        @results[UPSERTED_COUNT]
       end
 
       # Get the upserted document ids, if the operation has inserts.
@@ -113,7 +166,7 @@ module Mongo
       #
       # @since 2.1.0
       def upserted_ids
-        @results[BulkWritable::UPSERTED_IDS]
+        @results[UPSERTED_IDS]
       end
 
       # Validates the bulk write result.

data/lib/mongo/bulk_write/result_combiner.rb

@@ -0,0 +1,117 @@
+# 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
+  class BulkWrite
+
+    # Combines bulk write results together.
+    #
+    # @api private
+    #
+    # @since 2.1.0
+    class ResultCombiner
+
+      # @return [ Integer ] count The count of documents in the entire batch.
+      attr_reader :count
+
+      # @return [ Hash ] results The results hash.
+      attr_reader :results
+
+      # Create the new result combiner.
+      #
+      # @api private
+      #
+      # @example Create the result combiner.
+      #   ResultCombiner.new
+      #
+      # @since 2.1.0
+      def initialize
+        @results = {}
+        @count = 0
+      end
+
+      # Combines a result into the overall results.
+      #
+      # @api private
+      #
+      # @example Combine the result.
+      #   combiner.combine!(result, count)
+      #
+      # @param [ Operation::Result ] result The result to combine.
+      # @param [ Integer ] count The count of requests in the batch.
+      #
+      # @since 2.1.0
+      def combine!(result, count)
+        combine_counts!(result)
+        combine_ids!(result)
+        combine_errors!(result)
+        @count += count
+      end
+
+      # Get the final result.
+      #
+      # @api private
+      #
+      # @example Get the final result.
+      #   combinator.result
+      #
+      # @return [ BulkWrite::Result ] The final result.
+      #
+      # @since 2.1.0
+      def result
+        BulkWrite::Result.new(results).validate!
+      end
+
+      private
+
+      def combine_counts!(result)
+        Result::FIELDS.each do |field|
+          if result.respond_to?(field)
+            results.merge!(field => (results[field] || 0) + result.send(field))
+          end
+        end
+      end
+
+      def combine_ids!(result)
+        if result.respond_to?(Result::INSERTED_IDS)
+          results.merge!(Result::INSERTED_IDS => result.inserted_ids)
+        end
+        if result.respond_to?(Result::UPSERTED)
+          results.merge!(Result::UPSERTED_IDS => result.upserted.map{ |doc| doc['_id'] })
+        end
+      end
+
+      def combine_errors!(result)
+        combine_write_errors!(result)
+        combine_write_concern_errors!(result)
+      end
+
+      def combine_write_errors!(result)
+        if write_errors = result.aggregate_write_errors(count)
+          results.merge!(
+            Error::WRITE_ERRORS => ((results[Error::WRITE_ERRORS] || []) << write_errors).flatten
+          )
+        else
+          result.validate!
+        end
+      end
+
+      def combine_write_concern_errors!(result)
+        if write_concern_errors = result.aggregate_write_concern_errors(count)
+          results.merge!(Error::WRITE_CONCERN_ERRORS => write_concern_errors)
+        end
+      end
+    end
+  end
+end

data/lib/mongo/bulk_write/transformable.rb

@@ -0,0 +1,117 @@
+# 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
+  class BulkWrite
+
+    # Defines behaviour around transformations.
+    #
+    # @api private
+    #
+    # @since 2.1.0
+    module Transformable
+
+      # The delete many model constant.
+      #
+      # @since 2.1.0
+      DELETE_MANY = :delete_many.freeze
+
+      # The delete one model constant.
+      #
+      # @since 2.1.0
+      DELETE_ONE = :delete_one.freeze
+
+      # The insert one model constant.
+      #
+      # @since 2.1.0
+      INSERT_ONE = :insert_one.freeze
+
+      # The replace one model constant.
+      #
+      # @since 2.1.0
+      REPLACE_ONE = :replace_one.freeze
+
+      # The update many model constant.
+      #
+      # @since 2.1.0
+      UPDATE_MANY = :update_many.freeze
+
+      # The update one model constant.
+      #
+      # @since 2.1.0
+      UPDATE_ONE = :update_one.freeze
+
+      # Proc to transform delete many ops.
+      #
+      # @since 2.1.0
+      DELETE_MANY_TRANSFORM = ->(doc){
+        { q: doc[:filter], limit: 0 }
+      }
+
+      # Proc to transform delete one ops.
+      #
+      # @since 2.1.0
+      DELETE_ONE_TRANSFORM = ->(doc){
+        { q: doc[:filter], limit: 1 }
+      }
+
+      # Proc to transform insert one ops.
+      #
+      # @since 2.1.0
+      INSERT_ONE_TRANSFORM = ->(doc){
+        doc
+      }
+
+      # Proc to transfor replace one ops.
+      #
+      # @since 2.1.0
+      REPLACE_ONE_TRANSFORM = ->(doc){
+        { q: doc[:filter], u: doc[:replacement], multi: false, upsert: doc.fetch(:upsert, false) }
+      }
+
+      # Proc to transform update many ops.
+      #
+      # @since 2.1.0
+      UPDATE_MANY_TRANSFORM = ->(doc){
+        { q: doc[:filter], u: doc[:update], multi: true, upsert: doc.fetch(:upsert, false) }
+      }
+
+      # Proc to transform update one ops.
+      #
+      # @since 2.1.0
+      UPDATE_ONE_TRANSFORM = ->(doc){
+        { q: doc[:filter], u: doc[:update], multi: false, upsert: doc.fetch(:upsert, false) }
+      }
+
+      # Document mappers from the bulk api input into proper commands.
+      #
+      # @since 2.1.0
+      MAPPERS = {
+        DELETE_MANY => DELETE_MANY_TRANSFORM,
+        DELETE_ONE  => DELETE_ONE_TRANSFORM,
+        INSERT_ONE  => INSERT_ONE_TRANSFORM,
+        REPLACE_ONE => REPLACE_ONE_TRANSFORM,
+        UPDATE_MANY => UPDATE_MANY_TRANSFORM,
+        UPDATE_ONE  => UPDATE_ONE_TRANSFORM
+      }.freeze
+
+      private
+
+      def transform(name, document)
+        validate(name, document)
+        MAPPERS[name].call(document)
+      end
+    end
+  end
+end

data/lib/mongo/bulk_write/unordered_combiner.rb

@@ -0,0 +1,52 @@
+# 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
+  class BulkWrite
+
+    # Combines groups of bulk write operations in no order.
+    #
+    # @api private
+    #
+    # @since 2.1.0
+    class UnorderedCombiner
+      include Transformable
+      include Validatable
+      include Combineable
+
+      # Combine the requests in order.
+      #
+      # @api private
+      #
+      # @example Combine the requests.
+      #   combiner.combine
+      #
+      # @return [ Array<Hash> ] The combined requests.
+      #
+      # @since 2.1.0
+      def combine
+        combine_requests({}).map do |name, ops|
+          { name => ops }
+        end
+      end
+
+      private
+
+      def add(operations, name, document)
+        (operations[name] ||= []).push(transform(name, document))
+        operations
+      end
+    end
+  end
+end

data/lib/mongo/bulk_write/validatable.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
+  class BulkWrite
+
+    # Defines behaviour around validations.
+    #
+    # @api private
+    #
+    # @since 2.1.0
+    module Validatable
+
+      # Validate the document.
+      #
+      # @api private
+      #
+      # @example Validate the document.
+      #   validatable.validate(:insert_one, { _id: 0 })
+      #
+      # @param [ Symbol ] name The operation name.
+      # @param [ Hash, BSON::Document ] document The document.
+      #
+      # @raise [ InvalidBulkOperation ] If not valid.
+      #
+      # @return [ Hash, BSON::Document ] The document.
+      #
+      # @since 2.1.0
+      def validate(name, document)
+        validate_operation(name)
+        validate_document(name, document)
+      end
+
+      private
+
+      def validate_document(name, document)
+        if document.respond_to?(:keys) || document.respond_to?(:data)
+          document
+        else
+          raise Error::InvalidBulkOperation.new(name, document)
+        end
+      end
+
+      def validate_operation(name)
+        unless Transformable::MAPPERS.key?(name)
+          raise Error::InvalidBulkOperationType.new(name)
+        end
+      end
+    end
+  end
+end