mongo 2.1.0.beta → 2.1.0.rc0

data/lib/mongo/client.rb

@@ -122,7 +122,7 @@ module Mongo
     #   attempt a connection.
     # @option options [ Hash ] :read The read preference options. They consist of a
     #   mode specified as a symbol, an array of hashes known as tag_sets,
-    #   and two timing options: local_threshold and server_selection_timeout.
+    #   and local_threshold.
     #   :mode can be one of :secondary, :secondary_preferred, :primary,
     #   :primary_preferred, :nearest.
     # @option options [ Array<Hash, String> ] :roles The list of roles for the
@@ -148,6 +148,9 @@ module Mongo
     #   Integer, :fsync => Boolean, :j => Boolean.
     # @option options [ true, false ] :monitoring Initializes a client without
     #   any default monitoring if false is provided.
+    # @option options [ Logger ] :logger A custom logger if desired.
+    # @option options [ true, false ] :truncate_logs Whether to truncate the
+    #   logs at the default 250 characters.
     #
     # @since 2.0.0
     def initialize(addresses_or_uri, options = {})
@@ -182,7 +185,7 @@ module Mongo
     #
     # @since 2.0.0
     def read_preference
-      @read_preference ||= ServerSelector.get(options[:read] || {}, options)
+      @read_preference ||= ServerSelector.get((options[:read] || {}).merge(options))
     end
 
     # Use the database with the provided name. This will switch the current
@@ -295,7 +298,7 @@ module Mongo
     end
 
     def create_from_uri(connection_string, opts = {})
-      uri = URI.new(connection_string)
+      uri = URI.new(connection_string, opts)
       @options = Database::DEFAULT_OPTIONS.merge(uri.client_options.merge(opts)).freeze
       @cluster = Cluster.new(uri.servers, @monitoring, options)
       @database = Database.new(self, options[:database], options)
@@ -303,6 +306,7 @@ module Mongo
 
     def initialize_copy(original)
       @options = original.options.dup
+      @monitoring = Monitoring.new(@options)
       @database = nil
       @read_preference = nil
       @write_concern = nil

data/lib/mongo/cluster.rb

@@ -65,7 +65,7 @@ module Mongo
       address = Address.new(host)
       if !addresses.include?(address)
         if addition_allowed?(address)
-          log_debug([ "Adding #{address.to_s} to the cluster." ])
+          log_debug("Adding #{address.to_s} to the cluster.")
           @update_lock.synchronize { @addresses.push(address) }
           server = Server.new(address, self, @monitoring, event_listeners, options)
           @update_lock.synchronize { @servers.push(server) }
@@ -125,7 +125,7 @@ module Mongo
     #
     # @since 2.0.0
     def next_primary
-      ServerSelector.get({ mode: :primary }, options).select_server(self)
+      ServerSelector.get({ mode: :primary }.merge(options)).select_server(self)
     end
 
     # Elect a primary server from the description that has just changed to a
@@ -166,7 +166,7 @@ module Mongo
     #
     # @since 2.0.0
     def remove(host)
-      log_debug([ "#{host} being removed from the cluster." ])
+      log_debug("#{host} being removed from the cluster.")
       address = Address.new(host)
       removed_servers = @servers.select { |s| s.address == address }
       @update_lock.synchronize { @servers = @servers - removed_servers }

data/lib/mongo/cluster/topology/replica_set.rb

@@ -61,7 +61,7 @@ module Mongo
         def elect_primary(description, servers)
           if description.replica_set_name == replica_set_name
             unless detect_stale_primary!(description)
-              log_debug([ "Server #{description.address.to_s} elected as primary in #{replica_set_name}." ])
+              log_debug("Server #{description.address.to_s} elected as primary in #{replica_set_name}.")
               servers.each do |server|
                 if server.primary? && server.address != description.address
                   server.description.unknown!
@@ -70,9 +70,10 @@ module Mongo
               update_max_election_id(description)
             end
           else
-            log_warn([
-              "Server #{description.address.to_s} in incorrect replica set: #{description.replica_set_name}."
-            ])
+            log_warn(
+              "Server #{description.address.to_s} has incorrect replica set name: " +
+              "'#{description.replica_set_name}'. The current replica set name is '#{replica_set_name}'."
+            )
           end
           self
         end
@@ -157,8 +158,9 @@ module Mongo
         def remove_hosts?(description)
           !description.config.empty? &&
             (description.primary? ||
-              description.hosts.empty? ||
-                !member_of_this_set?(description))
+              description.me_mismatch? ||
+                description.hosts.empty? ||
+                  !member_of_this_set?(description))
         end
 
         # Whether a specific server in the cluster can be removed, given a description.

