dry-configurable 0.7.0 → 0.9.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.4.0, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct)

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Issue Guidelines
+
+## Reporting bugs
+
+If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
+
+## Reporting feature requests
+
+Report a feature request **only after discussing it first on [discourse.dry-rb.org](https://discourse.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
+
+## Reporting questions, support requests, ideas, concerns etc.
+
+**PLEASE DON'T** - use [discourse.dry-rb.org](http://discourse.dry-rb.org) instead.
+
+# Pull Request Guidelines
+
+A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
+
+Other requirements:
+
+1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
+2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
+3) Add API documentation if it's a new feature
+4) Update API documentation if it changes an existing feature
+5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
+
+# Asking for help
+
+If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org) or join [our chat](https://dry-rb.zulipchat.com).

data/Gemfile

@@ -7,10 +7,14 @@ group :test do
     gem 'codeclimate-test-reporter', require: false
     gem 'simplecov', require: false
   end
+
+  gem 'warning'
 end
 
 group :tools do
   gem 'guard'
   gem 'guard-rspec'
   gem 'listen', '3.0.6'
+  gem 'pry-byebug', platform: :mri
+  gem "ossy", git: "https://github.com/solnic/ossy.git", branch: "master"
 end

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2017 dry-rb
+Copyright (c) 2015-2019 dry-rb team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -1,47 +1,35 @@
 [gitter]: https://gitter.im/dry-rb/chat
 [gem]: https://rubygems.org/gems/dry-configurable
 [travis]: https://travis-ci.org/dry-rb/dry-configurable
-[code_climate]: https://codeclimate.com/github/dry-rb/dry-configurable
 [inch]: http://inch-ci.org/github/dry-rb/dry-configurable
+[chat]: https://dry-rb.zulipchat.com
 
-# dry-configurable [![Join the Gitter chat](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+# dry-configurable [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://img.shields.io/gem/v/dry-configurable.svg)][gem]
 [![Build Status](https://img.shields.io/travis/dry-rb/dry-configurable.svg)][travis]
-[![Code Climate](https://img.shields.io/codeclimate/github/dry-rb/dry-configurable.svg)][code_climate]
-[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/dry-rb/dry-configurable.svg)][code_climate]
+[![Maintainability](https://api.codeclimate.com/v1/badges/25311e81391498d6b7c8/maintainability)](https://codeclimate.com/github/dry-rb/dry-configurable/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/25311e81391498d6b7c8/test_coverage)](https://codeclimate.com/github/dry-rb/dry-configurable/test_coverage)
 [![API Documentation Coverage](http://inch-ci.org/github/dry-rb/dry-configurable.svg)][inch]
 
-## Synopsis
+## Installation
+
+Add this line to your application's Gemfile:
 
 ```ruby
-class App
-  extend Dry::Configurable
-
-  # Pass a block for nested configuration (works to any depth)
-  setting :database do
-    # Can pass a default value
-    setting :dsn, 'sqlite:memory'
-  end
-  # Defaults to nil if no default value is given
-  setting :adapter
-  # Passing the reader option as true will create reader method for the class
-  setting :pool, 5, reader: true
-  # Passing the reader attributes works with nested configuration
-  setting :uploader, reader: true do
-    setting :bucket, 'dev'
-  end
-end
-
-App.configure do |config|
-  config.database.dsn = 'jdbc:sqlite:memory'
-end
-
-App.config.database.dsn
-# => 'jdbc:sqlite:memory'
-App.config.adapter # => nil
-App.pool # => 5
-App.uploader.bucket # => 'dev'
+gem 'dry-configurable'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install dry-configurable
 ```
 
 ## Links

data/docsite/source/index.html.md

@@ -0,0 +1,55 @@
+---
+title: Introduction & Usage
+description: Thread-safe configuration mixin
+layout: gem-single
+order: 7
+type: gem
+name: dry-configurable
+sections:
+  - testing
+---
+
+### Introduction
+
+`dry-configurable` is a simple mixin to add thread-safe configuration behaviour to your classes. There are many libraries that make use of configuration, and each seemed to have their own implementation with a similar or duplicate interface, so we thought it was strange that this behaviour had not already been encapsulated into a reusable gem, hence `dry-configurable` was born.
+
+### Usage
+
+`dry-configurable` is extremely simple to use, just extend the mixin and use the `setting` macro to add configuration options:
+
+```ruby
+class App
+  extend Dry::Configurable
+
+  # Pass a block for nested configuration (works to any depth)
+  setting :database do
+    # Can pass a default value
+    setting :dsn, 'sqlite:memory'
+  end
+  # Defaults to nil if no default value is given
+  setting :adapter
+  # Pre-process values
+  setting(:path, 'test') { |value| Pathname(value) }
+  # Passing the reader option as true will create attr_reader method for the class
+  setting :pool, 5, reader: true
+  # Passing the reader attributes works with nested configuration
+  setting :uploader, reader: true do
+    setting :bucket, 'dev'
+  end
+end
+
+App.config.database.dsn
+# => "sqlite:memory"
+
+App.config.database.dsn = 'jdbc:sqlite:memory'
+App.config.database.dsn
+# => "jdbc:sqlite:memory"
+App.config.adapter
+# => nil
+App.config.path
+# => #<Pathname:test>
+App.pool
+# => 5
+App.uploader.bucket
+# => 'dev'
+```

data/docsite/source/testing.html.md

@@ -0,0 +1,27 @@
+---
+title: Testing
+layout: gem-single
+name: dry-configurable
+---
+
+### How to reset the config to its original state on testing environment
+
+update `spec_helper.rb` :
+
+```ruby
+require "dry/configurable/test_interface"
+
+# this is your module/class that extended by Dry::Configurable
+module AwesomeModule
+  enable_test_interface
+end
+```
+
+and on spec file (`xxx_spec.rb`) :
+
+```ruby 
+before(:all) { AwesomeModule.reset_config }
+# or 
+before(:each) { AwesomeModule.reset_config }
+
+```

data/dry-configurable.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 require File.expand_path('../lib/dry/configurable/version', __FILE__)
 
 Gem::Specification.new do |spec|
@@ -7,15 +6,22 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Andy Holland']
   spec.email         = ['andyholland1991@aol.com']
   spec.summary       = 'A mixin to add configuration functionality to your classes'
-  spec.homepage      = 'https://github.com/dryrb/dry-configurable'
+  spec.homepage      = 'https://github.com/dry-rb/dry-configurable'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|bin)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.metadata = {
+    'source_code_uri' => 'https://github.com/dry-rb/dry-configurable',
+    'changelog_uri' => 'https://github.com/dry-rb/dry-configurable/blob/master/CHANGELOG.md'
+  }
+
+  spec.required_ruby_version = ">= 2.4.0"
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
+  spec.add_runtime_dependency 'dry-core', '~> 0.4', '>= 0.4.7'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

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,122 @@ 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
+      #   a new configuration class, and bound as the default value
+      #
+      # @return [Dry::Configurable::Config]
+      #
+      # @api public
+      def setting(key, value = Undefined, options = Undefined, &block)
+        raise_already_defined_config(key) if _settings.config_defined?
+
+        setting = _settings.add(key, value, options, &block)
+
+        if setting.reader?
+          readers = singleton_class < Configurable ? 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 +143,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 +155,9 @@ module Dry
     #
     # @api public
     def configure
-      raise_frozen_config if frozen?
+      raise FrozenConfig, 'Cannot modify frozen config' if frozen?
       yield(config) if block_given?
+      self
     end
 
     # Finalize and freeze configuration
@@ -80,106 +170,22 @@ module Dry
       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
+    def dup
+      super.tap do |copy|
+        copy.instance_variable_set(:@config, config.dup)
       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?
+    def clone
+      if frozen?
+        super
+      else
+        super.tap do |copy|
+          copy.instance_variable_set(:@config, config.dup)
+        end
       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