config 2.0.0 → 2.2.3

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/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

@@ -59,6 +59,11 @@ module Config
           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] = Config.env_parse_values ? __value(value) : value
       end
 
@@ -127,6 +132,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 +152,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 +210,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,7 +217,7 @@ 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

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

data/lib/config/version.rb

@@ -1,3 +1,3 @@
 module Config
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.2.3'.freeze
 end

data/lib/config.rb

@@ -1,9 +1,7 @@
-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/validation/schema'
@@ -11,30 +9,26 @@ 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
@@ -48,7 +42,6 @@ module Config
     end
 
     config.load!
-    config.load_env! if @@use_env
     config
   end
 
@@ -61,16 +54,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/generators/config/templates/config.rb

@@ -21,7 +21,12 @@ Config.setup do |config|
 
   # Define ENV variable prefix deciding which variables to load into config.
   #
-  # config.env_prefix = 'Settings'
+  # Reading variables from ENV is case-sensitive. If you define lowercase value below, ensure your ENV variables are
+  # prefixed in the same way.
+  #
+  # When not set it defaults to `config.const_name`.
+  #
+  config.env_prefix = 'SETTINGS'
 
   # What string to use as level separator for settings loaded from ENV variables. Default value of '.' works well
   # with Heroku, but you might want to change it for example for '__' to easy override settings from command line, where

metadata

@@ -1,31 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: config
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.3
 platform: ruby
 authors:
 - Piotr Kuczynski
 - Fred Wu
 - Jacques Crocker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-22 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: deep_merge
   requirement: !ruby/object:Gem::Requirement
@@ -47,12 +33,15 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.1
 - !ruby/object:Gem::Dependency
-  name: dry-schema
+  name: dry-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -60,180 +49,145 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '3.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.2
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '3.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.2
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bootsnap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.7.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.7.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.7.2
+        version: 6.0.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.7.2
+        version: 6.0.3.1
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.7
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.7
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: mdl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.13
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.13
-- !ruby/object:Gem::Dependency
-  name: mdl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.62'
+        version: 0.85.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.62'
+        version: 0.85.0
 description: 'Easiest way to manage multi-environment settings in any ruby project
   or framework: Rails, Sinatra, Pandrino and others'
 email:
@@ -245,16 +199,18 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - CHANGELOG.md
+- CONTRIBUTING.md
 - LICENSE.md
 files:
 - CHANGELOG.md
+- CONTRIBUTING.md
 - LICENSE.md
 - README.md
 - config.gemspec
 - lib/config.rb
 - lib/config/compatibility.rb
+- lib/config/configuration.rb
 - lib/config/integrations/heroku.rb
-- lib/config/integrations/rails/engine.rb
 - lib/config/integrations/rails/railtie.rb
 - lib/config/integrations/sinatra.rb
 - lib/config/options.rb
@@ -273,14 +229,12 @@ files:
 - lib/generators/config/templates/settings/development.yml
 - lib/generators/config/templates/settings/production.yml
 - lib/generators/config/templates/settings/test.yml
-- spec/app/rails_5.1/README.md
-- spec/app/rails_5.2/README.md
-- spec/app/rails_5/README.md
-homepage: https://github.com/railsconfig/config
+homepage: https://github.com/rubyconfig/config
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "\n\e[33mThanks for installing Config\e[0m\nPlease consider
+  donating to our open collective to help us maintain this project.\n\n\nDonate: \e[34mhttps://opencollective.com/rubyconfig/donate\e[0m\n"
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -296,8 +250,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Effortless multi-environment settings in Rails, Sinatra, Pandrino and others
 test_files: []

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

@@ -1,9 +0,0 @@
-module Config
-  module Integrations
-    module Rails
-      class Engine < ::Rails::Engine
-        isolate_namespace Config
-      end
-    end
-  end
-end