config 2.1.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e61b3780ec9c2a5586d1e50691a655761542740ed0ae370b5c1ad769e4d6349
-  data.tar.gz: 9a3d32e7943894f2f44546ab8c161d8b97ffe3a6df620856cbb037c337d83db6
+  metadata.gz: ee641c05cf97c8e76b7076ba7b9c66e490999d307cf4be1b6c404f5cabfc38a5
+  data.tar.gz: 9c9b4f47ca0259234082bd4339df446370e0f8cda3be6e8dfb25aff347c2ac75
 SHA512:
-  metadata.gz: 58015736b2f1bd3394102de9dcf09c64ee9f56c51abac9673a1a38dd867ab26b12abccda26c0b81d04c052a9e6c8cff48fd015004734dc4f9a0abb1dec1a1dea
-  data.tar.gz: cfea04abd4b76cd40913dea8544df5a049ecaf50faa475fe3662f6b3389bdf9aac35c26d9614dbaaf35df06ee7033ae4ee6a3943bc28373583cd930c9569b186
+  metadata.gz: 374734550ff18a367d2932d10601dda32cfd29640b7ce7e647c00b11b5f3dbd85afbcb57d9e3dd369cbd5d9b1c44e66af4ed7b4c5bc438136ed9474d9797741f
+  data.tar.gz: '093ca60e0208e03bd6b4cf624084c2eeead073b531c702196d325aff5f9d48bfaf1da326d3725bb7d79702ff66a6332942e478a553e14b02dea54cc6a491619a'

data/CHANGELOG.md

@@ -2,129 +2,199 @@
 
 ## Unreleased
 
