sinclair 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4826b55d94281092e5a0ba4d397366c39ec3494ec6f84743480c9e6ef69a030e
-  data.tar.gz: fbd63c4a98eacaf569a56c95411e71043f5b400bd7f98b593c73fba1a68d5bd6
+  metadata.gz: cf2a52c6d33753fa9a52ad79fc4657d9d8573526a471ffb8c4fad386b1063e63
+  data.tar.gz: e219d16240478c36417001ac957437c4bcd2b29b241d51dde3802a0f9114dd32
 SHA512:
-  metadata.gz: 531c6f6db55bed97a3bfcf8f8c6001ae35cd5226aa5e386b0bb9442afcea7984bdf77ef4b16774e6e7c44c4b51c8ec15eac74431042f26a12d069909a2fa6a1f
-  data.tar.gz: 5820b843eaddf7838d430c4713645fbad5a8bf46850bc9cce5dbc1cc9f7d0005dc949969c06ba6ed3ca088a9790fdf32121e2e795dcc09935092636594809ed2
+  metadata.gz: 1d8348d94ceebf9dc9a303f7f9e394ee3e8d42351a5c9b78a503c0882fb65a6afa6054a124cae96d7cc77380c7c239e10774a6dc0b7bb4091ff2de5fb4cc9df6
+  data.tar.gz: 8c6177428b8184b3b949bfa493a17b23b4a401b5767ebd131ffbdf125c03f061e20be249f079194557dcaf429c91f58517ab76b1cea9f7e2635bea55df76276b

data/README.md

@@ -14,7 +14,7 @@ methods
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/sinclair/1.4.0
+https://www.rubydoc.info/gems/sinclair/1.4.1
 
 Installation
 ---------------
@@ -308,7 +308,8 @@ Configurable is a module that, when used, can add configurations
 to your classes/modules.
 
 Configurations are read-only objects that can only be set using
-the `configurable#configure` method
+the `configurable#configure` method which accepts a block or
+hash
 
 ```ruby
   module MyConfigurable
@@ -318,9 +319,8 @@ the `configurable#configure` method
     configurable_with :host, port: 80
   end
 
-  MyConfigurable.configure do |config|
+  MyConfigurable.configure(port: 5555) do |config|
     config.host 'interstella.art'
-    config.port 5555
   end
 
   MyConfigurable.config.host # returns 'interstella.art'

data/lib/sinclair/config_factory.rb

@@ -32,45 +32,6 @@ class Sinclair
       warn CONFIG_CLASS_WARNING
     end
 
-    # @api public
-    #
-    # Returns current instance of config
-    #
-    # the method returns the same instance until +reset_config+
-    # is called
-    #
-    # @return [Config,Object] the instance of given
-    #   config_class. by default, this returns
-    #   +Class.new(Config).new+
-    #
-    # @see #reset_config
-    #
-    # @example (see ConfigFactory)
-    def config
-      @config ||= config_class.new
-    end
-
-    # @api public
-    #
-    # Cleans the current config instance
-    #
-    # After cleaning it, {#config} will generate a new
-    # instance
-    #
-    # @return [NilClass]
-    #
-    # @example
-    #   factory = Sinclair::ConfigFactory.new
-    #
-    #   config = factory.config
-    #
-    #   factory.reset_config
-    #
-    #   factory.config == config # returns false
-    def reset_config
-      @config = nil
-    end
-
     # Adds possible configurations
     #
     # It change the configuration class adding methods
@@ -102,39 +63,59 @@ class Sinclair
       config_attributes.concat(builder.config_names.map(&:to_sym))
     end
 
-    # @api public
+    # (see Configurable#config)
     #
-    # Set the values in the config
+    # @see #reset_config
     #
-    # The block given is evaluated by the {ConfigBuilder}
-    # where each method missed will be used to set a variable
-    # in the config
+    # @example (see ConfigFactory)
+    def config
+      @config ||= config_class.new
+    end
+
+    # (see Configurable#reset_config)
     #
-    # @yield [ConfigBuilder] methods called in the block
-    #   that are not present in {ConfigBuilder} are
-    #   then set as instance variables of the config
+    # @example
+    #   factory = Sinclair::ConfigFactory.new
     #
-    # @return [Object] the result of the block
+    #   config = factory.config
+    #
+    #   factory.reset_config
+    #
+    #   factory.config == config # returns false
+    def reset_config
+      @config = nil
+    end
+
+    # (see Configurable#configure)
     #
     # @example Setting name on config
     #   class MyConfig
     #     extend Sinclair::ConfigClass
     #
