sinclair 1.6.2 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15c8c49649134851cc9f1fb6a92d4ea19ff82cc2e68ce2d09339987b2623a5d4
-  data.tar.gz: def1468dbdf88b1f700edc6fd172cc6dc06d56b9aba07171cb6d7c3a7bcdc32e
+  metadata.gz: e73aaf0289f39dd23b05bbd256c7bbd98de3d5a2a963bddd096315241ad81d6b
+  data.tar.gz: ed6e16a5b51ef93cc7bd083c6ae304121df91dfc67ac71b8804cc340c63a002a
 SHA512:
-  metadata.gz: fcaf42f0c6ee8b2cdb4986e003b487f1f53184d9486c9479477fcfe4fb38550ff9deecc4b3029da563812179152ecee68c379b5673f60eedfb7df9a4f945b30c
-  data.tar.gz: 622f77edaeb7d9b247a15c071ecb80981e82d915124dbeb57851c86153c1790bd301ea7be067b9020281dc9aeecd6cec54ec4403a74972bf7f8d9d89cf444020
+  metadata.gz: a38a73d5ddca24d0dfacb8c535255a83978f84b0913c940f7eda1e6a5f162fd14c314b063df67d35673c2b83d55fc0d42ed7a8aaa2fbfa7093f0e23e7bef5abc
+  data.tar.gz: 1bb0387bd0cc01250985b5b000fac058e34a39b37b352cf89a953ab36fef069fda576121ff59ef0d95ab3521cce2879e0940085d95d4ccd95feb1e169d06da47

data/README.md

