dry-configurable 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eeb18b428640615a653b1e669bcbedf1130f83ef
-  data.tar.gz: 294ec402fe8dbfb378c6a5e1d5d442c49ac7baf1
+SHA256:
+  metadata.gz: b54f274cf2ae374ac89bd1e3342da1ccf4c066ab220bdb8fd19c726be6f5d717
+  data.tar.gz: 6045cf60f22c40d231335ec10b84207fda52e888ca6eeba5d953267af782f148
 SHA512:
-  metadata.gz: f3c268381efd9f202447a9785873ea151e5ce4edc004c87006a0c5b91165b3b29827d99799cf2f75a386214c5906b09d9b12983aec05502ad88591f1fa702896
-  data.tar.gz: fd8c289e25a8fa28ec55e1f69ec5f569e2b6dbf0506ca7df49a80c6277c99510bc0505dc7c063fd97144f2723105bba62448472bc2db73c941dce1bca8db9cbf
+  metadata.gz: 02f95a505041d9b8d6ea199ce17aff5fd37e076577be2d5fd690a6350956f46c553a9d9972d447acdf6a97d370a44c6605c2c0c88f59ec821034977d9e33d6e1
+  data.tar.gz: af67f8149439b833d1898671ed187a5d1ca1e7d85aa6670723759016188092d8476b0a66574eedd70972c7f52f6534039a58854864c5e913f3d2f724696de9cc

data/.gitignore

@@ -2,7 +2,6 @@
 coverage
 /.bundle
 vendor/bundle
-bin/
 tmp/
 .idea/
 Gemfile.lock

data/.travis.yml

@@ -8,22 +8,15 @@ script:
 after_success:
   - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3.1
-  - rbx-3
-  - jruby-9.1.5.0
-  - ruby-head
-  - jruby-head
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
+  - jruby-9.2.5.0
 env:
   global:
     - JRUBY_OPTS='--dev -J-Xmx1024M'
     - COVERAGE='true'
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
 notifications:
   email: false
   webhooks:

data/CHANGELOG.md

