Get specs passing and change name to Options::Redacted

Author: estolfo

lib/mongo/client.rb

@@ -217,7 +217,7 @@ def use(name)
     # @since 2.0.0
     def with(new_options = {})
       clone.tap do |client|
-        opts = new_options || {}
+        opts = Options::Redacted.new(new_options) || Options::Redacted.new
         client.options.update(opts)
         Database.create(client)
         # We can't use the same cluster if some options that would affect it
@@ -292,14 +292,14 @@ def list_databases
     private
 
     def create_from_addresses(addresses, opts = {})
-      @options = Options::SensitiveOptions.new.merge(Database::DEFAULT_OPTIONS.merge(opts)).freeze
+      @options = Options::Redacted.new.merge(Database::DEFAULT_OPTIONS.merge(opts)).freeze
       @cluster = Cluster.new(addresses, @monitoring, options)
       @database = Database.new(self, options[:database], options)
     end
 
     def create_from_uri(connection_string, opts = {})
       uri = URI.new(connection_string, opts)
-      @options = Options::SensitiveOptions.new.merge(Database::DEFAULT_OPTIONS.merge(uri.client_options.merge(opts))).freeze
+      @options = Options::Redacted.new.merge(Database::DEFAULT_OPTIONS.merge(uri.client_options.merge(opts))).freeze
       @cluster = Cluster.new(uri.servers, @monitoring, options)
       @database = Database.new(self, options[:database], options)
     end
@@ -314,7 +314,7 @@ def initialize_copy(original)
 
     def cluster_modifying?(new_options)
       cluster_options = new_options.reject do |name|
-        CRUD_OPTIONS.include?(name)
+        CRUD_OPTIONS.include?(name.to_sym)
       end
       cluster_options.any? do |name, value|
         options[name] != value

lib/mongo/database.rb

@@ -148,7 +148,12 @@ def collections
     #
     # @return [ Hash ] The result of the command execution.
     def command(operation, opts = {})