data/lib/mongo/cluster/topology/unknown.rb

@@ -55,7 +55,7 @@ module Mongo
         # @return [ Sharded, ReplicaSet ] The new topology.
         def elect_primary(description, servers)
           if description.mongos?
-            log_debug([ "Mongos #{description.address.to_s} discovered." ])
+            log_debug("Mongos #{description.address.to_s} discovered.")
             Sharded.new(options)
           else
             initialize_replica_set(description, servers)
@@ -204,7 +204,10 @@ module Mongo
         private
 
         def initialize_replica_set(description, servers)
-          log_debug([ "Server #{description.address.to_s} discovered as primary." ])
+          log_debug(
+            "Server #{description.address.to_s} discovered as primary in replica set: " +
+            "'#{description.replica_set_name}'. Changing topology to replica set."
+          )
           servers.each do |server|
             if server.standalone? && server.address != description.address
               server.description.unknown!

data/lib/mongo/collection.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/bulk_write'
 require 'mongo/collection/view'
 
 module Mongo
@@ -33,7 +34,7 @@ module Mongo
     attr_reader :options
 
     # Get client, cluster, read preference, and write concern from client.
-    def_delegators :database, :client, :cluster, :read_preference, :write_concern
+    def_delegators :database, :client, :cluster
 
     # Delegate to the cluster for the next primary.
     def_delegators :cluster, :next_primary
@@ -41,6 +42,11 @@ module Mongo
     # Convenience delegators to find.
     def_delegators :find, :parallel_scan
 
+    # Options that can be updated on a new Collection instance via the #with method.
+    #
+    # @since 2.1.0
+    CHANGEABLE_OPTIONS = [ :read, :write ]
+
     # Check if a collection is equal to another object. Will check the name and
     # the database for equality.
     #
@@ -74,6 +80,53 @@ module Mongo
       @options = options.freeze
     end
 
+    # Get the read preference on this collection.
+    #
+    # @example Get the read preference.
+    #   collection.read_preference
+    #
+    # @return [ Mongo::ServerSelector ] The read preference.
+    #
+    # @since 2.0.0
+    def read_preference
+      @read_preference ||= options[:read] ? ServerSelector.get(client.options.merge(options[:read])) :
+        database.read_preference
+    end
+
+    # Get the write concern on this collection.
+    #
+    # @example Get the write concern.
+    #   collection.write_concern
+    #
+    # @return [ Mongo::WriteConcern ] The write concern.
+    #
+    # @since 2.0.0
+    def write_concern
+      @write_concern ||= options[:write] ? WriteConcern.get(options[:write]) :
+        database.write_concern
+    end
+
+    # Provides a new collection with either a new read preference or new write concern
+    # merged over the existing read preference / write concern.
+    #
+    # @example Get a collection with changed read preference.
+    #   collection.with(:read => { :mode => :primary_preferred })
+    #
+    # @example Get a collection with changed write concern.
+    #   collection.with(:write => { w:  3 })
+
+    # @param [ Hash ] new_options The new options to use.
+    #
+    # @return [ Mongo::Collection ] A new collection instance.
+    #
+    # @since 2.1.0
+    def with(new_options)
+      new_options.keys.each do |k|
+        raise Error::UnchangeableCollectionOption.new(k) unless CHANGEABLE_OPTIONS.include?(k)
+      end
+      Collection.new(database, name, options.merge(new_options))
+    end
+
     # Is the collection capped?
     #
     # @example Is the collection capped?
@@ -286,7 +339,7 @@ module Mongo
     # @example Execute a bulk write.
     #   collection.bulk_write(operations, options)
     #
-    # @param [ Array<Hash> ] operations The operations.
+    # @param [ Array<Hash> ] requests The bulk write requests.
     # @param [ Hash ] options The options.
     #
     # @option options [ true, false ] :ordered Whether the operations
@@ -297,8 +350,8 @@ module Mongo
     # @return [ BulkWrite::Result ] The result of the operation.
     #
     # @since 2.0.0
-    def bulk_write(operations, options = {})
-      BulkWrite.get(self, operations, options).execute
+    def bulk_write(requests, options = {})
+      BulkWrite.new(self, requests, options).execute
     end
 
     # Remove a document from the collection.
@@ -329,6 +382,24 @@ module Mongo
       find(filter).delete_many
     end
 