-    #     attr_reader :name
+    #     attr_reader :name, :email
     #   end
     #
     #   factory = Sinclair::ConfigFactory.new(
     #     config_class: MyConfig,
-    #     config_attributes: [:name]
+    #     config_attributes: %i[name email]
     #   )
     #
     #   config = factory.config
     #
-    #   factory.configure { name 'John' }
+    #   factory.configure(email: 'john@server.com') do
+    #     name 'John'
+    #   end
     #
-    #   config.name # returns 'John'
-    def configure(&block)
-      config_builder.instance_eval(&block)
+    #   config.name  # returns 'John'
+    #   config.email # returns 'john@server.com'
+    def configure(config_hash = {}, &block)
+      config_builder.instance_eval(&block) if block
+
+      config_builder.instance_eval do
+        config_hash.each do |key, value|
+          public_send(key, value)
+        end
+      end
     end
 
     # Returns a new instance of ConfigFactory

data/lib/sinclair/configurable.rb

@@ -25,23 +25,57 @@ class Sinclair
       "configurable_with.\n" \
       "In future releases this will be enforced.\n" \
       'see more on https://github.com/darthjee/sinclair/blob/master/WARNINGS.md#usage-of-custom-config-classes'
-    # (see ConfigFactory#config)
+
+    # @method config
+    #
+    # @api public
+    #
+    # Returns current instance of config
+    #
+    # the method returns the same instance until +reset_config+
+    # is called
+    #
+    # @return [Config,Object] the instance of given
+    #   config_class. by default, this returns
+    #   +Class.new(Config).new+
+    #
+    # @see #reset_config
     # @see ConfigFactory#config
-    def config
-      config_factory.config
-    end
 
-    # (see ConfigFactory#reset_config)
+    # @method reset_config
+    #
+    # @api public
+    #
+    # Cleans the current config instance
+    #
+    # After cleaning it, {#config} will generate a new
+    # instance
+    #
+    # @return [NilClass]
+    #
     # @see ConfigFactory#reset_config
-    def reset_config
-      config_factory.reset_config
-    end
 
-    # (see ConfigFactory#configure)
+    # @method configure(config_hash = {}, &block)
+    #
+    # @api public
+    #
+    # Set the values in the config
+    #
+    # The block given is evaluated by the {ConfigBuilder}
+    # where each method missed will be used to set a variable
+    # in the config
+    #
+    # @param config_hash [Hash] hash with keys and values for
+    #   the configuration
+    #
+    # @yield [ConfigBuilder] methods called in the block
+    #   that are not present in {ConfigBuilder} are
+    #   then set as instance variables of the config
+    #
+    # @return [Object] the result of the block
+    #
     # @see ConfigFactory#configure
-    def configure(&block)
-      config_factory.configure(&block)
-    end
+    delegate :config, :reset_config, :configure, to: :config_factory
 
     protected
 

data/lib/sinclair/version.rb

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

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

@@ -6,9 +6,8 @@ describe Sinclair::Configurable do
   describe 'README' do
     describe 'Configured with' do
       before do
-        MyConfigurable.configure do |config|
+        MyConfigurable.configure(port: 5555) do |config|
           config.host 'interstella.art'
-          config.port 5555
         end
       end
 

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

@@ -68,12 +68,22 @@ describe Sinclair::ConfigFactory do
     end
 
     describe '#configure' do
-      let(:config_class) { MyConfig }
+      let(:config_class)      { MyConfig }
+      let(:email)             { 'john@server.com' }
+      let(:config_attributes) { %i[name email] }
 
-      it 'sets variable on config' do
-        expect { factory.configure { name 'John' } }
-          .to change(config, :name)
-          .from(nil).to('John')
+      describe 'Setting name with hash and block' do
+        it 'sets name on config' do
+          expect { factory.configure(email: email) { name 'John' } }
+            .to change(config, :name)
+            .from(nil).to('John')
+        end
+
+        it 'sets email on config' do
+          expect { factory.configure(email: email) { name 'John' } }
+            .to change(config, :email)
+            .from(nil).to(email)
+        end
       end
     end
   end

data/spec/lib/sinclair/configurable_spec.rb

@@ -165,24 +165,49 @@ describe Sinclair::Configurable do
   describe '.configure' do
     let(:config) { configurable.config }
 
