dry-configurable 0.9.0 → 0.11.0

data/lib/dry/configurable/instance_methods.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'dry/configurable/config'
+require 'dry/configurable/methods'
+
+module Dry
+  module Configurable
+    # Instance-level API when `Dry::Configurable` is included in a class
+    #
+    # @api public
+    module InstanceMethods
+      include Methods
+
+      # Return object's configuration
+      #
+      # @return [Config]
+      #
+      # @api public
+      attr_reader :config
+
+      # @api private
+      def initialize(*)
+        @config = Config.new(self.class._settings.dup)
+        super
+      end
+
+      # Finalize the config and freeze the object
+      #
+      # @api public
+      def finalize!
+        return self if frozen?
+
+        super
+        freeze
+      end
+
+      private
+
+      # @api public
+      def initialize_copy(source)
+        super
+        @config = source.config.dup
+      end
+    end
+  end
+end

data/lib/dry/configurable/methods.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'dry/configurable/errors'
+
+module Dry
+  module Configurable
+    # Common API for both classes and instances
+    #
+    # @api public
+    module Methods
+      # @api public
+      def configure(&block)
+        raise FrozenConfig, 'Cannot modify frozen config' if frozen?
+
+        yield(config) if block
+        self
+      end
+
+      # Finalize and freeze configuration
+      #
+      # @return [Dry::Configurable::Config]
+      #
+      # @api public
+      def finalize!
+        return self if config.frozen?
+
+        config.finalize!
+        self
+      end
+    end
+  end
+end

data/lib/dry/configurable/setting.rb

@@ -1,45 +1,118 @@
+# frozen_string_literal: true
+
+require 'set'
+
+require 'dry/equalizer'
+
+require 'dry/configurable/constants'
+require 'dry/configurable/config'
+
 module Dry
   module Configurable
     # This class represents a setting and is used internally.
     #
-    # @private
+    # @api private
     class Setting
-      VALID_NAME = /\A[a-z_]\w*\z/i
+      include Dry::Equalizer(:name, :value, :options)
+
+      OPTIONS = %i[input default reader constructor settings].freeze
+
+      DEFAULT_CONSTRUCTOR = -> v { v }.freeze
 
+      CLONABLE_VALUE_TYPES = [Array, Hash, Set, Config].freeze
+
+      # @api private
       attr_reader :name
 
+      # @api private
+      attr_reader :writer_name
+
+      # @api private
+      attr_reader :input
+
+      # @api private
+      attr_reader :default
+
+      # @api private
+      attr_reader :value
+
+      # @api private
       attr_reader :options
 
-      attr_reader :processor
+      # Specialized Setting which includes nested settings
+      #
+      # @api private
+      class Nested < Setting
+        CONSTRUCTOR = Config.method(:new)
+
+        # @api private
+        def pristine
+          with(input: input.pristine)
+        end
 
-      def initialize(name, value, processor, options = EMPTY_HASH)
-        unless VALID_NAME =~ name.to_s
-          raise ArgumentError, "+#{name}+ is not a valid setting name"
+        # @api private
+        def constructor
+          CONSTRUCTOR
         end
-        @name = name.to_sym
-        @value = value
-        @processor = processor
+      end
+
+      # @api private
+      def initialize(name, input: Undefined, default: Undefined, **options)
+        @name = name
+        @writer_name = :"#{name}="
+        @input = input.equal?(Undefined) ? default : input
+        @default = default
         @options = options
+        set!
+      end
+
+      # @api private
+      def nested(settings)
+        Nested.new(name, input: settings, **options)
+      end
+
+      # @api private
+      def pristine
+        with(input: Undefined)
       end
 
-      def value
-        Undefined.default(@value, nil)
+      # @api private
+      def with(new_opts)
+        self.class.new(name, input: input, default: default, **options, **new_opts)
       end
 
-      def undefined?
-        Undefined.equal?(@value)
+      # @api private
+      def constructor
+        options[:constructor] || DEFAULT_CONSTRUCTOR
       end
 
+      # @api private
       def reader?
-        options[:reader]
+        options[:reader].equal?(true)
+      end
+
+      # @api private
+      def writer?(meth)
+        writer_name.equal?(meth)
       end
 
-      def node?
-        Settings === @value
+      # @api private
+      def clonable_value?
+        CLONABLE_VALUE_TYPES.any? { |type| value.is_a?(type) }
+      end
+
+      private
+
+      # @api private
+      def initialize_copy(source)
+        super
+        @value = source.value.dup if source.clonable_value?
+        @options = source.options.dup
       end
 
-      def reserved?
-        options[:reserved]
+      # @api private
+      def set!
+        @value = constructor[input.equal?(Undefined) ? nil : input]
       end
     end
   end

data/lib/dry/configurable/settings.rb

@@ -1,116 +1,71 @@
-require 'set'
-require 'concurrent/array'
-require 'dry/configurable/settings/argument_parser'
-require 'dry/configurable/setting'
-require 'dry/configurable/config'
+# frozen_string_literal: true
+
+require 'concurrent/map'
+
+require 'dry/equalizer'
+require 'dry/configurable/constants'
 
 module Dry
   module Configurable
-    # A collection of settings. This is not part of the public API.
+    # A settings map
     #
-    # @private
+    # @api private
     class Settings
