RUBY-1021 implement #select and #reject for Options::Redacted

Author: estolfo

lib/mongo/options/redacted.rb

@@ -65,6 +65,80 @@ def has_key?(key)
       end
       alias_method :key?, :has_key?
 
+      # Returns a new options object consisting of pairs for which the block returns false.
+      #
+      # @example Get a new options object with pairs for which the block returns false.
+      #   new_options = options.reject { |k, v| k == 'database' }
+      #
+      # @yieldparam [ String, Object ] The key as a string and its value.
+      #
+      # @return [ Options::Redacted ] A new options object.
+      #
+      # @since 2.1.0
+      def reject(&block)
+        new_options = dup
+        new_options.reject!(&block) || new_options
+      end
+
+      # Only keeps pairs for which the block returns false.
+      #
+      # @example Remove pairs from this object for which the block returns true.
+      #   options.reject! { |k, v| k == 'database' }
+      #
+      # @yieldparam [ String, Object ] The key as a string and its value.
+      #
+      # @return [ Options::Redacted ] This object.
+      #
+      # @since 2.1.0
+      def reject!
+        if block_given?
+          n_keys = keys.size
+          self.keys.each do |key|
+            self.delete(key) if yield(key, self[key])
+          end
+          n_keys == keys.size ? nil : self
+        else
+          self.to_enum
+        end
+      end
+
+      # Returns a new options object consisting of pairs for which the block returns true.
+      #
+      # @example Get a new options object with pairs for which the block returns true.
+      #   ssl_options = options.select { |k, v| k =~ /ssl/ }
+      #
+      # @yieldparam [ String, Object ] The key as a string and its value.
+      #
+      # @return [ Options::Redacted ] A new options object.
+      #
+      # @since 2.1.0
+      def select(&block)
+        new_options = dup
+        new_options.select!(&block) || new_options
+      end
+
+      # Only keeps pairs for which the block returns true.
+      #
+      # @example Remove pairs from this object for which the block does not return true.
+      #   options.select! { |k, v| k =~ /ssl/ }
+      #
+      # @yieldparam [ String, Object ] The key as a string and its value.
+      #
+      # @return [ Options::Redacted ] This object.
+      #
+      # @since 2.1.0
+      def select!
+        if block_given?
+          n_keys = keys.size
+          self.keys.each do |key|
+            self.delete(key) unless yield(key, self[key])
+          end
+          n_keys == keys.size ? nil : self
+        else
+          self.to_enum
+        end
+      end
+
       private
 
       def redacted_string(method)

spec/mongo/options/redacted_spec.rb

@@ -129,4 +129,218 @@
       end
     end
   end
+
+  describe '#reject' do
+
+    let(:options) do
+      described_class.new(a: 1, b: 2, c: 3)
+    end
+
+    context 'when no block is provided' do
+
+      it 'returns an enumerable' do
+        expect(options.reject).to be_a(Enumerator)
+      end
+    end
+
+    context 'when a block is provided' do
+
+      context 'when the block evaluates to true for some pairs' do
+
+        let(:result) do
+          options.reject { |k,v| k == 'a' }
+        end
+
+        it 'returns an object consisting of only the remaining pairs' do
+          expect(result).to eq(described_class.new(b: 2, c: 3))
+        end
+
+        it 'returns a new object' do
+          expect(result).not_to be(options)
+        end
+      end
+
+      context 'when the block does not evaluate to true for any pairs' do
+
+        let(:result) do
+          options.reject { |k,v| k == 'd' }
+        end
+
+        it 'returns an object with all pairs intact' do
+          expect(result).to eq(described_class.new(a: 1, b: 2, c: 3))
+        end
+
+        it 'returns a new object' do
+          expect(result).not_to be(options)
+        end
+      end
+    end
+  end
+
+  describe '#reject!' do
+
+    let(:options) do
+      described_class.new(a: 1, b: 2, c: 3)
+    end
+
+    context 'when no block is provided' do
+
+      it 'returns an enumerable' do
+        expect(options.reject).to be_a(Enumerator)
+      end
+    end
+
+    context 'when a block is provided' do
+
+      context 'when the block evaluates to true for some pairs' do
+
+        let(:result) do
+          options.reject! { |k,v| k == 'a' }
+        end
+
+        it 'returns an object consisting of only the remaining pairs' do
+          expect(result).to eq(described_class.new(b: 2, c: 3))
+        end
+
+        it 'returns the same object' do
+          expect(result).to be(options)
+        end
+      end
+
+      context 'when the block does not evaluate to true for any pairs' do
+
+        let(:result) do
+          options.reject! { |k,v| k == 'd' }
+        end
+
+        it 'returns nil' do
+          expect(result).to be(nil)
+        end
+      end
+    end
+  end
+
+  describe '#select' do
+
+    let(:options) do
+      described_class.new(a: 1, b: 2, c: 3)
+    end
+
+    context 'when no block is provided' do
+
+      it 'returns an enumerable' do
+        expect(options.reject).to be_a(Enumerator)
+      end
+    end
+
+    context 'when a block is provided' do
+
+      context 'when the block evaluates to true for some pairs' do
+
+        let(:result) do
+          options.select { |k,v| k == 'a' }
+        end
+
+        it 'returns an object consisting of those pairs' do
+          expect(result).to eq(described_class.new(a: 1))
+        end
+
+        it 'returns a new object' do
+          expect(result).not_to be(options)
+        end
+      end
+
+      context 'when the block does not evaluate to true for any pairs' do
+
+        let(:result) do
+          options.select { |k,v| k == 'd' }
+        end
+
+        it 'returns an object with no pairs' do
+          expect(result).to eq(described_class.new)
+        end
+
+        it 'returns a new object' do
+          expect(result).not_to be(options)
+        end
+      end
+
+      context 'when the object is unchanged' do
+
+        let(:options) do
+          described_class.new(a: 1, b: 2, c: 3)
+        end
+
+        let(:result) do
+          options.select { |k,v| ['a', 'b', 'c'].include?(k) }
+        end
+
+        it 'returns a new object' do
+          expect(result).to eq(described_class.new(a: 1, b: 2, c: 3))
+        end
+      end
+    end
+  end
+
+  describe '#select!' do
+
+    let(:options) do
+      described_class.new(a: 1, b: 2, c: 3)
+    end
+
+    context 'when no block is provided' do
+
+      it 'returns an enumerable' do
+        expect(options.reject).to be_a(Enumerator)
+      end
+    end
+
+    context 'when a block is provided' do
+
+      context 'when the block evaluates to true for some pairs' do
+
+        let(:result) do
+          options.select! { |k,v| k == 'a' }
+        end
+
+        it 'returns an object consisting of those pairs' do
+          expect(result).to eq(described_class.new(a: 1))
+        end
+
+        it 'returns the same object' do
+          expect(result).to be(options)
+        end
+      end
+
+      context 'when the block does not evaluate to true for any pairs' do
+
+        let(:result) do
+          options.select! { |k,v| k == 'd' }
+        end
+
+        it 'returns an object with no pairs' do
+          expect(result).to eq(described_class.new)
+        end
+
+        it 'returns the same object' do
+          expect(result).to be(options)
+        end
+      end
+
+      context 'when the object is unchanged' do
+
+        let(:options) do
+          described_class.new(a: 1, b: 2, c: 3)
+        end
+
+        let(:result) do
+          options.select! { |k,v| ['a', 'b', 'c'].include?(k) }
+        end
+
+        it 'returns nil' do
+          expect(result).to be(nil)
+        end
+      end
+    end
+  end
 end