dry-configurable 0.12.1 → 1.0.0

data/lib/dry/configurable/dsl.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/configurable/constants'
-require 'dry/configurable/setting'
-require 'dry/configurable/settings'
-require 'dry/configurable/compiler'
-require 'dry/configurable/dsl/args'
-
 module Dry
   module Configurable
     # Setting DSL used by the class API
@@ -14,49 +8,67 @@ module Dry
     class DSL
       VALID_NAME = /\A[a-z_]\w*\z/i.freeze
 
-      # @api private
       attr_reader :compiler
 
-      # @api private
       attr_reader :ast
 
-      # @api private
-      def initialize(&block)
+      attr_reader :options
+
+      def initialize(**options, &block)
         @compiler = Compiler.new
         @ast = []
+        @options = options
         instance_exec(&block) if block
       end
 
-      # Register a new setting node and compile it into a setting object
+      # Registers a new setting node and compile it into a setting object
       #
       # @see ClassMethods.setting
-      # @api public
+      # @api private
       # @return Setting
-      def setting(name, *args, &block)
+      def setting(name, **options, &block) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
         unless VALID_NAME.match?(name.to_s)
           raise ArgumentError, "#{name} is not a valid setting name"
         end
 
-        args = Args.new(args)
-
-        args.ensure_valid_options
+        ensure_valid_options(options)
 
-        default, opts = args
+        options = {default: default, config_class: config_class, **options}
 
-        node = [:setting, [name.to_sym, default, opts == default ? EMPTY_HASH : opts]]
+        node = [:setting, [name.to_sym, options]]
 
         if block
-          if block.arity.zero?
-            ast << [:nested, [node, DSL.new(&block).ast]]
-          else
-            ast << [:constructor, [node, block]]
-          end
+          ast << [:nested, [node, DSL.new(&block).ast]]
         else
           ast << node
         end
 
         compiler.visit(ast.last)
       end
+
+      def config_class
+        options[:config_class]
+      end
+
+      def default
+        options[:default_undefined] ? Undefined : nil
+      end
+
+      private
+
+      def ensure_valid_options(options)
+        return if options.none?
+
+        invalid_keys = options.keys - Setting::OPTIONS
+
+        raise ArgumentError, "Invalid options: #{invalid_keys.inspect}" unless invalid_keys.empty?
+      end
+
+      # Returns a tuple of valid and invalid options hashes derived from the options hash
+      # given to the setting
+      def valid_and_invalid_options(options)
+        options.partition { |k, _| Setting::OPTIONS.include?(k) }.map(&:to_h)
+      end
     end
   end
 end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Dry
+  module Configurable
+    class Extension < Module
+      # @api private
+      attr_reader :config_class
+
+      # @api private
+      attr_reader :default_undefined
+
+      # @api private
+      def initialize(config_class: Configurable::Config, default_undefined: false)
+        super()
+        @config_class = config_class
+        @default_undefined = default_undefined
+        freeze
+      end
+
+      # @api private
+      def extended(klass)
+        super
+        klass.extend(ClassMethods)
+        klass.instance_variable_set(:@__config_extension__, self)
+      end
+
+      # @api private
+      def included(klass)
+        raise AlreadyIncludedError if klass.include?(InstanceMethods)
+
+        super
+
+        klass.class_eval do
+          extend(ClassMethods)
+          include(InstanceMethods)
+          prepend(Initializer)
+
+          class << self
+            undef :config
+            undef :configure
+          end
+        end
+
+        klass.instance_variable_set(:@__config_extension__, self)
+      end
+    end
+  end
+end

data/lib/dry/configurable/instance_methods.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/configurable/config'
-require 'dry/configurable/methods'
+require "dry/configurable/config"
+require "dry/configurable/methods"
 
 module Dry
   module Configurable
@@ -12,9 +12,11 @@ module Dry
     module Initializer
       # @api private
       def initialize(*)
-        @config = Config.new(self.class._settings.dup)
+        @config = self.class.__config_build__(self.class.settings)
+
         super
       end
+      ruby2_keywords(:initialize) if respond_to?(:ruby2_keywords, true)
     end
 
     # Instance-level API when `Dry::Configurable` is included in a class
@@ -33,9 +35,7 @@ module Dry
       # Finalize the config and freeze the object
       #
       # @api public
