dry-configurable 0.7.0 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eeb18b428640615a653b1e669bcbedf1130f83ef
-  data.tar.gz: 294ec402fe8dbfb378c6a5e1d5d442c49ac7baf1
+SHA256:
+  metadata.gz: e2952b22a9581b91b77a416925a150088ea715be486638e293beae10d5b493a8
+  data.tar.gz: 6cf8073234d53e391e25d03eb0b3548694ebbaa30742169895b8f1d519f258d7
 SHA512:
-  metadata.gz: f3c268381efd9f202447a9785873ea151e5ce4edc004c87006a0c5b91165b3b29827d99799cf2f75a386214c5906b09d9b12983aec05502ad88591f1fa702896
-  data.tar.gz: fd8c289e25a8fa28ec55e1f69ec5f569e2b6dbf0506ca7df49a80c6277c99510bc0505dc7c063fd97144f2723105bba62448472bc2db73c941dce1bca8db9cbf
+  metadata.gz: 441ba5b074dd577bd0e0d37b5a99e76dc1ab85068885832e791eba4cd7a61e5691683f96c93e930a29d59e838b294d82248074433c670466ad31f773e1994dab
+  data.tar.gz: 02f13c05320aca5bb6900dd831966c3edc760fd66b9bfe40f94d079da0f3af30ecbdd07cdd024807d305296caf55f1b1613c285cdec86db97fb57659c42c11a0

data/.gitignore

@@ -2,8 +2,8 @@
 coverage
 /.bundle
 vendor/bundle
-bin/
 tmp/
 .idea/
 Gemfile.lock
 spec/examples.txt
+pkg/

data/.travis.yml

@@ -3,27 +3,21 @@ dist: trusty
 sudo: required
 cache: bundler
 bundler_args: --without console
-script:
-  - bundle exec rake spec
 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.4.6
+  - 2.5.5
+  - 2.6.3
+  - jruby-9.2.7.0
+  - truffleruby
+matrix:
+  allow_failures:
+    - rvm: truffleruby
 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,72 @@