@@ -15,7 +15,7 @@ methods
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.6.2](https://www.rubydoc.info/gems/sinclair/1.6.2)
+[https://www.rubydoc.info/gems/sinclair/1.6.3](https://www.rubydoc.info/gems/sinclair/1.6.3)
 
 Installation
 ---------------
@@ -463,6 +463,8 @@ Options allows projects to have an easy to configure option object
  options.retries  # returns nil
  options.protocol # returns 'http'
  options.port     # returns 443
+
+ ConnectionOptions.new(invalid: 10) # raises Sinclair::Exception::InvalidOptions
 ```
 
 RSspec matcher

data/lib/sinclair/options.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'set'
+
 class Sinclair
   # @api public
   # @author Darthjee
@@ -21,28 +23,56 @@ class Sinclair
     autoload :Builder, 'sinclair/options/builder'
 
     class << self
+      # @api private
+      #
+      # returns invalid options
+      #
+      # @return [Array<Symbol>]
+      def invalid_options_in(names)
+        names.map(&:to_sym) - allowed_options.to_a
+      end
+
+      # @api private
+      #
+      # Allow new option
+      #
+      # This does not create the method
+      #
+      # @param name [String,Symbol] options to be allowed
+      #
+      # @return [Set<Symbol>]
+      def allow(name)
+        allowed_options << name.to_sym
+      end
+
+      private
+
       # @api private
       # @private
       #
       # Options allowed when initializing options
       #
-      # @return [Array<Symbol>]
+      # @return [Set<Symbol>]
       def allowed_options
-        @allowed_options ||= (superclass.try(:allowed_options).dup || [])
+        @allowed_options ||= build_allowed_options
       end
 
       # @api private
       # @private
       #
-      # returns invalid options
+      # Build set of allowed options
       #
-      # @return [Array<Symbol>]
-      def invalid_options_in(names)
-        names.map(&:to_sym) - allowed_options
+      # When class is descendent of {Options}
+      # a duplication of it's parents allowed_options is
+      # returned
+      #
+      # @return (see allowed_options)
+      def build_allowed_options
+        superclass.send(:allowed_options).dup
+      rescue NoMethodError
+        Set.new
       end
 
-      private
-
       # @api public
       # @!visibility public
       #

data/lib/sinclair/options/builder.rb

@@ -57,7 +57,7 @@ class Sinclair
       def add_all_methods
         attributes.each do |option, value|
           add_method(option, cached: :full) { value }
-          klass.allowed_options.push(option.to_sym)
+          klass.allow(option)
         end
       end
     end

data/lib/sinclair/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Sinclair
-  VERSION = '1.6.2'
+  VERSION = '1.6.3'
 end

data/spec/integration/readme/sinclair/options_spec.rb

@@ -15,5 +15,13 @@ describe Sinclair::Options do
       expect(options.protocol).to eq('http')
       expect(options.port).to eq(443)
     end
+
+    context 'when initialized with invalid options' do
+      it do
+        expect do
+          ConnectionOptions.new(invalid: 10)
+        end.to raise_error(Sinclair::Exception::InvalidOptions)
+      end
+    end
   end
 end

data/spec/lib/sinclair/options/builder_spec.rb

@@ -11,6 +11,10 @@ describe Sinclair::Options::Builder do
     let(:klass)   { Class.new(Sinclair::Options) }
     let(:options) { klass.new }
 
+    let(:test_keys) do
+      %i[timeout retries invalid]
+    end
+
     context 'when calling with keys' do
       let(:args) { [:timeout, 'retries'] }
 
@@ -26,14 +30,14 @@ describe Sinclair::Options::Builder do
 
       it do
         expect { builder.build }
-          .to change(klass, :allowed_options)
-          .from([])
-          .to(%i[timeout retries])
+          .to change { klass.invalid_options_in(test_keys) }
+          .from(test_keys)
+          .to([:invalid])
       end
 
       it do
         expect { builder.build }
-          .not_to change(Sinclair::Options, :allowed_options)
+          .not_to change { Sinclair::Options.invalid_options_in(test_keys) }
       end
 
       context 'when when calling method after building' do
@@ -67,6 +71,10 @@ describe Sinclair::Options::Builder do
         [:protocol, { 'port' => 443 }]
       end
 
+      let(:test_keys) do
+        %i[timeout retries protocol port invalid]
+      end
+
       let(:super_builder) do
         described_class.new(super_class, :timeout, 'retries')
       end
@@ -85,14 +93,14 @@ describe Sinclair::Options::Builder do
 
       it do
         expect { builder.build }
-          .to change(klass, :allowed_options)
-          .from(%i[timeout retries])
-          .to(%i[timeout retries protocol port])
+          .to change { klass.invalid_options_in(test_keys) }
+          .from(%i[protocol port invalid])
+          .to(%i[invalid])
       end
 
       it do
         expect { builder.build }
-          .not_to change(super_class, :allowed_options)
+          .not_to change { super_class.invalid_options_in(test_keys) }
       end
     end
   end

data/spec/lib/sinclair/options_spec.rb

@@ -6,7 +6,8 @@ describe Sinclair::Options do
   subject(:options) { klass.new }
 
   describe '.with_options' do
-    let(:klass) { Class.new(described_class) }
+    let(:klass)     { Class.new(described_class) }
+    let(:test_keys) { %i[timeout retries invalid] }
 
     context 'when calling with keys' do
       it 'add first method' do
@@ -19,16 +20,18 @@ describe Sinclair::Options do
           .to add_method(:retries).to(klass)
       end
 
-      it do
+      it 'adds options to allowed' do
         expect { klass.send(:with_options, :timeout, 'retries') }
-          .to change(klass, :allowed_options)
-          .from([])
-          .to(%i[timeout retries])
+          .to change { klass.invalid_options_in(test_keys) }
+          .from(%i[timeout retries invalid])
+          .to([:invalid])
       end
 
       it do
         expect { klass.send(:with_options, :timeout, 'retries') }
-          .not_to change(described_class, :allowed_options)
+          .not_to change {
+                    described_class.invalid_options_in(%i[timeout retries invalid])
+                  }
       end
 
       context 'when when calling method after building' do
@@ -36,6 +39,17 @@ describe Sinclair::Options do
 
         it { expect(options.timeout).to be_nil }
       end
+
+      context 'when calling method twice' do
+        before { klass.send(:with_options, :timeout, retries: 10) }
+
+        it do
+          expect { klass.send(:with_options, :timeout, :retries) }
+            .not_to change {
+                      klass.invalid_options_in(%i[timeout retries invalid])
+                    }
+        end
+      end
     end
 
     context 'when calling with a hash' do
@@ -57,7 +71,11 @@ describe Sinclair::Options do
       let(:super_class) { Class.new(described_class) }
       let(:klass)       { Class.new(super_class) }
 
-      before { super_class.send(:with_options, :timeout, 'retries') }
+      let(:test_keys) do
+        %i[timeout retries name protocol port invalid]
+      end
+
+      before { super_class.send(:with_options, :timeout, 'retries', name: 'My Connector') }
 
       it 'add first method' do
         expect { klass.send(:with_options, :protocol, 'port' => 443) }
@@ -71,14 +89,110 @@ describe Sinclair::Options do
 
       it do
         expect { klass.send(:with_options, 'protocol', port: 443) }
-          .to change(klass, :allowed_options)
-          .from(%i[timeout retries])
-          .to(%i[timeout retries protocol port])
+          .to change {
+                klass.invalid_options_in(test_keys)
+              }.from(%i[protocol port invalid])
+          .to([:invalid])
       end
 
       it do
         expect { klass.send(:with_options, 'protocol', port: 443) }
-          .not_to change(super_class, :allowed_options)
+          .not_to change {
+                    super_class.invalid_options_in(%i[protocol port])
+                  }
+      end
+
+      context 'when overriding a method' do
+        it do
+          expect { klass.send(:with_options, :name, timeout: 10) }
+            .not_to change { klass.invalid_options_in(%i[name timeout]) }
+        end
+
+        it 'change methods to return new default' do
+          expect { klass.send(:with_options, :name, timeout: 10) }
+            .to change { klass.new.timeout }
+            .from(nil).to(10)
+        end
+
+        it 'change methods to return without default' do
+          expect { klass.send(:with_options, :name, timeout: 10) }
+            .to change { klass.new.name }
+            .from('My Connector').to(nil)
+        end
+      end
+    end
+  end
+
+  describe '.invalid_options_in' do
+    let(:klass)     { Class.new(described_class) }
+    let(:test_keys) { %i[timeout invalid] }
+
+    it 'returns alls keys as invalid' do
+      expect(klass.invalid_options_in(test_keys))
+        .to eq(test_keys)
+    end
+
+    context 'when allowed options was never set' do
+      before { klass.allow(:timeout) }
+
+      it 'returns keys that are not allowed by the input' do
+        expect(klass.invalid_options_in(test_keys))
+          .to eq([:invalid])
+      end
+    end
+
+    context 'when calling on subclass' do
+      let(:super_class) { Class.new(described_class) }
+      let(:klass)       { Class.new(super_class) }
+      let(:test_keys)   { %i[timeout invalid] }
+
+      before { super_class.allow(:timeout) }
+
+      context 'when not adding allowed options' do
+        it 'returns keys that are not allowed by the input' do
+          expect(klass.invalid_options_in(test_keys))
+            .to eq([:invalid])
+        end
+      end
+
+      context 'when adding keys' do
+        before { super_class.allow(:retries) }
+
+        it 'returns keys that are not allowed by the input' do
+          expect(klass.invalid_options_in(test_keys))
+            .to eq([:invalid])
+        end
+
+        it 'adds new key to accepted' do
+          expect(klass.invalid_options_in([:retries]))
+            .to be_empty
+        end
+      end
+    end
+  end
+
+  describe '.allow' do
+    let(:klass)     { Class.new(described_class) }
+    let(:test_keys) { %i[timeout retries invalid] }
+
+    it 'adds options to allowed' do
+      expect { klass.allow(:timeout) }
+        .to change { klass.invalid_options_in(test_keys) }
+        .from(%i[timeout retries invalid])
+        .to(%i[retries invalid])
+    end
+
+    context 'when calling on subclass' do
+      let(:super_class) { Class.new(described_class) }
+      let(:klass)       { Class.new(super_class) }
+
+      before { super_class.allow(:timeout) }
+
+      it 'adds options to allowed' do
+        expect { klass.allow(:retries) }
+          .to change { klass.invalid_options_in(test_keys) }
+          .from(%i[retries invalid])
+          .to(%i[invalid])
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2020-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport