config 2.2.1 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 554478f496c7582db5d4a3965d44499cde1b9d739002cf9e828eb0578de3b356
-  data.tar.gz: d3d21afa1efa34e03d958e4ae347de44ff00f2e1f45ffdeceef8785bfcb41b61
+  metadata.gz: 9695bee8465b0c65165242a23d7df19a04047c78d131587f87b5c0e356930a6c
+  data.tar.gz: 13b9ee27af8ad78c2450111854c1f8498b1019d0cd8c358eaa986bd0d01b8541
 SHA512:
-  metadata.gz: bde322b8eb560783917d36ebcaea664d10b255ccdf915b86fa8330b3e7ed50aba4c3f66ba265f5b2bd896a679bd74ccc6add60e2f5d92a088fb8c1d61cafce75
-  data.tar.gz: 81895a02cdda30016f6dc80d2f6a5d3e01669d884ee177ec5bbdc910938a4e3f5964749416694afa99b375316735ba98c1a375ee90430a847b6ee5cd68e64809
+  metadata.gz: a15b3c5112f4f776f2df92d28fa4ac8d6d0dc92eeb294b863b0be055696d8a3cc7de4abbd44aab28cd31c9e2d716e8debbcae84a439758bd1ac9d5c4415da264
+  data.tar.gz: 65b04c96cf9e826fccceeff15a5897c19e2a617ab131922c1ab395dfe4aad8fe6320c5c5916b07f80c75c98369460cd9a252201d684da667a37a543edea4651e

data/CHANGELOG.md

@@ -1,8 +1,113 @@
 # Changelog
 
-## Unreleased
+## 5.4.0
 
