mongo 2.1.2 → 2.2.0.rc0

data/lib/mongo/collection/view/writable.rb

@@ -31,10 +31,13 @@ module Mongo
         #
         # @since 2.0.0
         def find_one_and_delete
-          cmd = { :findandmodify => collection.name, :query => selector, :remove => true }
+          cmd = { :findandmodify => collection.name, :query => filter, :remove => true }
           cmd[:fields] = projection if projection
           cmd[:sort] = sort if sort
           cmd[:maxTimeMS] = max_time_ms if max_time_ms
+          wc = options[:write_concern] || (collection.write_concern &&
+                                           collection.write_concern.options)
+          cmd[:writeConcern] = wc if wc
           write_with_retry do
             database.command(cmd).first['value']
           end
@@ -52,8 +55,11 @@ module Mongo
         # @param [ Hash ] opts The options.
         #
         # @option opts [ Symbol ] :return_document Either :before or :after.
-        # @option opts [ true, false ] :upsert Whether to upsert if the
-        #   document doesn't exist.
+        # @option opts [ true, false ] :upsert Whether to upsert if the document doesn't exist.
+        # @option opts [ true, false ] :bypass_document_validation Whether or
+        #   not to skip document level validation.
+        # @option options [ Hash ] :write_concern The write concern options.
+        #   Defaults to the collection's write concern.
         #
         # @return [ BSON::Document ] The document.
         #
@@ -71,18 +77,27 @@ module Mongo
         # @param [ Hash ] opts The options.
         #
         # @option opts [ Symbol ] :return_document Either :before or :after.
+        # @option opts [ true, false ] :upsert Whether to upsert if the document doesn't exist.
+        # @option opts [ true, false ] :bypass_document_validation Whether or
+        #   not to skip document level validation.
+        # @option options [ Hash ] :write_concern The write concern options.
+        #   Defaults to the collection's write concern.
         #
         # @return [ BSON::Document ] The document.
         #
         # @since 2.0.0
         def find_one_and_update(document, opts = {})
-          cmd = { :findandmodify => collection.name, :query => selector }
+          cmd = { :findandmodify => collection.name, :query => filter }
           cmd[:update] = document
           cmd[:fields] = projection if projection
           cmd[:sort] = sort if sort
           cmd[:new] = !!(opts[:return_document] && opts[:return_document] == :after)
           cmd[:upsert] = opts[:upsert] if opts[:upsert]
           cmd[:maxTimeMS] = max_time_ms if max_time_ms
+          cmd[:bypassDocumentValidation] = !!opts[:bypass_document_validation]
+          wc = options[:write_concern] || (collection.write_concern &&
+                                           collection.write_concern.options)
+          cmd[:writeConcern] = wc if wc
           write_with_retry do
             value = database.command(cmd).first['value']
             value unless value.nil? || value.empty?
