dry-configurable 0.8.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b54f274cf2ae374ac89bd1e3342da1ccf4c066ab220bdb8fd19c726be6f5d717
-  data.tar.gz: 6045cf60f22c40d231335ec10b84207fda52e888ca6eeba5d953267af782f148
+  metadata.gz: d220ee0a9d75b6b400a98b8165b32f9c3fe3fbfdc4661f36e8a99a6a36181cb7
+  data.tar.gz: 3c22814973a66b5ea08efaa14c6c8dc2130b7a8c20e48167e400aa51e66426e3
 SHA512:
-  metadata.gz: 02f95a505041d9b8d6ea199ce17aff5fd37e076577be2d5fd690a6350956f46c553a9d9972d447acdf6a97d370a44c6605c2c0c88f59ec821034977d9e33d6e1
-  data.tar.gz: af67f8149439b833d1898671ed187a5d1ca1e7d85aa6670723759016188092d8476b0a66574eedd70972c7f52f6534039a58854864c5e913f3d2f724696de9cc
+  metadata.gz: 44819f0abbc69555c660df2cf1e777bd0a6ca9bcccc9fbbd9c1198983e2739e47530527f7d07b737432a4429fe1243d28d62625992bb76f91e1437bab441eb42
+  data.tar.gz: 28001d7d843d4e70bbcc4a57332400b868fd385345b8a5977b82c713fc2b9f21f4a5e5746fee630e8f6d83990144943b7b7b1e604291a91096fd25971982c91e

data/CHANGELOG.md

@@ -1,12 +1,74 @@
-## 0.8.0 - 2019-02-05
+## unreleased 
 
-## Fixed
+Complete rewrite of the library while keeping the public API intact. See #78 for a detailed overview.
 
-* 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))
+### Changed
 