-    it do
-      expect { configurable.configure { |c| c.user 'Bob' } }
-        .to change(config, :user)
-        .from(nil).to('Bob')
-    end
-
-    context 'when it was defined using string' do
+    context 'when configuring using a block' do
       it do
-        expect { configurable.configure { |c| c.password '123456' } }
-          .to change(config, :password)
-          .from(nil).to('123456')
+        expect { configurable.configure { |c| c.user 'Bob' } }
+          .to change(config, :user)
+          .from(nil).to('Bob')
+      end
+
+      context 'when it was defined using string' do
+        it do
+          expect { configurable.configure { |c| c.password '123456' } }
+            .to change(config, :password)
+            .from(nil).to('123456')
+        end
+      end
+
+      context 'when calling a method that was not defined' do
+        it do
+          expect { configurable.configure { |c| c.nope '123456' } }
+            .to raise_error(NoMethodError)
+        end
       end
     end
 
-    context 'when calling a method that was not defined' do
+    context 'when configuring using a hash' do
       it do
-        expect { configurable.configure { |c| c.nope '123456' } }
-          .to raise_error(NoMethodError)
+        expect { configurable.configure(user: 'Bob') }
+          .to change(config, :user)
+          .from(nil).to('Bob')
+      end
+
+      context 'when it was defined using string' do
+        it do
+          expect { configurable.configure(password: '123456') }
+            .to change(config, :password)
+            .from(nil).to('123456')
+        end
+      end
+
+      context 'when calling a method that was not defined' do
+        it do
+          expect { configurable.configure(nope: '123456') }
+            .to raise_error(NoMethodError)
+        end
       end
     end
 

data/spec/support/models/my_config.rb

@@ -3,5 +3,5 @@
 class MyConfig
   extend Sinclair::ConfigClass
 
-  attr_reader :name, :config
+  attr_reader :name, :email, :config
 end

data/spec/support/shared_examples/config_factory.rb

@@ -66,32 +66,71 @@ shared_examples 'a config factory adding config' do
 end
 
 shared_examples 'configure a config' do
-  it 'sets value on config' do
-    expect { factory.configure { |c| c.user 'Bob' } }
-      .to change(config, :user).to('Bob')
-  end
+  context 'when a block is given' do
+    it 'sets value on config' do
+      expect { factory.configure { |c| c.user 'Bob' } }
+        .to change(config, :user).to('Bob')
+    end
 
-  context 'when re-seting the value to nil' do
-    before { factory.configure { |c| c.user 'Bob' } }
+    context 'when re-seting the value to nil' do
+      before { factory.configure { |c| c.user 'Bob' } }
+
+      it 'sets nil value on config' do
+        expect { factory.configure { |c| c.user nil } }
+          .to change(config, :user).to(nil)
+      end
+    end
 
-    it 'sets nil value on config' do
-      expect { factory.configure { |c| c.user nil } }
-        .to change(config, :user).to(nil)
+    context 'when calling a method that was not defined' do
+      it do
+        expect { factory.configure { |c| c.nope '123456' } }
+          .to raise_error(NoMethodError)
+      end
+    end
+
+    context 'when it was defined using string' do
+      it do
+        expect { factory.configure { |c| c.password '123456' } }
+          .to change(config, :password)
+          .to('123456')
+      end
     end
   end
 
-  context 'when calling a method that was not defined' do
+  context 'when no block nor hash is given' do
     it do
-      expect { factory.configure { |c| c.nope '123456' } }
-        .to raise_error(NoMethodError)
+      expect { factory.configure }.not_to raise_error
     end
   end
 
-  context 'when it was defined using string' do
-    it do
-      expect { factory.configure { |c| c.password '123456' } }
-        .to change(config, :password)
-        .to('123456')
+  context 'when a hash is given' do
+    it 'sets value on config' do
+      expect { factory.configure(user: 'Bob') }
+        .to change(config, :user).to('Bob')
+    end
+
+    context 'when re-seting the value to nil' do
+      before { factory.configure(user: 'Bob') }
+
+      it 'sets nil value on config' do
+        expect { factory.configure(user: nil) }
+          .to change(config, :user).to(nil)
+      end
+    end
+
+    context 'when setting a variable that was not defined' do
+      it do
+        expect { factory.configure(nope: '123456') }
+          .to raise_error(NoMethodError)
+      end
+    end
+
+    context 'when it was defined using string' do
+      it do
+        expect { factory.configure(password: '123456') }
+          .to change(config, :password)
+          .to('123456')
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-30 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport