dry-configurable 0.1.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58a630055aefd53b2ec5d0261f353e9779dcab8f
-  data.tar.gz: 42b5d3dddc4d819a6e80adcd3d9b341fed1cbea0
+  metadata.gz: 8dd64a779f30057a298a82a7f73d6ce3c36909ce
+  data.tar.gz: 0d32b52327b7ceaaff31b8911b52d1f9457e19c4
 SHA512:
-  metadata.gz: d13cd68936ab7a5f96ed705011b1bd5cfb8112091a825fa2fb38e3afe4fdfd72be2f2646504dd00c543bc95ef310e1bb67b1a3d129c683a0d73b63ab3d31a0f0
-  data.tar.gz: 5ac518f3fc7f260431a9b5122045c6a53b32929529c2384618ef870fc2da399e9ffa4cc66d20239258a7422c14501b16431fcbe0aac26e9bba940bd0bf63d77f
+  metadata.gz: f775f2e95646928bedbfb2ae1e1a57a342473b18e055a76ccfcf7c039e171a5cf8ded036ca96f69f7ea75f922794f6868076f202fc266b0b1c285dc820c7b330
+  data.tar.gz: 0f53eb85546a0a7d1ac4707b7dd68fad429e106a7589c1b272a539c2784fe04d656d9efcac19e940bfc2193d8e2d9962f1329ec113a99c25e29e3152865a110a

data/.travis.yml

@@ -9,7 +9,7 @@ rvm:
   - 2.1
   - 2.2
   - rbx-2
-  - jruby
+  - jruby-9.0.5.0
   - ruby-head
   - jruby-head
 env:
@@ -17,6 +17,7 @@ env:
     - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
+    - rvm: rbx-2
     - rvm: ruby-head
     - rvm: jruby-head
 notifications:

data/Gemfile

@@ -7,9 +7,7 @@ group :test do
 end
 
 group :tools do
-  gem 'rubocop'
   gem 'guard'
   gem 'guard-rspec'
-  gem 'guard-rubocop'
   gem 'listen', '3.0.6'
 end

data/lib/dry/configurable.rb

@@ -1,5 +1,6 @@
 require 'concurrent'
 require 'dry/configurable/config'
+require 'dry/configurable/config/value'
 require 'dry/configurable/version'
 
 # A collection of micro-libraries, each intended to encapsulate
@@ -29,14 +30,14 @@ module Dry
     # @private
     def self.extended(base)
       base.class_eval do
-        @_config_mutex = Mutex.new
-        @_settings = Concurrent::Map.new
+        @_config_mutex = ::Mutex.new
+        @_settings = ::Concurrent::Array.new
       end
     end
 
     # @private
     def inherited(subclass)
-      subclass.instance_variable_set(:@_config_mutex, Mutex.new)
+      subclass.instance_variable_set(:@_config_mutex, ::Mutex.new)
       subclass.instance_variable_set(:@_settings, @_settings.clone)
       subclass.instance_variable_set(:@_config, @_config.clone) if defined?(@_config)
       super
@@ -50,7 +51,7 @@ module Dry
     def config
       return @_config if defined?(@_config)
       @_config_mutex.synchronize do
-        @_config ||= Config.new(*_settings.keys).new(*_settings.values) unless _settings.empty?
+        @_config ||= ::Dry::Configurable::Config.create(_settings) unless _settings.empty?
       end
     end
 
@@ -79,9 +80,29 @@ module Dry
     # @return [Dry::Configurable::Config]
     #
     # @api public
-    def setting(key, default = nil, &block)
-      default = _config_for(&block) if block_given?
-      _settings[key] = default
+    def setting(key, value = ::Dry::Configurable::Config::Value::NONE, &block)
+      if block
+        if block.parameters.empty?
+          value = _config_for(&block)
+        else
+          processor = block
+        end
+      end
+
+      _settings << ::Dry::Configurable::Config::Value.new(
+        key,
+        value,
+        processor || ::Dry::Configurable::Config::DEFAULT_PROCESSOR
+      )
+    end
+
+    # Return an array of setting names
+    #
+    # @return [Array]
+    #
+    # @api public
+    def settings
+      _settings.map(&:name)
     end
 
     # @private no, really...
@@ -93,7 +114,7 @@ module Dry
 
     # @private
     def _config_for(&block)
