dry-configurable 0.9.0

data/lib/dry/configurable/error.rb

@@ -0,0 +1,7 @@
+module Dry
+  module Configurable
+    Error = Class.new(::StandardError)
+    AlreadyDefinedConfig = ::Class.new(Error)
+    FrozenConfig = ::Class.new(Error)
+  end
+end

data/lib/dry/configurable/setting.rb

@@ -0,0 +1,46 @@
+module Dry
+  module Configurable
+    # This class represents a setting and is used internally.
+    #
+    # @private
+    class Setting
+      VALID_NAME = /\A[a-z_]\w*\z/i
+
+      attr_reader :name
+
+      attr_reader :options
+
+      attr_reader :processor
+
+      def initialize(name, value, processor, options = EMPTY_HASH)
+        unless VALID_NAME =~ name.to_s
+          raise ArgumentError, "+#{name}+ is not a valid setting name"
+        end
+        @name = name.to_sym
+        @value = value
+        @processor = processor
+        @options = options
+      end
+
+      def value
+        Undefined.default(@value, nil)
+      end
+
+      def undefined?
+        Undefined.equal?(@value)
+      end
+
+      def reader?
+        options[:reader]
+      end
+
+      def node?
+        Settings === @value
+      end
+
+      def reserved?
+        options[:reserved]
+      end
+    end
+  end
+end

data/lib/dry/configurable/settings.rb

@@ -0,0 +1,117 @@
+require 'set'
+require 'concurrent/array'
+require 'dry/configurable/settings/argument_parser'
+require 'dry/configurable/setting'
+require 'dry/configurable/config'
+
+module Dry
+  module Configurable
+    # A collection of settings. This is not part of the public 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
+
+      attr_reader :config_class
+
+      attr_reader :index
+      private :index
+
+      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?
+      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
+      end
+
+      def [](name)
+        index[name]
+      end
+
+      def empty?
+        settings.empty?
+      end
+
+      def name?(name)
+        index.key?(name)
+      end
+
+      def dup
+        Settings.new(settings.dup)
+      end
+
+      def freeze
+        settings.freeze
+        super
+      end
+
+      def create_config
+        config_class.new
+      end
+
+      def config_defined?
+        config_class.config_defined?
+      end
+
+      def reserved?(name)
+        reserved_names.include?(name)
+      end
+
+      def reserved_names
+        @reserved_names ||= [
+          config_class.instance_methods(false),
+          config_class.superclass.instance_methods(false),
+          %i(class public_send)
+        ].reduce(:+)
+      end
+    end
+  end
+end

data/lib/dry/configurable/settings/argument_parser.rb

@@ -0,0 +1,50 @@
+module Dry
+  # Argument parser
+  #
+  # Passing and array or arguments, it will decide which 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. In this case, all unknown options will be reject with an exception.
+  #
+  # @example
+  #   p = Dry::Configurable::ArgumentParser.new.('db:sqlite', reader: true)
+  #
+  #   p[0] # => 'db:sqlite'
+  #   p[1] # => ArgumentParser::DEFAULT_PROCESSOR
+  #   p[2] # => { reader: true }
+  module Configurable
+    class Settings
+      # @private
+      class ArgumentParser
+        DEFAULT_PROCESSOR = ->(v) { v }
+
+        # @private
+        def call(val, opts, block)
+          if block && block.parameters.empty?
+            raise ArgumentError unless Undefined.equal?(opts)
+
+            processor = DEFAULT_PROCESSOR
+
+            value, options = Settings.capture(&block), val
+          else
+            processor = block || DEFAULT_PROCESSOR
+
+            if Undefined.equal?(opts) && val.is_a?(Hash) && val.key?(:reader)
+              value, options = Undefined, val
+            else
+              value, options = val, opts
+            end
+          end
+
+          [value, processor, options(**Undefined.default(options, EMPTY_HASH))]
+        end
+
+        def options(reader: false)
+          { reader: reader }
+        end
+      end
+    end
+  end
+end

data/lib/dry/configurable/test_interface.rb

@@ -0,0 +1,26 @@
+module Dry
+  module Configurable
+    # Methods meant to be used in a testing scenario
+    module TestInterface
+      # Resets configuration to default values
+      #
+      # @return [Dry::Configurable::Config]
+      #
+      # @api public
+      def reset_config
+        @config = if self.is_a?(Module)
+                    _settings.create_config
+                  else
+                    self.class._settings.create_config
+                  end
+      end
+    end
+
+    # Mixes in test interface into the configurable module
+    #
+    # @api public
+    def enable_test_interface
+      extend Dry::Configurable::TestInterface
+    end
+  end
+end

data/lib/dry/configurable/version.rb

@@ -0,0 +1,6 @@
+module Dry
+  module Configurable
+    # @api public
+    VERSION = '0.9.0'.freeze
+  end
+end

data/rakelib/rubocop.rake

@@ -0,0 +1,18 @@
+begin
+  require 'rubocop/rake_task'
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << '--display-cop-names'
+  end
+
+  namespace :rubocop do
+    desc 'Generate a configuration file acting as a TODO list.'
+    task :auto_gen_config do
+      exec 'bundle exec rubocop --auto-gen-config'
+    end
+  end
+
+rescue LoadError
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: dry-configurable
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Andy Holland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-06 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: 
+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/config.rb
+- lib/dry/configurable/error.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
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/dry-rb/dry-configurable
+  changelog_uri: https://github.com/dry-rb/dry-configurable/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A mixin to add configuration functionality to your classes
+test_files: []