-      def finalize!
-        return self if frozen?
-
+      def finalize!(freeze_values: false)
         super
         freeze
       end

data/lib/dry/configurable/methods.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/configurable/errors'
-
 module Dry
   module Configurable
     # Common API for both classes and instances
@@ -10,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
@@ -21,10 +19,8 @@ module Dry
       # @return [Dry::Configurable::Config]
       #
       # @api public
-      def finalize!
-        return self if config.frozen?
-
-        config.finalize!
+      def finalize!(freeze_values: false)
+        config.finalize!(freeze_values: freeze_values)
         self
       end
     end

data/lib/dry/configurable/setting.rb

@@ -1,107 +1,61 @@
 # frozen_string_literal: true
 
-require 'set'
-
-require 'dry/core/equalizer'
-
-require 'dry/configurable/constants'
-require 'dry/configurable/config'
+require "set"
 
 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, :value, :options, inspect: false)
+      include Dry::Equalizer(:name, :default, :constructor, :children, :options, inspect: false)
 
-      OPTIONS = %i[input default reader constructor cloneable settings].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
-      attr_reader :writer_name
-
-      # @api private
-      attr_reader :input
-
-      # @api private
+      # @api public
       attr_reader :default
 
-      # @api private
-      attr_reader :options
+      # @api public
+      attr_reader :mutable
 
-      # Specialized Setting which includes nested settings
-      #
-      # @api private
-      class Nested < Setting
-        CONSTRUCTOR = Config.method(:new)
+      # @api public
+      attr_reader :constructor
 
-        # @api private
-        def pristine
-          with(input: input.pristine)
-        end
+      # @api public
+      attr_reader :children
 
-        # @api private
-        def constructor
-          CONSTRUCTOR
-        end
-      end
+      # @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
-      def initialize(name, input: Undefined, default: Undefined, **options)
+      def initialize(
+        name,
+        default:,
+        constructor: DEFAULT_CONSTRUCTOR,
+        children: EMPTY_ARRAY,
+        **options
+      )
         @name = name
-        @writer_name = :"#{name}="
-        @input = input
         @default = 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
         @options = options
-
-        evaluate if input_defined?
-      end
-
-      # @api private
-      def input_defined?
-        !input.equal?(Undefined)
-      end
-
-      # @api private
-      def value
-        @value ||= evaluate
-      end
-
-      # @api private
-      def evaluated?
-        instance_variable_defined?(:@value)
-      end
-
-      # @api private
-      def nested(settings)
-        Nested.new(name, input: settings, **options)
-      end
-
-      # @api private
-      def pristine
-        with(input: Undefined)
-      end
-
-      # @api private
-      def with(new_opts)
-        self.class.new(name, input: input, default: default, **options, **new_opts)
-      end
-
-      # @api private
-      def constructor
-        options[:constructor] || DEFAULT_CONSTRUCTOR
       end
 
       # @api private
@@ -109,43 +63,23 @@ module Dry
         options[:reader].equal?(true)
       end
 
-      # @api private
-      def writer?(meth)
-        writer_name.equal?(meth)
+      # @api public
+      def mutable?
+        mutable
       end
+      alias_method :cloneable?, :mutable?
 
       # @api private
-      def cloneable?
-        if options.key?(:cloneable)
-          # Return cloneable option if explicitly set
-          options[:cloneable]
+      def to_value
+        if children.any?
+          (options[:config_class] || Config).new(children)
         else
-          # Otherwise, infer cloneable from any of the input, default, or value
-          Setting.cloneable_value?(input) || Setting.cloneable_value?(default) || (
-            evaluated? && Setting.cloneable_value?(value)
-          )
-        end
-      end
-
-      private
+          value = default
+          value = constructor.(value) unless value.eql?(Undefined)
 
-      # @api private
-      def initialize_copy(source)
-        super
-
-        @options = source.options.dup
-
-        if source.cloneable?
-          @input = source.input.dup
-          @default = source.default.dup
-          @value = source.value.dup if source.evaluated?
+          mutable? ? value.dup : value
         end
       end
-
-      # @api private
-      def evaluate
-        @value = constructor[Undefined.coalesce(input, default, nil)]
-      end
     end
   end
 end

data/lib/dry/configurable/settings.rb

@@ -1,71 +1,64 @@
 # frozen_string_literal: true
 