-      config_klass = Class.new { extend Dry::Configurable }
+      config_klass = ::Class.new { extend ::Dry::Configurable }
       config_klass.instance_eval(&block)
       config_klass.config
     end

data/lib/dry/configurable/config.rb

@@ -1,7 +1,61 @@
 module Dry
   module Configurable
     # @private
-    class Config < ::Struct
+    class Config
+      DEFAULT_PROCESSOR = ->(v) { v }.freeze
+
+      def self.create(settings)
+        klass = ::Class.new(self)
+
+        settings.each do |setting|
+          klass.__send__(:define_method, setting.name) do
+            @config[setting.name]
+          end
+
+          klass.__send__(:define_method, "#{setting.name}=") do |value|
+            @config[setting.name] = setting.processor.call(value)
+          end
+        end
+
+        klass.new(settings)
+      end
+
+      def initialize(settings)
+        @config = ::Concurrent::Hash.new
+
+        settings.each do |setting|
+          if setting.none?
+            @config[setting.name] = nil
+          else
+            public_send("#{setting.name}=", setting.value)
+          end
+        end
+      end
+
+      def dup
+        dup = super
+        dup.instance_variable_set(:@config, @config.dup)
+        dup
+      end
+
+      def clone
+        clone = super
+        clone.instance_variable_set(:@config, @config.clone)
+        clone
+      end
+
+      def to_h
+        @config.each_with_object({}) do |tuple, hash|
+          key, value = tuple
+
+          if value.kind_of?(::Dry::Configurable::Config)
+            hash[key] = value.to_h
+          else
+            hash[key] = value 
+          end
+        end
+      end
+      alias to_hash to_h
     end
   end
 end

data/lib/dry/configurable/config/value.rb

@@ -0,0 +1,25 @@
+module Dry
+  module Configurable
+    class Config
+      # @private
+      class Value
+        # @private
+        NONE = ::Object.new.freeze
+
+        attr_reader :name, :processor
+
+        def initialize(name, value, processor)
+          @name, @value, @processor = name, value, processor
+        end
+
+        def value
+          none? ? nil : @value
+        end
+
+        def none?
+          @value.equal?(::Dry::Configurable::Config::Value::NONE)
+        end
+      end
+    end
+  end
+end

data/lib/dry/configurable/version.rb

@@ -1,6 +1,6 @@
 module Dry
   module Configurable
     # @api public
-    VERSION = '0.1.7'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/spec/support/shared_examples/configurable.rb

@@ -1,105 +1,243 @@
 RSpec.shared_examples 'a configurable class' do
   describe Dry::Configurable do
     describe 'settings' do
-      context 'without default value' do
-        before do
-          klass.setting :dsn
-        end
+      context 'without processor option' do
+        context 'without default value' do
+          before do
+            klass.setting :dsn
+          end
 
-        it 'returns nil' do
-          expect(klass.config.dsn).to be(nil)
+          it 'returns nil' do
+            expect(klass.config.dsn).to be(nil)
+          end
         end
-      end
 
-      context 'with default value' do
-        before do
-          klass.setting :dsn, 'sqlite:memory'
+        context 'with default value' do
+          context 'with a nil default value' do
+            before do
+              klass.setting :dsn, nil
+            end
+
+            it 'returns the default value' do
+              expect(klass.config.dsn).to be(nil)
+            end
+          end
+
+          context 'with a string default value' do
+            before do
+              klass.setting :dsn, 'sqlite:memory'
+            end
+
+            it 'returns the default value' do
+              expect(klass.config.dsn).to eq('sqlite:memory')
+            end
+          end
+
+          context 'with a hash default value' do
+            before do
+              klass.setting :db_config, {
+                user: 'root',
+                password: ''
+              }
+            end
+
+            it 'returns the default value' do
+              expect(klass.config.db_config).to eq(
+                user: 'root',
+                password: ''
+              )
+            end
+          end
         end
 
-        it 'returns the default value' do
-          expect(klass.config.dsn).to eq('sqlite:memory')
+        context 'nested configuration' do
+          before do
+            klass.setting :database do
+              setting :dsn, 'sqlite:memory'
+            end
+          end
+
+          it 'returns the default value' do
+            expect(klass.config.database.dsn).to eq('sqlite:memory')
+          end
         end
       end
 
