dry-configurable 0.11.6 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d76fbe81b58bc0a6d0e5abb5f135e32e6eb7f47533af60864a09e0143b3ea66c
-  data.tar.gz: 33f74bd69c1f030477088d32e80024969983e8dd793c58c89264828edc207a90
+  metadata.gz: a9dc2db3ddad9ce63a4129b8792a0d0fc26695169015c33721d49a153a3972bc
+  data.tar.gz: 67b7b36444ac64bd06bd0800e5ac74aaced969aa74b31bd686f8e7ecbc4b6b85
 SHA512:
-  metadata.gz: aef6696e55e9ec56e46fabc857db9f1c2c8e266efad943844faf574d2d7d224829ca14457f66c8082f016d4cbdcb7f6bc9a1f33f641c743621c3b998d2f604d4
-  data.tar.gz: 11ab00f69b7c172d23d6de19a2f0a208bbd83ecd91b865cb591d18df0f91fd4578d487fb2acd71a88e4b89477a17e602816999847cad4fc0671139aa68e11d00
+  metadata.gz: 32317f78da754f348e1b4cda2817d81d48ca0cc32fb2b8cedff62d499589063d8c7b3f54917114f37412007593ca44c6d33d99c87ab44d5fa3dcbd13684c3bb1
+  data.tar.gz: 373c4b8e6d9fcd015acae6b5aebaa82a307a57a1a541480a7c2887f6bba2c24c80992c9f1352e9a97caea3f21e857ebb23a94a0c43f8598332425f942e49794f

data/CHANGELOG.md