@@ -1,4 +1,48 @@
-## Unreleased
+## 0.8.0 - 2019-02-05
+
+## Fixed
+
+* A number of bugs related to inheriting settings from parent class were fixed. Ideally, new behavior will be :100: predictable but if you observe any anomaly, please report ([flash-gordon](https://github.com/flash-gordon))
+
+## Added
+
+* Support for instance-level configuration landed. For usage, `include` the module instead of extending ([flash-gordon](https://github.com/flash-gordon))
+  ```ruby
+  class App
+    include Dry::Configurable
+
+    setting :database
+  end
+
+  production = App.new
+  production.config.database = ENV['DATABASE_URL']
+  production.finalize!
+
+  development = App.new
+  development.config.database = 'jdbc:sqlite:memory'
+  development.finalize!
+  ```
+* Config values can be set from a hash with `.update`. Nested settings are supported ([flash-gordon](https://github.com/flash-gordon))
+  ```ruby
+  class App
+    extend Dry::Configurable
+
+    setting :db do
+      setting :host
+      setting :port
+    end
+
+    config.update(YAML.load(File.read("config.yml")))
+  end
+  ```
+
+## Changed
+
+* [BREAKING] Minimal supported Ruby version is set to 2.3 ([flash-gordon](https://github.com/flash-gordon))
+
+[Compare v0.7.0...v0.8.0](https://github.com/dry-rb/dry-configurable/compare/v0.7.0...v0.8.0)
+
+## 0.7.0 - 2017-04-25
 
 ## Added
 
@@ -10,4 +54,4 @@
 * Convert nested configs to nested hashes with `Config#to_h` ([saverio-kantox](https://github.com/saverio-kantox))
 * Disallow modification on frozen config ([qcam](https://github.com/qcam))
 
-[Compare v0.6.2...HEAD](https://github.com/dry-rb/dry-configurable/compare/v0.6.2...HEAD)
+[Compare v0.6.2...v0.7.0](https://github.com/dry-rb/dry-configurable/compare/v0.6.2...v0.7.0)

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Issue Guidelines
+
+## Reporting bugs
+
+If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
+
+## Reporting feature requests
+
+Report a feature request **only after discussing it first on [discuss.dry-rb.org](https://discuss.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
+
+## Reporting questions, support requests, ideas, concerns etc.
+
+**PLEASE DON'T** - use [discuss.dry-rb.org](http://discuss.dry-rb.org) instead.
+
+# Pull Request Guidelines
+
+A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
+
+Other requirements:
+
+1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
+2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
+3) Add API documentation if it's a new feature
+4) Update API documentation if it changes an existing feature
+5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
+
+# Asking for help
+
+If these guidelines aren't helpful, and you're stuck, please post a message on [discuss.dry-rb.org](https://discuss.dry-rb.org).

data/Gemfile

@@ -13,4 +13,5 @@ group :tools do
   gem 'guard'
   gem 'guard-rspec'
   gem 'listen', '3.0.6'
+  gem 'pry-byebug', platform: :mri
 end

data/README.md

@@ -1,47 +1,34 @@
 [gitter]: https://gitter.im/dry-rb/chat
 [gem]: https://rubygems.org/gems/dry-configurable
 [travis]: https://travis-ci.org/dry-rb/dry-configurable
-[code_climate]: https://codeclimate.com/github/dry-rb/dry-configurable
 [inch]: http://inch-ci.org/github/dry-rb/dry-configurable
 
 # dry-configurable [![Join the Gitter chat](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![Gem Version](https://img.shields.io/gem/v/dry-configurable.svg)][gem]
 [![Build Status](https://img.shields.io/travis/dry-rb/dry-configurable.svg)][travis]
-[![Code Climate](https://img.shields.io/codeclimate/github/dry-rb/dry-configurable.svg)][code_climate]
-[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/dry-rb/dry-configurable.svg)][code_climate]
+[![Maintainability](https://api.codeclimate.com/v1/badges/25311e81391498d6b7c8/maintainability)](https://codeclimate.com/github/dry-rb/dry-configurable/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/25311e81391498d6b7c8/test_coverage)](https://codeclimate.com/github/dry-rb/dry-configurable/test_coverage)
 [![API Documentation Coverage](http://inch-ci.org/github/dry-rb/dry-configurable.svg)][inch]
 
-## Synopsis
+## Installation
+
+Add this line to your application's Gemfile:
 
 ```ruby
-class App
-  extend Dry::Configurable
-
-  # Pass a block for nested configuration (works to any depth)
-  setting :database do
-    # Can pass a default value
-    setting :dsn, 'sqlite:memory'
-  end
-  # Defaults to nil if no default value is given
-  setting :adapter
-  # Passing the reader option as true will create reader method for the class
-  setting :pool, 5, reader: true
-  # Passing the reader attributes works with nested configuration
-  setting :uploader, reader: true do
-    setting :bucket, 'dev'
-  end
-end
-
-App.configure do |config|
-  config.database.dsn = 'jdbc:sqlite:memory'
-end
-
-App.config.database.dsn
-# => 'jdbc:sqlite:memory'
-App.config.adapter # => nil
-App.pool # => 5
-App.uploader.bucket # => 'dev'
+gem 'dry-configurable'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install dry-configurable
 ```
 
 ## Links

data/dry-configurable.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 require File.expand_path('../lib/dry/configurable/version', __FILE__)
 
 Gem::Specification.new do |spec|
@@ -7,15 +6,17 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Andy Holland']
   spec.email         = ['andyholland1991@aol.com']
   spec.summary       = 'A mixin to add configuration functionality to your classes'
-  spec.homepage      = 'https://github.com/dryrb/dry-configurable'
+  spec.homepage      = 'https://github.com/dry-rb/dry-configurable'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|bin)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = ">= 2.3.0"
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
+  spec.add_runtime_dependency 'dry-core', '~> 0.4', '>= 0.4.7'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/lib/dry/configurable/config.rb

@@ -1,61 +1,87 @@
+require 'concurrent/hash'
+
 module Dry
   module Configurable
     # @private
     class Config
-      DEFAULT_PROCESSOR = ->(v) { v }.freeze
+      class << self
+        # @private
+        def [](settings)
+          ::Class.new(Config) do
+            @settings = settings
+            singleton_class.send(:attr_reader, :settings)
+
+            @lock = ::Mutex.new
+            @config_defined = false
+          end
+        end
 
-      def self.create(settings)
-        klass = ::Class.new(self)
+        # @private
+        def define_accessors!
+          @lock.synchronize do
+            break if config_defined?
 
-        settings.each do |setting|
-          klass.__send__(:define_method, setting.name) do
-            @config[setting.name]
-          end
+            settings.each do |setting|
+              define_method(setting.name) do
+                @config[setting.name]
+              end
 
-          klass.__send__(:define_method, "#{setting.name}=") do |value|
-            raise_frozen_config if frozen?
-            @config[setting.name] = setting.processor.call(value)
+              define_method("#{setting.name}=") do |value|
+                raise FrozenConfig, 'Cannot modify frozen config' if frozen?
+                @config[setting.name] = setting.processor.(value)
+              end
+            end
+
+            @config_defined = true
           end
         end
 
-        klass.new(settings)
+        # @private
+        def config_defined?
+          @config_defined
+        end
       end
 
-      def initialize(settings)
+      def initialize
         @config = ::Concurrent::Hash.new
-
-        settings.each do |setting|
-          if setting.none?
-            @config[setting.name] = nil
-          else
-            public_send("#{setting.name}=", setting.value)
-          end
-        end
+        @lock = ::Mutex.new
+        @defined = false
       end
 
-      def dup
-        dup = super
-        dup.instance_variable_set(:@config, @config.dup)
-        dup
+      def defined?
+        @defined
       end
 
-      def clone
-        clone = super
-        clone.instance_variable_set(:@config, @config.clone)
-        clone
+      # @private
+      def define!(parent_config = EMPTY_HASH)
+        @lock.synchronize do
+          break if self.defined?
+
+          self.class.define_accessors!
+          set_values!(parent_config)
+
+          @defined = true
+        end
+
+        self
       end
 
+      # @private
       def finalize!
+        define!
         @config.freeze
         freeze
       end
 
+      # Serialize config to a Hash
+      #
+      # @return [Hash]
+      #
+      # @api public
       def to_h
-        @config.each_with_object({}) do |tuple, hash|
-          key, value = tuple
-
+        @config.each_with_object({}) do |(key, value), hash|
           case value
-          when ::Dry::Configurable::Config, ::Dry::Configurable::NestedConfig
+          when Config
             hash[key] = value.to_h
           else
             hash[key] = value
@@ -64,29 +90,72 @@ module Dry
       end
       alias to_hash to_h
 
+      # Get config value by a key
+      #
+      # @param [String,Symbol] name
+      #
+      # @return Config value
       def [](name)
-        raise_unknown_setting_error(name) unless setting?(name)
+        raise_unknown_setting_error(name) unless key?(name.to_sym)
         public_send(name)
       end
 
+      # Set config value.
+      # Note that finalized configs cannot be changed.
+      #
+      # @param [String,Symbol] name
+      # @param [Object] value
       def []=(name, value)
-        raise_unknown_setting_error(name) unless setting?(name)
+        raise_unknown_setting_error(name) unless key?(name.to_sym)
         public_send("#{name}=", value)
       end
 
+      # Whether config has a key
+      #
+      # @param [Symbol] key
+      # @return [Bool]
+      def key?(name)
+        self.class.settings.name?(name)
+      end
+
+      # Recursively update values from a hash
+      #
+      # @param [Hash] values to set
+      # @return [Config]
+      def update(values)
+        values.each do |key, value|
+          if self[key].is_a?(Config)
+            self[key].update(value)
+          else
+            self[key] = value
+          end
+        end
+        self
+      end
+
       private
 
-      def raise_frozen_config
-        raise FrozenConfig, 'Cannot modify frozen config'
+      # @private
+      def set_values!(parent)
+        self.class.settings.each do |setting|
+          if parent.key?(setting.name) && !setting.node?
+            @config[setting.name] = parent[setting.name]
+          elsif setting.undefined?
+            @config[setting.name] = nil
+          elsif setting.node?
+            value = setting.value.create_config
+            value.define!(parent.fetch(setting.name, EMPTY_HASH))
+            self[setting.name] = value
+          else
+            self[setting.name] = setting.value
+          end
+        end
       end
 
+      # @private
       def raise_unknown_setting_error(name)
         raise ArgumentError, "+#{name}+ is not a setting name"
       end
-
-      def setting?(name)
-        @config.key?(name.to_sym)
-      end
     end
   end
 end

data/lib/dry/configurable/error.rb

@@ -1,5 +1,3 @@
-# A collection of micro-libraries, each intended to encapsulate
-# a common task in Ruby
 module Dry
   module Configurable
     Error = Class.new(::StandardError)

data/lib/dry/configurable/setting.rb

@@ -0,0 +1,37 @@
+module Dry
+  module Configurable
+    # This class represents a setting and is used internally.
+    #
+    # @private
+    class Setting
+      attr_reader :name
+
+      attr_reader :options
+
+      attr_reader :processor
+
+      def initialize(name, value, processor, options = EMPTY_HASH)
+        @name = name.to_sym
+        @value = value
+        @processor = processor
+        @options = options
+      end
+
+      def value
+        Undefined.default(@value, nil)
+      end
+
+      def undefined?
+        Undefined.equal?(@value)
+      end
+
+      def reader?
+        options[:reader]
+      end
+
+      def node?
+        Settings === @value
+      end
+    end
+  end
+end

data/lib/dry/configurable/settings/argument_parser.rb

@@ -0,0 +1,50 @@
+module Dry
+  # Argument parser
+  #
+  # Passing and array or arguments, it will decide which one are arguments
+  # and which one are options.
+  #
+  # We have a limitation if setting the value without options, as a hash
+  # having the same key as one of the valid options, will parse the value
+  # as options. In this case, all unknown options will be reject with an exception.
+  #
+  # @example
+  #   p = Dry::Configurable::ArgumentParser.new.('db:sqlite', reader: true)
+  #
+  #   p[0] # => 'db:sqlite'
+  #   p[1] # => ArgumentParser::DEFAULT_PROCESSOR
+  #   p[2] # => { reader: true }
+  module Configurable
+    class Settings
+      # @private
+      class ArgumentParser
+        DEFAULT_PROCESSOR = ->(v) { v }
+
+        # @private
+        def call(val, opts, block)
+          if block && block.parameters.empty?
+            raise ArgumentError unless Undefined.equal?(opts)
+
+            processor = DEFAULT_PROCESSOR
+
+            value, options = Settings.capture(&block), val
+          else
+            processor = block || DEFAULT_PROCESSOR
+
+            if Undefined.equal?(opts) && val.is_a?(Hash) && val.key?(:reader)
+              value, options = Undefined, val
+            else
+              value, options = val, opts
+            end
+          end
+
+          [value, processor, options(Undefined.default(options, EMPTY_HASH))]
+        end
+
+        def options(reader: false)
+          { reader: reader }
+        end
+      end
+    end
+  end
+end

data/lib/dry/configurable/settings.rb

@@ -0,0 +1,92 @@
+require 'set'
+require 'concurrent/array'
+require 'dry/configurable/settings/argument_parser'
+require 'dry/configurable/setting'
+require 'dry/configurable/config'
+
+module Dry
+  module Configurable
+    # A collection of settings. This is not part of the public API.
+    #
+    # @private
+    class Settings
+      Parser = ArgumentParser.new.freeze
+
+      class DSL
+        def self.call(&block)
+          new.instance_exec do
+            instance_exec(&block)
+            @settings
+          end
+        end
+
+        def initialize
+          @settings = Settings.new
+        end
+
+        def setting(*args, &block)
+          @settings.add(*args, &block)
+        end
+      end
+
+      # Capture nested config definition
+      #
+      # @return [Dry::Configurable::Setting]
+      def self.capture(&block)
+        DSL.(&block)
+      end
+
+      attr_reader :settings
+
+      attr_reader :config_class
+
+      attr_reader :names
+
+      def initialize(settings = ::Concurrent::Array.new)
+        @settings = settings
+        @config_class = Config[self]
+        @names = Set.new(settings.map(&:name))
+        yield(self) if block_given?
+      end
+
+      def add(key, value = Undefined, options = Undefined, &block)
+        extended = singleton_class < Configurable
+        raise_already_defined_config(key) if extended && configured?
+
+        Setting.new(key, *Parser.(value, options, block)).tap do |s|
+          settings << s
+          names << s.name
+        end
+      end
+
+      def each
+        settings.each { |s| yield(s) }
+      end
+
+      def empty?
+        settings.empty?
+      end
+
+      def name?(name)
+        names.include?(name)
+      end
+
+      def dup
+        Settings.new(settings.dup)
+      end
+
+      def freeze
+        settings.freeze
+        super
+      end
+
+      def create_config
+        config_class.new
+      end
+
+      def config_defined?
+        config_class.config_defined?
+      end
+    end
+  end
+end

data/lib/dry/configurable/test_interface.rb

@@ -8,7 +8,11 @@ module Dry
       #
       # @api public
       def reset_config
-        create_config
+        if self.is_a?(Class)
+          @config = _settings.create_config
+        else
+          @config = self.class._settings.create_config
+        end
       end
     end
 

data/lib/dry/configurable/version.rb

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