-## Unreleased
+## 0.8.3 - 2019-05-29
+
+## Fixed
+
+* `Configurable#dup` and `Configurable#clone` make a copy of instance-level config so that it doesn't get mutated/shared across instances (flash-gordon)
+
+[Compare v0.8.2...v0.8.3](https://github.com/dry-rb/dry-configurable/compare/v0.8.2...v0.8.3)
+
+## 0.8.2 - 2019-02-25
+
+## Fixed
+
+* Test interface support for modules ([Neznauy](https://github.com/Neznauy))
+
+[Compare v0.8.1...v0.8.2](https://github.com/dry-rb/dry-configurable/compare/v0.8.1...v0.8.2)
+
+## 0.8.1 - 2019-02-06
+
+## Fixed
+
+* `.configure` doesn't require a block, this makes the behavior consistent with the previous versions ([flash-gordon](https://github.com/flash-gordon))
+
+[Compare v0.8.0...v0.8.1](https://github.com/dry-rb/dry-configurable/compare/v0.8.0...v0.8.1)
+
+## 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 +78,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,35 @@
 [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
+[chat]: https://dry-rb.zulipchat.com
 
-# dry-configurable [![Join the Gitter chat](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+# dry-configurable [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![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,22 @@ 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.metadata = {
+    'source_code_uri' => 'https://github.com/dry-rb/dry-configurable',
+    'changelog_uri' => 'https://github.com/dry-rb/dry-configurable/blob/master/CHANGELOG.md'
+  }
+
+  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.rb

@@ -1,9 +1,6 @@
-require 'concurrent'
-require 'dry/configurable/config'
+require 'dry/core/constants'
+require 'dry/configurable/settings'
 require 'dry/configurable/error'
-require 'dry/configurable/nested_config'
-require 'dry/configurable/argument_parser'
-require 'dry/configurable/config/value'
 require 'dry/configurable/version'
 
 # A collection of micro-libraries, each intended to encapsulate
@@ -11,7 +8,7 @@ require 'dry/configurable/version'
 module Dry
   # A simple configuration mixin
   #
-  # @example
+  # @example class-level configuration
   #
   #   class App
   #     extend Dry::Configurable
@@ -21,30 +18,123 @@ module Dry
   #     end
   #   end
   #
-  #   App.configure do |config|
-  #     config.database.dsn = 'jdbc:sqlite:memory'
+  #   App.config.database.dsn = 'jdbc:sqlite:memory'
+  #   App.config.database.dsn
+  #     # => "jdbc:sqlite:memory"
+  #
+  # @example instance-level configuration
+  #
+  #   class App
+  #     include Dry::Configurable
+  #
+  #     setting :database
   #   end
   #
-  #   App.config.database.dsn
-  #     # => "jdbc:sqlite:memory'"
+  #   production = App.new
+  #   production.config.database = ENV['DATABASE_URL']
+  #   production.finalize!
+  #
+  #   development = App.new
+  #   development.config.database = 'jdbc:sqlite:memory'
+  #   development.finalize!
   #
   # @api public
   module Configurable
-    # @private
-    def self.extended(base)
-      base.class_eval do
-        @_config_mutex = ::Mutex.new
-        @_settings = ::Concurrent::Array.new
-        @_reader_attributes = ::Concurrent::Array.new
+    include Dry::Core::Constants
+
+    module ClassMethods
+      # @private
+      def self.extended(base)
+        base.instance_exec do
+          @settings = Settings.new
+        end
+      end
+
+      # Add a setting to the configuration
+      #
+      # @param [Mixed] key
+      #   The accessor key for the configuration value
+      # @param [Mixed] default
+      #   The default config value
+      #
+      # @yield
+      #   If a block is given, it will be evaluated in the context of
+      #   and new configuration class, and bound as the default value
+      #
+      # @return [Dry::Configurable::Config]
+      #
+      # @api public
+      def setting(key, value = Undefined, options = Undefined, &block)
+        extended = singleton_class < Configurable
+        raise_already_defined_config(key) if _settings.config_defined?
+
+        setting = _settings.add(key, value, options, &block)
+
+        if setting.reader?
+          readers = extended ? singleton_class : self
+          readers.send(:define_method, setting.name) { config[setting.name] }
+        end
+      end
+
+      # Return an array of setting names
+      #
+      # @return [Set]
+      #
+      # @api public
+      def settings
+        _settings.names
+      end
+
+      # @private no, really...
+      def _settings
+        @settings
+      end
+
+      private
+
+      # @private
+      def raise_already_defined_config(key)
+        raise AlreadyDefinedConfig,
+              "Cannot add setting +#{key}+, #{self} is already configured"
+      end
+
+      # @private
+      def inherited(subclass)
+        parent = self
+        subclass.instance_exec do
+          @settings = parent._settings.dup
+        end
+
+        if singleton_class < Configurable
+          parent_config = @config
+          subclass.instance_exec do
+            @config = _settings.create_config
+            @config.define!(parent_config.to_h) if parent_config.defined?
+          end
+        end
+
+        super
+      end
+    end
+
+    class << self
+      # @private
+      def extended(base)
+        base.extend(ClassMethods)
+        base.class_eval do
+          @config = _settings.create_config
+        end
+      end
+
+      # @private
+      def included(base)
+        base.extend(ClassMethods)
       end
     end
 
     # @private
-    def inherited(subclass)
-      subclass.instance_variable_set(:@_config_mutex, ::Mutex.new)
-      subclass.instance_variable_set(:@_settings, @_settings.clone)
-      subclass.instance_variable_set(:@_reader_attributes, @_reader_attributes.clone)
-      subclass.instance_variable_set(:@_config, @_config.clone) if defined?(@_config)
+    def initialize(*)
+      @config = self.class._settings.create_config
       super
     end
 
@@ -54,8 +144,8 @@ module Dry
     #
     # @api public
     def config
-      return @_config if defined?(@_config)
-      create_config
+      return @config if @config.defined?
+      @config.define!
     end
 
     # Return configuration
@@ -66,8 +156,9 @@ module Dry
     #
     # @api public
     def configure
-      raise_frozen_config if frozen?
+      raise FrozenConfig, 'Cannot modify frozen config' if frozen?
       yield(config) if block_given?
+      self
     end
 
     # Finalize and freeze configuration
@@ -80,106 +171,22 @@ module Dry
       config.finalize!
     end
 
-    # Add a setting to the configuration
-    #
-    # @param [Mixed] key
-    #   The accessor key for the configuration value
-    # @param [Mixed] default
-    #   The default config value
-    #
-    # @yield
-    #   If a block is given, it will be evaluated in the context of
-    #   and new configuration class, and bound as the default value
-    #
-    # @return [Dry::Configurable::Config]
-    #
     # @api public
-    def setting(key, *args, &block)
-      raise_already_defined_config(key) if defined?(@_config)
-      value, options = ArgumentParser.call(args)
-      if block
-        if block.parameters.empty?
-          value = _config_for(&block)
-        else
-          processor = block
-        end
+    def dup
+      super.tap do |copy|
+        copy.instance_variable_set(:@config, config.dup)
       end
-
-      _settings << ::Dry::Configurable::Config::Value.new(
-        key,
-        !value.nil? ? value : ::Dry::Configurable::Config::Value::NONE,
-        processor || ::Dry::Configurable::Config::DEFAULT_PROCESSOR
-      )
-      store_reader_options(key, options) if options.any?
     end
 
-    # Return an array of setting names
-    #
-    # @return [Array]
-    #
     # @api public
-    def settings
-      _settings.map(&:name)
-    end
-
-    # @private no, really...
-    def _settings
-      @_settings
-    end
-
-    def _reader_attributes
-      @_reader_attributes
-    end
-
-    private
-
-    # @private
-    def _config_for(&block)
-      ::Dry::Configurable::NestedConfig.new(&block)
-    end
-
-    # @private
-    def create_config
-      @_config_mutex.synchronize do
-        create_config_for_nested_configurations
-        @_config = ::Dry::Configurable::Config.create(_settings) unless _settings.empty?
+    def clone
+      if frozen?
+        super
+      else
+        super.tap do |copy|
+          copy.instance_variable_set(:@config, config.dup)
+        end
       end
     end
-
-    # @private
-    def create_config_for_nested_configurations
-      nested_configs.map(&:create_config)
-    end
-
-    # @private
-    def nested_configs
-      _settings.select { |setting| setting.value.is_a?(::Dry::Configurable::NestedConfig) }.map(&:value)
-    end
-
-    # @private
-    def raise_already_defined_config(key)
-      raise AlreadyDefinedConfig,
-            "Cannot add setting +#{key}+, #{self} is already configured"
-    end
-
-    # @private
-    def raise_frozen_config
-      raise FrozenConfig, 'Cannot modify frozen config'
-    end
-
-    # @private
-    def store_reader_options(key, options)
-      _reader_attributes << key if options.fetch(:reader, false)
-    end
-
-    # @private
-    def method_missing(method, *args, &block)
-      _reader_attributes.include?(method) ? config.public_send(method, *args, &block) : super
-    end
-
-    # @private
-    def respond_to_missing?(method, _include_private = false)
-      _reader_attributes.include?(method) || super
-    end
   end
 end