@@ -1,4 +1,189 @@
-## unreleased 
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## 1.0.1 2022-11-16
+
+
+### Changed
+
+- Renamed `@config` and `@_settings` internal instance variables to `@__config__` and `@__settings__` in order to avoid clashes with user-defined instance variables (#159 by @timriley)
+
+[Compare v1.0.0...v1.0.1](https://github.com/dry-rb/dry-configurable/compare/v1.0.0...v1.0.1)
+
+## 1.0.0 2022-11-04
+
+
+### Changed
+
+- Dependency on `dry-core` was updated to ~> 1.0 (@solnic)
+
+[Compare v0.16.1...v1.0.0](https://github.com/dry-rb/dry-configurable/compare/v0.16.1...v1.0.0)
+
+## 0.16.1 2022-10-13
+
+
+### Changed
+
+- Restored performance of config value reads (direct reader methods as well as aggregate methods like `#values` and `#to_h`) to pre-0.16.0 levels (#149 by @timriley)
+
+[Compare v0.16.0...v0.16.1](https://github.com/dry-rb/dry-configurable/compare/v0.16.0...v0.16.1)
+
+## 0.16.0 2022-10-08
+
+
+### Added
+
+- Support for custom config classes via `config_class:` option (#136 by @solnic)
+
+  ```ruby
+  extend Dry::Configurable(config_class: MyConfig)
+  ```
+
+  Your config class should inherit from `Dry::Configurable::Config`.
+- Return `Dry::Core::Constants::Undefined` (instead of nil) as the value for non-configured settings via a `default_undefined: true` option (#141 by @timriley)
+
+  ```ruby
+  extend Dry::Configurable(default_undefined: true)
+  ```
+
+  You must opt into this feature via the `default_undefined: true` option. Non-configured setting values are still `nil` by default.
+
+### Fixed
+
+- Remove exec bit from version.rb (#139 by @Fryguy)
+
+### Changed
+
+- Improve memory usage by separating setting definitions from config values (#138 by @timriley)
+
+  Your usage of dry-configurable may be impacted if you have been accessing objects from `_settings` or the internals of `Dry::Configurable::Config`. `_settings` now returns `Dry::Configurable::Setting` instances, which contain only the details from the setting's definition. Setting _values_ remain in `Dry::Configurable::Config`.
+- Use Zeitwerk to speed up load time (#135 by @solnic)
+
+[Compare v0.15.0...v0.16.0](https://github.com/dry-rb/dry-configurable/compare/v0.15.0...v0.16.0)
+
+## 0.15.0 2022-04-21
+
+
+### Changed
+
+- The `finalize!` method (as class or instance method, depending on whether you extend or include `Dry::Configurable` respectively) now accepts a boolean `freeze_values:` argument, which if true, will recursively freeze all config values in addition to the `config` itself. (#105 by @ojab)
+
+  ```ruby
+  class MyConfigurable
+    include Dry::Configurable
+
+    setting :db, default: "postgre"
+  end
+
+  my_obj = MyConfigurable.new
+  my_obj.finalize!(freeze_values: true)
+  my_obj.config.db << "sql" # Will raise FrozenError
+  ```
+- `Dry::Configurable::Config#update` will set hashes as values for non-nested settings (#131 by @ojab)
+
+  ```ruby
+  class MyConfigurable
+    extend Dry::Configurable
+
+    setting :sslcert, constructor: ->(v) { v&.values_at(:pem, :pass)&.join }
+  end
+
+  MyConfigurable.config.update(sslcert: {pem: "cert", pass: "qwerty"})
+  MyConfigurable.config.sslcert # => "certqwerty"
+  ```
+- `Dry::Configurable::Config#update` will accept any values implicitly convertible to hash via `#to_hash` (#133 by @timriley)
+
+[Compare v0.14.0...v0.15.0](https://github.com/dry-rb/dry-configurable/compare/v0.14.0...v0.15.0)
+
+## 0.14.0 2022-01-14
+
+
+### Changed
+
+- Settings defined after an access to `config` will still be made available on that `config`. (#130 by @timriley)
+- Cloneable settings are cloned immediately upon assignment. (#130 by @timriley)
+- Changes to config values in parent classes after subclasses have already been created will not be propogated to those subclasses. Subclasses created _after_ config values have been changed in the parent _will_ receive those config values. (#130 by @timriley)
+
+[Compare v0.13.0...v0.14.0](https://github.com/dry-rb/dry-configurable/compare/v0.13.0...v0.14.0)
+
+## 0.13.0 2021-09-12
+
+
+### Added
+
+- Added flags to determine whether to warn on the API usage deprecated in this release (see "Changed" section below). Set these to `false` to suppress the warnings. (#124 by @timriley)
+
+  ```ruby
+  Dry::Configurable.warn_on_setting_constructor_block false
+  Dry::Configurable.warn_on_setting_positional_default false
+  ```
+
+### Fixed
+
+- Fixed `ArgumentError` for classes including `Dry::Configurable` whose `initializer` has required kwargs. (#113 by @timriley)
+
+### Changed
+
+- Deprecated the setting constructor provided as a block. Provide it via the `constructor:` keyword argument instead. (#111 by @waiting-for-dev & @timriley)
+
+  ```ruby
+  setting :path, constructor: -> path { Pathname(path) }
+  ```
+- Deprecated the setting default provided as the second positional argument. Provide it via the `default:` keyword argument instead. (#112 and #121 by @waiting-for-dev & @timriley)
+
+  ```ruby
+  setting :path, default: "some/default/path"
+  ```
+- [BREAKING] Removed implicit `to_hash` conversion from `Config`. (#114 by @timriley)
+
+[Compare v0.12.1...v0.13.0](https://github.com/dry-rb/dry-configurable/compare/v0.12.1...v0.13.0)
+
+## 0.12.1 2021-02-15
+
+
+### Added
+
+- Settings may be specified with a `cloneable` option, e.g.
+
+```ruby
+setting :component_dirs, Configuration::ComponentDirs.new, cloneable: true
+```
+
+This change makes it possible to provide “rich” config values that carry their own
+configuration interface.
+
+In the above example, `ComponentDirs` could provide its own API for adding component
+dirs and configuring aspects of their behavior at the same time. By being passed to
+the setting along with `cloneable: true`, dry-configurable will ensure the setting's
+values are cloned along with the setting at all the appropriate times.
+
+A custom cloneable setting value should provide its own `#initialize_copy` (used by
+`Object#dup`) with the appropriate logic. (@timriley in #102)
+
+### Fixed
+
+- Only `#initialize` instance method is prepended, leaving the rest of the instance
+methods to be included as normal again. This allows classes including
+`Dry::Configurable` to override instance methods with their own methods as required
+(@adam12 in #103)
+
+
+[Compare v0.12.0...v0.12.1](https://github.com/dry-rb/dry-configurable/compare/v0.12.0...v0.12.1)
+
+## 0.12.0 2020-12-26
+
+
+### Fixed
+
+- Setting values provided by defaults and/or pre-processor blocks are no longer accidentally memoized across instances of classes including Dry::Configurable (#99) (@timriley & @esparta)
+
+### Changed
+
+- Instance behavior is now prepended, so that if you have your own `initialize`, calling `super` is no longer required (see #98 for more details) (@zabolotnov87)
+- Switched to equalizer from dry-core (@solnic)
+
+[Compare v0.11.6...v0.12.0](https://github.com/dry-rb/dry-configurable/compare/v0.11.6...v0.12.0)
+
+## 0.11.6 2020-06-22
 
 
 ### Changed
@@ -6,7 +191,7 @@
 - A meaningful error is raised when the extension is included more than once (issue #89 fixed via #94) (@landongrindheim)
 - Evaluate setting input immediately when input is provided. This allows for earlier feedback from constructors designed to raise errors on invalid input (#95) (@timriley)
 
-[Compare v0.11.5...master](https://github.com/dry-rb/dry-configurable/compare/v0.11.5...master)
+[Compare v0.11.5...v0.11.6](https://github.com/dry-rb/dry-configurable/compare/v0.11.5...v0.11.6)
 
 ## 0.11.5 2020-03-23
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 dry-rb team
+Copyright (c) 2015-2022 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,3 +1,4 @@
+<!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-configurable
 [actions]: https://github.com/dry-rb/dry-configurable/actions
 [codacy]: https://www.codacy.com/gh/dry-rb/dry-configurable
@@ -10,19 +11,19 @@
 [![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]
+[![Inline docs](http://inch-ci.org/github/dry-rb/dry-configurable.svg?branch=main)][inchpages]
 
 ## Links
 
-* [User documentation](http://dry-rb.org/gems/dry-configurable)
+* [User documentation](https://dry-rb.org/gems/dry-configurable)
 * [API documentation](http://rubydoc.info/gems/dry-configurable)
 
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.4`
-* jruby >= `9.2`
+* MRI `>= 2.7.0`
+* jruby `>= 9.3` (postponed until 2.7 is supported)
 
 ## License
 

data/dry-configurable.gemspec

@@ -1,36 +1,36 @@
 # frozen_string_literal: true
-# this file is managed by dry-rb/devtools project
 
-lib = File.expand_path('lib', __dir__)
+# this file is synced from dry-rb/template-gem project
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'dry/configurable/version'
+require "dry/configurable/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'dry-configurable'
+  spec.name          = "dry-configurable"
   spec.authors       = ["Andy Holland"]
   spec.email         = ["andyholland1991@aol.com"]
-  spec.license       = 'MIT'
+  spec.license       = "MIT"
   spec.version       = Dry::Configurable::VERSION.dup
 
   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.homepage      = "https://dry-rb.org/gems/dry-configurable"
   spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-configurable.gemspec", "lib/**/*"]
-  spec.bindir        = 'bin'
+  spec.bindir        = "bin"
   spec.executables   = []
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  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.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-configurable/blob/main/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"
+  spec.required_ruby_version = ">= 2.7.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_runtime_dependency "dry-core", "~> 1.0", "< 2"
+  spec.add_runtime_dependency "zeitwerk", "~> 2.6"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/dry/configurable/class_methods.rb

@@ -1,11 +1,6 @@
 # frozen_string_literal: true
 
-require 'set'
-
-require 'dry/configurable/constants'
-require 'dry/configurable/dsl'
-require 'dry/configurable/methods'
-require 'dry/configurable/settings'
+require "set"
 
 module Dry
   module Configurable
@@ -13,54 +8,55 @@ module Dry
       include Methods
 
       # @api private
-      def inherited(klass)
+      def inherited(subclass)
         super
 
-        parent_settings = (respond_to?(:config) ? config._settings : _settings)
+        subclass.instance_variable_set(:@__config_extension__, __config_extension__)
+
+        new_settings = settings.dup
+        subclass.instance_variable_set(:@__settings__, new_settings)
 
-        klass.instance_variable_set('@_settings', parent_settings)
+        # Only classes **extending** Dry::Configurable have class-level config. When
+        # Dry::Configurable is **included**, the class-level config method is undefined because it
+        # resides at the instance-level instead (see `Configurable.included`).
+        if respond_to?(:config)
+          subclass.instance_variable_set(:@__config__, config.dup_for_settings(new_settings))
+        end
       end
 
       # Add a setting to the configuration
       #
-      # @param [Mixed] key
+      # @param [Mixed] name
       #   The accessor key for the configuration value
       # @param [Mixed] default
-      #   The default config value
-      #
+      #   Default value for the setting
+      # @param [#call] constructor
+      #   Transformation given value will go through
+      # @param [Boolean] reader
+      #   Whether a reader accessor must be created
       # @yield
-      #   If a block is given, it will be evaluated in the context of
-      #   a new configuration class, and bound as the default value
+      #   A block can be given to add nested settings.
       #
       # @return [Dry::Configurable::Config]
       #
       # @api public
-      def setting(*args, &block)
-        setting = __config_dsl__.setting(*args, &block)
+      def setting(*args, **options, &block)
+        setting = __config_dsl__.setting(*args, **options, &block)
 
-        _settings << setting
+        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
+      # Returns the defined settings for the class.
       #
       # @return [Settings]
       #
       # @api public
-      def _settings
-        @_settings ||= Settings.new
+      def settings
+        @__settings__ ||= Settings.new
       end
 
       # Return configuration
@@ -69,12 +65,25 @@ module Dry
       #
       # @api public
       def config
-        @config ||= Config.new(_settings)
+        @__config__ ||= __config_build__
+      end
+
+      # @api private
+      def __config_build__(settings = self.settings)
+        __config_extension__.config_class.new(settings)
+      end
+
+      # @api private
+      def __config_extension__
+        @__config_extension__
       end
 
       # @api private
       def __config_dsl__
-        @dsl ||= DSL.new
+        @__config_dsl__ ||= DSL.new(
+          config_class: __config_extension__.config_class,
+          default_undefined: __config_extension__.default_undefined
+        )
       end
 
       # @api private

data/lib/dry/configurable/compiler.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/configurable/setting'
-require 'dry/configurable/settings'
-
 module Dry
   module Configurable
     # Setting compiler used internally by the DSL
@@ -23,22 +20,18 @@ module Dry
         public_send(:"visit_#{type}", rest)
       end
 
-      # @api private
-      def visit_constructor(node)
-        setting, constructor = node
-        visit(setting).with(constructor: constructor)
-      end
-
       # @api private
       def visit_setting(node)
-        name, default, opts = node
-        Setting.new(name, **opts, default: default)
+        name, opts = node
+        Setting.new(name, **opts)
       end
 
       # @api private
       def visit_nested(node)
         parent, children = node
-        visit(parent).nested(call(children))
+        name, opts = parent[1]
+
+        Setting.new(name, **opts, children: Settings.new(call(children)))
       end
     end
   end