dry-configurable 0.12.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38b75c91290021054add38bdd9e3313f17aa133e219330a9b02a83227abd101c
-  data.tar.gz: 4b808bd3880c35e2e80a702e4577f2b2da35ef2b31667f4314accc3cf0c20470
+  metadata.gz: 5d067b9cb78be3e3904b22ab5e73a6903cecb387c241d08c875f2a1eaf1002a4
+  data.tar.gz: c7f9be3367d11ea23c10a8a73d0a63d0fab54a1cf6cd2f5053e8845b808bd801
 SHA512:
-  metadata.gz: efdd98ed5f60acf8090296954942f01c21702c29fa60c1edea21e0fbbb185955963b268191cb042ee33cc4651f4350419e7cbc2b7125c36103dce2733d137fa4
-  data.tar.gz: 21d278a4f9f4a90d530145408585c30e004ce2830d5777a408bd9ea83bdfd5cba2ce58f1a1ca46f1212d0e8d5967891a25467f39e59a8af20291cf5ca1beff3f
+  metadata.gz: 45d5b855ac62fa249080b1c40ed9faf0644cf9daa3d3a18c8c3cc0780723006dd510d3b0cb156d2251962775f95396b591e96136d951e08e4679dd684118601d
+  data.tar.gz: fc7420686647324a2c671f183aff7b1fc69131f80db292d0847e53dc5744e16904f56dc74a35b6dadb6cce1f4927409a632d026d7127ccb5844d9b8ba67b4e98

data/CHANGELOG.md

@@ -1,5 +1,124 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
+## 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
 
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2021 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.5`
-* jruby >= `9.2`
+* MRI `>= 2.7.0`
+* jruby `>= 9.3` (postponed until 2.7 is supported)
 
 ## License
 

data/dry-configurable.gemspec

@@ -1,35 +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.5.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.5", ">= 0.5.0"
+  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,53 +8,54 @@ 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
+      def settings
         @_settings ||= Settings.new
       end
 
@@ -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

data/lib/dry/configurable/config.rb

@@ -1,11 +1,6 @@
 # frozen_string_literal: true
 
-require 'concurrent/map'
-
-require 'dry/core/equalizer'
-
-require 'dry/configurable/constants'
-require 'dry/configurable/errors'
+require "set"
 
 module Dry
   module Configurable
@@ -19,12 +14,29 @@ module Dry
       attr_reader :_settings
 
       # @api private
-      attr_reader :_resolved
+      attr_reader :_values
+
+      # @api private
+      attr_reader :_configured
+      protected :_configured
 
       # @api private
-      def initialize(settings)
-        @_settings = settings.dup
-        @_resolved = Concurrent::Map.new
+      def initialize(settings, values: {})
+        @_settings = settings
+        @_values = values
+        @_configured = Set.new
+      end
+
+      # @api private
+      private def initialize_copy(source)
+        super
+        @_values = source.__send__(:dup_values)
+        @_configured = source._configured.dup
+      end
+
+      # @api private
+      def dup_for_settings(settings)
+        dup.tap { |config| config.instance_variable_set(:@_settings, settings) }
       end
 
       # Get config value by a key
@@ -34,9 +46,19 @@ module Dry
       # @return Config value
       def [](name)
         name = name.to_sym
-        raise ArgumentError, "+#{name}+ is not a setting name" unless _settings.key?(name)
 
-        _settings[name].value
+        unless (setting = _settings[name])
+          raise ArgumentError, "+#{name}+ is not a setting name"
+        end
+
+        _values.fetch(name) {
+          # Mutable settings may be configured after read
+          _configured.add(name) if setting.cloneable?
+
+          setting.to_value.tap { |value|
+            _values[name] = value
+          }
+        }
       end
 
       # Set config value.
@@ -45,21 +67,34 @@ module Dry
       # @param [String,Symbol] name
       # @param [Object] value
       def []=(name, value)
-        public_send(:"#{name}=", value)
+        raise FrozenConfigError, "Cannot modify frozen config" if frozen?
+
+        name = name.to_sym
+
+        unless (setting = _settings[name])
+          raise ArgumentError, "+#{name}+ is not a setting name"
+        end
+
+        _configured.add(name)
+
+        _values[name] = setting.constructor.(value)
       end
 
       # Update config with new values
       #
-      # @param values [Hash] A hash with new values
+      # @param values [Hash, #to_hash] A hash with new values
       #
       # @return [Config]
       #
       # @api public
       def update(values)
         values.each do |key, value|
-          case value
-          when Hash
-            self[key].update(value)
+          if self[key].is_a?(self.class)
+            unless value.respond_to?(:to_hash)
+              raise ArgumentError, "#{value.inspect} is not a valid setting value"
+            end
+
+            self[key].update(value.to_hash)
           else
             self[key] = value
           end
@@ -67,62 +102,113 @@ module Dry
         self
       end
 
-      # Dump config into a hash
+      # Returns true if the value for the given key has been set on this config.
+      #
+      # For simple values, this returns true if the value has been explicitly assigned.
+      #
+      # For cloneable (mutable) values, since these are captured on read, returns true if the value
+      # does not compare equally to its corresdponing default value. This relies on these objects
+      # having functioning `#==` checks.
+      #
+      # @return [Bool]
+      #
+      # @api public
+      def configured?(key)
+        if _configured.include?(key) && _settings[key].cloneable?
+          return _values[key] != _settings[key].to_value
+        end
+
+        _configured.include?(key)
+      end
+
+      # Returns the current config values.
+      #
+      # Nested configs remain in their {Config} instances.
       #
       # @return [Hash]
       #
       # @api public
       def values