-      context 'nested configuration' do
-        before do
-          klass.setting :database do
-            setting :dsn, 'sqlite:memory'
+      context 'with processor' do
+        context 'without default value' do
+          before do
+            klass.setting(:dsn) { |dsn| "sqlite:#{dsn}" }
+          end
+
+          it 'returns nil' do
+            expect(klass.config.dsn).to be(nil)
           end
         end
 
-        it 'returns the default value' do
-          expect(klass.config.database.dsn).to eq('sqlite:memory')
+        context 'with default value' do
+          before do
+            klass.setting(:dsn, 'memory') { |dsn| "sqlite:#{dsn}" }
+          end
+
+          it 'returns the default value' do
+            expect(klass.config.dsn).to eq('sqlite:memory')
+          end
+        end
+
+        context 'nested configuration' do
+          before do
+            klass.setting :database do
+              setting(:dsn, 'memory') { |dsn| "sqlite:#{dsn}" }
+            end
+          end
+
+          it 'returns the default value' do
+            expect(klass.config.database.dsn).to eq('sqlite:memory')
+          end
         end
       end
     end
 
     describe 'configuration' do
       context 'without nesting' do
-        before do
-          klass.setting :dsn, 'sqlite:memory'
-        end
+        context 'without processor' do
+          before do
+            klass.setting :dsn, 'sqlite:memory'
+          end
+
+          before do
+            klass.configure do |config|
+              config.dsn = 'jdbc:sqlite:memory'
+            end
+          end
 
-        before do
-          klass.configure do |config|
-            config.dsn = 'jdbc:sqlite:memory'
+          it 'updates the config value' do
+            expect(klass.config.dsn).to eq('jdbc:sqlite:memory')
           end
         end
 
-        it 'updates the config value' do
-          expect(klass.config.dsn).to eq('jdbc:sqlite:memory')
+        context 'with processor' do
+          before do
+            klass.setting(:dsn, 'sqlite') { |dsn| "#{dsn}:memory"}
+          end
+
+          before do
+            klass.configure do |config|
+              config.dsn = 'jdbc:sqlite'
+            end
+          end
+
+          it 'updates the config value' do
+            expect(klass.config.dsn).to eq('jdbc:sqlite:memory')
+          end
         end
       end
 
       context 'with nesting' do
-        before do
-          klass.setting :database do
-            setting :dsn, 'sqlite:memory'
+        context 'without processor' do
+          before do
+            klass.setting :database do
+              setting :dsn, 'sqlite:memory'
+            end
+
+            klass.configure do |config|
+              config.database.dsn = 'jdbc:sqlite:memory'
+            end
           end
 
-          klass.configure do |config|
-            config.database.dsn = 'jdbc:sqlite:memory'
+          it 'updates the config value' do
+            expect(klass.config.database.dsn).to eq('jdbc:sqlite:memory')
           end
         end
 
-        it 'updates the config value' do
-          expect(klass.config.database.dsn).to eq('jdbc:sqlite:memory')
+        context 'with processor' do
+          before do
+            klass.setting :database do
+              setting(:dsn, 'sqlite') { |dsn| "#{dsn}:memory"}
+            end
+
+            klass.configure do |config|
+              config.database.dsn = 'jdbc:sqlite'
+            end
+          end
+
+          it 'updates the config value' do
+            expect(klass.config.database.dsn).to eq('jdbc:sqlite:memory')
+          end
         end
       end
 
       context 'when inherited' do
-        before do
-          klass.setting :dsn
-          klass.configure do |config|
-            config.dsn = 'jdbc:sqlite:memory'
+        context 'without processor' do
+          before do
+            klass.setting :dsn
+            klass.configure do |config|
+              config.dsn = 'jdbc:sqlite:memory'
+            end
           end
-        end
 
-        subject!(:subclass) { Class.new(klass) }
+          subject!(:subclass) { Class.new(klass) }
+
+          it 'retains its configuration' do
+            expect(subclass.config.dsn).to eq('jdbc:sqlite:memory')
+          end
 
-        it 'retains its configuration' do
-          expect(subclass.config.dsn).to eq('jdbc:sqlite:memory')
+          context 'when the inherited config is modified' do
+            before do
+              subclass.configure do |config|
+                config.dsn = 'jdbc:sqlite:file'
+              end
+            end
+
+            it 'does not modify the original' do
+              expect(klass.config.dsn).to eq('jdbc:sqlite:memory')
+              expect(subclass.config.dsn).to eq('jdbc:sqlite:file')
+            end
+          end
         end
 
