mongo 2.1.0.beta → 2.2.0

data/lib/mongo/collection/view/builder/modifiers.rb

@@ -0,0 +1,80 @@
+# 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 Collection
+    class View
+      module Builder
+
+        # Provides behaviour for mapping modifiers.
+        #
+        # @since 2.2.0
+        module Modifiers
+          extend self
+
+          # Mappings from driver options to legacy server values.
+          #
+          # @since 2.2.0
+          DRIVER_MAPPINGS = BSON::Document.new(
+            sort: '$orderby',
+            hint: '$hint',
+            comment: '$comment',
+            snapshot: '$snapshot',
+            max_scan: '$maxScan',
+            max_value: '$max',
+            min_value: '$min',
+            max_time_ms: '$maxTimeMS',
+            return_key: '$returnKey',
+            show_disk_loc: '$showDiskLoc',
+            explain: '$explain'
+          ).freeze
+
+          # Mappings from server values to driver options.
+          #
+          # @since 2.2.0
+          SERVER_MAPPINGS = BSON::Document.new(DRIVER_MAPPINGS.invert).freeze
+
+          # Transform the provided server modifiers to driver options.
+          #
+          # @example Transform to driver options.
+          #   Modifiers.map_driver_options(modifiers)
+          #
+          # @param [ Hash ] modifiers The modifiers.
+          #
+          # @return [ BSON::Document ] The driver options.
+          #
+          # @since 2.2.0
+          def self.map_driver_options(modifiers)
+            Options::Mapper.transform_documents(modifiers, SERVER_MAPPINGS)
+          end
+
+          # Transform the provided options into a document of only server
+          # modifiers.
+          #
+          # @example Map the server modifiers.
+          #   Modifiers.map_server_modifiers(options)
+          #
+          # @param [ Hash, BSON::Document ] options The options.
+          #
+          # @return [ BSON::Document ] The modifiers.
+          #
+          # @since 2.2.0
+          def self.map_server_modifiers(options)
+            Options::Mapper.transform_documents(options, DRIVER_MAPPINGS)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/collection/view/builder/op_query.rb

@@ -0,0 +1,83 @@
+# 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 Collection
+    class View
+      module Builder
+
+        # Builds a legacy OP_QUERY specification from options.
+        #
+        # @since 2.2.0
+        class OpQuery
+          extend Forwardable
+
+          def_delegators :@view, :cluster, :collection, :database, :filter, :options, :read
+
+          # @return [ BSON::Document ] modifiers The server modifiers.
+          attr_reader :modifiers
+
+          # Create the new legacy query builder.
+          #
+          # @example Create the query builder.
+          #   QueryBuilder.new(view)
+          #
+          # @param [ Collection::View ] view The collection view.
+          #
+          # @since 2.2.2
+          def initialize(view)
+            @view = view
+            @modifiers = Modifiers.map_server_modifiers(options)
+          end
+
+          def specification
+            {
+              :selector  => requires_special_filter? ? special_filter : filter,
+              :read      => read,
+              :options   => query_options,
+              :db_name   => database.name,
+              :coll_name => collection.name
+            }
+          end
+
+          private
+
+          def query_options
+            BSON::Document.new(
+              project: options[:projection],
+              skip: options[:skip],
+              limit: options[:limit],
+              flags: Flags.map_flags(options),
+              batch_size: options[:batch_size]
+            )
+          end
+
+          def requires_special_filter?
+            !modifiers.empty? || cluster.sharded?
+          end
+
+          def read_pref_formatted
+            @read_formatted ||= read.to_mongos
+          end
+
+          def special_filter
+            sel = BSON::Document.new(:$query => filter).merge!(modifiers)
+            sel[:$readPreference] = read_pref_formatted unless read_pref_formatted.nil?
+            sel
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# 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/collection/view/builder/aggregation'
+require 'mongo/collection/view/builder/map_reduce'
+require 'mongo/collection/view/builder/op_query'
+require 'mongo/collection/view/builder/find_command'
+require 'mongo/collection/view/builder/flags'
+require 'mongo/collection/view/builder/modifiers'

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

@@ -21,6 +21,21 @@ module Mongo
       # @since 2.0.0
       module Explainable
 
+        # The query planner verbosity constant.
+        #
+        # @since 2.2.0
+        QUERY_PLANNER = 'queryPlanner'.freeze
+
+        # The execution stats verbosity constant.
+        #
+        # @since 2.2.0
+        EXECUTION_STATS = 'executionStats'.freeze
+
+        # The all plans execution verbosity constant.
+        #
+        # @since 2.2.0
+        ALL_PLANS_EXECUTION = 'allPlansExecution'.freeze
+
         # Get the explain plan for the query.
         #
         # @example Get the explain plan for the query.

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

@@ -15,6 +15,10 @@
 module Mongo
   class Collection
     class View
+
+      # Defines behaviour around views being configurable and immutable.
+      #
+      # @since 2.0.0
       module Immutable
 
         # @return [ Hash ] options The additional query options.
@@ -22,21 +26,10 @@ module Mongo
 
         private
 
-        # @api private
-        #
-        # @note In the including class, the method #immutable needs to be
-        #   implemented in order to define how a new class of that type needs to
-        #   be instantiated.
         def configure(field, value)
           return options[field] if value.nil?
           new(options.merge(field => value))
         end
-
-        def configure_flag(flag)
-          new(options.dup).tap do |view|
-            view.send(:flags).push(flag)
-          end
-        end
       end
     end
   end

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

@@ -35,13 +35,48 @@ module Mongo
         #
         # @yieldparam [ Hash ] Each matching document.
         def each
