dry-configurable 0.16.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d8c3e4ebee8cf7f978c48580f64c1547c6c818b50ed7064b0758b4bffb072ee
-  data.tar.gz: 2aa701383b59289fbe591100642027fc5bc0d074bd0ec5d6d085359293af0f8f
+  metadata.gz: 5d067b9cb78be3e3904b22ab5e73a6903cecb387c241d08c875f2a1eaf1002a4
+  data.tar.gz: c7f9be3367d11ea23c10a8a73d0a63d0fab54a1cf6cd2f5053e8845b808bd801
 SHA512:
-  metadata.gz: 221e2cfb38c4eae38ab6b56250e2d70672c9d1e6883b048f5a6bc807d0996065bf1b8e4a102fd78b6a95a4a4ffcf21dcfd46c64737acd915b3d1b80f9dca273e
-  data.tar.gz: 1f04a6b9af22d12a6b310902cdf5761362762a7fcca97c78a2feb17a28ce3199285a8cd1b6e80c56cde10f7fc2983c8598990fa263e5e55656502ad22761dd2e
+  metadata.gz: 45d5b855ac62fa249080b1c40ed9faf0644cf9daa3d3a18c8c3cc0780723006dd510d3b0cb156d2251962775f95396b591e96136d951e08e4679dd684118601d
+  data.tar.gz: fc7420686647324a2c671f183aff7b1fc69131f80db292d0847e53dc5744e16904f56dc74a35b6dadb6cce1f4927409a632d026d7127ccb5844d9b8ba67b4e98

data/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 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)

data/dry-configurable.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.7.0"
 
   # to update dependencies edit project.yml
-  spec.add_runtime_dependency "dry-core", "~> 0.6"
+  spec.add_runtime_dependency "dry-core", "~> 1.0", "< 2"
   spec.add_runtime_dependency "zeitwerk", "~> 2.6"
 
   spec.add_development_dependency "bundler"

data/lib/dry/configurable/class_methods.rb

@@ -13,7 +13,7 @@ module Dry
 
         subclass.instance_variable_set(:@__config_extension__, __config_extension__)
 
-        new_settings = _settings.dup
+        new_settings = settings.dup
         subclass.instance_variable_set(:@_settings, new_settings)
 
         # Only classes **extending** Dry::Configurable have class-level config. When
@@ -43,28 +43,19 @@ module Dry
       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
-        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
 
@@ -78,7 +69,7 @@ module Dry
       end
 
       # @api private
-      def __config_build__(settings = _settings)
+      def __config_build__(settings = self.settings)
         __config_extension__.config_class.new(settings)
       end
 

data/lib/dry/configurable/config.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
-require "dry/core/constants"
 require "set"
 
-require "dry/core/equalizer"
-
 module Dry
   module Configurable
     # Config exposes setting values through a convenient API
@@ -70,7 +67,7 @@ module Dry
       # @param [String,Symbol] name
       # @param [Object] value
       def []=(name, value)
-        raise FrozenConfig, "Cannot modify frozen config" if frozen?
+        raise FrozenConfigError, "Cannot modify frozen config" if frozen?
 
         name = name.to_sym
 
@@ -149,7 +146,19 @@ module Dry
       end
 
       # @api private
+      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)
@@ -158,6 +167,13 @@ module Dry
           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
 

data/lib/dry/configurable/constants.rb

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

data/lib/dry/configurable/dsl.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "dry/core/deprecations"
-
 module Dry
   module Configurable
     # Setting DSL used by the class API

data/lib/dry/configurable/errors.rb

@@ -6,7 +6,8 @@ module Dry
   # @api public
   module Configurable
     Error = Class.new(::StandardError)
-    AlreadyIncluded = ::Class.new(Error)
-    FrozenConfig = ::Class.new(Error)
+
+    AlreadyIncludedError = Class.new(Error)
+    FrozenConfigError = Class.new(Error)
   end
 end

data/lib/dry/configurable/extension.rb

@@ -26,7 +26,7 @@ module Dry
 
       # @api private
       def included(klass)
-        raise AlreadyIncluded if klass.include?(InstanceMethods)
+        raise AlreadyIncludedError if klass.include?(InstanceMethods)
 
         super
 

data/lib/dry/configurable/instance_methods.rb

@@ -12,7 +12,7 @@ module Dry
     module Initializer
       # @api private
       def initialize(*)
-        @config = self.class.__config_build__(self.class._settings)
+        @config = self.class.__config_build__(self.class.settings)
 
         super
       end

data/lib/dry/configurable/methods.rb

@@ -8,7 +8,7 @@ module Dry
     module Methods
       # @api public
       def configure(&block)