@@ -172,7 +187,7 @@ module Mongo
         def remove(value)
           write_with_retry do
             Operation::Write::Delete.new(
-              :delete => { Operation::Q => selector, Operation::LIMIT => value },
+              :delete => { Operation::Q => filter, Operation::LIMIT => value },
               :db_name => collection.database.name,
               :coll_name => collection.name,
               :write_concern => collection.write_concern
@@ -183,13 +198,14 @@ module Mongo
         def update(spec, multi, opts)
           write_with_retry do
             Operation::Write::Update.new(
-              :update => { Operation::Q => selector,
+              :update => { Operation::Q => filter,
                            Operation::U => spec,
                            Operation::MULTI => multi,
                            Operation::UPSERT => !!opts[:upsert] },
               :db_name => collection.database.name,
               :coll_name => collection.name,
-              :write_concern => collection.write_concern
+              :write_concern => collection.write_concern,
+              :bypass_document_validation => !!opts[:bypass_document_validation]
             ).execute(next_primary.context)
           end
         end

data/lib/mongo/cursor.rb

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/cursor/builder'
+
 module Mongo
 
   # Client-side representation of an iterator over a query result set on
@@ -35,6 +37,9 @@ module Mongo
     def_delegators :@view, :collection, :limit
     def_delegators :collection, :client, :database
 
+    # @return [ Collection::View ] view The collection view.
+    attr_reader :view
+
     # Creates a +Cursor+ object.
     #
     # @example Instantiate the cursor.
@@ -82,12 +87,71 @@ module Mongo
       end
     end
 
-    private
-
+    # Get the batch size.
+    #
+    # @example Get the batch size.
+    #   cursor.batch_size
+    #
+    # @return [ Integer ] The batch size.
+    #
+    # @since 2.2.0
     def batch_size
       @view.batch_size && @view.batch_size > 0 ? @view.batch_size : limit
     end
 
+    # Is the cursor closed?
+    #
+    # @example Is the cursor closed?
+    #   cursor.closed?
+    #
+    # @return [ true, false ] If the cursor is closed.
+    #
+    # @since 2.2.0
+    def closed?
+      !more?
+    end
+
+    # Get the parsed collection name.
+    #
+    # @example Get the parsed collection name.
+    #   cursor.coll_name
+    #
+    # @return [ String ] The collection name.
+    #
+    # @since 2.2.0
+    def collection_name
+      @coll_name || collection.name
+    end
+
+    # Get the cursor id.
+    #
+    # @example Get the cursor id.
+    #   cursor.id
+    #
+    # @note A cursor id of 0 means the cursor was closed on the server.
+    #
+    # @return [ Integer ] The cursor id.
+    #
+    # @since 2.2.0
+    def id
+      @cursor_id
+    end
+
+    # Get the number of documents to return. Used on 3.0 and lower server
+    # versions.
+    #
+    # @example Get the number to return.
+    #   cursor.to_return
+    #
+    # @return [ Integer ] The number of documents to return.
+    #
+    # @since 2.2.0
+    def to_return
+      use_limit? ? @remaining : (batch_size || 0)
+    end
+
+    private
+
     def exhausted?
       limited? ? @remaining <= 0 : false
     end
@@ -97,16 +161,11 @@ module Mongo
     end
 
     def get_more_operation
-      Operation::Read::GetMore.new(get_more_spec)
-    end
-
-    def get_more_spec
-      {
-        :to_return => to_return,
-        :cursor_id => @cursor_id,
-        :db_name   => database.name,
-        :coll_name => @coll_name || collection.name
-      }
+      if @server.features.find_command_enabled?
+        Operation::Commands::GetMore.new(Builder::GetMoreCommand.new(self).specification)
+      else
+        Operation::Read::GetMore.new(Builder::OpGetMore.new(self).specification)
+      end
     end
 
     def kill_cursors
@@ -114,15 +173,11 @@ module Mongo
     end
 
     def kill_cursors_operation
-      Operation::KillCursors.new(kill_cursors_spec)
-    end
-
-    def kill_cursors_spec
-      {
-        :coll_name => @coll_name || collection.name,
-        :db_name => database.name,
-        :cursor_ids => [ @cursor_id ]
-      }
+      if @server.features.find_command_enabled?
+        Operation::Commands::Command.new(Builder::KillCursorsCommand.new(self).specification)
+      else
+        Operation::KillCursors.new(Builder::OpKillCursors.new(self).specification)
+      end
     end
 
     def limited?
@@ -140,10 +195,6 @@ module Mongo
       result.documents
     end
 
-    def to_return
-      use_limit? ? @remaining : (batch_size || 0)
-    end
-
     def use_limit?
       limited? && batch_size >= @remaining
     end

data/lib/mongo/cursor/builder.rb

@@ -0,0 +1,18 @@
+# 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.
+
+require 'mongo/cursor/builder/op_get_more'
+require 'mongo/cursor/builder/op_kill_cursors'
+require 'mongo/cursor/builder/get_more_command'
+require 'mongo/cursor/builder/kill_cursors_command'

data/lib/mongo/cursor/builder/get_more_command.rb

@@ -0,0 +1,71 @@
+# 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 Cursor
+    module Builder
+
+      # Generates a specification for a get more command.
+      #
+      # @since 2.2.0
+      class GetMoreCommand
+        extend Forwardable
+
+        # @return [ Cursor ] cursor The cursor.
+        attr_reader :cursor
+
+        def_delegators :@cursor, :batch_size, :collection_name, :database, :view
+
+        # Create the new builder.
+        #
+        # @example Create the builder.
+        #   GetMoreCommand.new(cursor)
+        #
+        # @param [ Cursor ] cursor The cursor.
+        #
+        # @since 2.2.0
+        def initialize(cursor)
+          @cursor = cursor
+        end
+
+        # Get the specification.
+        #
+        # @example Get the specification.
+        #   get_more_command.specification
+        #
+        # @return [ Hash ] The spec.
+        #
+        # @since 2.2.0
+        def specification
+          { selector: get_more_command, db_name: database.name }
+        end
+
+        private
+
+        def get_more_command
+          command = { :getMore => cursor.id, :collection => collection_name }
+          command[:batchSize] = batch_size if batch_size
+          # If the max_await_time_ms option is set, then we set maxTimeMS on
+          # the get more command.
+          if view.respond_to?(:max_await_time_ms)
+            if view.max_await_time_ms && view.options[:await_data]
+              command[:maxTimeMS] = view.max_await_time_ms
+            end
+          end
+          command
+        end
+      end
+    end
+  end
+end

data/lib/mongo/cursor/builder/kill_cursors_command.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 Cursor
+    module Builder
+
+      # Generates a specification for a kill cursors command.
+      #
+      # @since 2.2.0
+      class KillCursorsCommand
+        extend Forwardable
+
+        # @return [ Cursor ] cursor The cursor.
+        attr_reader :cursor
+
+        def_delegators :@cursor, :collection_name, :database
+
+        # Create the new builder.
+        #
+        # @example Create the builder.
+        #   KillCursorsCommand.new(cursor)
+        #
+        # @param [ Cursor ] cursor The cursor.
+        #
+        # @since 2.2.0
+        def initialize(cursor)
+          @cursor = cursor
+        end
+
+        # Get the specification.
+        #
+        # @example Get the specification.
+        #   kill_cursors_command.specification
+        #
+        # @return [ Hash ] The spec.
+        #
+        # @since 2.2.0
+        def specification
+          { selector: kill_cursors_command, db_name: database.name }
+        end
+
+        private
+
+        def kill_cursors_command
+          { :killCursors => collection_name, :cursors => [ cursor.id ] }
+        end
+      end
+    end
+  end
+end

data/lib/mongo/cursor/builder/op_get_more.rb

@@ -0,0 +1,61 @@
+# 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 Cursor
+    module Builder
+
+      # Encapsulates behaviour around generating an OP_GET_MORE specification.
+      #
+      # @since 2.2.0
+      class OpGetMore
+        extend Forwardable
+
+        # @return [ Cursor ] cursor The cursor.
+        attr_reader :cursor
+
+        def_delegators :@cursor, :collection_name, :database, :to_return
+
+        # Create the new builder.
+        #
+        # @example Create the builder.
+        #   OpGetMore.new(cursor)
+        #
+        # @param [ Cursor ] cursor The cursor.
+        #
+        # @since 2.2.0
+        def initialize(cursor)
+          @cursor = cursor
+        end
+
+        # Get the specification.
+        #
+        # @example Get the specification.
+        #   op_get_more.specification
+        #
+        # @return [ Hash ] The specification.
+        #
+        # @since 2.2.0
+        def specification
+          {
+            :to_return => to_return,
+            :cursor_id => cursor.id,
+            :db_name   => database.name,
+            :coll_name => collection_name
+          }
+        end
+      end
+    end
+  end
+end

data/lib/mongo/cursor/builder/op_kill_cursors.rb

@@ -0,0 +1,56 @@
+# 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 Cursor
+    module Builder
+
+      # Encapsulates behaviour around generating an OP_KILL_CURSORS specification.
+      #
+      # @since 2.2.0
+      class OpKillCursors
+        extend Forwardable
+
+        # @return [ Cursor ] cursor The cursor.
+        attr_reader :cursor
+
+        def_delegators :@cursor, :collection_name, :database
+
+        # Create the new builder.
+        #
+        # @example Create the builder.
+        #   OpKillCursors.new(cursor)
+        #
+        # @param [ Cursor ] cursor The cursor.
+        #
+        # @since 2.2.0
+        def initialize(cursor)
+          @cursor = cursor
+        end
+
+        # Get the specification.
+        #
+        # @example Get the specification.
+        #   op_kill_cursors.specification
+        #
+        # @return [ Hash ] The specification.
+        #
+        # @since 2.2.0
+        def specification
+          { :coll_name => collection_name, :db_name => database.name, :cursor_ids => [ cursor.id ] }
+        end
+      end
+    end
+  end
+end