-require 'concurrent/map'
-
-require 'dry/core/equalizer'
-require 'dry/configurable/constants'
-
 module Dry
   module Configurable
-    # A settings map
+    # A collection of defined settings on a given class.
     #
     # @api private
     class Settings
-      include Dry::Equalizer(:elements)
+      include Dry::Equalizer(:settings)
 
       include Enumerable
 
       # @api private
-      attr_reader :elements
+      attr_reader :settings
+
+      # @api private
+      def initialize(settings = EMPTY_ARRAY)
+        @settings = settings.each_with_object({}) { |s, m| m[s.name] = s }
+      end
 
       # @api private
-      def initialize(elements = EMPTY_ARRAY)
-        initialize_elements(elements)
+      private def initialize_copy(source)
+        @settings = source.settings.dup
       end
 
       # @api private
       def <<(setting)
-        elements[setting.name] = 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)
-        elements[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
-        elements.keys
+        settings.keys
       end
 
-      # @api private
+      # @api public
       def each(&block)
-        elements.values.each(&block)
-      end
-
-      # @api private
-      def pristine
-        self.class.new(map(&:pristine))
-      end
-
-      private
-
-      # @api private
-      def initialize_copy(source)
-        initialize_elements(source.map(&:dup))
-      end
-
-      # @api private
-      def initialize_elements(elements)
-        @elements = elements.each_with_object(Concurrent::Map.new) { |s, m|
-          m[s.name] = s
-        }
+        settings.each_value(&block)
       end
     end
   end

data/lib/dry/configurable/version.rb

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

data/lib/dry/configurable.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
-require 'concurrent/array'
+require "zeitwerk"
 
-require 'dry/configurable/constants'
-require 'dry/configurable/class_methods'
-require 'dry/configurable/instance_methods'
-require 'dry/configurable/config'
-require 'dry/configurable/setting'
-require 'dry/configurable/errors'
+require "dry/core"
+require "dry/configurable/constants"
+require "dry/configurable/errors"
 
 module Dry
+  # @api public
+  def self.Configurable(**options)
+    Configurable::Extension.new(**options)
+  end
+
   # A simple configuration mixin
   #
   # @example class-level configuration
@@ -44,27 +46,32 @@ module Dry
   #
   # @api public
   module Configurable
+    def self.loader
+      @loader ||= Zeitwerk::Loader.new.tap do |loader|
+        root = File.expand_path("..", __dir__)
+        loader.tag = "dry-configurable"
+        loader.inflector = Zeitwerk::GemInflector.new("#{root}/dry-configurable.rb")
+        loader.push_dir(root)
+        loader.ignore(
+          "#{root}/dry-configurable.rb",
+          "#{root}/dry/configurable/{constants,errors,version}.rb"
+        )
+        loader.inflector.inflect("dsl" => "DSL")
+      end
+    end
+
     # @api private
     def self.extended(klass)
       super
-      klass.extend(ClassMethods)
+      klass.extend(Extension.new)
     end
 
     # @api private
     def self.included(klass)
-      raise AlreadyIncluded if klass.include?(InstanceMethods)
-
       super
-      klass.class_eval do
-        extend(ClassMethods)
-        include(InstanceMethods)
-        prepend(Initializer)
-
-        class << self
-          undef :config
-          undef :configure
-        end
-      end
+      klass.include(Extension.new)
     end
+
+    loader.setup
   end
 end

data/lib/dry-configurable.rb

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

metadata

@@ -1,22 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: dry-configurable
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: concurrent-ruby
+  name: dry-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,26 +27,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: dry-core
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -104,8 +104,8 @@ files:
 - lib/dry/configurable/config.rb
 - lib/dry/configurable/constants.rb
 - lib/dry/configurable/dsl.rb
-- lib/dry/configurable/dsl/args.rb
 - lib/dry/configurable/errors.rb
+- lib/dry/configurable/extension.rb
 - lib/dry/configurable/instance_methods.rb
 - lib/dry/configurable/methods.rb
 - lib/dry/configurable/setting.rb
@@ -117,7 +117,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  changelog_uri: https://github.com/dry-rb/dry-configurable/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/dry-rb/dry-configurable/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/dry-rb/dry-configurable
   bug_tracker_uri: https://github.com/dry-rb/dry-configurable/issues
 post_install_message: 
@@ -128,14 +128,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A mixin to add configuration functionality to your classes