+    # Execute a parallel scan on the collection view.
+    #
+    # Returns a list of up to cursor_count cursors that can be iterated concurrently.
+    # As long as the collection is not modified during scanning, each document appears once
+    # in one of the cursors' result sets.
+    #
+    # @example Execute a parallel collection scan.
+    #   collection.parallel_scan(2)
+    #
+    # @param [ Integer ] cursor_count The max number of cursors to return.
+    #
+    # @return [ Array<Cursor> ] An array of cursors.
+    #
+    # @since 2.1
+    def parallel_scan(cursor_count)
+      find.send(:parallel_scan, cursor_count)
+    end
+
     # Replaces a single document in the collection with the new document.
     #
     # @example Replace a single document.

data/lib/mongo/collection/view.rb

@@ -127,8 +127,7 @@ module Mongo
       def initialize(collection, selector = {}, options = {})
         validate_doc!(selector)
         @collection = collection
-        @selector = selector.dup
-        @options = options.dup
+        setup(selector, options)
       end
 
       # Get a human-readable string representation of +View+.

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

@@ -25,6 +25,7 @@ module Mongo
         include Immutable
         include Iterable
         include Explainable
+        include Loggable
 
         # @return [ View ] view The collection view.
         attr_reader :view
@@ -132,16 +133,20 @@ module Mongo
           Operation::Aggregate.new(aggregate_spec)
         end
 
+        def valid_server?(server)
+          server.standalone? || server.mongos? || server.primary? || secondary_ok?
+        end
+
+        def secondary_ok?
+          pipeline.none? { |op| op.key?('$out') || op.key?(:$out) }
+        end
+
         def send_initial_query(server)
-          begin
-            initial_query_op.execute(server.context)
-          rescue Mongo::Error::NeedPrimaryServer
-            log_warn([
-              'Rerouting the Aggregation operation to the primary server.'
-            ])
-            server = ServerSelector.get(mode: :primary).select_server(cluster)
-            initial_query_op.execute(server.context)
+          unless valid_server?(server)
+            log_warn('Rerouting the Aggregation operation to the primary server.')
+            server = cluster.next_primary
           end
+          initial_query_op.execute(server.context)
         end
       end
     end

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

@@ -22,14 +22,14 @@ 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))
+          new(options.merge(field => value, :modifiers => @modifiers))
+        end
+
+        def configure_modifier(field, value)
+          return @modifiers[Readable::SPECIAL_FIELDS[field]] if value.nil?
+          new(options.merge(:modifiers => @modifiers.merge(Readable::SPECIAL_FIELDS[field] => value)))
         end
 
         def configure_flag(flag)

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

@@ -36,12 +36,21 @@ 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 = Cursor.new(view, send_initial_query(server), server)
+          @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
         end
       end
     end

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

@@ -25,6 +25,7 @@ module Mongo
         include Enumerable
         include Immutable
         include Iterable
+        include Loggable
 
         # @return [ View ] view The collection view.
         attr_reader :view
@@ -158,12 +159,16 @@ module Mongo
               :mapreduce => collection.name,
               :map => map,
               :reduce => reduce,
-              :query => view.selector[:$query] || view.selector,
+              :query => view.modifiers[:$query] || view.selector,
               :out => { inline: 1 }
-            }.merge(options).merge(view.options)
+            }.merge(options).merge(view_options)
           }
         end
 
+        def view_options
+          view.sort ? view.options.merge(:sort => view.sort) : view.options
+        end
+
         def new(options)
           MapReduce.new(view, map, reduce, options)
         end
@@ -172,29 +177,29 @@ module Mongo
           Operation::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('Rerouting the MapReduce operation to the primary server.')
+            server = cluster.next_primary
           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 }
+            :coll_name => out.respond_to?(:keys) ? out.values.first : out }
         end
 
         def fetch_query_op

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

@@ -21,20 +21,21 @@ module Mongo
       # @since 2.0.0
       module Readable
 