-          server = read.select_server(cluster)
-          initial_query = send_initial_query(server)
-          cursor = Cursor.new(view, initial_query, server).to_enum
-          cursor.each do |doc|
+          @cursor = nil
+          read_with_retry do
+            server = read.select_server(cluster, false)
+            result = send_initial_query(server)
+            @cursor = Cursor.new(view, result, server)
+          end
+          @cursor.each do |doc|
             yield doc
           end if block_given?
-          cursor
+          @cursor.to_enum
+        end
+
+        # Stop the iteration by sending a KillCursors command to the server.
+        #
+        # @example Stop the iteration.
+        #   view.close_query
+        #
+        # @since 2.1.0
+        def close_query
+          @cursor.send(:kill_cursors) if @cursor && !@cursor.closed?
+        end
+
+        private
+
+        def initial_query_op(server)
+          if server.features.find_command_enabled?
+            initial_command_op
+          else
+            Operation::Read::Query.new(Builder::OpQuery.new(self).specification)
+          end
+        end
+
+        def initial_command_op
+          if explained?
+            Operation::Commands::Command.new(Builder::FindCommand.new(self).explain_specification)
+          else
+            Operation::Commands::Find.new(Builder::FindCommand.new(self).specification)
+          end
+        end
+
+        def send_initial_query(server)
+          initial_query_op(server).execute(server.context)
         end
       end
     end

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

@@ -24,7 +24,18 @@ module Mongo
         extend Forwardable
         include Enumerable
         include Immutable
-        include Iterable
+        include Loggable
+        include Retryable
+
+        # The inline option.
+        #
+        # @since 2.1.0
+        INLINE = 'inline'.freeze
+
+        # Reroute message.
+        #
+        # @since 2.1.0
+        REROUTE = 'Rerouting the MapReduce operation to the primary server.'.freeze
 
         # @return [ View ] view The collection view.
         attr_reader :view
@@ -41,6 +52,31 @@ module Mongo
         # Delegate necessary operations to the collection.
         def_delegators :collection, :database
 
+        # Iterate through documents returned by the map/reduce.
+        #
+        # @example Iterate through the result of the map/reduce.
+        #   map_reduce.each do |document|
+        #     p document
+        #   end
+        #
+        # @return [ Enumerator ] The enumerator.
+        #
+        # @since 2.0.0
+        #
+        # @yieldparam [ Hash ] Each matching document.
+        def each
+          @cursor = nil
+          write_with_retry do
+            server = read.select_server(cluster, false)
+            result = send_initial_query(server)
+            @cursor = Cursor.new(view, result, server)
+          end
+          @cursor.each do |doc|
+            yield doc
+          end if block_given?
+          @cursor.to_enum
+        end
+
         # Set or get the finalize function for the operation.
         #
         # @example Set the finalize function.
@@ -71,7 +107,7 @@ module Mongo
           @view = view
           @map = map.freeze
           @reduce = reduce.freeze
-          @options = options.dup
+          @options = options.freeze
         end
 
         # Set or get the jsMode flag for the operation.
@@ -86,7 +122,7 @@ module Mongo
         #
         # @since 2.0.0
         def js_mode(value = nil)
-          configure(:jsMode, value)
+          configure(:js_mode, value)
         end
 
         # Set or get the output location for the operation.
@@ -147,21 +183,11 @@ module Mongo
         private
 
         def inline?
-          out.nil? || out == { inline: 1 } || out == { 'inline' => 1 }
+          out.nil? || out == { inline: 1 } || out == { INLINE => 1 }
         end
 
         def map_reduce_spec
-          {
-            :db_name => database.name,
-            :read => read,
-            :selector => {
-              :mapreduce => collection.name,
-              :map => map,
-              :reduce => reduce,
-              :query => view.selector[:$query] || view.selector,
-              :out => { inline: 1 }
-            }.merge(options).merge(view.options)
-          }
+          Builder::MapReduce.new(map, reduce, view, options).specification
         end
 
         def new(options)
@@ -169,40 +195,44 @@ module Mongo
         end
 
         def initial_query_op
-          Operation::MapReduce.new(map_reduce_spec)
+          Operation::Commands::MapReduce.new(map_reduce_spec)
+        end
+
+        def valid_server?(server)
+          server.standalone? || server.mongos? || server.primary? || secondary_ok?
+        end
+
+        def secondary_ok?
+          out.respond_to?(:keys) && out.keys.first.to_s.downcase == INLINE
         end
 
         def send_initial_query(server)
-          result =
-            begin
-              initial_query_op.execute(server.context)
-            rescue Mongo::Error::NeedPrimaryServer
-              log_warn([
-                'Rerouting the MapReduce operation to the primary server.'
-              ])
-              server = ServerSelector.get(mode: :primary).select_server(cluster)
-              initial_query_op.execute(server.context)
-            end
-          if inline?
-            result
-          else
-            send_fetch_query(server)
+          unless valid_server?(server)
+            log_warn(REROUTE)
+            server = cluster.next_primary(false)
           end
+          result = initial_query_op.execute(server.context)
+          inline? ? result : send_fetch_query(server)
         end
 
         def fetch_query_spec
-          { :selector  => {},
-            :options   => {},
-            :db_name   => database.name,
-            :coll_name => out.values.first }
+          Builder::MapReduce.new(map, reduce, view, options).query_specification
+        end
+
+        def find_command_spec
+          Builder::MapReduce.new(map, reduce, view, options).command_specification
         end
 
-        def fetch_query_op
-          Operation::Read::Query.new(fetch_query_spec)
+        def fetch_query_op(server)
+          if server.features.find_command_enabled?
+            Operation::Commands::Find.new(find_command_spec)
+          else
+            Operation::Read::Query.new(fetch_query_spec)
+          end
         end
 
         def send_fetch_query(server)
-          fetch_query_op.execute(server.context)
+          fetch_query_op(server).execute(server.context)
         end
       end
     end