dry-configurable 0.7.0 → 0.8.0

data/lib/dry/configurable.rb

@@ -1,9 +1,6 @@
-require 'concurrent'
-require 'dry/configurable/config'
+require 'dry/core/constants'
+require 'dry/configurable/settings'
 require 'dry/configurable/error'
-require 'dry/configurable/nested_config'
-require 'dry/configurable/argument_parser'
-require 'dry/configurable/config/value'
 require 'dry/configurable/version'
 
 # A collection of micro-libraries, each intended to encapsulate
@@ -11,7 +8,7 @@ require 'dry/configurable/version'
 module Dry
   # A simple configuration mixin
   #
-  # @example
+  # @example class-level configuration
   #
   #   class App
   #     extend Dry::Configurable
@@ -21,30 +18,123 @@ module Dry
   #     end
   #   end
   #
-  #   App.configure do |config|
-  #     config.database.dsn = 'jdbc:sqlite:memory'
+  #   App.config.database.dsn = 'jdbc:sqlite:memory'
+  #   App.config.database.dsn
+  #     # => "jdbc:sqlite:memory"
+  #
+  # @example instance-level configuration
+  #
+  #   class App
+  #     include Dry::Configurable
+  #
+  #     setting :database
   #   end
   #
-  #   App.config.database.dsn
-  #     # => "jdbc:sqlite:memory'"
+  #   production = App.new
+  #   production.config.database = ENV['DATABASE_URL']
+  #   production.finalize!
+  #
+  #   development = App.new
+  #   development.config.database = 'jdbc:sqlite:memory'
+  #   development.finalize!
   #
   # @api public
   module Configurable
-    # @private
-    def self.extended(base)
-      base.class_eval do
-        @_config_mutex = ::Mutex.new
-        @_settings = ::Concurrent::Array.new
-        @_reader_attributes = ::Concurrent::Array.new
+    include Dry::Core::Constants
+
+    module ClassMethods
+      # @private
+      def self.extended(base)
+        base.instance_exec do
+          @settings = Settings.new
+        end
+      end
+
+      # Add a setting to the configuration
+      #
+      # @param [Mixed] key
+      #   The accessor key for the configuration value
+      # @param [Mixed] default
+      #   The default config value
+      #
+      # @yield
+      #   If a block is given, it will be evaluated in the context of
+      #   and new configuration class, and bound as the default value
+      #
+      # @return [Dry::Configurable::Config]
+      #
+      # @api public
+      def setting(key, value = Undefined, options = Undefined, &block)
+        extended = singleton_class < Configurable
+        raise_already_defined_config(key) if _settings.config_defined?
+
+        setting = _settings.add(key, value, options, &block)
+
+        if setting.reader?
+          readers = extended ? singleton_class : self
+          readers.send(:define_method, setting.name) { config[setting.name] }
+        end
+      end
+
+      # Return an array of setting names
+      #
+      # @return [Set]
+      #
+      # @api public
+      def settings
+        _settings.names
+      end
+
+      # @private no, really...
+      def _settings
+        @settings
+      end
+
+      private
+
+      # @private
+      def raise_already_defined_config(key)
+        raise AlreadyDefinedConfig,
+              "Cannot add setting +#{key}+, #{self} is already configured"
+      end
+
+      # @private
+      def inherited(subclass)
+        parent = self
+        subclass.instance_exec do
+          @settings = parent._settings.dup
+        end
+
+        if singleton_class < Configurable
+          parent_config = @config
+          subclass.instance_exec do
+            @config = _settings.create_config
+            @config.define!(parent_config.to_h) if parent_config.defined?
+          end
+        end
+
+        super
+      end
+    end
+
+    class << self
+      # @private
+      def extended(base)
+        base.extend(ClassMethods)
+        base.class_eval do
+          @config = _settings.create_config
+        end
+      end
+
+      # @private
+      def included(base)
+        base.extend(ClassMethods)
       end
     end
 
     # @private
-    def inherited(subclass)
-      subclass.instance_variable_set(:@_config_mutex, ::Mutex.new)
-      subclass.instance_variable_set(:@_settings, @_settings.clone)
-      subclass.instance_variable_set(:@_reader_attributes, @_reader_attributes.clone)
-      subclass.instance_variable_set(:@_config, @_config.clone) if defined?(@_config)
+    def initialize(*)
+      @config = self.class._settings.create_config
       super
     end
 
@@ -54,8 +144,8 @@ module Dry
     #
     # @api public
     def config