-        context 'when the inherited config is modified' do
+        context 'with processor' do
           before do
-            subclass.configure do |config|
-              config.dsn = 'jdbc:sqlite:file'
+            klass.setting(:dsn) { |dsn| "#{dsn}:memory" }
+            klass.configure do |config|
+              config.dsn = 'jdbc:sqlite'
             end
           end
 
-          it 'does not modify the original' do
-            expect(klass.config.dsn).to eq('jdbc:sqlite:memory')
+          subject!(:subclass) { Class.new(klass) }
+
+          it 'retains its configuration' do
+            expect(subclass.config.dsn).to eq('jdbc:sqlite:memory')
+          end
+
+          context 'when the inherited config is modified' do
+            before do
+              subclass.configure do |config|
+                config.dsn = 'sqlite'
+              end
+            end
+
+            it 'does not modify the original' do
+              expect(klass.config.dsn).to eq('jdbc:sqlite:memory')
+              expect(subclass.config.dsn).to eq('sqlite:memory')
+            end
           end
         end
 
         context 'when the inherited settings are modified' do
           before do
+            klass.setting :dsn
+            klass.configure do |config|
+              config.dsn = 'jdbc:sqlite:memory'
+            end
+
             subclass.setting :db
           end
 
+          subject!(:subclass) { Class.new(klass) }
+
           it 'does not modify the original' do
-            expect(klass._settings.keys).to_not include(:db)
+            expect(klass.settings).to_not include(:db)
           end
         end
       end

data/spec/unit/dry/configurable/config/value_spec.rb

@@ -0,0 +1,47 @@
+RSpec.describe Dry::Configurable::Config::Value do
+  let(:klass) { Dry::Configurable::Config::Value }
+  let(:config) { klass.new(name, value, processor) }
+  let(:name) { :db }
+  let(:value) { 'test' }
+  let(:processor) { ->(v) { v }}
+
+  describe '#name' do
+    subject! { config.name }
+
+    it { is_expected.to eq(name) }
+  end
+
+  describe '#value' do
+    subject! { config.value }
+
+    context 'when value is not NONE' do
+      it { is_expected.to eq(value) }
+    end
+
+    context 'when value is NONE' do
+      let(:value) { klass::NONE }
+
+      it { is_expected.to be(nil) }
+    end
+  end
+
+  describe '#processor' do
+    subject! { config.processor }
+
+    it { is_expected.to eq(processor) }
+  end
+
+  describe '#none?' do
+    subject! { config.none? }
+
+    context 'when value is not NONE' do
+      it { is_expected.to be(false) }
+    end
+
+    context 'when value is NONE' do
+      let(:value) { klass::NONE }
+
+      it { is_expected.to be(true) }
+    end
+  end
+end

data/spec/unit/dry/configurable/config_spec.rb