-        raise FrozenConfig, "Cannot modify frozen config" if frozen?
+        raise FrozenConfigError, "Cannot modify frozen config" if config.frozen?
 
         yield(config) if block
         self

data/lib/dry/configurable/setting.rb

@@ -2,43 +2,41 @@
 
 require "set"
 
-require "dry/core/equalizer"
-
 module Dry
   module Configurable
-    # This class represents a setting and is used internally.
+    # A defined setting.
     #
-    # @api private
+    # @api public
     class Setting
       include Dry::Equalizer(:name, :default, :constructor, :children, :options, inspect: false)
 
-      OPTIONS = %i[default reader constructor cloneable settings config_class].freeze
+      OPTIONS = %i[default reader constructor mutable cloneable settings config_class].freeze
 
       DEFAULT_CONSTRUCTOR = -> v { v }.freeze
 
-      CLONEABLE_VALUE_TYPES = [Array, Hash, Set, Config].freeze
+      MUTABLE_VALUE_TYPES = [Array, Hash, Set, Config].freeze
 
-      # @api private
+      # @api public
       attr_reader :name
 
-      # @api private
+      # @api public
       attr_reader :default
 
-      # @api private
-      attr_reader :cloneable
+      # @api public
+      attr_reader :mutable
 
-      # @api private
+      # @api public
       attr_reader :constructor
 
-      # @api private
+      # @api public
       attr_reader :children
 
-      # @api private
+      # @api public
       attr_reader :options
 
       # @api private
-      def self.cloneable_value?(value)
-        CLONEABLE_VALUE_TYPES.any? { |type| value.is_a?(type) }
+      def self.mutable_value?(value)
+        MUTABLE_VALUE_TYPES.any? { |type| value.is_a?(type) }
       end
 
       # @api private
@@ -51,8 +49,9 @@ module Dry
       )
         @name = name
         @default = default
-        @cloneable = children.any? || options.fetch(:cloneable) {
-          Setting.cloneable_value?(default)
+        @mutable = children.any? || options.fetch(:mutable) {
+          # Allow `cloneable` as an option alias for `mutable`
+          options.fetch(:cloneable) { Setting.mutable_value?(default) }
         }
         @constructor = constructor
         @children = children
@@ -64,10 +63,11 @@ module Dry
         options[:reader].equal?(true)
       end
 
-      # @api private
-      def cloneable?
-        cloneable
+      # @api public
+      def mutable?
+        mutable
       end
+      alias_method :cloneable?, :mutable?
 
       # @api private
       def to_value
@@ -77,7 +77,7 @@ module Dry
           value = default
           value = constructor.(value) unless value.eql?(Undefined)
 
-          cloneable? ? value.dup : value
+          mutable? ? value.dup : value
         end
       end
     end

data/lib/dry/configurable/settings.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require "dry/core/equalizer"
-
 module Dry
   module Configurable
-    # A settings map
+    # A collection of defined settings on a given class.
     #
     # @api private
     class Settings
@@ -20,37 +18,48 @@ module Dry
         @settings = settings.each_with_object({}) { |s, m| m[s.name] = s }
       end
 
+      # @api private
+      private def initialize_copy(source)
+        @settings = source.settings.dup
+      end
+
       # @api private
       def <<(setting)
         settings[setting.name] = setting
         self
       end
 
-      # @api private
+      # Returns the setting for the given name, if found.
+      #
+      # @return [Setting, nil] the setting, or nil if not found
+      #
+      # @api public
       def [](name)
         settings[name]
       end
 
-      # @api private
+      # Returns true if a setting for the given name is defined.
+      #
+      # @return [Boolean]
+      #
+      # @api public
       def key?(name)
         keys.include?(name)
       end
 
-      # @api private
+      # Returns the list of defined setting names.
+      #
+      # @return [Array<Symbol>]
+      #
+      # @api public
       def keys
         settings.keys
       end
 
-      # @api private
+      # @api public
       def each(&block)
         settings.each_value(&block)
       end
-
-      private
-
-      def initialize_copy(source)
-        @settings = source.settings.dup
-      end
     end
   end
 end

data/lib/dry/configurable/version.rb

@@ -3,6 +3,6 @@
 module Dry
   module Configurable
     # @api public
-    VERSION = "0.16.1"
+    VERSION = "1.0.0"
   end
 end

data/lib/dry/configurable.rb

@@ -2,7 +2,7 @@
 
 require "zeitwerk"
 
-require "dry/core/constants"
+require "dry/core"
 require "dry/configurable/constants"
 require "dry/configurable/errors"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-configurable
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-12 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-core
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement