sinclair 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a99344876ea7ff46dc785f5d9a9daddedce4fa84fb1d33c1387f333ef2611f8
-  data.tar.gz: 2687f7ebd7816a13275d9aede938dff46731edde1dba1b2e0a272f9e0967af18
+  metadata.gz: 46aae0be813637d70c6060f5ac9a14537d19eb2d5e4275a31e864625b396c038
+  data.tar.gz: '08f41f83267f7f017b036e4fd806e336a17932ae4f93eadae0e08dd4341c51cb'
 SHA512:
-  metadata.gz: 8b6278abe2c8f3b0ec4f20cc9856508cf7f5726643229d532c075e5a142cca02141f5e3e8b8d99bea25859dd2a4b072b2fb457aa0b682f4a25949f132c2715e4
-  data.tar.gz: d0e6cae7c4e3d1f87c99f737066292cdee42ee6b14c00ce7b1a6cb1eb20f05dd73a776e5cd75c3ac2d6ffb7ab1a91a67f57d5d0d00385238aa57ab84dbc6d7bb
+  metadata.gz: 61deac1e3f21b5f238f33fd900ffadacd478b48cdaa3387ac7c272c28edb6d810af1609ec0d76b670861339c9de13600c8c39538c5be0199d5175fe6ed899434
+  data.tar.gz: 3681a6b3f56c9380e6bcc19bde499c0f4afc593075d8e23144ecc3d0168f0c89bf5352f351b1b87930fc2ba937f313a94292498157e75e6e4e7d56b12bd2efac

data/README.md

@@ -14,7 +14,7 @@ methods
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/sinclair/1.3.2
+https://www.rubydoc.info/gems/sinclair/1.3.3
 
 Installation
 ---------------