-      return @_config if defined?(@_config)
-      create_config
+      return @config if @config.defined?
+      @config.define!
     end
 
     # Return configuration
@@ -66,8 +156,9 @@ module Dry
     #
     # @api public
     def configure
-      raise_frozen_config if frozen?
-      yield(config) if block_given?
+      raise FrozenConfig, 'Cannot modify frozen config' if frozen?
+      yield(config)
+      self
     end
 
     # Finalize and freeze configuration
@@ -79,107 +170,5 @@ module Dry
       freeze
       config.finalize!
     end
-
-    # Add a setting to the configuration
-    #
-    # @param [Mixed] key
-    #   The accessor key for the configuration value
-    # @param [Mixed] default
-    #   The default config value
-    #
-    # @yield
-    #   If a block is given, it will be evaluated in the context of
-    #   and new configuration class, and bound as the default value
-    #
-    # @return [Dry::Configurable::Config]
-    #
-    # @api public
-    def setting(key, *args, &block)
-      raise_already_defined_config(key) if defined?(@_config)
-      value, options = ArgumentParser.call(args)
-      if block
-        if block.parameters.empty?
-          value = _config_for(&block)
-        else
-          processor = block
-        end
-      end
-
-      _settings << ::Dry::Configurable::Config::Value.new(
-        key,
-        !value.nil? ? value : ::Dry::Configurable::Config::Value::NONE,
-        processor || ::Dry::Configurable::Config::DEFAULT_PROCESSOR
-      )
-      store_reader_options(key, options) if options.any?
-    end
-
-    # Return an array of setting names
-    #
-    # @return [Array]
-    #
-    # @api public
-    def settings
-      _settings.map(&:name)
-    end
-
-    # @private no, really...
-    def _settings
-      @_settings
-    end
-
-    def _reader_attributes
-      @_reader_attributes
-    end
-
-    private
-
-    # @private
-    def _config_for(&block)
-      ::Dry::Configurable::NestedConfig.new(&block)
-    end
-
-    # @private
-    def create_config
-      @_config_mutex.synchronize do
-        create_config_for_nested_configurations
-        @_config = ::Dry::Configurable::Config.create(_settings) unless _settings.empty?
-      end
-    end
-
-    # @private
-    def create_config_for_nested_configurations
-      nested_configs.map(&:create_config)
-    end
-
-    # @private
-    def nested_configs
-      _settings.select { |setting| setting.value.is_a?(::Dry::Configurable::NestedConfig) }.map(&:value)
-    end
-
-    # @private
-    def raise_already_defined_config(key)
-      raise AlreadyDefinedConfig,
-            "Cannot add setting +#{key}+, #{self} is already configured"
-    end
-
-    # @private
-    def raise_frozen_config
-      raise FrozenConfig, 'Cannot modify frozen config'
-    end
-
-    # @private
-    def store_reader_options(key, options)
-      _reader_attributes << key if options.fetch(:reader, false)
-    end
-
-    # @private
-    def method_missing(method, *args, &block)
-      _reader_attributes.include?(method) ? config.public_send(method, *args, &block) : super
-    end
-
-    # @private
-    def respond_to_missing?(method, _include_private = false)
-      _reader_attributes.include?(method) || super
-    end
   end
 end

metadata

@@ -1,69 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: dry-configurable
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-25 00:00:00.000000000 Z
+date: 2019-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dry-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -73,12 +93,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .codeclimate.yml
-- .gitignore
-- .rspec
-- .ruby-version
-- .travis.yml
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -86,21 +106,15 @@ files:
 - dry-configurable.gemspec
 - lib/dry-configurable.rb
 - lib/dry/configurable.rb
-- lib/dry/configurable/argument_parser.rb
 - lib/dry/configurable/config.rb
-- lib/dry/configurable/config/value.rb
 - lib/dry/configurable/error.rb
-- lib/dry/configurable/nested_config.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
-- spec/integration/configurable_spec.rb
-- spec/spec_helper.rb
-- spec/support/shared_examples/configurable.rb
-- spec/unit/dry/configurable/argument_parser_spec.rb
-- spec/unit/dry/configurable/config/value_spec.rb
-- spec/unit/dry/configurable/config_spec.rb
-homepage: https://github.com/dryrb/dry-configurable
+homepage: https://github.com/dry-rb/dry-configurable
 licenses:
 - MIT
 metadata: {}