-        _settings
-          .map { |setting| [setting.name, setting.value] }
-          .map { |key, value| [key, value.is_a?(self.class) ? value.to_h : value] }
-          .to_h
+        # Ensure all settings are represented in values
+        _settings.each { |setting| self[setting.name] unless _values.key?(setting.name) }
+
+        _values
       end
-      alias_method :to_h, :values
-      alias_method :to_hash, :values
 
-      # @api private
-      def finalize!
-        _settings.freeze
-        freeze
+      # Returns config values as a hash, with nested values also converted from {Config} instances
+      # into hashes.
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def to_h
+        values.to_h { |key, value| [key, value.is_a?(self.class) ? value.to_h : value] }
       end
 
       # @api private
-      def pristine
-        self.class.new(_settings.pristine)
+      alias_method :_dry_equalizer_hash, :hash
+
+      # @api public
+      def hash
+        return @__hash__ if instance_variable_defined?(:@__hash__)
+
+        _dry_equalizer_hash
+      end
+
+      # @api public
+      def finalize!(freeze_values: false)
+        return self if frozen?
+
+        values.each_value do |value|
+          if value.is_a?(self.class)
+            value.finalize!(freeze_values: freeze_values)
+          elsif freeze_values
+            value.freeze
+          end
+        end
+
+        # Memoize the hash for the object when finalizing (regardless of whether values themselves
+        # are to be frozen; the intention of finalization is that no further changes should be
+        # made). The benefit of freezing the hash at this point is that it saves repeated expensive
+        # computation (through Dry::Equalizer's hash implementation) if that hash is to be used
+        # later in performance-sensitive situations, such as when serving as a cache key or similar.
+        @__hash__ = _dry_equalizer_hash
+
+        freeze
       end
 
       # @api private
-      def respond_to_missing?(meth, include_private = false)
-        super || _settings.key?(resolve(meth))
+      def pristine
+        self.class.new(_settings)
       end
 
       private
 
-      # @api private
-      def method_missing(meth, *args)
-        setting = _settings[resolve(meth)]
+      def method_missing(name, *args)
+        setting_name = setting_name_from_method(name)
+        setting = _settings[setting_name]
 
         super unless setting
 
-        if setting.writer?(meth)
-          raise FrozenConfig, 'Cannot modify frozen config' if frozen?
-
-          _settings << setting.with(input: args[0])
+        if name.end_with?("=")
+          self[setting_name] = args[0]
         else
-          setting.value
+          self[setting_name]
         end
       end
 
-      # @api private
-      def resolve(meth)
-        _resolved.fetch(meth) { _resolved[meth] = meth.to_s.tr('=', '').to_sym }
+      def respond_to_missing?(meth, include_private = false)
+        _settings.key?(setting_name_from_method(meth)) || super
       end
 
-      # @api private
-      def initialize_copy(source)
-        super
-        @_settings = source._settings.dup
+      def setting_name_from_method(method_name)
+        method_name.to_s.tr("=", "").to_sym
+      end
+
+      def dup_values
+        _values.each_with_object({}) { |(key, val), dup_hsh|
+          dup_hsh[key] = _settings[key].cloneable? ? val.dup : val
+        }
       end
     end
   end

data/lib/dry/configurable/constants.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/core/constants'
-
 module Dry
   # Shared constants
   #