sinclair 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c574eec3a6df9fca413808866c33a03da39ac3aea5a55ad588ea0532fdcb8058
-  data.tar.gz: ccdf5e26711abfeb0c9a2eee9f59cabc8a4ae912b624b976720b228b7be7adbd
+  metadata.gz: 5a99344876ea7ff46dc785f5d9a9daddedce4fa84fb1d33c1387f333ef2611f8
+  data.tar.gz: 2687f7ebd7816a13275d9aede938dff46731edde1dba1b2e0a272f9e0967af18
 SHA512:
-  metadata.gz: 807968f16b1be5c991e7377aa888fc70548c8058945e7f137a6cfa53ef4a6359c5be19305a5184f8d2b1d7ed8343d815a8595b9deef8b1f266c7e5fbca4bc94f
-  data.tar.gz: 2dc1e2cbf9e95829d488e49ee6835775d99cc9743313b0b58ea50fc2ac739a471ecd98da35c9193dc631bcbfdfabe6cb665fa190a97afacf4b4d4ecfec9dde95
+  metadata.gz: 8b6278abe2c8f3b0ec4f20cc9856508cf7f5726643229d532c075e5a142cca02141f5e3e8b8d99bea25859dd2a4b072b2fb457aa0b682f4a25949f132c2715e4
+  data.tar.gz: d0e6cae7c4e3d1f87c99f737066292cdee42ee6b14c00ce7b1a6cb1eb20f05dd73a776e5cd75c3ac2d6ffb7ab1a91a67f57d5d0d00385238aa57ab84dbc6d7bb

data/README.md

@@ -14,7 +14,7 @@ methods
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/sinclair/1.3.1
+https://www.rubydoc.info/gems/sinclair/1.3.2
 
 Installation
 ---------------
@@ -314,7 +314,8 @@ the `configurable#configure` method
   class MyConfigurable
     extend Sinclair::Configurable
 
-    configurable_with :host, :port
+    # port is defaulted to 80
+    configurable_with :host, port: 80
   end
 
   MyConfigurable.configure do |config|
@@ -328,7 +329,7 @@ the `configurable#configure` method
   MyConfigurable.reset_config
 
   MyConfigurable.config.host # returns nil