@@ -110,24 +124,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: A mixin to add configuration functionality to your classes
-test_files:
-- spec/integration/configurable_spec.rb
-- spec/spec_helper.rb
-- spec/support/shared_examples/configurable.rb
-- spec/unit/dry/configurable/argument_parser_spec.rb
-- spec/unit/dry/configurable/config/value_spec.rb
-- spec/unit/dry/configurable/config_spec.rb
+test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.0.0-p247

data/lib/dry/configurable/argument_parser.rb

@@ -1,91 +0,0 @@
-module Dry
-  # Argument parser
-  #
-  # Passing and array or arguments, it will decide wich one are arguments
-  # and which one are options.
-  #
-  # We have a limitation if setting the value without options, as a hash
-  # having the same key as one of the valid options, will parse the value
-  # as options.
-  #
-  # @example
-  #   p = Dry::Configurable::ArgumentParser.new(['db:sqlite', { reader: true })
-  #
-  #   p.value # => 'db:sqlite'
-  #   p.options # => { reader: true }
-  #
-  #   Dry::Configurable::ArgumentParser.call(['db:sqlite', { reader: true })
-  #    # => [ 'db:sqlite', { reader: true } ]
-  module Configurable
-    # @private
-    class ArgumentParser
-      VALID_OPTIONS = %i(reader).freeze
-
-      def self.call(data)
-        parsed = new(data)
-        [parsed.value, parsed.options]
-      end
-
-      def initialize(data)
-        @data = data
-      end
-
-      def value
-        parse_args[:value]
-      end
-
-      def options
-        parse_args[:options]
-      end
-
-      private
-
-      attr_reader :data
-
-      # @private
-      def default_args
-        { value: nil, options: {} }
-      end
-
-      # @private
-      def parse_args
-        return default_args if data.empty?
-        if data.size > 1
-          { value: data.first, options: check_options(data.last) }
-        else
-          default_args.merge(check_for_value_or_options(data.first))
-        end
-      end
-
-      # @private
-      def check_options(opts)
-        return {} if opts.empty?
-        opts.select { |k, _| VALID_OPTIONS.include?(k) }
-      end
-
-      # @private
-      def check_for_value_or_options(args)
-        case args
-        when Hash
-          parse_hash(args)
-        else
-          { value: args }
-        end
-      end
-
-      # @private
-      def parse_hash(args)
-        if hash_include_options_key(args)
-          { options: check_options(args) }
-        else
-          { value: args }
-        end
-      end
-
-      # @private
-      def hash_include_options_key(hash)
-        hash.any? { |k, _| VALID_OPTIONS.include?(k) }
-      end
-    end
-  end
-end

data/lib/dry/configurable/config/value.rb

@@ -1,27 +0,0 @@
-module Dry
-  module Configurable
-    class Config
-      # @private
-      class Value
-        # @private
-        NONE = ::Object.new.freeze
-
-        attr_reader :name, :processor
-
-        def initialize(name, value, processor)
-          @name = name.to_sym
-          @value = value
-          @processor = processor
-        end
-
-        def value
-          none? ? nil : @value
-        end
-
-        def none?
-          @value.equal?(::Dry::Configurable::Config::Value::NONE)
-        end
-      end
-    end
-  end
-end

data/lib/dry/configurable/nested_config.rb

@@ -1,33 +0,0 @@
-module Dry
-  module Configurable
-    # @private
-    class NestedConfig
-      def initialize(&block)
-        klass = ::Class.new { extend ::Dry::Configurable }
-        klass.instance_eval(&block)
-        @klass = klass
-      end
-
-      # @private no, really...
-      def create_config
-        if @klass.instance_variables.include?(:@_config)
-          @klass.__send__(:create_config)
-        end
-      end
-
-      private
-
-      def config
-        @klass.config
-      end
-
-      def method_missing(method, *args, &block)
-        config.respond_to?(method) ? config.public_send(method, *args, &block) : super
-      end
-
-      def respond_to_missing?(method, _include_private = false)
-        config.respond_to?(method) || super
-      end
-    end
-  end
-end

data/spec/integration/configurable_spec.rb

@@ -1,25 +0,0 @@
-RSpec.describe Dry::Configurable do
-  context 'when extended' do
-    let(:klass) do
-      Class.new do
-        extend Dry::Configurable
-      end
-    end
-
-    it_behaves_like 'a configurable class'
-  end
-
-  context 'when extended then inherited' do
-    let(:base_klass) do
-      Class.new do
-        extend Dry::Configurable
-      end
-    end
-
-    let(:klass) do
-      Class.new(base_klass)
-    end
-
-    it_behaves_like 'a configurable class'
-  end
-end