-## Added
+- Accessing config in a parent class no longer prevents you from adding more settings in a child class (@solnic)
+- (internal) New low-level Setting and Config API (@solnic)
+- (internal) `config` objects use method_missing now (@solnic)
+
+[Compare v0.10.0...master](https://github.com/dry-rb/dry-configurable/compare/v0.10.0...master)
+
+## 0.10.0 2020-01-31
+
+YANKED because the change also broke inheritance for classes that used `configured` before other classes inherited from them.
+
+### Changed
+
+- Inheriting settings no longer defines the config object. This change fixed a use case where parent class that already used its config would prevent a child class from adding new settings (@solnic)
+
+[Compare v0.9.0...v0.10.0](https://github.com/dry-rb/dry-configurable/compare/v0.9.0...v0.10.0)
+
+## 0.9.0 2019-11-06
+
+
+### Fixed
+
+- Support for reserved names in settings. Some Kernel methods (`public_send` and `class` specifically) are not available if you use access settings via method call. Same for methods of the `Config` class. You can still access them with `[]` and `[]=`. Ruby keywords are fully supported. Invalid names containing special symbols (including `!` and `?`) are rejected. Note that these changes don't affect the `reader` option, if you define a setting named `:class` and pass `reader: true` ... well ... (flash-gordon)
+- Settings can be redefined in subclasses without a warning about overriding exsting methods (flash-gordon)
+- Fix warnings about using keyword arguments in 2.7 (koic)
+
+
+[Compare v0.8.3...v0.9.0](https://github.com/dry-rb/dry-configurable/compare/v0.8.3...v0.9.0)
+
+## 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
+
+
+### Added
+
+- Support for instance-level configuration landed. For usage, `include` the module instead of extending ([flash-gordon](https://github.com/flash-gordon))
 
-* 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
@@ -22,7 +84,8 @@
   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))
+- 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
@@ -36,22 +99,25 @@
   end
   ```
 
-## Changed
+### 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))
+
+### Changed
 
-* [BREAKING] Minimal supported Ruby version is set to 2.3 ([flash-gordon](https://github.com/flash-gordon))
+- [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
+## 0.7.0 2017-04-25
 
-## Added
 
-* Introduce `Configurable.finalize!` which freezes config and its dependencies ([qcam](https://github.com/qcam))
+### Added
 
-## Fixed
+- Introduce `Configurable.finalize!` which freezes config and its dependencies ([qcam](https://github.com/qcam))
 
-* Allow for boolean false as default setting value ([yuszuv](https://github.com/yuszuv))
-* 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))
+### Fixed
 
-[Compare v0.6.2...v0.7.0](https://github.com/dry-rb/dry-configurable/compare/v0.6.2...v0.7.0)
+- Allow for boolean false as default setting value ([yuszuv](https://github.com/yuszuv))
+- 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))

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2017 dry-rb
+Copyright (c) 2015-2020 dry-rb team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -1,39 +1,28 @@
-[gitter]: https://gitter.im/dry-rb/chat
 [gem]: https://rubygems.org/gems/dry-configurable
-[travis]: https://travis-ci.org/dry-rb/dry-configurable
-[inch]: http://inch-ci.org/github/dry-rb/dry-configurable
+[actions]: https://github.com/dry-rb/dry-configurable/actions
+[codacy]: https://www.codacy.com/gh/dry-rb/dry-configurable
+[chat]: https://dry-rb.zulipchat.com
+[inchpages]: http://inch-ci.org/github/dry-rb/dry-configurable
 
-# 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]
-[![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]
+[![Gem Version](https://badge.fury.io/rb/dry-configurable.svg)][gem]
+[![CI Status](https://github.com/dry-rb/dry-configurable/workflows/ci/badge.svg)][actions]
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/0276a97990e04eb0ac722b3e7f3620b5)][codacy]
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/0276a97990e04eb0ac722b3e7f3620b5)][codacy]
+[![Inline docs](http://inch-ci.org/github/dry-rb/dry-configurable.svg?branch=master)][inchpages]
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'dry-configurable'
-```
-
-And then execute:
-
-```sh
-$ bundle
-```
+## Links
 
-Or install it yourself as:
+* [User documentation](http://dry-rb.org/gems/dry-configurable)
+* [API documentation](http://rubydoc.info/gems/dry-configurable)
 
-```sh
-$ gem install dry-configurable
-```
+## Supported Ruby versions
 
-## Links
+This library officially supports the following Ruby versions:
 
-* [Documentation](http://dry-rb.org/gems/dry-configurable)
+* MRI >= `2.4`
+* jruby >= `9.2`
 
 ## License
 

data/dry-configurable.gemspec

@@ -1,24 +1,38 @@
-require File.expand_path('../lib/dry/configurable/version', __FILE__)
+# frozen_string_literal: true
+# this file is managed by dry-rb/devtools project
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dry/configurable/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'dry-configurable'
-  spec.version       = Dry::Configurable::VERSION
-  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/dry-rb/dry-configurable'
+  spec.authors       = ["Andy Holland"]
+  spec.email         = ["andyholland1991@aol.com"]
   spec.license       = 'MIT'
+  spec.version       = Dry::Configurable::VERSION.dup
 
-  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.summary       = "A mixin to add configuration functionality to your classes"
+  spec.description   = spec.summary
+  spec.homepage      = 'https://dry-rb.org/gems/dry-configurable'
+  spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-configurable.gemspec", "lib/**/*"]
+  spec.bindir        = 'bin'
+  spec.executables   = []
   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.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-configurable/blob/master/CHANGELOG.md'
+  spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-configurable'
+  spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-configurable/issues'
+
+  spec.required_ruby_version = ">= 2.4.0"
+
+  # to update dependencies edit project.yml
+  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
+  spec.add_runtime_dependency "dry-core", "~> 0.4", ">= 0.4.7"
+  spec.add_runtime_dependency "dry-equalizer", "~> 0.2"
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/dry-configurable.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'dry/configurable'

data/lib/dry/configurable.rb

@@ -1,10 +1,13 @@
-require 'dry/core/constants'
-require 'dry/configurable/settings'
-require 'dry/configurable/error'
-require 'dry/configurable/version'
+# frozen_string_literal: true
+
+require 'concurrent/array'
+
+require 'dry/configurable/constants'
+require 'dry/configurable/class_methods'
+require 'dry/configurable/instance_methods'
+require 'dry/configurable/config'
+require 'dry/configurable/setting'
 
-# A collection of micro-libraries, each intended to encapsulate
-# a common task in Ruby
 module Dry
   # A simple configuration mixin
   #
@@ -40,135 +43,24 @@ module Dry
   #
   # @api public
   module Configurable
-    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 initialize(*)
-      @config = self.class._settings.create_config
+    # @api private
+    def self.extended(klass)
       super
+      klass.extend(ClassMethods)
     end
 
-    # Return configuration
-    #
-    # @return [Dry::Configurable::Config]
-    #
-    # @api public
-    def config
-      return @config if @config.defined?
-      @config.define!
-    end
-
-    # Return configuration
-    #
-    # @yield [Dry::Configuration::Config]
-    #
-    # @return [Dry::Configurable::Config]
-    #
-    # @api public
-    def configure
-      raise FrozenConfig, 'Cannot modify frozen config' if frozen?
-      yield(config)
-      self
-    end
+    # @api private
+    def self.included(klass)
+      super
+      klass.class_eval do
+        extend(ClassMethods)
+        include(InstanceMethods)
 
-    # Finalize and freeze configuration
-    #
-    # @return [Dry::Configurable::Config]
-    #
-    # @api public
-    def finalize!
-      freeze
-      config.finalize!
+        class << self
+          undef :config
+          undef :configure
+        end
+      end
     end
   end
 end

data/lib/dry/configurable/class_methods.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'set'
+
+require 'dry/configurable/constants'
+require 'dry/configurable/dsl'
+require 'dry/configurable/methods'
+require 'dry/configurable/settings'
+
+module Dry
+  module Configurable
+    module ClassMethods
+      include Methods
+
+      # @api private
+      def inherited(klass)
+        super
+
+        parent_settings = (respond_to?(:config) ? config.settings : _settings)
+
+        klass.instance_variable_set('@_settings', parent_settings)
+      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
+      #   a new configuration class, and bound as the default value
+      #
+      # @return [Dry::Configurable::Config]
+      #
+      # @api public
+      def setting(*args, &block)
+        setting = __config_dsl__.setting(*args, &block)
+
+        _settings << setting
+
+        __config_reader__.define(setting.name) if setting.reader?
+
+        self
+      end
+
+      # Return declared settings
+      #
+      # @return [Set<Symbol>]
+      #
+      # @api public
+      def settings
+        @settings ||= Set[*_settings.map(&:name)]
+      end
+
+      # Return declared settings
+      #
+      # @return [Settings]
+      #
+      # @api public
+      def _settings
+        @_settings ||= Settings.new
+      end
+
+      # Return configuration
+      #
+      # @return [Config]
+      #
+      # @api public
+      def config
+        @config ||= Config.new(_settings)
+      end
+
+      # @api private
+      def __config_dsl__
+        @dsl ||= DSL.new
+      end
+
+      # @api private
+      def __config_reader__
+        @__config_reader__ ||=
+          begin
+            reader = Module.new do
+              def self.define(name)
+                define_method(name) do
+                  config[name]
+                end
+              end
+            end
+
+            if included_modules.include?(InstanceMethods)
+              include(reader)
+            end
+
+            extend(reader)
+
+            reader
+          end
+      end
+    end
+  end
+end