-...
+### New features
+
+* Add configuration option `environment` to override the use of `Rails.env` ([#356](https://github.com/rubyconfig/config/pull/356))
+
+## 5.3.0
+
+* Remove `dry-validation` from dependencies ([#333](https://github.com/rubyconfig/config/pull/333))
+
+## 5.2.0
+
+### New features
+
+* Allow to use custom filename && directory name to store configs ([#341](https://github.com/rubyconfig/config/pull/341))
+
+### Bug fixes
+
+* Prevent name collision with private methods from ancestors ([#351](https://github.com/rubyconfig/config/pull/351))
+
+## 5.1.0
+
+* Fix conflicts with Rails 7 active_support methods ([#347](https://github.com/rubyconfig/config/pull/347))
+
+## 5.0.0
+
+### BREAKING CHANGES
+
+* No longer load `deep_merge`'s monkey patch for `Hash#deep_merge` and `Hash#deep_merge!` ([#342](https://github.com/rubyconfig/config/pull/342)). If you rely on those methods and are not using Rails / Active Support, you can load the monkey patch via `require 'deep_merge/deep_merge_hash'`. This change fixes Rails 7.x support.
+
+## 4.2.1
+
+### Bug fixes
+
+* Address edge case with `table` config param ([#339](https://github.com/rubyconfig/config/pull/339))
+
+## 4.2.0
+
+### Bug fixes
+
+* Remove use of method `File.exists?` to fix use in Ruby 3.0 ([#318](https://github.com/rubyconfig/config/pull/318))
+
+## 4.1.0
+
+### Bug fixes
+
+* Only load `Railtie` integration if `Rails::Railtie` is defined ([#319](https://github.com/rubyconfig/config/pull/319))
+* Fix indentation warning in Ruby 3.1 ([#322](https://github.com/rubyconfig/config/pull/322))
+
+## 4.0.0
+
+### BREAKING CHANGES
+
+* Rails versions `< 5.2` are no longer supported ([#316](https://github.com/rubyconfig/config/pull/316))
+* Ruby versions `< 2.6` are no longer supported ([#316](https://github.com/rubyconfig/config/pull/316))
+* Support `HashSource` and `EnvSource` instances in `Config.load_files` and `Config.load_and_set_settings`. ([#315](https://github.com/rubyconfig/config/pull/315)). There are a few subtle breaking changes:
+  * Previously, `Config.load_files` (called from `Config.load_and_set_settings`) would call `.to_s` on each of its arguments. Now, this responsibility is defered to YAMLSource. In effect, if your application passes String or Pathname objects to `Config.load_files`, no changes are necessary, but if you were somehow relying on the `.to_s` call for some other type of object, you'll now need to call `.to_s` on that object before passing it to `Config`.
+  * Before this change, `Config.load_files` would call `uniq` on its argument array. This call has been removed, so duplicate file paths are not removed before further processing. In some cases, this can cause differences in behavior since later config files override the values in earlier ones. In most cases, it's best to ensure that duplicate paths are not passed to `Config.load_files`.
+
+## 3.1.1
+
+### Bug fixes
+
+* Allow the use of unsafe YAML parsing features when using psych >= 4 ([#306](https://github.com/railsconfig/config/issues/306))
+
+## 3.1.0
+
+### New features
+
+* Evaluating ERB in YAML files can now be disabled with `Config.evaluate_erb_in_yaml = false`. The default value for this option is `true` for backwards-compatibility. ([#303](https://github.com/rubyconfig/config/pull/303))
+
+## 3.0.0
+
+### BREAKING CHANGES
+
+* After upgrade behaviour of `to_h` would change and match behaviour of `to_hash`. Check [#217](https://github.com/rubyconfig/config/issues/217#issuecomment-741953382) for more details.
+* `Config::Options#load_env!` and `Config::Options#reload_env!` have been removed. If you need to reload settings after modifying the `ENV` hash, use `Config.reload!` or `Config::Options#reload!` instead.
+
+### Bug fixes
+
+* Added alias `to_h` for `to_hash` ([#277](https://github.com/railsconfig/config/issues/277))
+
+### Changes
+
+* Add `Config::Sources::EnvSource` for loading settings from flat `Hash`es with `String` keys and `String` values, such as from AWS SecretsManager ([#299](https://github.com/railsconfig/config/pull/299))
+
+## 2.2.3
+
+### Bug fixes
+
+* Revert added alias to_h for to_hash ([#277](https://github.com/railsconfig/config/issues/277))
+
+### Changes
+
+* Raise explicit error on environment variable conflicts ([#293](https://github.com/railsconfig/config/issues/293))
+
+## 2.2.2
+
+### Bug fixes
+
+* Added alias to_h for to_hash ([#277](https://github.com/railsconfig/config/issues/277))
+* Prevent unnecessary doubled loading of environment variables ([#291](https://github.com/rubyconfig/config/pull/291))
+* Return `Hash` from `Config::Options#as_json` instead of `Array` of pairs when using ActiveSupport Core Extensions ([#292](https://github.com/rubyconfig/config/pull/292))
+
+### Changes
+
+* Add JRuby 9.2 to the test matrix ([#228](https://github.com/railsconfig/config/issues/228))
+* Add exit! to reserved keywords ([#289](https://github.com/railsconfig/config/issues/289))
 
 ## 2.2.1
 
@@ -16,7 +121,7 @@
 
 * Fix missing new_ostruct_member in Ruby 2.7 ([#255](https://github.com/rubyconfig/config/pull/255))
 * Fix validation contract documentation ([#260](https://github.com/rubyconfig/config/pull/260))
-* Fix validation contract documentation ([#260](https://github.com/rubyconfig/config/pull/260))
+* Excluded test application's *.md files from the gem build ([#267](https://github.com/rubyconfig/config/pull/267))
 
 ### Changes
 

data/CONTRIBUTING.md

@@ -3,7 +3,7 @@
 Install appraisal
 
 ```bash
-gem install bundler -v 1.17.3
+gem install bundler
 gem install appraisal
 ```
 
@@ -16,13 +16,19 @@ bundle install
 Bootstrap
 
 ```bash
-appraisal install
+bundle exec appraisal install
+```
+
+If you need to create new test app for specific rails version
+
+```bash
+bundle exec appraisal rails-7.0 rails new spec/app/rails_7.0
 ```
 
 Run the test suite:
 
 ```bash
-appraisal rspec
+bundle exec appraisal rspec
 ```
 
 If you modified any of the documentation files verify their format:

data/README.md

@@ -1,9 +1,8 @@
 # Config
 
-[![Gem Version](https://badge.fury.io/rb/config.svg)](http://badge.fury.io/rb/config)
+[![Version](https://img.shields.io/gem/v/config)](https://rubygems.org/gems/config)
+[![Downloads Total](https://img.shields.io/gem/dt/config)](https://rubygems.org/gems/config)
 [![Tests](https://github.com/rubyconfig/config/workflows/tests/badge.svg)](https://github.com/rubyconfig/config/actions?query=branch%3Amaster)
-[![Maintainability](https://api.codeclimate.com/v1/badges/85c206c13dce7de090af/maintainability)](https://codeclimate.com/github/rubyconfig/config/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/85c206c13dce7de090af/test_coverage)](https://codeclimate.com/github/rubyconfig/config/test_coverage)
 [![Financial Contributors on Open Collective](https://opencollective.com/rubyconfig/all/badge.svg?label=backers)](https://opencollective.com/rubyconfig)
 
 ## Summary
@@ -21,16 +20,21 @@ Config helps you easily manage environment specific settings in an easy and usab
 
 ## Compatibility
 
+Current version supports and is [tested](.github/workflows/tests.yml#L19) for the following interpreters and frameworks:
+
 * Interpreters
-  * [Ruby](https://www.ruby-lang.org/en/) `>= 2.4`
-  * [TruffleRuby](https://github.com/oracle/truffleruby) `>= 19.0.0`
+  * [Ruby](https://www.ruby-lang.org) `>= 2.6`
+  * [JRuby](https://www.jruby.org) `>= 9.2`
+  * [TruffleRuby](https://github.com/oracle/truffleruby) `>= 19.3`
 * Application frameworks
-  * Rails `>= 4.2` and `5`
+  * Rails `>= 5.2`
   * Padrino
   * Sinatra
 
 For Ruby `2.0` to `2.3` or Rails `3` to `4.1` use version `1.x` of this gem. For older versions of Rails or Ruby use [AppConfig](http://github.com/fredwu/app_config).
 
+For Ruby `2.4` or `2.5` or Rails `4.2`, `5.0`, or `5.1` use version `3.x` of this gem.
+
 ## Installing
 
 ### Installing on Rails
@@ -42,12 +46,15 @@ Add `gem 'config'` to your `Gemfile` and run `bundle install` to install it. The
 which will generate customizable config file `config/initializers/config.rb` and set of default settings files:
 
     config/settings.yml
+    config/settings.local.yml
     config/settings/development.yml
     config/settings/production.yml
     config/settings/test.yml
 
 You can now edit them to adjust to your needs.
 
+> Note: By default, the config environment will match the Rails environment (`Rails.env`). This can be changed by setting `config.environment`.
+
 ### Installing on Padrino
 
 Add the gem to your `Gemfile` and run `bundle install` to install it. Then edit `app.rb` and register `Config`
@@ -186,8 +193,9 @@ Settings.add_source!("#{Rails.root}/config/settings/local.yml")
 Settings.reload!
 ```
 
-> Note: this is an example usage, it is easier to just use the default local files `settings.local.yml,
-settings/#{Rails.env}.local.yml and environments/#{Rails.env}.local.yml` for your developer specific settings.
+> Note: this is an example usage, it is easier to just use the default local
+> files `settings.local.yml`, `settings/#{Rails.env}.local.yml` and
+> `environments/#{Rails.env}.local.yml` for your developer specific settings.
 
 You also have the option to add a raw hash as a source. One use case might be storing settings in the database or in environment variables that overwrite what is in the YML files.
 
@@ -200,7 +208,9 @@ You may pass a hash to `prepend_source!` as well.
 
 ## Embedded Ruby (ERB)
 
-Embedded Ruby is allowed in the configuration files. Consider the two following config files.
+Embedded Ruby is allowed in the YAML configuration files. ERB will be evaluated at load time by default, and when the `evaluate_erb_in_yaml` configuration is set to `true`.
+
+Consider the two following config files.
 
 * ```#{Rails.root}/config/settings.yml```
 
@@ -261,6 +271,9 @@ After installing `Config` in Rails, you will find automatically generated file t
 ### General
 
 * `const_name` - name of the object holing you settings. Default: `'Settings'`
+* `evaluate_erb_in_yaml` - evaluate ERB in YAML config files. Set to false if the config file contains ERB that should not be evaluated at load time. Default: `true`
+* `file_name` - name of the file to store general keys accessible in all environments. Default: `'settings'` - located at `config/settings.yml`
+* `dir_name` - name of the directory to store environment-specific files. Default: `'settings'` - located at `config/settings/`
 
 ### Merge customization
 
@@ -415,6 +428,21 @@ ENV['Settings.section.server'] = 'google.com'
 
 It won't work with arrays, though.
 
+It is considered an error to use environment variables to simutaneously assign a "flat" value and a multi-level value to a key.
+
+```ruby
+# Raises an error when settings are loaded
+ENV['BACKEND_DATABASE'] = 'development'
+ENV['BACKEND_DATABASE_USER'] = 'postgres'
+```
+
+Instead, specify keys of equal depth in the environment variable names:
+
+```ruby
+ENV['BACKEND_DATABASE_NAME'] = 'development'
+ENV['BACKEND_DATABASE_USER'] = 'postgres'
+```
+
 ### Working with Heroku
 
 Heroku uses ENV object to store sensitive settings. You cannot upload such files to Heroku because it's ephemeral filesystem gets recreated from the git sources on each instance refresh. To use config with Heroku just set the `use_env` var to `true` as mentioned above.
@@ -460,12 +488,83 @@ Settings.section.server # => 'google.com'
 Settings.section.ssl_enabled # => false
 ```
 
+### Working with AWS Secrets Manager
+
+It is possible to parse variables stored in an AWS Secrets Manager Secret as if they were environment variables by using `Config::Sources::EnvSource`.
+
+For example, the plaintext secret might look like this:
+
+```json
+{
+  "Settings.foo": "hello",
+  "Settings.bar": "world",
+}
+```
+
+In order to load those settings, fetch the settings from AWS Secrets Manager, parse the plaintext as JSON, pass the resulting `Hash` into a new `EnvSource`, load the new source, and reload.
+
+```ruby
+# fetch secrets from AWS
+client = Aws::SecretsManager::Client.new
+response = client.get_secret_value(secret_id: "#{ENV['ENVIRONMENT']}/my_application")
+secrets = JSON.parse(response.secret_string)
+
+# load secrets into config
+secret_source = Config::Sources::EnvSource.new(secrets)
+Settings.add_source!(secret_source)
+Settings.reload!
+```
+
+In this case, the following settings will be available:
+
+```ruby
+Settings.foo # => "hello"
+Settings.bar # => "world"
+```
+
+By default, `EnvSource` will use configuration for `env_prefix`, `env_separator`, `env_converter`, and `env_parse_values`, but any of these can be overridden in the constructor.
+
+```ruby
+secret_source = Config::Sources::EnvSource.new(secrets,
+                                               prefix: 'MyConfig',
+                                               separator: '__',
+                                               converter: nil,
+                                               parse_values: false)
+```
+
 ## Contributing
 
 You are very warmly welcome to help. Please follow our [contribution guidelines](CONTRIBUTING.md)
 
 Any and all contributions offered in any form, past present or future are understood to be in complete agreement and acceptance with [MIT](LICENSE) license.
 
+### Running specs
+
+Setup
+
+```sh
+bundle install
+bundle exec appraisal install
+```
+
+List defined appraisals:
+
+```sh
+bundle exec appraisal list
+```
+
+Run specs for specific appraisal:
+
+```sh
+bundle exec appraisal rails-6.1 rspec
+```
+
+Run specs for all appraisals:
+
+```sh
+bundle exec appraisal rspec
+```
+
 ## Authors
 
 * [Piotr Kuczynski](http://github.com/pkuczynski)
@@ -497,4 +596,4 @@ Support this project by becoming a [sponsor](https://opencollective.com/rubyconf
 
 ## License
 
-Copyright (C) Piotr Kuczynski. Released under the [MIT License](LICENSE).
+Copyright (C) Piotr Kuczynski. Released under the [MIT License](LICENSE.md).

data/config.gemspec

@@ -1,6 +1,5 @@
-$:.push File.expand_path('../lib', __FILE__)
-
-require 'config/version'
+require_relative 'lib/config/version'
+require_relative 'lib/config/dry_validation_requirements'
 
 Gem::Specification.new do |s|
   s.name             = 'config'
@@ -8,46 +7,52 @@ Gem::Specification.new do |s|
   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.summary          = 'Effortless multi-environment settings in Rails, Sinatra, Pandrino and others'
+  s.summary          = 'Effortless multi-environment settings in Rails, Sinatra, Padrino and others'
   s.description      = 'Easiest way to manage multi-environment settings in any ruby project or framework: ' +
-                       'Rails, Sinatra, Pandrino and others'
+                       'Rails, Sinatra, Padrino and others'
   s.homepage         = 'https://github.com/rubyconfig/config'
   s.license          = 'MIT'
   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 🙏
+  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"
+Donate: \e[34mhttps://opencollective.com/rubyconfig/donate\e[0m\n"
 
+  s.metadata = {
+    'changelog_uri' => "https://github.com/rubyconfig/config/blob/master/CHANGELOG.md",
+    'source_code_uri' => 'https://github.com/rubyconfig/config',
+    'bug_tracker_uri' => 'https://github.com/rubyconfig/config/issues'
+  }
   s.files = `git ls-files`.split($/)
   s.files.select! { |file| /(^lib\/|^\w+.md$|\.gemspec$)/ =~ file }
 
   s.require_paths         = ['lib']
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 2.6.0'
 
   s.add_dependency 'deep_merge', '~> 1.2', '>= 1.2.1'
-  s.add_dependency 'dry-validation', '~> 1.0', '>= 1.0.0'
 
+  s.add_development_dependency 'dry-validation', *Config::DryValidationRequirements::VERSIONS
   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 'rspec', '~> 3.7', '>= 3.7.0'
+  s.add_development_dependency 'appraisal', '~> 2.5', '>= 2.5.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']
-    File.read(Dir['gemfiles/rails*.gemfile'].sort.last).scan(/gem "(.*?)", "(.*?)"/m) do |name, version|
+    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.17.1' if RUBY_ENGINE == 'ruby'
+    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.8', '>= 0.8.0'
-    s.add_development_dependency 'rubocop', '~> 0.78.0'
+    s.add_development_dependency 'mdl', '~> 0.9', '>= 0.9.0'
+    s.add_development_dependency 'rubocop', '~> 0.85.0'
   end
 end

data/lib/config/dry_validation_requirements.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Config
+  module DryValidationRequirements
+    VERSIONS = ['~> 1.0', '>= 1.0.0'].freeze
+
+    def self.load_dry_validation!
+      return if defined?(@load_dry_validation)
+
+      begin
+        require 'dry/validation/version'
+        version = Gem::Version.new(Dry::Validation::VERSION)
+        unless VERSIONS.all? { |req| Gem::Requirement.new(req).satisfied_by?(version) }
+          raise LoadError
+        end
+      rescue LoadError
+        raise ::Config::Error, 'Could not find a dry-validation version' \
+          ' matching requirements' \
+          " (#{VERSIONS.map(&:inspect) * ','})"
+      end
+
+      require 'dry/validation'
+      @load_dry_validation = true
+      nil
+    end
+  end
+end

data/lib/config/error.rb

@@ -0,0 +1,4 @@
+module Config
+  class Error < StandardError
+  end
+end

data/lib/config/integrations/heroku.rb

@@ -14,8 +14,8 @@ module Config
       def vars
         # Load only local options to Heroku
         Config.load_and_set_settings(
-            Rails.root.join("config", "settings.local.yml").to_s,
-            Rails.root.join("config", "settings", "#{environment}.local.yml").to_s,
+            Rails.root.join("config", "#{Config.file_name}.local.yml").to_s,
+            Rails.root.join("config", Config.dir_name, "#{environment}.local.yml").to_s,
             Rails.root.join("config", "environments", "#{environment}.local.yml").to_s
         )
 

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

@@ -9,7 +9,7 @@ module Config
 
           # Parse the settings before any of the initializers
           Config.load_and_set_settings(
-            Config.setting_files(::Rails.root.join('config'), ::Rails.env)
+            Config.setting_files(::Rails.root.join('config'), Config.environment.nil? ? ::Rails.env : Config.environment.to_sym)
           )
         end
 

data/lib/config/options.rb

@@ -16,7 +16,7 @@ module Config
 
     def add_source!(source)
       # handle yaml file paths
-      source = (Sources::YAMLSource.new(source)) if source.is_a?(String)
+      source = (Sources::YAMLSource.new(source)) if source.is_a?(String) || source.is_a?(Pathname)
       source = (Sources::HashSource.new(source)) if source.is_a?(Hash)
 
       @config_sources ||= []
@@ -24,49 +24,13 @@ module Config
     end
 
     def prepend_source!(source)
-      source = (Sources::YAMLSource.new(source)) if source.is_a?(String)
+      source = (Sources::YAMLSource.new(source)) if source.is_a?(String) || source.is_a?(Pathname)
       source = (Sources::HashSource.new(source)) if source.is_a?(Hash)
 
       @config_sources ||= []
       @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,13 +112,17 @@ module Config
     end
 
     # Some keywords that don't play nicely with OpenStruct
-    SETTINGS_RESERVED_NAMES = %w[select collect test count zip min max].freeze
+    SETTINGS_RESERVED_NAMES = %w[select collect test count zip min max exit! table].freeze
+
+    # Some keywords that don't play nicely with Rails 7.*
+    RAILS_RESERVED_NAMES = %w[maximum minimum].freeze
 
     # An alternative mechanism for property access.
     # This let's you do foo['bar'] along with foo.bar.
     def [](param)
       return super if SETTINGS_RESERVED_NAMES.include?(param)
-      send("#{param}")
+      return super if RAILS_RESERVED_NAMES.include?(param)
+      public_send("#{param}")
     end
 
     def []=(param, value)
@@ -162,12 +135,18 @@ module Config
       end
     end
 
+    RAILS_RESERVED_NAMES.each do |name|
+      define_method name do
+        self[name]
+      end
+    end
+
     def key?(key)
-      table.key?(key)
+      @table.key?(key)
     end
 
     def has_key?(key)
-      table.has_key?(key)
+      @table.has_key?(key)
     end
 
     def method_missing(method_name, *args)
@@ -212,17 +191,5 @@ module Config
       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/sources/yaml_source.rb

@@ -5,21 +5,27 @@ module Config
   module Sources
     class YAMLSource
       attr_accessor :path
+      attr_reader :evaluate_erb
 
-      def initialize(path)
+      def initialize(path, evaluate_erb: Config.evaluate_erb_in_yaml)
         @path = path.to_s
+        @evaluate_erb = !!evaluate_erb
       end
 
       # returns a config hash from the YML file
       def load
-        result = YAML.load(ERB.new(IO.read(@path)).result) if @path and File.exist?(@path)
+        if @path and File.exist?(@path)
+          file_contents = IO.read(@path)
+          file_contents = ERB.new(file_contents).result if evaluate_erb
+          result = YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(file_contents) : YAML.load(file_contents)
+        end
 
         result || {}
 
-        rescue Psych::SyntaxError => e
-          raise "YAML syntax error occurred while parsing #{@path}. " \
-                "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
-                "Error: #{e.message}"
+      rescue Psych::SyntaxError => e
+        raise "YAML syntax error occurred while parsing #{@path}. " \
+              "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
+              "Error: #{e.message}"
       end
     end
   end

data/lib/config/validation/error.rb

@@ -1,6 +1,8 @@
+require_relative "../error"
+
 module Config
   module Validation
-    class Error < StandardError
+    class Error < ::Config::Error
 
       def self.format(v_res)
         v_res.errors.group_by(&:path).map do |path, messages|

data/lib/config/validation/schema.rb

@@ -1,3 +1,6 @@
+require_relative '../dry_validation_requirements'
+require_relative '../error'
+
 module Config
   module Validation
     module Schema
@@ -9,7 +12,7 @@ module Config
       def schema(&block)
         if block_given?
           # Delay require until optional schema validation is requested
-          require 'dry-validation'
+          Config::DryValidationRequirements.load_dry_validation!
           @schema = Dry::Schema.define(&block)
         else
           @schema

data/lib/config/validation/validate.rb

@@ -4,6 +4,10 @@ module Config
   module Validation
     module Validate
       def validate!
+        return unless Config.validation_contract || Config.schema
+
+        Config::DryValidationRequirements.load_dry_validation!
+
         validate_using!(Config.validation_contract)
         validate_using!(Config.schema)
       end

data/lib/config/version.rb

@@ -1,3 +1,3 @@
 module Config
-  VERSION = '2.2.1'.freeze
+  VERSION = '5.4.0'.freeze
 end

data/lib/config.rb

@@ -1,11 +1,12 @@
-require 'config/compatibility'
 require 'config/options'
 require 'config/configuration'
+require 'config/dry_validation_requirements'
 require 'config/version'
 require 'config/sources/yaml_source'
 require 'config/sources/hash_source'
+require 'config/sources/env_source'
 require 'config/validation/schema'
-require 'deep_merge'
+require 'deep_merge/core'
 
 module Config
   extend Config::Validation::Schema
@@ -18,12 +19,16 @@ module Config
     env_converter: :downcase,
     env_parse_values: true,
     fail_on_missing: false,
+    file_name: 'settings',
+    dir_name: 'settings',
     # deep_merge options
     knockout_prefix: nil,
     merge_nil_values: true,
     overwrite_arrays: true,
     merge_hash_arrays: false,
-    validation_contract: nil
+    validation_contract: nil,
+    evaluate_erb_in_yaml: true,
+    environment: nil
   )
 
   def self.setup
@@ -33,30 +38,31 @@ module Config
 
   # Create a populated Options instance from a settings file. If a second file is given, then the sections of that
   # file will overwrite existing sections of the first file.
-  def self.load_files(*files)
+  def self.load_files(*sources)
     config = Options.new
 
     # add settings sources
-    [files].flatten.compact.uniq.each do |file|
-      config.add_source!(file.to_s)
+    [sources].flatten.compact.each do |source|
+      config.add_source!(source)
     end
 
+    config.add_source!(Sources::EnvSource.new(ENV)) if Config.use_env
+
     config.load!
-    config.load_env! if use_env
     config
   end
 
   # Loads and sets the settings constant!
-  def self.load_and_set_settings(*files)
+  def self.load_and_set_settings(*sources)
     name = Config.const_name
     Object.send(:remove_const, name) if Object.const_defined?(name)
-    Object.const_set(name, Config.load_files(files))
+    Object.const_set(name, Config.load_files(sources))
   end
 
   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, "#{Config.file_name}.yml").to_s,
+      File.join(config_root, Config.dir_name, "#{env}.yml").to_s,
       File.join(config_root, 'environments', "#{env}.yml").to_s,
       *local_setting_files(config_root, env)
     ].freeze
@@ -64,8 +70,8 @@ module Config
 
   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, "#{Config.file_name}.local.yml").to_s if env != 'test'),
+      File.join(config_root, Config.dir_name, "#{env}.local.yml").to_s,
       File.join(config_root, 'environments', "#{env}.local.yml").to_s
     ].compact
   end
@@ -76,7 +82,7 @@ module Config
 end
 
 # Rails integration
-require('config/integrations/rails/railtie') if defined?(::Rails)
+require('config/integrations/rails/railtie') if defined?(::Rails::Railtie)
 
 # Sinatra integration
 require('config/integrations/sinatra') if defined?(::Sinatra)

data/lib/generators/config/install_generator.rb

@@ -12,18 +12,18 @@ module Config
       end
 
       def copy_settings
-        template "settings.yml", "config/settings.yml"
-        template "settings.local.yml", "config/settings.local.yml"
-        directory "settings", "config/settings"
+        template "settings.yml", "config/#{Config.file_name}.yml"
+        template "settings.local.yml", "config/#{Config.file_name}.local.yml"
+        directory "settings", "config/#{Config.dir_name}"
       end
 
       def modify_gitignore
-        create_file '.gitignore' unless File.exists? '.gitignore'
+        create_file '.gitignore' unless File.exist? '.gitignore'
 
         append_to_file '.gitignore' do
-          "\n"                                +
-          "config/settings.local.yml\n"       +
-          "config/settings/*.local.yml\n"     +
+          "\n"                                      +
+          "config/#{Config.file_name}.local.yml\n"  +
+          "config/#{Config.dir_name}/*.local.yml\n" +
           "config/environments/*.local.yml\n"
         end
       end

data/lib/generators/config/templates/config.rb

@@ -15,6 +15,11 @@ Config.setup do |config|
   #
   # config.overwrite_arrays = true
 
+  # Defines current environment, affecting which settings file will be loaded.
+  # Default: `Rails.env`
+  #
+  # config.environment = ENV.fetch('ENVIRONMENT', :development)
+
   # Load environment variables from the `ENV` object and override any settings defined in files.
   #
   # config.use_env = false
@@ -52,4 +57,12 @@ Config.setup do |config|
   #   required(:email).filled(format?: EMAIL_REGEX)
   # end
 
+  # Evaluate ERB in YAML config files at load time.
+  #
+  # config.evaluate_erb_in_yaml = true
+
+  # Name of directory and file to store config keys
+  #
+  # config.file_name = 'settings'
+  # config.dir_name = 'settings'
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: config
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 5.4.0
 platform: ruby
 authors:
 - Piotr Kuczynski
 - Fred Wu
 - Jacques Crocker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2024-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -36,174 +36,188 @@ dependencies:
   name: dry-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
     - - "~>"
       - !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.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - "~>"
       - !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.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.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.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.7.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
   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: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: bootsnap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.0.2.1
+        version: 7.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.0.2.1
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 6.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 6.0.3
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 3.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
-  name: mdl
+  name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: mdl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 0.85.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 0.85.0
 description: 'Easiest way to manage multi-environment settings in any ruby project
-  or framework: Rails, Sinatra, Pandrino and others'
+  or framework: Rails, Sinatra, Padrino and others'
 email:
 - piotr.kuczynski@gmail.com
 - ifredwu@gmail.com
@@ -222,13 +236,15 @@ files:
 - README.md
 - config.gemspec
 - lib/config.rb
-- lib/config/compatibility.rb
 - lib/config/configuration.rb
+- lib/config/dry_validation_requirements.rb
+- lib/config/error.rb
 - lib/config/integrations/heroku.rb
 - lib/config/integrations/rails/railtie.rb
 - lib/config/integrations/sinatra.rb
 - lib/config/options.rb
 - lib/config/rack/reloader.rb
+- lib/config/sources/env_source.rb
 - lib/config/sources/hash_source.rb
 - lib/config/sources/yaml_source.rb
 - lib/config/tasks/heroku.rake
@@ -246,10 +262,12 @@ files:
 homepage: https://github.com/rubyconfig/config
 licenses:
 - MIT
-metadata: {}
-post_install_message: "\n\e[33mThanks for installing Config\e[0m \U0001F64F\nPlease
-  consider donating to our open collective to help us maintain this project.\n\n\n\U0001F449
-  \ Donate: \e[34mhttps://opencollective.com/rubyconfig/donate\e[0m\n"
+metadata:
+  changelog_uri: https://github.com/rubyconfig/config/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/rubyconfig/config
+  bug_tracker_uri: https://github.com/rubyconfig/config/issues
+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:
@@ -258,15 +276,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.4.22
+signing_key:
 specification_version: 4
-summary: Effortless multi-environment settings in Rails, Sinatra, Pandrino and others
+summary: Effortless multi-environment settings in Rails, Sinatra, Padrino and others
 test_files: []

data/lib/config/compatibility.rb

@@ -1,3 +0,0 @@
-if defined?(RbConfig) && defined?(Config)
-  Object.send :remove_const, :Config
-end