-        # Special fields and their getters for the query selector.
+        # Special fields and their option names for the query selector.
         #
         # @since 2.0.0
         SPECIAL_FIELDS = {
-          :$query => :selector,
-          :$readPreference => :read_pref_formatted,
-          :$orderby => :sort,
-          :$hint => :hint,
-          :$comment => :comment,
-          :$snapshot => :snapshot,
-          :$maxScan => :max_scan,
-          :$maxTimeMS => :max_time_ms,
-          :$showDiskLoc => :show_disk_loc,
-          :$explain => :explained?
+            :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
 
         # Options to cursor flags mapping.
@@ -65,35 +66,6 @@ module Mongo
           Aggregation.new(self, pipeline, options)
         end
 
-        # Execute a parallel scan on the collection view.
-        # Returns a list of up to cursor_count cursors that can be iterated concurrently.
-        # As long as the collection is not modified during scanning, each document appears once
-        # in one of the cursors' result sets.
-        #
-        # @example Execute a parallel collection scan.
-        #   view.parallel_scan(2)
-        #
-        # @param [ Integer ] cursor_count The max number of cursors to return.
-        #
-        # @return [ Array<Cursor> ] An array of cursors.
-        #
-        # @since 2.1
-        def parallel_scan(cursor_count)
-          server = read.select_server(cluster)
-          Operation::ParallelScan.new(
-            :coll_name => collection.name,
-            :db_name => database.name,
-            :cursor_count => cursor_count
-          ).execute(server.context).cursor_ids.map do |cursor_id|
-            result = Operation::Read::GetMore.new({ :to_return => 0,
-                                                    :cursor_id => cursor_id,
-                                                    :db_name   => database.name,
-                                                    :coll_name => collection.name
-              }).execute(server.context)
-            Cursor.new(self, result, server)
-          end
-        end
-
         # Allows the query to get partial results if some shards are down.
         #
         # @example Allow partial results.
@@ -120,7 +92,7 @@ module Mongo
         #
         # @since 2.0.0
         def batch_size(batch_size = nil)
-          configure(:batch_size, batch_size)
+          configure(__method__, batch_size)
         end
 
         # Associate a comment with the query.
@@ -138,7 +110,7 @@ module Mongo
         #
         # @since 2.0.0
         def comment(comment = nil)
-          configure(:comment, comment)
+          configure_modifier(__method__, comment)
         end
 
         # Get a count of matching documents in the collection.
@@ -202,7 +174,7 @@ module Mongo
         #
         # @since 2.0.0
         def hint(hint = nil)
-          configure(:hint, hint)
+          configure_modifier(__method__, hint)
         end
 
         # The max number of docs to return from the query.
@@ -216,7 +188,7 @@ module Mongo
         #
         # @since 2.0.0
         def limit(limit = nil)
-          configure(:limit, limit)
+          configure(__method__, limit)
         end
 
         # Execute a map/reduce operation on the collection view.
@@ -246,7 +218,35 @@ module Mongo
         #
         # @since 2.0.0
         def max_scan(value = nil)
-          configure(:max_scan, value)
+          configure_modifier(__method__, value)
+        end
+
+        # Set the maximum value to search.
+        #
+        # @example Set the max value.
+        #   view.max_value(_id: 1)
+        #
+        # @param [ Hash ] value The max field and value.
+        #
+        # @return [ Hash, View ] The value or a new +View+.
+        #
+        # @since 2.1.0
+        def max_value(value = nil)
+          configure_modifier(__method__, value)
+        end
+
+        # Set the minimum value to search.
+        #
+        # @example Set the min value.
+        #   view.min_value(_id: 1)
+        #
+        # @param [ Hash ] value The min field and value.
+        #
+        # @return [ Hash, View ] The value or a new +View+.
+        #
+        # @since 2.1.0
+        def min_value(value = nil)
+          configure_modifier(__method__, value)
         end
 
         # The server normally times out idle cursors after an inactivity period
@@ -259,7 +259,7 @@ module Mongo
         #
         # @since 2.0.0
         def no_cursor_timeout
-          configure_flag(:no_cursor_timeout)
+          configure_flag(__method__)
         end
 
         # The fields to include or exclude from each doc in the result set.
@@ -278,7 +278,7 @@ module Mongo
         # @since 2.0.0
         def projection(document = nil)
           validate_doc!(document) if document
-          configure(:projection, document)
+          configure(__method__, document)
         end
 
         # The read preference to use for the query.
@@ -294,7 +294,21 @@ module Mongo
         # @since 2.0.0
         def read(value = nil)
           return default_read if value.nil?
-          configure(:read, value.is_a?(Hash) ? ServerSelector.get(value) : value)
+          configure(__method__, value.is_a?(Hash) ? ServerSelector.get(value) : value)
+        end
+
+        # Set whether to return only the indexed field or fields.
+        #
+        # @example Set the return key value.
+        #   view.return_key(true)
+        #
+        # @param [ true, false ] value The return key value.
+        #
+        # @return [ true, false, View ] The value or a new +View+.
+        #
+        # @since 2.1.0
+        def return_key(value = nil)
+          configure_modifier(__method__, value)
         end
 
         # Set whether the disk location should be shown for each document.
@@ -309,7 +323,7 @@ module Mongo
         #
         # @since 2.0.0
         def show_disk_loc(value = nil)
-          configure(:show_disk_loc, value)
+          configure_modifier(__method__, value)
         end
 
         # The number of docs to skip before returning results.
@@ -324,7 +338,7 @@ module Mongo
         #
         # @since 2.0.0
         def skip(number = nil)
-          configure(:skip, number)
+          configure(__method__, number)
         end
 
         # Set the snapshot value for the view.
@@ -339,7 +353,7 @@ module Mongo
         #
         # @since 2.0.0
         def snapshot(value = nil)
-          configure(:snapshot, value)
+          configure_modifier(__method__, value)
         end
 
         # The key and direction pairs by which the result set will be sorted.
@@ -354,7 +368,7 @@ module Mongo
         #
         # @since 2.0.0
         def sort(spec = nil)
-          configure(:sort, spec)
+          configure_modifier(__method__, spec)
         end
 
         # “meta” operators that let you modify the output or behavior of a query.
@@ -368,7 +382,8 @@ module Mongo
         #
         # @since 2.1.0
         def modifiers(doc = nil)
-          configure(:modifiers, doc)
+          return @modifiers if doc.nil?
+          new(options.merge(__method__ => doc))
         end
 
         # A cumulative time limit in milliseconds for processing operations on a cursor.
@@ -382,12 +397,12 @@ module Mongo
         #
         # @since 2.1.0
         def max_time_ms(max = nil)
-          configure(:max_time_ms, max)
+          configure_modifier(__method__, max)
         end
 
         private
 
-        def default_read(read = nil)
+        def default_read
           options[:read] || read_preference
         end
 
@@ -400,17 +415,59 @@ module Mongo
           end
         end
 
-        def has_special_fields?
-          modifiers || sort || hint || comment || max_time_ms || max_scan ||
-              show_disk_loc || snapshot || explained? || cluster.sharded?
+        def parallel_scan(cursor_count)
+          server = read.select_server(cluster)
+          Operation::ParallelScan.new(
+            :coll_name => collection.name,
+            :db_name => database.name,
+            :cursor_count => cursor_count
+          ).execute(server.context).cursor_ids.map do |cursor_id|
+            result = Operation::Read::GetMore.new({ :to_return => 0,
+                                                    :cursor_id => cursor_id,
+                                                    :db_name   => database.name,
+                                                    :coll_name => collection.name
+              }).execute(server.context)
+            Cursor.new(self, result, server)
+          end
+        end
+
+        def setup(sel, opts)
+          setup_options(opts)
+          setup_selector(sel)
+        end
+
+        def setup_options(opts)
+          @options = opts ? opts.dup : {}
+          @modifiers = @options[:modifiers] ? @options.delete(:modifiers).dup : BSON::Document.new
+          @options.keys.each { |k| @modifiers.merge!(SPECIAL_FIELDS[k] => @options.delete(k)) if SPECIAL_FIELDS[k] }
+          @options.freeze
+        end
+
+        def setup_selector(sel)
+          @selector = sel ? sel.dup : {}
+          if @selector[:$query] || @selector['$query']
+            @selector.keys.each { |k| @modifiers.merge!(k => @selector.delete(k)) if k[0] == '$' }
+          end
+          @modifiers.freeze
+          @selector.freeze
         end
 
         def query_options
-          { :project => projection, :skip => skip, :limit => to_return, :flags => flags }
+          {
+            :project => projection,
+            :skip => skip,
+            :limit => limit,
+            :flags => flags,
+            :batch_size => batch_size
+          }
+        end
+
+        def requires_special_selector?
+          !modifiers.empty? || cluster.sharded?
         end
 
         def query_spec
-          sel = has_special_fields? ? special_selector : selector
+          sel = requires_special_selector? ? special_selector : selector
           { :selector  => sel,
             :read      => read,
             :options   => query_options,
@@ -419,19 +476,13 @@ module Mongo
         end
 
         def read_pref_formatted
-          read.to_mongos
+          @read_formatted ||= read.to_mongos
         end
 
         def special_selector
-          SPECIAL_FIELDS.reduce({}) do |hash, (key, method)|
-            value = send(method) || (options[:modifiers] && options[:modifiers][key])
-            hash[key] = value if value
-            hash
-          end
-        end
-
-        def to_return
-          [ limit || batch_size, batch_size || limit ].min
+          sel = BSON::Document.new(:$query => selector).merge!(modifiers)
+          sel[:$readPreference] = read_pref_formatted unless read_pref_formatted.nil?
+          sel
         end
 
         def validate_doc!(doc)