-      Parser = ArgumentParser.new.freeze
-
-      class DSL
-        def self.call(&block)
-          new.instance_exec do
-            instance_exec(&block)
-            @settings
-          end
-        end
-
-        def initialize
-          @settings = Settings.new
-        end
-
-        def setting(*args, &block)
-          @settings.add(*args, &block)
-        end
-      end
-
-      # Capture nested config definition
-      #
-      # @return [Dry::Configurable::Setting]
-      def self.capture(&block)
-        DSL.(&block)
-      end
-
-      attr_reader :settings
+      include Dry::Equalizer(:elements)
 
-      attr_reader :config_class
+      include Enumerable
 
-      attr_reader :index
-      private :index
+      # @api private
+      attr_reader :elements
 
-      def initialize(settings = ::Concurrent::Array.new)
-        @settings = settings
-        @config_class = Config[self]
-        @index = settings.map { |s| [s.name, s] }.to_h
-        yield(self) if block_given?
+      # @api private
+      def initialize(elements = EMPTY_ARRAY)
+        initialize_elements(elements)
       end
 
-      def add(key, value = Undefined, options = Undefined, &block)
-        extended = singleton_class < Configurable
-        raise_already_defined_config(key) if extended && configured?
-
-        *args, opts = Parser.(value, options, block)
-
-        Setting.new(key, *args, { **opts, reserved: reserved?(key) }).tap do |s|
-          settings.delete_if { |e| e.name.eql?(s.name) }
-          settings << s
-          index[s.name] = s
-          @names = nil
-        end
-      end
-
-      def each
-        settings.each { |s| yield(s) }
-      end
-
-      def names
-        @names ||= index.keys.to_set
+      # @api private
+      def <<(setting)
+        elements[setting.name] = setting
+        self
       end
 
+      # @api private
       def [](name)
-        index[name]
-      end
-
-      def empty?
-        settings.empty?
+        elements[name]
       end
 
-      def name?(name)
-        index.key?(name)
+      # @api private
+      def key?(name)
+        keys.include?(name)
       end
 
-      def dup
-        Settings.new(settings.dup)
+      # @api private
+      def keys
+        elements.keys
       end
 
-      def freeze
-        settings.freeze
-        super
+      # @api private
+      def each(&block)
+        elements.values.each(&block)
       end
 
-      def create_config
-        config_class.new
+      # @api private
+      def pristine
+        self.class.new(map(&:pristine))
       end
 
-      def config_defined?
-        config_class.config_defined?
-      end
+      private
 
-      def reserved?(name)
-        reserved_names.include?(name)
+      # @api private
+      def initialize_copy(source)
+        initialize_elements(source.map(&:dup))
       end
 
-      def reserved_names
-        @reserved_names ||= [
-          config_class.instance_methods(false),
-          config_class.superclass.instance_methods(false),
-          %i(class public_send)
-        ].reduce(:+)
+      # @api private
+      def initialize_elements(elements)
+        @elements = elements.each_with_object(Concurrent::Map.new) { |s, m|
+          m[s.name] = s
+        }
       end
     end
   end

data/lib/dry/configurable/test_interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dry
   module Configurable
     # Methods meant to be used in a testing scenario
@@ -8,11 +10,7 @@ module Dry
       #
       # @api public
       def reset_config
-        @config = if self.is_a?(Module)
-                    _settings.create_config
-                  else
-                    self.class._settings.create_config
-                  end
+        @config = config.pristine
       end
     end
 

data/lib/dry/configurable/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Dry
   module Configurable
     # @api public
-    VERSION = '0.9.0'.freeze
+    VERSION = '0.11.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-configurable
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2020-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.7
+- !ruby/object:Gem::Dependency
+  name: dry-equalizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,49 +100,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: A mixin to add configuration functionality to your classes
 email:
 - andyholland1991@aol.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".github/ISSUE_TEMPLATE/----please-don-t-ask-for-support-via-issues.md"
-- ".github/ISSUE_TEMPLATE/---bug-report.md"
-- ".github/ISSUE_TEMPLATE/---feature-request.md"
-- ".github/workflows/ci.yml"
-- ".github/workflows/docsite.yml"
-- ".github/workflows/sync_configs.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- docsite/source/index.html.md
-- docsite/source/testing.html.md
 - dry-configurable.gemspec
 - lib/dry-configurable.rb
 - lib/dry/configurable.rb
+- lib/dry/configurable/class_methods.rb
+- lib/dry/configurable/compiler.rb
 - lib/dry/configurable/config.rb
-- lib/dry/configurable/error.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/instance_methods.rb
+- lib/dry/configurable/methods.rb
 - lib/dry/configurable/setting.rb
 - lib/dry/configurable/settings.rb
-- lib/dry/configurable/settings/argument_parser.rb
 - lib/dry/configurable/test_interface.rb
 - lib/dry/configurable/version.rb
-- rakelib/rubocop.rake
-homepage: https://github.com/dry-rb/dry-configurable
+homepage: https://dry-rb.org/gems/dry-configurable
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/dry-rb/dry-configurable
+  allowed_push_host: https://rubygems.org
   changelog_uri: https://github.com/dry-rb/dry-configurable/blob/master/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: 
 rdoc_options: []
 require_paths:
@@ -144,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A mixin to add configuration functionality to your classes