@@ -0,0 +1,131 @@
+RSpec.describe Dry::Configurable::Config do
+  let(:klass) { Dry::Configurable::Config }
+  let(:config) { klass.create(settings) }
+  let(:settings) do
+    [
+      value_class.new(:db, 'sqlite', ->(v) { "#{v}:memory" }),
+      value_class.new(:user, 'root', ->(v) { v }),
+      value_class.new(:pass, none, ->(v) { v })
+    ]
+  end
+  let(:value_class) { Dry::Configurable::Config::Value }
+  let(:none) { value_class::NONE }
+
+  describe '.create' do
+    it 'creates a config subclass from the given settings' do
+      expect(config.class).to be < klass
+
+      expect(config.db).to eq('sqlite:memory')
+      expect(config.user).to eq('root')
+      expect(config.pass).to be(nil)
+
+      expect { config.db = 'ineedm0ar' }.to change(config, :db)
+        .from('sqlite:memory')
+        .to('ineedm0ar:memory')
+      expect { config.user = 'whoami' }.to change(config, :user)
+        .from('root')
+        .to('whoami')
+      expect { config.pass = 'h4xz0rz' }.to change(config, :pass)
+        .from(nil)
+        .to('h4xz0rz')
+    end
+  end
+
+  describe '#clone' do
+    subject!(:clone) { config.clone }
+
+    it 'clones and returns the config' do
+      expect(clone.db).to eq(config.db)
+      expect(clone.user).to eq(config.user)
+      expect(clone.pass).to eq(config.pass)
+      is_expected.to_not be(config)
+    end
+  end
+
+  describe '#dup' do
+    subject!(:dup) { config.dup }
+
+    it 'dups and returns the config' do
+      expect(dup.db).to eq(config.db)
+      expect(dup.user).to eq(config.user)
+      expect(dup.pass).to eq(config.pass)
+      is_expected.to_not be(config)
+    end
+  end
+
+  describe '#to_h' do
+    subject! { config.to_h }
+
+    context 'without nesting' do
+      it 'returns a config hash' do
+        is_expected.to eq(
+          db: 'sqlite:memory',
+          user: 'root',
+          pass: nil
+        )
+      end
+    end
+
+    context 'with nesting' do
+      let(:nested_setting) do
+        klass.create([value_class.new(:bar, 'baz', ->(v) { v })])
+      end
+      let(:settings) do
+        [
+          value_class.new(:db, 'sqlite', ->(v) { "#{v}:memory" }),
+          value_class.new(:user, 'root', ->(v) { v }),
+          value_class.new(:pass, none, ->(v) { v }),
+          value_class.new(:foo, nested_setting, ->(v) { v })
+        ]
+      end
+      it 'returns a config hash' do
+        is_expected.to eq(
+          db: 'sqlite:memory',
+          user: 'root',
+          pass: nil,
+          foo: {
+            bar: 'baz'
+          }
+        )
+      end
+    end
+  end
+
+  describe '#to_hash' do
+    subject! { config.to_hash }
+
+    context 'without nesting' do
+      it 'returns a config hash' do
+        is_expected.to eq(
+          db: 'sqlite:memory',
+          user: 'root',
+          pass: nil
+        )
+      end
+    end
+
+    context 'with nesting' do
+      let(:nested_setting) do
+        klass.create([value_class.new(:bar, 'baz', ->(v) { v })])
+      end
+      let(:settings) do
+        [
+          value_class.new(:db, 'sqlite', ->(v) { "#{v}:memory" }),
+          value_class.new(:user, 'root', ->(v) { v }),
+          value_class.new(:pass, none, ->(v) { v }),
+          value_class.new(:foo, nested_setting, ->(v) { v })
+        ]
+      end
+      it 'returns a config hash' do
+        is_expected.to eq(
+          db: 'sqlite:memory',
+          user: 'root',
+          pass: nil,
+          foo: {
+            bar: 'baz'
+          }
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-configurable
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -76,8 +76,6 @@ files:
 - .codeclimate.yml
 - .gitignore
 - .rspec
-- .rubocop.yml
-- .rubocop_todo.yml
 - .ruby-version
 - .travis.yml
 - Gemfile
@@ -88,11 +86,14 @@ files:
 - lib/dry-configurable.rb
 - lib/dry/configurable.rb
 - lib/dry/configurable/config.rb
+- lib/dry/configurable/config/value.rb
 - lib/dry/configurable/version.rb
 - rakelib/rubocop.rake
 - spec/integration/configurable_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples/configurable.rb
+- spec/unit/dry/configurable/config/value_spec.rb
+- spec/unit/dry/configurable/config_spec.rb
 homepage: https://github.com/dryrb/dry-configurable
 licenses:
 - MIT
@@ -121,3 +122,5 @@ test_files:
 - spec/integration/configurable_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples/configurable.rb
+- spec/unit/dry/configurable/config/value_spec.rb
+- spec/unit/dry/configurable/config_spec.rb

data/.rubocop.yml

@@ -1,16 +0,0 @@
-# Generated by `rubocop --auto-gen-config`
-inherit_from: .rubocop_todo.yml
-
-Metrics/LineLength:
-  Max: 120
-
-Style/Documentation:
-  Enabled: false
-
-Lint/HandleExceptions:
-  Exclude:
-    - rakelib/*.rake
-
-Style/FileName:
-  Exclude:
-    - lib/dry-configurable.rb

data/.rubocop_todo.yml

@@ -1,6 +0,0 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-06-10 18:54:14 +0100 using RuboCop version 0.26.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.