mongo 2.5.1 → 2.5.2

data/lib/mongo/operation/shared/idable.rb

@@ -0,0 +1,64 @@
+# Copyright (C) 2018 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
+
+    # Shared behavior of operations that require its documents to each have an id.
+    #
+    # @since 2.5.2
+    module Idable
+
+      def documents
+        @documents ||= ensure_ids(super)
+      end
+
+      private
+
+      # The option for a custom id generator.
+      #
+      # @since 2.2.0
+      ID_GENERATOR = :id_generator.freeze
+
+      # Get the id generator.
+      #
+      # @example Get the id generator.
+      #   idable.id_generator
+      #
+      # @return [ IdGenerator ] The default or custom id generator.
+      #
+      # @since 2.2.0
+      def id_generator
+        @id_generator ||= (spec[ID_GENERATOR] || Operation::ObjectIdGenerator.new)
+      end
+
+      def id(doc)
+        doc.respond_to?(:id) ? doc.id : (doc['_id'] || doc[:_id])
+      end
+
+      def has_id?(doc)
+        !!id(doc)
+      end
+
+      def ensure_ids(documents)
+        @ids = []
+        documents.collect do |doc|
+          doc_with_id = has_id?(doc) ? doc : doc.merge(_id: id_generator.generate)
+          @ids << id(doc_with_id)
+          doc_with_id
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/{commands/distinct.rb → shared/limited.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,13 +14,16 @@
 
 module Mongo
   module Operation
-    module Commands
 
-      # Encapsulates behaviour for executing a distinct command.
-      #
-      # @since 2.5.0
-      class Distinct < Command
-        include CausallyConsistent
+    # Shared behavior of operations that require its documents to each have an id.
+    #
+    # @since 2.5.2
+    module Limited
+
+      private
+
+      def options(server = nil)
+        super.merge(limit: -1)
       end
     end
   end

data/lib/mongo/operation/{object_id_generator.rb → shared/object_id_generator.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@ module Mongo
     # @since 2.2.0
     class ObjectIdGenerator
 
-      # Generate a nwe id.
+      # Generate a new id.
       #
       # @example Generate the id.
       #   object_id_generator.generate

data/lib/mongo/operation/{read_preference.rb → shared/read_preference_supported.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,35 +15,30 @@
 module Mongo
   module Operation
 
-    # Adds behaviour for updating the options and the selector for operations
-    # that need to take read preference into account.
+    # Shared behavior of operations that support read preference.
     #
-    # @since 2.0.0
-    module ReadPreference
-      include UsesCommandOpMsg
+    # @since 2.5.2
+    module ReadPreferenceSupported
+
+      private
 
-      # The constant for slave ok flags.
-      #
-      # @since 2.0.6
       SLAVE_OK = :slave_ok
 
-      private
+      def options(server)
+        update_options_for_slave_ok(super, server)
+      end
 
       def update_selector_for_read_pref(sel, server)
         if read && server.mongos? && read_pref = read.to_mongos
-          sel = sel[:$query] ? sel : { :$query => sel }
+          sel = sel[:$query] ? sel : {:$query => sel}
           sel.merge(:$readPreference => read_pref)
         else
           sel
         end
       end
 
-      def slave_ok?(server)
-        (server.cluster.single? && !server.mongos?) || (read && read.slave_ok?)
-      end
-
       def update_options_for_slave_ok(opts, server)
-        if slave_ok?(server)
+        if (server.cluster.single? && !server.mongos?) || (read && read.slave_ok?)
           opts.dup.tap do |o|
             (o[:flags] ||= []) << SLAVE_OK
           end
@@ -52,14 +47,9 @@ module Mongo
         end
       end
 
-      def message(server)
-        if server.features.op_msg_enabled?
-          command_op_msg(server, selector, options)
-        else
-          sel = update_selector_for_read_pref(selector, server)
-          opts = update_options_for_slave_ok(options, server)
-          Protocol::Query.new(db_name, query_coll, sel, opts)
-        end
+      def command(server)
+        sel = super
+        update_selector_for_read_pref(sel, server)
       end
     end
   end

data/lib/mongo/operation/shared/result/aggregatable.rb

@@ -0,0 +1,75 @@
+# Copyright (C) 2014-2018 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
+    class Result
+
+      # Defines custom behaviour of bulk write results
+      #
+      # @since 2.0.0
+      module Aggregatable
+
+        # Aggregate the write errors returned from this result.
+        #
+        # @example Aggregate the write errors.
+        #   result.aggregate_write_errors(0)
+        #
+        # @param [ Integer ] count The number of documents already executed.
+        #
+        # @return [ Array ] The aggregate write errors.
+        #
+        # @since 2.0.0
+        def aggregate_write_errors(count)
+          return unless @replies
+          @replies.reduce(nil) do |errors, reply|
+            if write_errors = reply.documents.first[Error::WRITE_ERRORS]
+              wes = write_errors.collect do |we|
+                we.merge!('index' => count + we['index'])
+              end
+              (errors || []) << wes if wes
+            end
+          end
+        end
+
+        # Aggregate the write concern errors returned from this result.
+        #
+        # @example Aggregate the write concern errors.
+        #   result.aggregate_write_concern_errors(100)
+        #
+        # @param [ Integer ] count The number of documents already executed.
+        #
+        # @return [ Array ] The aggregate write concern errors.
+        #
+        # @since 2.0.0
+        def aggregate_write_concern_errors(count)
+          return unless @replies
+          @replies.each_with_index.reduce(nil) do |errors, (reply, _)|
+            if write_concern_errors = reply.documents.first[Error::WRITE_CONCERN_ERRORS]
+              (errors || []) << write_concern_errors.reduce(nil) do |errs, wce|
+                wce.merge!('index' => count + wce['index'])
+                (errs || []) << write_concern_error
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+
+
+
+

data/lib/mongo/operation/shared/sessions_supported.rb

@@ -0,0 +1,79 @@
+# Copyright (C) 2015-2017 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
+
+    # Shared behavior of operations that support a session.
+    #
+    # @since 2.5.2
+    module SessionsSupported
+
+      private
+
+      ZERO_TIMESTAMP = BSON::Timestamp.new(0, 0)
+
+      READ_PREFERENCE = '$readPreference'.freeze
+
+      def apply_causal_consistency!(selector, server); end
+
+      def flags
+        acknowledged_write? ? [:none] : [:more_to_come]
+      end
+
+      def apply_cluster_time!(selector, server)
+        if !server.standalone?
+          cluster_time = [server.cluster_time, (session && session.cluster_time)].max_by do |doc|
+            (doc && doc[Cluster::CLUSTER_TIME]) || ZERO_TIMESTAMP
+          end
+
+          if cluster_time && (cluster_time[Cluster::CLUSTER_TIME] > ZERO_TIMESTAMP)
+            selector[CLUSTER_TIME] = cluster_time
+          end
+        end
+      end
+
+      def add_write_concern!(sel)
+        if write_concern
+          sel[:writeConcern] = write_concern.options
+        end
+      end
+
+      def apply_session_id!(selector)
+        session.add_id!(selector)
+      end
+
+      def command(server)
+        sel = selector(server)
+        sel[:writeConcern] = write_concern.options if write_concern
+        sel[Protocol::Msg::DATABASE_IDENTIFIER] = db_name
+        sel[READ_PREFERENCE] = read.to_doc if read
+        if server.features.sessions_enabled?
+          apply_cluster_time!(sel, server)
+          if acknowledged_write? && session
+            sel[:txnNumber] = BSON::Int64.new(txn_num) if txn_num
+            apply_session_id!(sel)
+            apply_causal_consistency!(sel, server)
+          end
+        elsif session && session.explicit?
+          apply_cluster_time!(sel, server)
+          sel[:txnNumber] = BSON::Int64.new(txn_num) if txn_num
+          apply_session_id!(sel)
+          apply_causal_consistency!(sel, server)
+        end
+        sel
+      end
+    end
+  end
+end

data/lib/mongo/operation/{specifiable.rb → shared/specifiable.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -333,7 +333,7 @@ module Mongo
       # @return [ Hash ] The options.
       #
       # @since 2.0.0
-      def options
+      def options(server = nil)
         spec[OPTIONS] || {}
       end
 
@@ -382,7 +382,7 @@ module Mongo
       #
       # @since 2.4.0
       def collation
-        spec[COLLATION]
+        send(self.class::IDENTIFIER).first[COLLATION]
       end
 
       # The selector for from the specification.
@@ -393,7 +393,7 @@ module Mongo
       # @return [ Hash ] The selector spec.
       #
       # @since 2.0.0
-      def selector
+      def selector(server = nil)
         spec[SELECTOR]
       end
 
@@ -526,6 +526,42 @@ module Mongo
       def txn_num
         @spec[:txn_num]
       end
+
+      # The command.
+      #
+      # @example Get the command.
+      #   specifiable.command
+      #
+      # @return [ Hash ] The command.
+      #
+      # @since 2.5.2
+      def command(server = nil)
+        selector(server)
+      end
+
+      # The array filters.
+      #
+      # @example Get the array filters.
+      #   specifiable.array_filters
+      #
+      # @return [ Hash ] The array filters.
+      #
+      # @since 2.5.2
+      def array_filters
+        selector[Operation::ARRAY_FILTERS] if selector
+      end
+
+      # Does the operation have an acknowledged write concern.
+      #
+      # @example Determine whether the operation has an acknoweldged write.
+      #   specifiable.array_filters
+      #
+      # @return [ Hash ] The array filters.
+      #
+      # @since 2.5.2
+      def acknowledged_write?
+        write_concern.nil? || write_concern.acknowledged?
+      end
     end
   end
 end

data/lib/mongo/operation/shared/write.rb

@@ -0,0 +1,81 @@
+# Copyright (C) 2018 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
+
+    # Shared behavior of operations that write (update, insert, delete).
+    #
+    # @since 2.5.2
+    module Write
+
+      # Execute the operation.
+      #
+      # @example
+      #   operation.execute(server)
+      #
+      # @param [ Mongo::Server ] server The server to send the operation to.
+      #
+      # @return [ Mongo::Operation::Result ] The operation result.
+      #
+      # @since 2.5.2
+      def execute(server)
+        validate!
+        result = if server.features.op_msg_enabled?
+            self.class::OpMsg.new(spec).execute(server)
+          elsif !acknowledged_write?
+            self.class::Legacy.new(spec).execute(server)
+          else
+            self.class::Command.new(spec).execute(server)
+          end
+        result.validate!
+      end
+
+      # Execute the bulk write operation.
+      #
+      # @example
+      #   operation.bulk_execute(server)
+      #
+      # @param [ Mongo::Server ] server The server to send the operation to.
+      #
+      # @return [ Mongo::Operation::Delete::BulkResult,
+      #           Mongo::Operation::Insert::BulkResult,
+      #           Mongo::Operation::Update::BulkResult ] The bulk result.
+      #
+      # @since 2.5.2
+      def bulk_execute(server)
+        if server.features.op_msg_enabled?
+          self.class::OpMsg.new(spec).execute(server).bulk_result
+        else
+          self.class::Command.new(spec).execute(server).bulk_result
+        end
+      end
+
+      private
+
+      def validate!
+        if !acknowledged_write?
+          if collation
+            raise Error::UnsupportedCollation.new(
+                Error::UnsupportedCollation::UNACKNOWLEDGED_WRITES_MESSAGE)
+          end
+          if array_filters
+            raise Error::UnsupportedArrayFilters.new(
+                Error::UnsupportedArrayFilters::UNACKNOWLEDGED_WRITES_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end