mongo 1.12.5 → 2.0.0

data/lib/mongo/operation/read/query.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.
+
+module Mongo
+  module Operation
+    module Read
+
+      # A MongoDB query operation.
+      #
+      # @example Create the query operation.
+      #   Read::Query.new({
+      #     :selector => { :foo => 1 },
+      #     :db_name => 'test-db',
+      #     :coll_name => 'test-coll',
+      #     :options => { :limit => 2 }
+      #   })
+      #
+      # @param [ Hash ] spec The specifications for the query.
+      #
+      # @option spec :selector [ Hash ] The query selector.
+      # @option spec :db_name [ String ] The name of the database on which
+      #   the query should be run.
+      # @option spec :coll_name [ String ] The name of the collection on which
+      #   the query should be run.
+      # @option spec :options [ Hash ] Options for the query.
+      #
+      # @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
+
+        private
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message(context) ]))
+          end
+        end
+
+        def query_coll
+          coll_name
+        end
+      end
+    end
+  end
+end

data/lib/mongo/{functional.rb → operation/read.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2013 MongoDB, Inc.
+# 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.
@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/functional/authentication'
-require 'mongo/functional/logging'
-require 'mongo/functional/read_preference'
-require 'mongo/functional/write_concern'
-require 'mongo/functional/uri_parser'
-require 'mongo/functional/scram'
+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

@@ -0,0 +1,34 @@
+# 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
+
+    # Adds behaviour for queries that need to take read preference into account.
+    #
+    # @since 2.0.0
+    module ReadPreferrable
+
+      private
+
+      def message(context)
+        sel = (context.mongos? && read_pref = read.to_mongos) ?
+                selector.merge(:$readPreference => read_pref) : selector
+        opts = context.standalone? || read.slave_ok? ?
+                 options.merge(flags: [:slave_ok]) : options
+        Protocol::Query.new(db_name, query_coll, sel, opts)
+      end
+    end
+  end
+end

data/lib/mongo/operation/result.rb

@@ -0,0 +1,259 @@
+# 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
+
+    # Result wrapper for operations.
+    #
+    # @since 2.0.0
+    class Result
+      extend Forwardable
+      include Enumerable
+
+      # The number of documents updated in the write.
+      #
+      # @since 2.0.0
+      N = 'n'.freeze
+
+      # The ok status field in the result.
+      #
+      # @since 2.0.0
+      OK = 'ok'.freeze
+
+      # @return [ Array<Protocol::Reply> ] replies The wrapped wire protocol replies.
+      attr_reader :replies
+
+      # Is the result acknowledged?
+      #
+      # @note On MongoDB 2.6 and higher all writes are acknowledged since the
+      #   driver uses write commands for all write operations. On 2.4 and
+      #   lower, the result is acknowledged if the GLE has been executed after
+      #   the command. If not, no replies will be specified. Reads will always
+      #   return true here since a replies is always provided.
+      #
+      # @return [ true, false ] If the result is acknowledged.
+      #
+      # @since 2.0.0
+      def acknowledged?
+        !!@replies
+      end
+
+      # Determine if this result is a collection of multiple replies from the
+      # server.
+      #
+      # @example Is the result for multiple replies?
+      #   result.multiple?
+      #
+      # @return [ true, false ] If the result is for multiple replies.
+      #
+      # @since 2.0.0
+      def multiple?
+        replies.size > 1
+      end
+
+      # Get the cursor id if the response is acknowledged.
+      #
+      # @note Cursor ids of 0 indicate there is no cursor on the server.
+      #
+      # @example Get the cursor id.
+      #   result.cursor_id
+      #
+      # @return [ Integer ] The cursor id.
+      #
+      # @since 2.0.0
+      def cursor_id
+        acknowledged? ? replies.last.cursor_id : 0
+      end
+
+      # Get the namespace of the cursor. The method should be defined in
+      # result classes where 'ns' is in the server response.
+      #
+      # @return [ Nil ]
+      #
+      # @since 2.0.0
+      def namespace
+        nil
+      end
+
+      # Get the documents in the result.
+      #
+      # @example Get the documents.
+      #   result.documents
+      #
+      # @return [ Array<BSON::Document> ] The documents.
+      #
+      # @since 2.0.0
+      def documents
+        if acknowledged?
+          replies.flat_map{ |reply| reply.documents }
+        else
+          []
+        end
+      end
+
+      # Iterate over the documents in the replies.
+      #
+      # @example Iterate over the documents.
+      #   result.each do |doc|
+      #     p doc
+      #   end
+      #
+      # @return [ Enumerator ] The enumerator.
+      #
+      # @since 2.0.0
+      #
+      # @yieldparam [ BSON::Document ] Each document in the result.
+      def each(&block)
+        documents.each(&block)
+      end
+
+      # Initialize a new result result.
+      #
+      # @example Instantiate the result.
+      #   Result.new(replies)
+      #
+      # @param [ Protocol::Reply ] replies The wire protocol replies.
+      #
+      # @since 2.0.0
+      def initialize(replies)
+        @replies = replies.is_a?(Protocol::Reply) ? [ replies ] : replies
+      end
+
+      # Get the pretty formatted inspection of the result.
+      #
+      # @example Inspect the result.
+      #   result.inspect
+      #
+      # @return [ String ] The inspection.
+      #
+      # @since 2.0.0
+      def inspect
+        "#<Mongo::Operation::Result:#{object_id} documents=#{documents}>"
+      end
+
+      # Get the first reply from the result.
+      #
+      # @example Get the first reply.
+      #   result.reply
+      #
+      # @return [ Protocol::Reply ] The first reply.
+      #
+      # @since 2.0.0
+      def reply
+        if acknowledged?
+          replies.first
+        else
+          nil
+        end
+      end
+
+      # Get the count of documents returned by the server.
+      #
+      # @example Get the number returned.
+      #   result.returned_count
+      #
+      # @return [ Integer ] The number of documents returned.
+      #
+      # @since 2.0.0
+      def returned_count
+        if acknowledged?
+          multiple? ? aggregate_returned_count : reply.number_returned
+        else
+          0
+        end
+      end
+
+      # If the result was a command then determine if it was considered a
+      # success.
+      #
+      # @note If the write was unacknowledged, then this will always return
+      #   true.
+      #
+      # @example Was the command successful?
+      #   result.successful?
+      #
+      # @return [ true, false ] If the command was successful.
+      #
+      # @since 2.0.0
+      def successful?
+        return true if !acknowledged?
+        if first_document.has_key?(OK)
+          first_document[OK] == 1 && parser.message.empty?
+        else
+          parser.message.empty?
+        end
+      end
+
+      # Validate the result by checking for any errors.
+      #
+      # @note This only checks for errors with writes since authentication is
+      #   handled at the connection level and any authentication errors would
+      #   be raised there, before a Result is ever created.
+      #
+      # @example Validate the result.
+      #   result.validate!
+      #
+      # @raise [ Error::OperationFailure ] If an error is in the result.
+      #
+      # @return [ Result ] The result if verification passed.
+      #
+      # @since 2.0.0
+      def validate!
+        !successful? ? raise(Error::OperationFailure.new(parser.message)) : self
+      end
+
+      # Get the number of documents written by the server.
+      #
+      # @example Get the number of documents written.
+      #   result.written_count
+      #
+      # @return [ Integer ] The number of documents written.
+      #
+      # @since 2.0.0
+      def written_count
+        if acknowledged?
+          multiple? ? aggregate_written_count : (first_document[N] || 0)
+        else
+          0
+        end
+      end
+      alias :n :written_count
+
+      private
+
+      def aggregate_returned_count
+        replies.reduce(0) do |n, reply|
+          n += reply.number_returned
+          n
+        end
+      end
+
+      def aggregate_written_count
+        documents.reduce(0) do |n, document|
+          n += (document[N] || 0)
+          n
+        end
+      end
+
+      def parser
+        @parser ||= Error::Parser.new(first_document)
+      end
+
+      def first_document
+        @first_document ||= first || BSON::Document.new
+      end
+    end
+  end
+end