+...
+
+## 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
+
+### Performance improvements
+
+* Get rid of unused Rails Engine class definition ([#247](https://github.com/rubyconfig/config/pull/247))
+* Require dry-validation only when schema is specified ([#253](https://github.com/rubyconfig/config/pull/253))
+* Defer modification of `ActionController::Base` to when it is loaded in Rails integration ([#250](https://github.com/rubyconfig/config/pull/250))
+
+### Bug fixes
+
+* 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))
+* Excluded test application's *.md files from the gem build ([#267](https://github.com/rubyconfig/config/pull/267))
+
+### Changes
+
+* Use sprockets 3.x when running unit tests for Rails 4.2 ([#256](https://github.com/rubyconfig/config/pull/256))
+* Cleanup example Rails application used for testing ([#263](https://github.com/rubyconfig/config/pull/263))
+* Upgrade markdown linter and fix errors ([#265](https://github.com/rubyconfig/config/pull/265))
+* Upgrade development dependencies and test matrix with latest Ruby and Rails versions ([#264](https://github.com/rubyconfig/config/pull/264))
+* Replace Travis CI with GitHub Actions ([#266](https://github.com/rubyconfig/config/pull/266))
+* Add Rails 6.0 to the test matrix ([#258](https://github.com/rubyconfig/config/pull/258))
+* Rename GitHub organization name from `railsconfig` to `rubyconfig` ([#268](https://github.com/rubyconfig/config/pull/268))
+
 ## 2.1.0
 
 ### New features
 
-* Add dry-validation contract support ([#238](https://github.com/railsconfig/config/pull/238))
+* Add dry-validation contract support ([#238](https://github.com/rubyconfig/config/pull/238))
 
 ### Changes
 
-* Get rid of activesupport dependency ([#230](https://github.com/railsconfig/config/pull/230))
-* Ignore .local files in test environment ([#135](https://github.com/railsconfig/config/issues/135), [#233](https://github.com/railsconfig/config/pull/233))
-* Execute default rspec against latest Rails app and load appropriate development dependencies dynamically ([#241](https://github.com/railsconfig/config/pull/241))
-* Fix inconsistent documentation for ENV prefix and default value in generator ([#246](https://github.com/railsconfig/config/pull/246))
+* Get rid of activesupport dependency ([#230](https://github.com/rubyconfig/config/pull/230))
+* Ignore .local files in test environment ([#135](https://github.com/rubyconfig/config/issues/135), [#233](https://github.com/rubyconfig/config/pull/233))
+* Execute default rspec against latest Rails app and load appropriate development dependencies dynamically ([#241](https://github.com/rubyconfig/config/pull/241))
+* Fix inconsistent documentation for ENV prefix and default value in generator ([#246](https://github.com/rubyconfig/config/pull/246))
 
 ### Bug fixes
 
-* Fix warnings when running tests in Rails 5 scope ([#240](https://github.com/railsconfig/config/issues/240)
-* Do not run incompatible code coverage on truffleruby ([#242](https://github.com/railsconfig/config/issues/242)
+* Fix warnings when running tests in Rails 5 scope ([#240](https://github.com/rubyconfig/config/issues/240)
+* Do not run incompatible code coverage on truffleruby ([#242](https://github.com/rubyconfig/config/issues/242)
 
 ## 2.0.0
 
 ### BREAKING CHANGES
 
 After upgrade to dry-schema 1.0 we had to drop support for Rails `< 4.2` and Ruby `< 2.4`.
-If you need older version of Ruby or Rails, please stick to 1.x version of this gem. 
+If you need older version of Ruby or Rails, please stick to 1.x version of this gem.
 
 ### New features
 
-* Add `merge_hash_arrays` as a configuration option ([#214](https://github.com/railsconfig/config/pull/214))
+* Add `merge_hash_arrays` as a configuration option ([#214](https://github.com/rubyconfig/config/pull/214))
 
 ### Changes
 
-* Upgraded dry-validation dependency to dry-schema 1.0 ([#224](https://github.com/railsconfig/config/pull/224))
-* Moved constant to be defined on `Object` instead of `Kernel` ([#227](https://github.com/railsconfig/config/issues/227))
-* Add TruffleRuby to the test matrix ([#229](https://github.com/railsconfig/config/issues/229))
+* Upgraded dry-validation dependency to dry-schema 1.0 ([#224](https://github.com/rubyconfig/config/pull/224))
+* Moved constant to be defined on `Object` instead of `Kernel` ([#227](https://github.com/rubyconfig/config/issues/227))
+* Add TruffleRuby to the test matrix ([#229](https://github.com/rubyconfig/config/issues/229))
 
 ## 1.7.2
 
 ### Bug fixes
 
-* Lock max version of dry-validation depending on the ruby version ([#223](https://github.com/railsconfig/config/pull/223))
+* Lock max version of dry-validation depending on the ruby version ([#223](https://github.com/rubyconfig/config/pull/223))
 
 ## 1.7.1
 
 ### New features
 
-* Upgrade dependencies ([#211](https://github.com/railsconfig/config/pull/211))
+* Upgrade dependencies ([#211](https://github.com/rubyconfig/config/pull/211))
 
 ### Changes
 
-* Add Ruby 2.5 and Rails 5.1 to the testing matrix on Travis ([#201](https://github.com/railsconfig/config/pull/201))
-* Add Ruby 2.6 tto the test matrix ([#210](https://github.com/railsconfig/config/pull/210))
-* Add Rails 5.2 to the test matrix ([#212](https://github.com/railsconfig/config/pull/212))
+* Add Ruby 2.5 and Rails 5.1 to the testing matrix on Travis ([#201](https://github.com/rubyconfig/config/pull/201))
+* Add Ruby 2.6 to the test matrix ([#210](https://github.com/rubyconfig/config/pull/210))
+* Add Rails 5.2 to the test matrix ([#212](https://github.com/rubyconfig/config/pull/212))
 
 ## 1.7.0
 
 ### New features
 
-* **WARNING:** `nil` values will from now on overwrite an existing value when merging configs! This change of behavior can be reverted via `config.merge_nil_values = false` in your Config initializer ([#196](https://github.com/railsconfig/config/pull/196))
+* **WARNING:** `nil` values will from now on overwrite an existing value when merging configs! This change of behavior can be reverted via `config.merge_nil_values = false` in your Config initializer ([#196](https://github.com/rubyconfig/config/pull/196))
 
 ## 1.6.1
 
 ### Bug fixes
 
-* Make dry-validation dependency less strict allowing to use newer versions ([#183](https://github.com/railsconfig/config/pull/183))
-* Fix `key?` and `has_key?`, which raise NoMethodError in non Rails environment, by using ActiveSupport `#delegate` implicitly ([#185](https://github.com/railsconfig/config/pull/185))
-* Update `deep_merge` dependency to latest version (v1.2.1) ([#191](https://github.com/railsconfig/config/pull/191))
-* Upgrade `rubocop` to version 0.52.1 ([#193](https://github.com/railsconfig/config/pull/193))
-* Add `zip` to the list of reserved keywords ([#197](https://github.com/railsconfig/config/pull/197))
+* Make dry-validation dependency less strict allowing to use newer versions ([#183](https://github.com/rubyconfig/config/pull/183))
+* Fix `key?` and `has_key?`, which raise NoMethodError in non Rails environment, by using ActiveSupport `#delegate` implicitly ([#185](https://github.com/rubyconfig/config/pull/185))
+* Update `deep_merge` dependency to latest version (v1.2.1) ([#191](https://github.com/rubyconfig/config/pull/191))
+* Upgrade `rubocop` to version 0.52.1 ([#193](https://github.com/rubyconfig/config/pull/193))
+* Add `zip` to the list of reserved keywords ([#197](https://github.com/rubyconfig/config/pull/197))
 
 ## 1.6.0
 
 ### New features
 
 * `Config#fail_on_missing` option (default `false`) to raise a `KeyError` exception when accessing a non-existing key
-* Add ability to test if a value was set for a given key with `key?` and `has_key?` ([#182](https://github.com/railsconfig/config/pull/182))
+* Add ability to test if a value was set for a given key with `key?` and `has_key?` ([#182](https://github.com/rubyconfig/config/pull/182))
 
 ## 1.5.1
 
 ### New features
 
-* Add parsing of ENV variable values to Boolean type ([#180](https://github.com/railsconfig/config/pull/180))
+* Add parsing of ENV variable values to Boolean type ([#180](https://github.com/rubyconfig/config/pull/180))
 
 ## 1.5.0
 
 ### New features
 
-* Add ability to validate config schema ([#155](https://github.com/railsconfig/config/pull/155) thanks to [@ok32](https://github.com/ok32))
-* Add count to the reserved names list ([#167](https://github.com/railsconfig/config/pull/167) thanks to [@carbonin](https://github.com/carbonin))
+* Add ability to validate config schema ([#155](https://github.com/rubyconfig/config/pull/155) thanks to [@ok32](https://github.com/ok32))
+* Add count to the reserved names list ([#167](https://github.com/rubyconfig/config/pull/167) thanks to [@carbonin](https://github.com/carbonin))
 
 ### Bug fixes
 
-* Correctly parse `env_prefix`, which contains `env_separator` ([#177](https://github.com/railsconfig/config/pull/177) thanks to [@rdodson41](https://github.com/rdodson41))
+* Correctly parse `env_prefix`, which contains `env_separator` ([#177](https://github.com/rubyconfig/config/pull/177) thanks to [@rdodson41](https://github.com/rdodson41))
 
 ## 1.4.0
 
 ### New features
 
-* Added support for passing a raw ruby hash into to both `Settings.add_source!` and `Settings.prepend_source!` ([#108](https://github.com/railsconfig/config/pull/159) thanks to [@halloffame](https://github.com/halloffame))
+* Added support for passing a raw ruby hash into to both `Settings.add_source!` and `Settings.prepend_source!` ([#108](https://github.com/rubyconfig/config/pull/159) thanks to [@halloffame](https://github.com/halloffame))
 
 ### Bug fixes
 
-* Added new reserved name `test` ([#158](https://github.com/railsconfig/config/pull/158) thanks to [@milushov](https://github.com/milushov))
-* `to_hash` should not replace nested config objects with Hash ([#160](https://github.com/railsconfig/config/issues/160) thanks to [@seikichi](https://github.com/seikichi))
+* Added new reserved name `test` ([#158](https://github.com/rubyconfig/config/pull/158) thanks to [@milushov](https://github.com/milushov))
+* `to_hash` should not replace nested config objects with Hash ([#160](https://github.com/rubyconfig/config/issues/160) thanks to [@seikichi](https://github.com/seikichi))
 
 ## 1.3.0
 
-* **WARNING:** Overwrite arrays found in previously loaded settings file ([#137](https://github.com/railsconfig/config/pull/137) thanks to [@Fryguy](https://github.com/Fryguy) and [@dtaniwaki](https://github.com/dtaniwaki)) - this is a change breaking previous behaviour. If you want to keep Config to work as before, which is merging arrays found in following loaded settings file, please add `config.overwrite_arrays = false` to your Config initializer
+* **WARNING:** Overwrite arrays found in previously loaded settings file ([#137](https://github.com/rubyconfig/config/pull/137) thanks to [@Fryguy](https://github.com/Fryguy) and [@dtaniwaki](https://github.com/dtaniwaki)) - this is a change breaking previous behaviour. If you want to keep Config to work as before, which is merging arrays found in following loaded settings file, please add `config.overwrite_arrays = false` to your Config initializer
 * Changed default ENV variables loading settings to downcase variable names and parse values
 * Added parsing ENV variables values to Float type
-* Change method definition order in Rails integration module to prevent undefined method `preload` error (based on [@YaroSpace](https://github.com/YaroSpace) suggestion in [#111](https://github.com/railsconfig/config/issues/111)
+* Change method definition order in Rails integration module to prevent undefined method `preload` error (based on [@YaroSpace](https://github.com/YaroSpace) suggestion in [#111](https://github.com/rubyconfig/config/issues/111)
 
 ## 1.2.1
 
-* Fixed support for multilevel settings loaded from ENV variables (inspired by [@cbeer](https://github.com/cbeer) in [#144](https://github.com/railsconfig/config/pull/144))
+* Fixed support for multilevel settings loaded from ENV variables (inspired by [@cbeer](https://github.com/cbeer) in [#144](https://github.com/rubyconfig/config/pull/144))
 
 ## 1.2.0
 
-* Add ability to load settings from ENV variables ([#108](https://github.com/railsconfig/config/issues/108) thanks to [@vinceve](https://github.com/vinceve) and [@spalladino](https://github.com/spalladino))
-* Removed Rails 5 deprecation warnings for prepend_before_filter ([#141](https://github.com/railsconfig/config/pull/141))
+* Add ability to load settings from ENV variables ([#108](https://github.com/rubyconfig/config/issues/108) thanks to [@vinceve](https://github.com/vinceve) and [@spalladino](https://github.com/spalladino))
+* Removed Rails 5 deprecation warnings for prepend_before_filter ([#141](https://github.com/rubyconfig/config/pull/141))
 
 ## 1.1.1
 
-* Downgrade minimum ruby version to 2.0.0 ([#136](https://github.com/railsconfig/config/issues/136))
+* Downgrade minimum ruby version to 2.0.0 ([#136](https://github.com/rubyconfig/config/issues/136))
 
 ## 1.1.0
 
@@ -133,12 +203,12 @@ If you need older version of Ruby or Rails, please stick to 1.x version of this
 
 ## 1.0.0
 
-* `RailsConfig` is now officially renamed to `Config`
-* Fixed array descent when converting to hash ([#89](https://github.com/railsconfig/config/pull/89))
-* Catch OpenStruct reserved keywords ([#95](https://github.com/railsconfig/config/pull/95) by [@dudo](https://github.com/dudo))
-* Allows loading before app configuration process ([#107](https://github.com/railsconfig/config/pull/107) by [@Antiarchitect](https://github.com/Antiarchitect))
-* `deep_merge` is now properly managed via gemspec ([#110](https://github.com/railsconfig/config/pull/110))
-* Added `prepend_source!` ([#102](https://github.com/railsconfig/config/pull/102))
+* `rubyconfig` is now officially renamed to `Config`
+* Fixed array descent when converting to hash ([#89](https://github.com/rubyconfig/config/pull/89))
+* Catch OpenStruct reserved keywords ([#95](https://github.com/rubyconfig/config/pull/95) by [@dudo](https://github.com/dudo))
+* Allows loading before app configuration process ([#107](https://github.com/rubyconfig/config/pull/107) by [@Antiarchitect](https://github.com/Antiarchitect))
+* `deep_merge` is now properly managed via gemspec ([#110](https://github.com/rubyconfig/config/pull/110))
+* Added `prepend_source!` ([#102](https://github.com/rubyconfig/config/pull/102))
 
 ## 0.99
 

data/CONTRIBUTING.md

@@ -28,5 +28,5 @@ appraisal rspec
 If you modified any of the documentation files verify their format:
 
 ```bash
-mdl --style .mdlstyle.rb *.md
+mdl *.md
 ```

data/README.md

@@ -1,10 +1,10 @@
 # Config
 
-[![Build Status](https://api.travis-ci.org/railsconfig/config.svg?branch=master)](http://travis-ci.org/railsconfig/config)
-[![Gem Version](https://badge.fury.io/rb/config.svg)](http://badge.fury.io/rb/config)
-[![Maintainability](https://api.codeclimate.com/v1/badges/85c206c13dce7de090af/maintainability)](https://codeclimate.com/github/railsconfig/config/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/85c206c13dce7de090af/test_coverage)](https://codeclimate.com/github/railsconfig/config/test_coverage)
-[![Financial Contributors on Open Collective](https://opencollective.com/rubyconfig/all/badge.svg?label=financial+contributors)](https://opencollective.com/rubyconfig)
+[![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)
+[![Build](https://img.shields.io/github/workflow/status/rubyconfig/config/tests)](https://rubygems.org/gems/config)
+[![Tests](https://github.com/rubyconfig/config/workflows/tests/badge.svg)](https://github.com/rubyconfig/config/actions?query=branch%3Amaster)
+[![Financial Contributors on Open Collective](https://opencollective.com/rubyconfig/all/badge.svg?label=backers)](https://opencollective.com/rubyconfig)
 
 ## Summary
 
@@ -21,11 +21,14 @@ 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.4`
+  * [JRuby](https://www.jruby.org) `>= 9.2`
+  * [TruffleRuby](https://github.com/oracle/truffleruby) `>= 19.3`
 * Application frameworks
-  * Rails `>= 4.2` and `5`
+  * Rails `>= 4.2`, `5` and `6`
   * Padrino
   * Sinatra
 
@@ -42,6 +45,7 @@ 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
@@ -186,8 +190,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 +205,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 +268,7 @@ 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`
 
 ### Merge customization
 
@@ -321,7 +329,7 @@ class ConfigContract < Dry::Validation::Contract
 end
 
 Config.setup do |config|
-  config.validation_contract = ConfigContract
+  config.validation_contract = ConfigContract.new
 end
 ```
 
@@ -415,6 +423,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,14 +483,56 @@ 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.
 
-
-
 ## Authors
 
 * [Piotr Kuczynski](http://github.com/pkuczynski)
@@ -479,32 +544,24 @@ Any and all contributions offered in any form, past present or future are unders
 
 ### Code Contributors
 
-This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
-<a href="https://github.com/railsconfig/config/graphs/contributors"><img src="https://opencollective.com/rubyconfig/contributors.svg?width=890&button=false" /></a>
+This project exists thanks to all the people who contribute and you are very warmly welcome to help. Please follow our [contribution guidelines](CONTRIBUTING.md).
 
-### Financial Contributors
+Any and all contributions offered in any form, past present or future are understood to be in complete agreement and acceptance with the [MIT](LICENSE) license.
 
-[[Become a financial contributor](https://opencollective.com/rubyconfig/contribute)] and and support us with a small donation to help us continue our activities. Thank you if you already one! 🙏 
+[![Contributors](https://opencollective.com/rubyconfig/contributors.svg?width=890&button=false)](https://github.com/rubyconfig/config/graphs/contributors)
+
+### Financial Contributors
 
-#### Individuals
+[Become a backer](https://opencollective.com/rubyconfig#backer) and support us with a small monthly donation to help us continue our activities. Thank you if you already one! 🙏
 
-<a href="https://opencollective.com/rubyconfig"><img src="https://opencollective.com/rubyconfig/individuals.svg?width=890"></a>
+[![Backers](https://opencollective.com/rubyconfig/backers.svg?width=890)](https://opencollective.com/rubyconfig)
 
-#### Organizations
+#### Sponsors
 
-Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/rubyconfig/contribute)]
+Support this project by becoming a [sponsor](https://opencollective.com/rubyconfig#sponsor). Your logo will show up here with a link to your website.
 
-<a href="https://opencollective.com/rubyconfig/organization/0/website"><img src="https://opencollective.com/rubyconfig/organization/0/avatar.svg"></a>
-<a href="https://opencollective.com/rubyconfig/organization/1/website"><img src="https://opencollective.com/rubyconfig/organization/1/avatar.svg"></a>
-<a href="https://opencollective.com/rubyconfig/organization/2/website"><img src="https://opencollective.com/rubyconfig/organization/2/avatar.svg"></a>
-<a href="https://opencollective.com/rubyconfig/organization/3/website"><img src="https://opencollective.com/rubyconfig/organization/3/avatar.svg"></a>
-<a href="https://opencollective.com/rubyconfig/organization/4/website"><img src="https://opencollective.com/rubyconfig/organization/4/avatar.svg"></a>
-<a href="https://opencollective.com/rubyconfig/organization/5/website"><img src="https://opencollective.com/rubyconfig/organization/5/avatar.svg"></a>
-<a href="https://opencollective.com/rubyconfig/organization/6/website"><img src="https://opencollective.com/rubyconfig/organization/6/avatar.svg"></a>
-<a href="https://opencollective.com/rubyconfig/organization/7/website"><img src="https://opencollective.com/rubyconfig/organization/7/avatar.svg"></a>
-<a href="https://opencollective.com/rubyconfig/organization/8/website"><img src="https://opencollective.com/rubyconfig/organization/8/avatar.svg"></a>
-<a href="https://opencollective.com/rubyconfig/organization/9/website"><img src="https://opencollective.com/rubyconfig/organization/9/avatar.svg"></a>
+[![Sponsors](https://opencollective.com/rubyconfig/sponsors.svg?width=890)](https://opencollective.com/rubyconfig)
 
 ## License
 
-Config is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+Copyright (C) Piotr Kuczynski. Released under the [MIT License](LICENSE.md).

data/config.gemspec

@@ -11,46 +11,44 @@ Gem::Specification.new do |s|
   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 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.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 'deep_merge', '~> 1.2', '>= 1.2.1'
-  s.add_dependency 'dry-validation', '~> 1.0'
+  s.add_dependency 'dry-validation', '~> 1.0', '>= 1.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 'rspec', '~> 3.7', '>= 3.7.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']
-    File.read(Dir['gemfiles/rails*.gemfile'].sort.last).scan(/gem "(.*?)", "(.*?)"/m) do |name, version|
+  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
 
-  # 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'] && ENV['TRAVIS_RUBY_VERSION'] != 'truffleruby'
-    s.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.9'
-    s.add_development_dependency 'simplecov', '~> 0.13.0'
+  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,11 +1,10 @@
-require 'dry-validation'
 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'
 
@@ -25,7 +24,8 @@ module Config
     merge_nil_values: true,
     overwrite_arrays: true,
     merge_hash_arrays: false,
-    validation_contract: nil
+    validation_contract: nil,
+    evaluate_erb_in_yaml: true
   )
 
   def self.setup
@@ -43,8 +43,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
 

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 min max].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/sources/yaml_source.rb

@@ -5,14 +5,20 @@ 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.load(file_contents)
+        end
 
         result || {}
 

data/lib/config/validation/schema.rb

@@ -8,6 +8,8 @@ module Config
 
       def schema(&block)
         if block_given?
+          # Delay require until optional schema validation is requested
+          require 'dry-validation'
           @schema = Dry::Schema.define(&block)
         else
           @schema

data/lib/config/version.rb

@@ -1,3 +1,3 @@
 module Config
-  VERSION = '2.1.0'.freeze
+  VERSION = '3.1.0'.freeze
 end

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

@@ -52,4 +52,7 @@ Config.setup do |config|
   #   required(:email).filled(format?: EMAIL_REGEX)
   # end
 
+  # Evaluate ERB in YAML config files at load time.
+  #
+  # config.evaluate_erb_yaml = true
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: config
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Piotr Kuczynski
 - Fred Wu
 - Jacques Crocker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-03 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -36,6 +36,9 @@ 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'
@@ -43,6 +46,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -72,40 +78,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.3.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.3.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.9.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.9.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: bootsnap
   requirement: !ruby/object:Gem::Requirement
@@ -126,14 +132,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.2
+        version: 6.0.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.2
+        version: 6.0.3.1
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -148,54 +154,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: mdl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.9.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.9.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.9'
 - !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:
@@ -219,11 +211,11 @@ files:
 - 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
 - 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
@@ -238,16 +230,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.0/README.md
-- spec/app/rails_5.1/README.md
-- spec/app/rails_5.2/README.md
-homepage: https://github.com/railsconfig/config
+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"
+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:
@@ -263,8 +251,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.0.3
+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

data/spec/app/rails_5.0/README.md

@@ -1,24 +0,0 @@
-# README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...

data/spec/app/rails_5.1/README.md

@@ -1,24 +0,0 @@
-# README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...

data/spec/app/rails_5.2/README.md

@@ -1,24 +0,0 @@
-# README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...