config 2.0.0 → 3.0.0

data/config.gemspec

@@ -7,44 +7,48 @@ Gem::Specification.new do |s|
   s.version          = Config::VERSION
   s.date             = Time.now.strftime '%F'
   s.authors          = ['Piotr Kuczynski', 'Fred Wu', 'Jacques Crocker']
-  s.email            = %w(piotr.kuczynski@gmail.com ifredwu@gmail.com railsjedi@gmail.com)
+  s.email            = %w[piotr.kuczynski@gmail.com ifredwu@gmail.com railsjedi@gmail.com]
   s.summary          = 'Effortless multi-environment settings in Rails, Sinatra, Pandrino and others'
   s.description      = 'Easiest way to manage multi-environment settings in any ruby project or framework: ' +
                        'Rails, Sinatra, Pandrino and others'
-  s.homepage         = 'https://github.com/railsconfig/config'
+  s.homepage         = 'https://github.com/rubyconfig/config'
   s.license          = 'MIT'
-  s.extra_rdoc_files = %w(README.md CHANGELOG.md LICENSE.md)
+  s.extra_rdoc_files = %w[README.md CHANGELOG.md CONTRIBUTING.md LICENSE.md]
   s.rdoc_options     = ['--charset=UTF-8']
+  s.post_install_message = "\n\e[33mThanks for installing Config\e[0m
+Please consider donating to our open collective to help us maintain this project.
+\n
+Donate: \e[34mhttps://opencollective.com/rubyconfig/donate\e[0m\n"
 
   s.files = `git ls-files`.split($/)
-  s.files.select! { |file| /(^lib\/|\.md$|\.gemspec$)/ =~ file }
-  s.files += Dir.glob('doc/**/*')
+  s.files.select! { |file| /(^lib\/|^\w+.md$|\.gemspec$)/ =~ file }
 
   s.require_paths         = ['lib']
   s.required_ruby_version = '>= 2.4.0'
 
-  s.add_dependency 'activesupport', '>= 4.2'
   s.add_dependency 'deep_merge', '~> 1.2', '>= 1.2.1'
-  s.add_dependency 'dry-schema', '~> 1.0'
+  s.add_dependency 'dry-validation', '~> 1.0', '>= 1.0.0'
 
-  s.add_development_dependency 'rake',        '~> 12.0',  '>= 12.0.0'
+  s.add_development_dependency 'rake', '~> 12.0', '>= 12.0.0'
 
   # Testing
-  s.add_development_dependency 'appraisal',   '~> 2.2',   '>= 2.2.0'
-  s.add_development_dependency 'rails',       '~> 5.2',   '>= 5.2.2'
-  s.add_development_dependency 'rspec',       '~> 3.7',   '>= 3.7.0'
-  s.add_development_dependency 'rspec-rails', '~> 3.7',   '>= 3.7.2'
-  s.add_development_dependency 'test-unit',   '~> 3.2',   '>= 3.2.7'
-  s.add_development_dependency 'sqlite3',     '~> 1.3',   '>= 1.3.13'
-
-  # Static code analysis
-  s.add_development_dependency 'mdl',         '~> 0.5',   '>= 0.5.0'
-
-  # Version 0.62 requires Ruby 2.2
-  s.add_development_dependency 'rubocop',     '~> 0.62'
-
-  if ENV['TRAVIS']
-    s.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.9'
-    s.add_development_dependency 'simplecov', '~> 0.13.0'
+  s.add_development_dependency 'appraisal', '~> 2.3', '>= 2.3.0'
+  s.add_development_dependency 'rspec', '~> 3.9', '>= 3.9.0'
+
+  # Default RSpec run will test against latest Rails app
+  unless ENV['APPRAISAL_INITIALIZED'] || ENV['GITHUB_ACTIONS']
+    gems_to_install = /gem "(.*?)", "(.*?)"(?!, platform: (?!\[:ruby\]))/
+    File.read(Dir['gemfiles/rails*.gemfile'].sort.last).scan(gems_to_install) do |name, version|
+      s.add_development_dependency name, version
+    end
+  end
+
+  if ENV['GITHUB_ACTIONS']
+    # Code coverage is needed only in CI
+    s.add_development_dependency 'simplecov', '~> 0.18.5' if RUBY_ENGINE == 'ruby'
+  else
+    # Static code analysis to be used locally
+    s.add_development_dependency 'mdl', '~> 0.9', '>= 0.9.0'
+    s.add_development_dependency 'rubocop', '~> 0.85.0'
   end
 end

data/lib/config.rb

@@ -1,40 +1,35 @@
-require 'active_support/core_ext/module/attribute_accessors'
-
 require 'config/compatibility'
 require 'config/options'
+require 'config/configuration'
 require 'config/version'
-require 'config/integrations/rails/engine' if defined?(::Rails)
 require 'config/sources/yaml_source'
 require 'config/sources/hash_source'
+require 'config/sources/env_source'
 require 'config/validation/schema'
 require 'deep_merge'
 
 module Config
   extend Config::Validation::Schema
-
-  # Ensures the setup only gets run once
-  @@_ran_once = false
-
-  mattr_accessor :const_name, :use_env, :env_prefix, :env_separator,
-                 :env_converter, :env_parse_values, :fail_on_missing
-  @@const_name = 'Settings'
-  @@use_env    = false
-  @@env_prefix = @@const_name
-  @@env_separator = '.'
-  @@env_converter = :downcase
-  @@env_parse_values = true
-  @@fail_on_missing = false
-
-  # deep_merge options
-  mattr_accessor :knockout_prefix, :merge_nil_values, :overwrite_arrays, :merge_hash_arrays
-  @@knockout_prefix = nil
-  @@merge_nil_values = true
-  @@overwrite_arrays = true
-  @@merge_hash_arrays = false
+  extend Config::Configuration.new(
+    # general options
+    const_name: 'Settings',
+    use_env: false,
+    env_prefix: 'Settings',
+    env_separator: '.',
+    env_converter: :downcase,
+    env_parse_values: true,
+    fail_on_missing: false,
+    # deep_merge options
+    knockout_prefix: nil,
+    merge_nil_values: true,
+    overwrite_arrays: true,
+    merge_hash_arrays: false,
+    validation_contract: nil
+  )
 
   def self.setup
-    yield self if @@_ran_once == false
-    @@_ran_once = true
+    yield self unless @_ran_once
+    @_ran_once = true
   end
 
   # Create a populated Options instance from a settings file. If a second file is given, then the sections of that
@@ -47,8 +42,9 @@ module Config
       config.add_source!(file.to_s)
     end
 
+    config.add_source!(Sources::EnvSource.new(ENV)) if Config.use_env
+
     config.load!
-    config.load_env! if @@use_env
     config
   end
 
@@ -61,16 +57,21 @@ module Config
 
   def self.setting_files(config_root, env)
     [
-      File.join(config_root, "settings.yml").to_s,
-      File.join(config_root, "settings", "#{env}.yml").to_s,
-      File.join(config_root, "environments", "#{env}.yml").to_s,
-
-      File.join(config_root, "settings.local.yml").to_s,
-      File.join(config_root, "settings", "#{env}.local.yml").to_s,
-      File.join(config_root, "environments", "#{env}.local.yml").to_s
+      File.join(config_root, 'settings.yml').to_s,
+      File.join(config_root, 'settings', "#{env}.yml").to_s,
+      File.join(config_root, 'environments', "#{env}.yml").to_s,
+      *local_setting_files(config_root, env)
     ].freeze
   end
 
+  def self.local_setting_files(config_root, env)
+    [
+      (File.join(config_root, 'settings.local.yml').to_s if env != 'test'),
+      File.join(config_root, 'settings', "#{env}.local.yml").to_s,
+      File.join(config_root, 'environments', "#{env}.local.yml").to_s
+    ].compact
+  end
+
   def self.reload!
     Object.const_get(Config.const_name).reload!
   end

data/lib/config/configuration.rb

@@ -0,0 +1,36 @@
+module Config
+  # The main configuration backbone
+  class Configuration < Module
+    # Accepts configuration options,
+    # initializing a module that can be used to extend
+    # the necessary class with the provided config methods
+    def initialize(**attributes)
+      attributes.each do |name, default|
+        define_reader(name, default)
+        define_writer(name)
+      end
+    end
+
+    private
+
+    def define_reader(name, default)
+      variable = :"@#{name}"
+
+      define_method(name) do
+        if instance_variable_defined?(variable)
+          instance_variable_get(variable)
+        else
+          default
+        end
+      end
+    end
+
+    def define_writer(name)
+      variable = :"@#{name}"
+
+      define_method("#{name}=") do |value|
+        instance_variable_set(variable, value)
+      end
+    end
+  end
+end

data/lib/config/integrations/rails/railtie.rb

@@ -23,7 +23,7 @@ module Config
         # Development environment should reload settings on every request
         if ::Rails.env.development?
           initializer :config_reload_on_development do
-            ActionController::Base.class_eval do
+            ActiveSupport.on_load :action_controller_base do
               if ::Rails::VERSION::MAJOR >= 4
                 prepend_before_action { ::Config.reload! }
               else

data/lib/config/options.rb

@@ -31,42 +31,6 @@ module Config
       @config_sources.unshift(source)
     end
 
-    def reload_env!
-      return self if ENV.nil? || ENV.empty?
-
-      hash = Hash.new
-
-      ENV.each do |variable, value|
-        separator = Config.env_separator
-        prefix = (Config.env_prefix || Config.const_name).to_s.split(separator)
-
-        keys = variable.to_s.split(separator)
-
-        next if keys.shift(prefix.size) != prefix
-
-        keys.map! { |key|
-          case Config.env_converter
-            when :downcase then
-              key.downcase.to_sym
-            when nil then
-              key.to_sym
-            else
-              raise "Invalid ENV variables name converter: #{Config.env_converter}"
-          end
-        }
-
-        leaf = keys[0...-1].inject(hash) { |h, key|
-          h[key] ||= {}
-        }
-
-        leaf[keys.last] = Config.env_parse_values ? __value(value) : value
-      end
-
-      merge!(hash)
-    end
-
-    alias :load_env! :reload_env!
-
     # look through all our sources and rebuild the configuration
     def reload!
       conf = {}
@@ -91,7 +55,6 @@ module Config
       # swap out the contents of the OStruct with a hash (need to recursively convert)
       marshal_load(__convert(conf).marshal_dump)
 
-      reload_env! if Config.use_env
       validate!
 
       self
@@ -118,6 +81,8 @@ module Config
       result
     end
 
+    alias :to_h :to_hash
+
     def each(*args, &block)
       marshal_dump.each(*args, &block)
     end
@@ -127,6 +92,10 @@ module Config
       to_hash.to_json(*args)
     end
 
+    def as_json(options = nil)
+      to_hash.as_json(options)
+    end
+
     def merge!(hash)
       current = to_hash
       DeepMerge.deep_merge!(
@@ -143,7 +112,7 @@ module Config
     end
 
     # Some keywords that don't play nicely with OpenStruct
-    SETTINGS_RESERVED_NAMES = %w[select collect test count zip].freeze
+    SETTINGS_RESERVED_NAMES = %w[select collect test count zip min max exit!].freeze
 
     # An alternative mechanism for property access.
     # This let's you do foo['bar'] along with foo.bar.
@@ -201,7 +170,6 @@ module Config
 
       h.each do |k, v|
         k = k.to_s if !k.respond_to?(:to_sym) && k.respond_to?(:to_s)
-        s.new_ostruct_member(k)
 
         if v.is_a?(Hash)
           v = v["type"] == "hash" ? v["contents"] : __convert(v)
@@ -209,21 +177,9 @@ module Config
           v = v.collect { |e| e.instance_of?(Hash) ? __convert(e) : e }
         end
 
-        s.send("#{k}=".to_sym, v)
+        s[k] = v
       end
       s
     end
-
-    # Try to convert string to a correct type
-    def __value(v)
-      case v
-      when 'false'
-        false
-      when 'true'
-        true
-      else
-        Integer(v) rescue Float(v) rescue v
-      end
-    end
   end
 end

data/lib/config/sources/env_source.rb

@@ -0,0 +1,73 @@
+module Config
+  module Sources
+    # Allows settings to be loaded from a "flat" hash with string keys, like ENV.
+    class EnvSource
+      attr_reader :prefix
+      attr_reader :separator
+      attr_reader :converter
+      attr_reader :parse_values
+
+      def initialize(env,
+                     prefix: Config.env_prefix || Config.const_name,
+                     separator: Config.env_separator,
+                     converter: Config.env_converter,
+                     parse_values: Config.env_parse_values)
+        @env = env
+        @prefix = prefix.to_s.split(separator)
+        @separator = separator
+        @converter = converter
+        @parse_values = parse_values
+      end
+
+      def load
+        return {} if @env.nil? || @env.empty?
+
+        hash = Hash.new
+
+        @env.each do |variable, value|
+          keys = variable.to_s.split(separator)
+
+          next if keys.shift(prefix.size) != prefix
+
+          keys.map! { |key|
+            case converter
+              when :downcase then
+                key.downcase
+              when nil then
+                key
+              else
+                raise "Invalid ENV variables name converter: #{converter}"
+            end
+          }
+
+          leaf = keys[0...-1].inject(hash) { |h, key|
+            h[key] ||= {}
+          }
+
+          unless leaf.is_a?(Hash)
+            conflicting_key = (prefix + keys[0...-1]).join(separator)
+            raise "Environment variable #{variable} conflicts with variable #{conflicting_key}"
+          end
+
+          leaf[keys.last] = parse_values ? __value(value) : value
+        end
+
+        hash
+      end
+
+      private
+
+      # Try to convert string to a correct type
+      def __value(v)
+        case v
+        when 'false'
+          false
+        when 'true'
+          true
+        else
+          Integer(v) rescue Float(v) rescue v
+        end
+      end
+    end
+  end
+end

data/lib/config/validation/schema.rb

@@ -1,21 +1,20 @@
-require 'dry-schema'
-require 'config/validation/schema'
-
 module Config
   module Validation
     module Schema
-
-      mattr_writer :schema
-      @@schema = nil
+      # Assigns schema configuration option
+      def schema=(value)
+        @schema = value
+      end
 
       def schema(&block)
         if block_given?
-          @@schema = Dry::Schema.define(&block)
+          # Delay require until optional schema validation is requested
+          require 'dry-validation'
+          @schema = Dry::Schema.define(&block)
         else
-          @@schema
+          @schema
         end
       end
-
     end
   end
 end

data/lib/config/validation/validate.rb

@@ -3,18 +3,23 @@ require 'config/validation/error'
 module Config
   module Validation
     module Validate
-
       def validate!
-        if Config.schema
-          v_res = Config.schema.(self.to_hash)
+        validate_using!(Config.validation_contract)
+        validate_using!(Config.schema)
+      end
+
+      private
 
-          unless v_res.success?
-            error = Config::Validation::Error.format(v_res)
-            raise Config::Validation::Error.new("Config validation failed:\n\n#{error}")
-          end
+      def validate_using!(validator)
+        if validator
+          result = validator.call(to_hash)
+
+          return if result.success?
+
+          error = Config::Validation::Error.format(result)
+          raise Config::Validation::Error, "Config validation failed:\n\n#{error}"
         end
       end
-
     end
   end
 end