-  MyConfigurable.config.port # returns nil
+  MyConfigurable.config.port # returns 80
 ```
 
 RSspec matcher

data/config/yardstick.yml

@@ -18,6 +18,9 @@ rules:
     exclude:
       - Sinclair::OptionsParser#options
       - Sinclair::OptionsParser#options_object
+      - Sinclair::Configurable#config
+      - Sinclair::Configurable#reset_config
+      - Sinclair::Configurable#configure
   ReturnTag:
     enabled: true
     exclude:
@@ -34,6 +37,11 @@ rules:
       - Sinclair::ConfigFactory#initialize
       - Sinclair::ConfigFactory#config_class
       - Sinclair::ConfigFactory#config_attributes
+      - Sinclair::ConfigFactory::MethodsBuilder#names
+      - Sinclair::ConfigFactory::MethodsBuilder#defaults
+      - Sinclair::Configurable#config
+      - Sinclair::Configurable#reset_config
+      - Sinclair::Configurable#configure
   Summary::Presence:
     enabled: true
     exclude:
@@ -52,6 +60,9 @@ rules:
       - Sinclair::ConfigFactory#initialize
       - Sinclair::ConfigFactory#config_class
       - Sinclair::ConfigFactory#config_attributes
+      - Sinclair::ConfigFactory::MethodsBuilder#initialize
+      - Sinclair::ConfigFactory::MethodsBuilder#names
+      - Sinclair::ConfigFactory::MethodsBuilder#defaults
   Summary::Length:
     enabled: true
     exclude: []

data/lib/sinclair/config_factory.rb

@@ -16,6 +16,8 @@ class Sinclair
   #   factory.config.equal?(config) # returns true
   #   config.name                   # returns 'John'
   class ConfigFactory
+    autoload :MethodsBuilder, 'sinclair/config_factory/methods_builder'
+
     # @param config_class [Class] configuration class to be used
     # @param config_attributes [Array<Symbol,String>] list of possible configurations
     def initialize(config_class: Class.new(Config), config_attributes: [])
@@ -77,9 +79,12 @@ class Sinclair
     #
     #   config.respond_to? :active
     #   # returns true
-    def add_configs(*attributes)
-      config_class.attr_reader(*attributes)
-      config_attributes.concat(attributes.map(&:to_sym))
+    def add_configs(*args)
+      builder = MethodsBuilder.new(config_class, *args)
+
+      builder.build
+
+      config_attributes.concat(builder.config_names.map(&:to_sym))
     end
 
     # Set the values in the config

data/lib/sinclair/config_factory/methods_builder.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class ConfigFactory
+    # @api private
+    #
+    # Class responsible for adding method to configuration
+    # classes
+    class MethodsBuilder < Sinclair
+      # @param klass [Class] class inheriting from {Sinclair::Config}
+      #  that will receive the methods
+      # @overload initialize(klass, *names, default)
+      #   @param names [Array<Symbol,String>] List of configuration names
+      #   to be added
+      #   @param default [Hash] Configurations that will receive a default
+      #   value when not configured
+      def initialize(klass, *names)
+        super(klass)
+
+        @names = names
+        @defaults = names.find { |arg| arg.is_a?(Hash) } || {}
+        names.delete(defaults)
+      end
+
+      # Build the methods in config class
+      #
+      # Methods will be attribute readers that, when an attribute
+      # (instance variable) has never been defined, a default value
+      # is returned
+      #
+      # Setting an instance variable to nil will not return default
+      # value.
+      #
+      # If default value is required, {Sinclair::Configurable#reset_config}
+      # should be called
+      #
+      # @return (see Sinclair#build)
+      #
+      # @see Sinclair#build
+      def build
+        config_hash.each do |method, value|
+          add_method(method, cached: :full) { value }
+        end
+
+        super
+      end
+
+      # Returns the name of all configs defined by {MethodsBuilder}
+      #
+      # @return [Array<String,Symbol>]
+      def config_names
+        config_hash.keys
+      end
+
+      private
+
+      attr_reader :names, :defaults
+
+      # @private
+      #
+      # Builds the final config hash
+      #
+      # Config hash merges defauls config hashs
+      # with {#name_as_hash}
+      #
+      # @return [Hash]
+      def config_hash
+        @config_hash ||= names_as_hash.merge!(defaults)
+      end
+
+      # @private
+      #
+      # Builds a hash with nil values from config names
+      #
+      # @return [Hash]
+      def names_as_hash
+        Hash[names.map { |*name| name }]
+      end
+    end
+  end
+end

data/lib/sinclair/configurable.rb

@@ -17,7 +17,8 @@ class Sinclair
   #   class MyConfigurable
   #     extend Sinclair::Configurable
   #
-  #     configurable_with :host, :port
+  #     # port is defaulted to 80
+  #     configurable_with :host, port: 80
   #   end
   #
   #   MyConfigurable.configure do
@@ -31,12 +32,31 @@ class Sinclair
   #   MyConfigurable.config.port
   #   # returns 5555
   #
-  #   MyConfigurable.reset
+  #   MyConfigurable.reset_config
   #
   #   MyConfigurable.config.host
   #   # returns nil
+  #
+  #   MyConfigurable.config.port
+  #   # returns 80
   module Configurable
-    delegate :config, :reset_config, :configure, to: :config_factory
+    # (see ConfigFactory#config)
+    # @see ConfigFactory#config
+    def config
+      config_factory.config
+    end
+
+    # (see ConfigFactory#reset_config)
+    # @see ConfigFactory#reset_config
+    def reset_config
+      config_factory.reset_config
+    end
+
+    # (see ConfigFactory#configure)
+    # @see ConfigFactory#configure
+    def configure(&block)
+      config_factory.configure(&block)
+    end
 
     protected
 
@@ -64,7 +84,7 @@ class Sinclair
 
     private
 
-    # @visibility public
+    # @!visibility public
     #
     # Adds a configuration option to config class
     #

data/lib/sinclair/version.rb

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

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

@@ -36,8 +36,7 @@ describe Sinclair::Configurable do
       end
 
       it 'resets configuration port' do
-        expect(MyConfigurable.config.port)
-          .to be_nil
+        expect(MyConfigurable.config.port).to eq(80)
       end
     end
   end

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

@@ -27,8 +27,11 @@ describe Sinclair::Configurable do
       before { MyConfigurable.reset_config }
 
       it 'returns initial value for host' do
-        expect(MyConfigurable.config.host)
-          .to be_nil
+        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

data/spec/lib/sinclair/config_factory/methods_builder_spec.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::ConfigFactory::MethodsBuilder do
+  describe '#build' do
+    let(:config_class) { Class.new(Sinclair::Config) }
+    let(:config)       { config_class.new }
+    let(:code_block)   { proc { builder.build } }
+
+    let(:setter_block) do
+      proc do |value|
+        config.instance_variable_set(:@name, value)
+      end
+    end
+
+    context 'when not initializing defaults' do
+      subject(:builder) { described_class.new(config_class, :name, 'password') }
+
+      it_behaves_like 'a config methods builder adding config'
+
+      it 'does not set a default value' do
+        code_block.call
+
+        expect(config.name).to be_nil
+      end
+    end
+
+    context 'when initializing defaults' do
+      subject(:builder) do
+        described_class.new(
+          config_class, name: 'Bobby', 'password' => 'abcdef'
+        )
+      end
+
+      it_behaves_like 'a config methods builder adding config'
+
+      it 'sets a default value' do
+        code_block.call
+
+        expect(config.name).to eq('Bobby')
+      end
+    end
+
+    context 'when mixing names and hash' do
+      subject(:builder) do
+        described_class.new(
+          config_class, :name, 'password' => 'abcdef'
+        )
+      end
+
+      it_behaves_like 'a config methods builder adding config'
+
+      it 'does not set a default value' do
+        code_block.call
+
+        expect(config.name).to be_nil
+      end
+
+      context 'when name and hash define same config' do
+        subject(:builder) do
+          described_class.new(
+            config_class, :name, name: 'Bobby'
+          )
+        end
+
+        it_behaves_like 'a config methods builder adding config'
+
+        it 'sets a default value' do
+          code_block.call
+
+          expect(config.name).to eq('Bobby')
+        end
+      end
+    end
+  end
+end

data/spec/lib/sinclair/config_factory_spec.rb

@@ -81,46 +81,23 @@ describe Sinclair::ConfigFactory do
   end
 
   describe '#add_configs' do
-    it 'adds reader to config' do
-      expect { factory.add_configs(:name) }
-        .to add_method(:name).to(factory.config)
-    end
-
-    it 'does not add setter to config' do
-      expect { factory.add_configs(:name) }
-        .not_to add_method(:name=).to(factory.config)
-    end
-
-    it 'does not change Sinclair::Config class' do
-      expect { factory.add_configs(:name) }
-        .not_to add_method(:name).to(Sinclair::Config.new)
-    end
+    let(:config) { factory.config }
 
-    it 'allows config_builder to handle method missing' do
-      factory.add_configs(:name)
-      expect { factory.configure { name 'John' } }.not_to raise_error
+    let(:code_block) do
+      proc { factory.instance_eval(&method_call) }
     end
 
-    it 'changes subclasses of config' do
-      expect { factory.add_configs(:name) }
-        .to add_method(:name).to(factory.child.config)
+    let(:setter_block) do
+      proc { |value| factory.configure { name value } }
     end
 
-    it 'does not mess with parent config_builder' do
-      factory.child.add_configs(:name)
-      expect { factory.configure { name 'John' } }
-        .to raise_error(NoMethodError)
-    end
+    it_behaves_like 'a config factory adding config' do
+      let(:method_call) { proc { add_configs(:name) } }
 
-    context 'when initializing with custom config class' do
-      it do
-        expect { factory.add_configs(:name) }
-          .to add_method(:name).to(factory.config)
-      end
+      it 'does not set a default value' do
+        code_block.call
 
-      it 'does not change other config classes' do
-        expect { factory.add_configs(:name) }
-          .not_to add_method(:name).to(other_factory.config)
+        expect(factory.config.name).to be_nil
       end
     end
 
@@ -130,30 +107,33 @@ describe Sinclair::ConfigFactory do
       factory.reset_config
       expect(factory.config).to be_a(Sinclair::Config)
     end
+
+    context 'when passing a hash' do
+      it_behaves_like 'a config factory adding config' do
+        let(:method_call) { proc { add_configs(name: 'Bobby') } }
+
+        it 'sets a default value' do
+          code_block.call
+
+          expect(factory.config.name).to eq('Bobby')
+        end
+      end
+    end
   end
 
   describe '#configure' do
-    before { factory.add_configs(:user, 'password') }
+    context 'when factory was not initialized with defaults' do
+      before { factory.add_configs(:user, 'password') }
 
-    it do
-      expect { factory.configure { |c| c.user 'Bob' } }
-        .to change(config, :user)
-        .from(nil).to('Bob')
+      it_behaves_like 'configure a config'
     end
 
-    context 'when it was defined using string' do
-      it do
-        expect { factory.configure { |c| c.password '123456' } }
-          .to change(config, :password)
-          .from(nil).to('123456')
+    context 'when factory initialized with defaults' do
+      before do
+        factory.add_configs(user: 'Jack', 'password' => 'abcdef')
       end
-    end
 
-    context 'when calling a method that was not defined' do
-      it do
-        expect { factory.configure { |c| c.nope '123456' } }
-          .to raise_error(NoMethodError)
-      end
+      it_behaves_like 'configure a config'
     end
   end
 

data/spec/support/models/my_configurable.rb

@@ -3,5 +3,6 @@
 class MyConfigurable
   extend Sinclair::Configurable
 
-  configurable_with :host, :port
+  # port is defaulted to 80
+  configurable_with :host, port: 80
 end

data/spec/support/shared_examples/config_factory.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+shared_examples 'a config methods builder adding config' do
+  it 'adds reader to config' do
+    expect(&code_block).to add_method(:name).to(config)
+  end
+
+  it 'does not add setter to config' do
+    expect(&code_block)
+      .not_to add_method(:name=).to(config)
+  end
+
+  it 'does not change Sinclair::Config class' do
+    expect(&code_block)
+      .not_to add_method(:name).to(Sinclair::Config)
+  end
+
+  it 'allows config_builder to handle method missing' do
+    code_block.call
+
+    expect { setter_block.call('John') }
+      .not_to raise_error
+  end
+
+  it 'adds reader for configuration' do
+    code_block.call
+    setter_block.call('John')
+
+    expect(config.name).to eq('John')
+  end
+
+  it 'adds reader for configuration accepting nil values' do
+    code_block.call
+    setter_block.call('John')
+    setter_block.call(nil)
+
+    expect(config.name).to be_nil
+  end
+end
+
+shared_examples 'a config factory adding config' do
+  it_behaves_like 'a config methods builder adding config'
+
+  it 'changes subclasses of config' do
+    expect(&code_block)
+      .to add_method(:name).to(factory.child.config)
+  end
+
+  it 'does not mess with parent config_builder' do
+    factory.child.instance_eval(&method_call)
+    expect { factory.configure { name 'John' } }
+      .to raise_error(NoMethodError)
+  end
+
+  context 'when initializing with custom config class' do
+    it do
+      expect(&code_block)
+        .to add_method(:name).to(factory.config)
+    end
+
+    it 'does not change other config classes' do
+      expect(&code_block)
+        .not_to add_method(:name).to(other_factory.config)
+    end
+  end
+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 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
+
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-17 00:00:00.000000000 Z
+date: 2019-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -189,6 +189,7 @@ files:
 - lib/sinclair/config.rb
 - lib/sinclair/config_builder.rb
 - lib/sinclair/config_factory.rb
+- lib/sinclair/config_factory/methods_builder.rb
 - lib/sinclair/configurable.rb
 - lib/sinclair/matchers.rb
 - lib/sinclair/matchers/add_method.rb
@@ -220,6 +221,7 @@ files:
 - spec/integration/yard/sinclair/options_parser_spec.rb
 - spec/integration/yard/sinclair_spec.rb
 - spec/lib/sinclair/config_builder_spec.rb
+- spec/lib/sinclair/config_factory/methods_builder_spec.rb
 - spec/lib/sinclair/config_factory_spec.rb
 - spec/lib/sinclair/configurable_spec.rb
 - spec/lib/sinclair/matchers/add_method_spec.rb
@@ -252,6 +254,7 @@ files:
 - spec/support/models/purchase.rb
 - spec/support/models/server.rb
 - spec/support/models/validator_builder.rb
+- spec/support/shared_examples/config_factory.rb
 - spec/support/shared_examples/method_definition.rb
 homepage: https://github.com/darthjee/sinclair
 licenses: []