-      preference = opts[:read] ? ServerSelector.get(opts[:read].merge(options)) : read_preference
+      if opts[:read]
+        preference = ServerSelector.get(Options::Redacted.new(
+                                            opts[:read]).merge(options))
+      else
+        preference = read_preference
+      end
       server = preference.select_server(cluster)
       Operation::Command.new({
         :selector => operation,

lib/mongo/options.rb

@@ -13,4 +13,4 @@
 # limitations under the License.
 
 require 'mongo/options/mapper'
-require 'mongo/options/sensitive_options'
+require 'mongo/options/redacted'

lib/mongo/options/sensitive_options.rb renamed to lib/mongo/options/redacted.rb

@@ -15,27 +15,31 @@
 module Mongo
   module Options
 
-    SENSITIVE_OPTIONS = [:password, :pwd]
+    REDACTED_OPTIONS = [:password, :pwd]
     REDACTED_STRING = '<REDACTED>'
 
-    class SensitiveOptions < BSON::Document
+    class Redacted < BSON::Document
 
       def inspect
-        '{' + reduce('') do |string, (k, v)|
-          string << "#{k.inspect}=>#{redact(k, v, __method__)}"
-        end + '}'
+        '{' + reduce([]) do |list, (k, v)|
+          list << "#{k.inspect}=>#{redact(k, v, __method__)}"
+        end.join(', ') + '}'
       end
 
       def to_s
-        '{' + reduce('') do |string, (k, v)|
-          string << "#{k.to_s}=>#{redact(k, v, __method__)}"
-        end + '}'
+        '{' + reduce([]) do |list, (k, v)|
+          list << "#{k.to_s}=>#{redact(k, v, __method__)}"
+        end.join(', ') + '}'
+      end
+
+      def has_key?(key)
+        super(convert_key(key))
       end
 
       private
 
       def redact(k, v, method)
-        return REDACTED_STRING if SENSITIVE_OPTIONS.include?(k.to_sym)
+        return REDACTED_STRING if REDACTED_OPTIONS.include?(k.to_sym)
         v.send(method)
       end
     end

lib/mongo/server/connection.rb

@@ -183,7 +183,7 @@ def deliver(messages)
       def setup_authentication!
         if options[:user]
           default_mechanism = @server.features.scram_sha_1_enabled? ? :scram : :mongodb_cr
-          user = Auth::User.new(Options::SensitiveOptions.new(:auth_mech => default_mechanism).merge(options))
+          user = Auth::User.new(Options::Redacted.new(:auth_mech => default_mechanism).merge(options))
           @authenticator = Auth.get(user)
         end
       end

spec/mongo/client_spec.rb

@@ -172,11 +172,15 @@
       )
     end
 
+    let(:options) do
+      Mongo::Options::Redacted.new(:read => { :mode => :primary },
+                                    :local_threshold_ms => 10,
+                                    :server_selection_timeout_ms => 10000,
+                                    :database => TEST_DB)
+    end
+
     let(:expected) do
-      [client.cluster, { :read => { :mode => :primary },
-                         :local_threshold_ms => 10,
-                         :server_selection_timeout_ms => 10000,
-                         :database => TEST_DB }].hash
+      [client.cluster, options].hash
     end
 
     it 'returns a hash of the cluster and options' do
@@ -291,8 +295,12 @@
           described_class.new(uri)
         end
 
+        let(:expected_options) do
+          Mongo::Options::Redacted.new(:write => { :w => 3 }, :database => 'testdb')
+        end
+
         it 'sets the options' do
-          expect(client.options).to eq(:write => { :w => 3 }, :database => 'testdb')
+          expect(client.options).to eq(expected_options)
         end
       end
 
@@ -306,8 +314,12 @@
           described_class.new(uri, :write => { :w => 3 })
         end
 
+        let(:expected_options) do
+          Mongo::Options::Redacted.new(:write => { :w => 3 }, :database => 'testdb')
+        end
+
         it 'sets the options' do
-          expect(client.options).to eq(:write => { :w => 3 }, :database => 'testdb')
+          expect(client.options).to eq(expected_options)
         end
       end
 
@@ -321,8 +333,12 @@
           described_class.new(uri, :write => { :w => 4 })
         end
 
+        let(:expected_options) do
+          Mongo::Options::Redacted.new(:write => { :w => 4 }, :database => 'testdb')
+        end
+
         it 'allows explicit options to take preference' do
-          expect(client.options).to eq(:write => { :w => 4 }, :database => 'testdb')
+          expect(client.options).to eq(expected_options)
         end
       end
 
@@ -497,20 +513,28 @@
         client.with(:read => { :mode => :primary })
       end
 
+      let(:new_options) do
+        Mongo::Options::Redacted.new(:read => { :mode => :primary },
+                                             :write => { :w => 1 },
+                                             :database => TEST_DB)
+      end
+
+      let(:original_options) do
+        Mongo::Options::Redacted.new(:read => { :mode => :secondary },
+                                             :write => { :w => 1 },
+                                             :database => TEST_DB)
+      end
+
       it 'returns a new client' do
         expect(new_client).not_to equal(client)
       end
 
       it 'replaces the existing options' do
-        expect(new_client.options).to eq({
-          :read => { :mode => :primary }, :write => { :w => 1 }, :database => TEST_DB
-        })
+        expect(new_client.options).to eq(new_options)
       end
 
       it 'does not modify the original client' do
-        expect(client.options).to eq({
-          :read => { :mode => :secondary }, :write => { :w => 1 }, :database => TEST_DB
-        })
+        expect(client.options).to eq(original_options)
       end
 
       it 'keeps the same cluster' do
@@ -579,7 +603,7 @@
         end
 
         it 'returns a acknowledged write concern' do
-          expect(concern.get_last_error).to eq(:getlasterror => 1, :j => true)
+          expect(concern.get_last_error).to eq(:getlasterror => 1, 'j' => true)
         end
       end
 

spec/mongo/grid/stream/write_spec.rb

@@ -87,14 +87,14 @@
         context 'when chunks are inserted' do
 
           it 'uses that write concern' do
-            expect(stream.send(:chunks_collection).write_concern.options).to eq(expected)
+            expect(stream.send(:chunks_collection).write_concern.options[:w]).to eq(expected[:w])
           end
         end
 
         context 'when a files document is inserted' do
 
           it 'uses that write concern' do
-            expect(stream.send(:files_collection).write_concern.options).to eq(expected)
+            expect(stream.send(:files_collection).write_concern.options[:w]).to eq(expected[:w])
           end
         end
       end