@@ -332,6 +332,38 @@ the `configurable#configure` method
   MyConfigurable.config.port # returns 80
 ```
 
+Configurations can also be done through custom classes
+
+```ruby
+  class MyServerConfig
+    def url
+      if @port
+        "http://#{@host}:#{@port}"
+      else
+        "http://#{@host}"
+      end
+    end
+  end
+
+  class Client
+    extend Sinclair::Configurable
+
+    configurable_by MyServerConfig, with: %i[host port]
+  end
+
+  Client.configure do
+    host 'interstella.com'
+  end
+
+  Client.config.url # returns 'http://interstella.com'
+
+  Client.configure do |config|
+    config.port 8080
+  end
+
+  Client.config.url # returns 'http://interstella.com:8080'
+```
+
 RSspec matcher
 ---------------
 

data/lib/sinclair/config_factory.rb

@@ -25,6 +25,8 @@ class Sinclair
       @config_attributes = config_attributes.dup
     end
 
+    # @api public
+    #
     # Returns current instance of config
     #
     # the method returns the same instance until +reset_config+
@@ -41,6 +43,8 @@ class Sinclair
       @config ||= config_class.new
     end
 
+    # @api public
+    #
     # Cleans the current config instance
     #
     # After cleaning it, {#config} will generate a new
@@ -87,6 +91,8 @@ class Sinclair
       config_attributes.concat(builder.config_names.map(&:to_sym))
     end
 
+    # @api public
+    #
     # Set the values in the config
     #
     # The block given is evaluated by the {ConfigBuilder}

data/lib/sinclair/configurable.rb

@@ -8,37 +8,14 @@ class Sinclair
   # By extending Configurable, class receives the methods public
   # {ConfigFactory#config .config}, {ConfigFactory#reset_config .reset_config}
   # and {ConfigFactory#configure .configure}
-  # and the private {#configurable_with .configurable_with}
+  # and the private methods {#configurable_with .configurable_with}
+  # and {#configurable_by .configurable_by}
   #
   # @see ConfigFactory
   # @see ConfigBuilder
   #
-  # @example
-  #   class MyConfigurable
-  #     extend Sinclair::Configurable
-  #
-  #     # port is defaulted to 80
-  #     configurable_with :host, port: 80
-  #   end
-  #
-  #   MyConfigurable.configure do
-  #     host 'interstella.com'
-  #     port 5555
-  #   end
-  #
-  #   MyConfigurable.config.host
-  #   # returns 'interstella.com'
-  #
-  #   MyConfigurable.config.port
-  #   # returns 5555
-  #
-  #   MyConfigurable.reset_config
-  #
-  #   MyConfigurable.config.host
-  #   # returns nil
-  #
-  #   MyConfigurable.config.port
-  #   # returns 80
+  # @example (see #configurable_with)
+  # @example (see #configurable_by)
   module Configurable
     # (see ConfigFactory#config)
     # @see ConfigFactory#config
@@ -93,9 +70,84 @@ class Sinclair
     #
     # @see ConfigFactory#add_configs
     #
-    # @example (see Configurable)
+    # @example Configuring with common {Sinclair::Config} class
+    #   class MyConfigurable
+    #     extend Sinclair::Configurable
+    #
+    #     # port is defaulted to 80
+    #     configurable_with :host, port: 80
+    #   end
+    #
+    #   MyConfigurable.configure do
+    #     host 'interstella.com'
+    #     port 5555
+    #   end
+    #
+    #   MyConfigurable.config.host
+    #   # returns 'interstella.com'
+    #
+    #   MyConfigurable.config.port
+    #   # returns 5555
+    #
+    #   MyConfigurable.reset_config
+    #
+    #   MyConfigurable.config.host
+    #   # returns nil
+    #
+    #   MyConfigurable.config.port
+    #   # returns 80
     def configurable_with(*attributes)
       config_factory.add_configs(*attributes)
     end
+
+    # @!visibility public
+    #
+    # Allows configuration to happen through custom config class
+    #
+    # @param config_class [Class] custom configuration class
+    # @param with [Array<Symbol,String>] List of all
+    #   configuration attributes expected to be found on
+    #   +config_class+
+    #
+    # configurable_with does not add methods to config_class.
+    # If needed, those can be added by a subsequent call to
+    # {#configurable_with}
+    #
+    # @return [ConfigFactory]
+    #
+    # @example Configured by custom config class
+    #   class MyServerConfig
+    #     def url
+    #       if @port
+    #         "http://#{@host}:#{@port}"
+    #       else
+    #         "http://#{@host}"
+    #       end
+    #     end
+    #   end
+    #
+    #   class Client
+    #     extend Sinclair::Configurable
+    #
+    #     configurable_by MyServerConfig, with: %i[host port]
+    #   end
+    #
+    #   Client.configure do
+    #     host 'interstella.com'
+    #   end
+    #
+    #   Client.config.url # returns 'http://interstella.com'
+    #
+    #   Client.configure do |config|
+    #     config.port 8080
+    #   end
+    #
+    #   Client.config.url # returns 'http://interstella.com:8080'
+    def configurable_by(config_class, with: [])
+      @config_factory = ConfigFactory.new(
+        config_class: config_class,
+        config_attributes: with.map(&:to_sym)
+      )
+    end
   end
 end

data/lib/sinclair/version.rb

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

data/scripts/rubycritic.sh

@@ -4,7 +4,7 @@ DIFF_LIST=$(git diff --name-only $CIRCLE_SHA1 $(git merge-base $CIRCLE_SHA1 orig
 
 if [ ! -z "$DIFF_LIST" ]; then
   mkdir -p tmp/rubycritic/compare
-  bundle exec rubycritic --format console --branch origin/master -t 0 $DIFF_LIST
+  bundle exec rubycritic --format console --branch origin/master -t 0  --maximum-decrease 1 $DIFF_LIST
 else
   echo "No changes detected. Skipping rubycritic..."
 fi

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

@@ -3,40 +3,72 @@
 require 'spec_helper'
 
 describe Sinclair::Configurable do
-  context 'when it is configured' do
-    before do
-      MyConfigurable.configure do |config|
-        config.host 'interstella.art'
-        config.port 5555
+  describe 'README' do
+    describe 'Configured with' do
+      before do
+        MyConfigurable.configure do |config|
+          config.host 'interstella.art'
+          config.port 5555
+        end
       end
-    end
 
-    after do
-      MyConfigurable.reset_config
-    end
+      after do
+        MyConfigurable.reset_config
+      end
 
-    it 'sets configuration host' do
-      expect(MyConfigurable.config.host)
-        .to eq('interstella.art')
-    end
+      it 'sets configuration host' do
+        expect(MyConfigurable.config.host)
+          .to eq('interstella.art')
+      end
+
+      it 'sets configuration port' do
+        expect(MyConfigurable.config.port)
+          .to eq(5555)
+      end
+
+      context 'when #rest_config is called' do
+        before do
+          MyConfigurable.reset_config
+        end
+
+        it 'resets configuration host' do
+          expect(MyConfigurable.config.host)
+            .to be_nil
+        end
 
-    it 'sets configuration port' do
-      expect(MyConfigurable.config.port)
-        .to eq(5555)
+        it 'resets configuration port' do
+          expect(MyConfigurable.config.port).to eq(80)
+        end
+      end
     end
 
-    context 'when #rest_config is called' do
+    describe 'Configured by' do
       before do
-        MyConfigurable.reset_config
+        Client.configure do
+          host 'interstella.com'
+        end
       end
 
-      it 'resets configuration host' do
-        expect(MyConfigurable.config.host)
-          .to be_nil
+      after do
+        Client.reset_config
+      end
+
+      it 'sets host' do
+        expect(Client.config.url)
+          .to eq('http://interstella.com')
       end
 
-      it 'resets configuration port' do
-        expect(MyConfigurable.config.port).to eq(80)
+      context 'when setting the port' do
+        before do
+          Client.configure do |config|
+            config.port 8080
+          end
+        end
+
+        it 'sets host and port' do
+          expect(Client.config.url)
+            .to eq('http://interstella.com:8080')
+        end
       end
     end
   end

data/spec/integration/yard/sinclair/configurable_spec.rb

@@ -1,37 +1,71 @@
 # frozen_string_literal: true
 
+require 'spec_helper'
+
 describe Sinclair::Configurable do
   describe '#yard' do
-    before do
-      MyConfigurable.configure do
-        host 'interstella.com'
-        port 5555
+    describe '#configurable_with' do
+      before do
+        MyConfigurable.configure do
+          host 'interstella.com'
+          port 5555
+        end
       end
-    end
 
-    after do
-      MyConfigurable.reset_config
-    end
+      after do
+        MyConfigurable.reset_config
+      end
 
-    it 'sets right value for config host' do
-      expect(MyConfigurable.config.host)
-        .to eq('interstella.com')
-    end
+      it 'sets right value for config host' do
+        expect(MyConfigurable.config.host)
+          .to eq('interstella.com')
+      end
+
+      it 'sets right value for config port' do
+        expect(MyConfigurable.config.port)
+          .to eq(5555)
+      end
 
-    it 'sets right value for config port' do
-      expect(MyConfigurable.config.port)
-        .to eq(5555)
+      context 'when reset_config is called' do
+        before { MyConfigurable.reset_config }
+
+        it 'returns initial value for host' do
+          expect(MyConfigurable.config.host).to be_nil
+        end
+
+        it 'returns initial value for port' do
+          expect(MyConfigurable.config.port).to eq(80)
+        end
+      end
     end
 
-    context 'when reset_config is called' do
-      before { MyConfigurable.reset_config }
+    describe '#configurable_by' do
+      before do
+        Client.configure do
+          host 'interstella.com'
+        end
+      end
 
-      it 'returns initial value for host' do
-        expect(MyConfigurable.config.host).to be_nil
+      after do
+        Client.reset_config
       end
 
-      it 'returns initial value for port' do
-        expect(MyConfigurable.config.port).to eq(80)
+      it 'sets host' do
+        expect(Client.config.url)
+          .to eq('http://interstella.com')
+      end
+
+      context 'when setting the port' do
+        before do
+          Client.configure do |config|
+            config.port 8080
+          end
+        end
+
+        it 'sets host and port' do
+          expect(Client.config.url)
+            .to eq('http://interstella.com:8080')
+        end
       end
     end
   end

data/spec/lib/sinclair/configurable_spec.rb

@@ -42,6 +42,11 @@ describe Sinclair::Configurable do
   end
 
   describe '.configurable_with' do
+    it do
+      expect(configurable.send(:configurable_with, :name, 'host'))
+        .to all(be_a(Symbol))
+    end
+
     it 'adds reader to config' do
       expect { configurable.send(:configurable_with, :name) }
         .to add_method(:name).to(configurable.config)
@@ -70,6 +75,64 @@ describe Sinclair::Configurable do
     end
   end
 
+  describe '#configurable_by' do
+    let(:config_class) { ServerConfig }
+
+    it do
+      expect(configurable.send(:configurable_by, config_class))
+        .to be_a(Sinclair::ConfigFactory)
+    end
+
+    it 'changes config class' do
+      expect { configurable.send(:configurable_by, config_class) }
+        .to change { configurable.config.class }
+        .to(ServerConfig)
+    end
+
+    context 'when config attributes are not given' do
+      it 'raises error with any configuration' do
+        expect { configurable.configure { host 'myhost' } }
+          .to raise_error(NoMethodError)
+      end
+    end
+
+    context 'when config attributes are given' do
+      let(:attributes) { [:host, 'port'] }
+
+      let(:block) do
+        proc do
+          configurable.send(
+            :configurable_by, config_class, with: attributes
+          )
+        end
+      end
+
+      it 'does not add symbol methods config object' do
+        expect(&block)
+          .not_to add_method(:host).to(configurable.config)
+      end
+
+      it 'does not add string methods config object' do
+        expect(&block)
+          .not_to add_method(:port).to(configurable.config)
+      end
+
+      it 'does not raises error on configuration of given symbol attributes' do
+        block.call
+
+        expect { configurable.configure { host 'myhost' } }
+          .not_to raise_error
+      end
+
+      it 'does not raises error on configuration of given string attributes' do
+        block.call
+
+        expect { configurable.configure { port 90 } }
+          .not_to raise_error
+      end
+    end
+  end
+
   describe '.configure' do
     let(:config) { configurable.config }
 
@@ -93,5 +156,43 @@ describe Sinclair::Configurable do
           .to raise_error(NoMethodError)
       end
     end
+
+    context 'when it was configured by custom class' do
+      let(:config_class) { ServerConfig }
+
+      before do
+        configurable.send(
+          :configurable_by, config_class, with: [:host, 'port']
+        )
+      end
+
+      context 'when config class has the methods' do
+        it do
+          expect { configurable.configure { |c| c.host 'myhost' } }
+            .not_to raise_error
+        end
+
+        it 'sets variable' do
+          expect { configurable.configure { |c| c.host 'myhost' } }
+            .to change(config, :host)
+            .from(nil).to('myhost')
+        end
+      end
+
+      context 'when config class does not have the methods' do
+        let(:config_class) { Class.new(Sinclair::Config) }
+
+        it do
+          expect { configurable.configure { |c| c.host 'myhost' } }
+            .not_to raise_error
+        end
+
+        it 'sets variable' do
+          expect { configurable.configure { |c| c.host 'myhost' } }
+            .to change { config.instance_variable_get(:@host) }
+            .from(nil).to('myhost')
+        end
+      end
+    end
   end
 end

data/spec/support/models/client.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require './spec/support/models/my_server_config'
+
+class Client
+  extend Sinclair::Configurable
+
+  configurable_by MyServerConfig, with: %i[host port]
+end

data/spec/support/models/my_server_config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class MyServerConfig
+  def url
+    if @port
+      "http://#{@host}:#{@port}"
+    else
+      "http://#{@host}"
+    end
+  end
+end

data/spec/support/models/server_config.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ServerConfig
+  attr_reader :host, :port
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-19 00:00:00.000000000 Z
+date: 2019-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -234,6 +234,7 @@ files:
 - spec/lib/sinclair_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixture_helpers.rb
+- spec/support/models/client.rb
 - spec/support/models/default_value.rb
 - spec/support/models/default_value_builder.rb
 - spec/support/models/default_valueable.rb
@@ -250,9 +251,11 @@ files:
 - spec/support/models/my_config.rb
 - spec/support/models/my_configurable.rb
 - spec/support/models/my_model.rb
+- spec/support/models/my_server_config.rb
 - spec/support/models/person.rb
 - spec/support/models/purchase.rb
 - spec/support/models/server.rb
+- spec/support/models/server_config.rb
 - spec/support/models/validator_builder.rb
 - spec/support/shared_examples/config_factory.rb
 - spec/support/shared_examples/method_definition.rb