config 1.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 73118a0190819d693e81132bc4a2746a453dd74d
-  data.tar.gz: 5c6a339dcfa60f444269f0ba45da298656297471
+SHA256:
+  metadata.gz: a9553d786b6f2a87d956e85494f9f8fd083e42076989e7c8217b84f72b1d6469
+  data.tar.gz: 592b1002dd18e793f444c2b4d00220c4cbbaf2f1e850d33c0d6c5bc5c41ae236
 SHA512:
-  metadata.gz: a28428c4f956dacbd9032fa97037819a15956eb0d694a48a4250425d3902ef9fd13bb67fcfdb011d1c67ea043476a386c2dd6e729de85a846ad13d2b772c67a5
-  data.tar.gz: 35fa737c860ca76a6c6aac73ccbdab4e5e399cfdf214d357e26cdd9e00fa1e3652a4701bfb73adcca498981cf67bd10c35088fe510d925605f43087f7cccee0b
+  metadata.gz: 80c5e1c7de910d8f7592b0bf2d1ad322dbf8aa6565617ca1f5d0bdede78316073aa5afb5bf6e7cb33ce42bace7770f4cb8f8a86d4fd13a31fc0e900e58c6ae9c
+  data.tar.gz: 8fe4ecdb8069e910c36f68cb3a55863182797539638be36f7be622057174a45f4605427aaa0f145fd399a518131310059408812e9ff5dd391a1c7691b45624a7

data/CHANGELOG.md

@@ -1,30 +1,194 @@
 # Changelog
 
+## Unreleased
+
+...
+
+## 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 ([#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/rubyconfig/config/pull/238))
+
+### Changes
+
+* 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/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.
+
+### New features
+
+* 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/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/rubyconfig/config/pull/223))
+
+## 1.7.1
+
+### New features
+
+* 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/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/rubyconfig/config/pull/196))
+
+## 1.6.1
+
+### Bug fixes
+
+* 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/rubyconfig/config/pull/182))
+
+## 1.5.1
+
+### New features
+
+* 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/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/rubyconfig/config/pull/177) thanks to [@rdodson41](https://github.com/rdodson41))
+
 ## 1.4.0
 
-* 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 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))
+### New features
+
+* 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/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
 
@@ -33,12 +197,12 @@
 
 ## 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
 
@@ -70,6 +234,3 @@
 
 * Expose Settings in application.rb, so you don't have to duplicate configuration for each environment file ([#59](https://github.com/railsjedi/config/issues/59))
 * Adding support for Rails 4.1.0.rc ([#70](https://github.com/railsjedi/config/issues/70))
-
-
-

data/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+
+Install appraisal
+
+```bash
+gem install bundler -v 1.17.3
+gem install appraisal
+```
+
+Bundle
+
+```bash
+bundle install
+```
+
+Bootstrap
+
+```bash
+appraisal install
+```
+
+Run the test suite:
+
+```bash
+appraisal rspec
+```
+
+If you modified any of the documentation files verify their format:
+
+```bash
+mdl *.md
+```

data/README.md

@@ -1,11 +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)
-[![Dependency Status](https://gemnasium.com/railsconfig/config.svg)](https://gemnasium.com/railsconfig/config)
-[![Code Climate](https://codeclimate.com/github/railsconfig/config/badges/gpa.svg)](https://codeclimate.com/github/railsconfig/config)
-[![Issue Count](https://codeclimate.com/github/railsconfig/config/badges/issue_count.svg)](https://codeclimate.com/github/railsconfig/config)
-[![Test Coverage](https://codeclimate.com/github/railsconfig/config/badges/coverage.svg)](https://codeclimate.com/github/railsconfig/config/coverage)
+[![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
 
@@ -22,16 +21,22 @@ Config helps you easily manage environment specific settings in an easy and usab
 
 ## Compatibility
 
-* Ruby `2.x`
-* Rails `>= 3.1`, `4` and `5`
-* Padrino
-* Sinatra
+Current version supports and is [tested](.github/workflows/tests.yml#L19) for the following interpreters and frameworks:
 
-For older versions of Rails or Ruby use [AppConfig](http://github.com/fredwu/app_config).
+* Interpreters
+  * [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`, `5` and `6`
+  * 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).
 
 ## Installing
 
-### Installing on Rails 3, 4 or 5
+### Installing on Rails
 
 Add `gem 'config'` to your `Gemfile` and run `bundle install` to install it. Then run
 
@@ -40,12 +45,13 @@ 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.
-a
+
 ### Installing on Padrino
 
 Add the gem to your `Gemfile` and run `bundle install` to install it. Then edit `app.rb` and register `Config`
@@ -56,8 +62,7 @@ register Config
 
 ### Installing on Sinatra
 
-Add the gem to your `Gemfile` and run `bundle install` to install it. Afterwards in need to register `Config` in your
-app and give it a root so it can find the config files.
+Add the gem to your `Gemfile` and run `bundle install` to install it. Afterwards in need to register `Config` in your app and give it a root so it can find the config files.
 
 ```ruby
 set :root, File.dirname(__FILE__)
@@ -66,15 +71,13 @@ register Config
 
 ### Installing on other ruby projects
 
-Add the gem to your `Gemfile` and run `bundle install` to install it.
-Then initialize `Config` manually within your configure block.
+Add the gem to your `Gemfile` and run `bundle install` to install it. Then initialize `Config` manually within your configure block.
 
 ```ruby
 Config.load_and_set_settings(Config.setting_files("/path/to/config_root", "your_project_environment"))
 ```
 
-It's also possible to initialize `Config` manually within your configure block if you want to just give it some yml
-paths to load from.
+It's also possible to initialize `Config` manually within your configure block if you want to just give it some yml paths to load from.
 
 ```ruby
 Config.load_and_set_settings("/path/to/yaml1", "/path/to/yaml2", ...)
@@ -82,8 +85,7 @@ Config.load_and_set_settings("/path/to/yaml1", "/path/to/yaml2", ...)
 
 ## Accessing the Settings object
 
-After installing the gem, `Settings` object will become available globally and by default will be compiled from the
-files listed below. Settings defined in files that are lower in the list override settings higher.
+After installing the gem, `Settings` object will become available globally and by default will be compiled from the files listed below. Settings defined in files that are lower in the list override settings higher.
 
     config/settings.yml
     config/settings/#{environment}.yml
@@ -135,8 +137,7 @@ Settings.reload_from_files(
 
 ### Environment specific config files
 
-You can have environment specific config files. Environment specific config entries take precedence over common config
-entries.
+You can have environment specific config files. Environment specific config entries take precedence over common config entries.
 
 Example development environment config file:
 
@@ -152,8 +153,7 @@ Example production environment config file:
 
 ### Developer specific config files
 
-If you want to have local settings, specific to your machine or development environment,
-you can use the following files, which are automatically `.gitignore` :
+If you want to have local settings, specific to your machine or development environment, you can use the following files, which are automatically `.gitignore` :
 
 ```ruby
 Rails.root.join("config", "settings.local.yml").to_s,
@@ -161,6 +161,8 @@ Rails.root.join("config", "settings", "#{Rails.env}.local.yml").to_s,
 Rails.root.join("config", "environments", "#{Rails.env}.local.yml").to_s
 ```
 
+**NOTE:** The file `settings.local.yml` will not be loaded in tests to prevent local configuration from causing flaky or non-deterministic tests. Environment-specific files (e.g. `settings/test.local.yml`) will still be loaded to allow test-specific credentials.
+
 ### Adding sources at runtime
 
 You can add new YAML config files at runtime. Just use:
@@ -179,19 +181,18 @@ Settings.prepend_source!("/path/to/source.yml")
 Settings.reload!
 ```
 
-This will do the same as `add_source`, but the given YML file will be loaded first (instead of last) and its settings
-will be overwritten by any other configuration file. This is especially useful if you want to define defaults.
+This will do the same as `add_source`, but the given YML file will be loaded first (instead of last) and its settings will be overwritten by any other configuration file. This is especially useful if you want to define defaults.
 
-One thing I like to do for my Rails projects is provide a local.yml config file that is .gitignored (so its independent
-per developer). Then I create a new initializer in `config/initializers/add_local_config.rb` with the contents
+One thing I like to do for my Rails projects is provide a local.yml config file that is .gitignored (so its independent per developer). Then I create a new initializer in `config/initializers/add_local_config.rb` with the contents
 
 ```ruby
 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.
 
@@ -251,18 +252,16 @@ Settings.section.servers[1].name # => amazon.com
 
 ## Configuration
 
-There are multiple configuration options available, however you can customize `Config` only once, preferably during
-application initialization phase:
+There are multiple configuration options available, however you can customize `Config` only once, preferably during application initialization phase:
 
 ```ruby
 Config.setup do |config|
   config.const_name = 'Settings'
-  ...
+  # ...
 end
 ```
 
-After installing `Config` in Rails, you will find automatically generated file that contains default configuration
-located at `config/initializers/config.rb`.
+After installing `Config` in Rails, you will find automatically generated file that contains default configuration located at `config/initializers/config.rb`.
 
 ### General
 
@@ -271,18 +270,139 @@ located at `config/initializers/config.rb`.
 ### Merge customization
 
 * `overwrite_arrays` - overwrite arrays found in previously loaded settings file. Default: `true`
+* `merge_hash_arrays` - merge hashes inside of arrays from previously loaded settings files. Makes sense only when `overwrite_arrays = false`. Default: `false`
 * `knockout_prefix` - ability to remove elements of the array set in earlier loaded settings file. Makes sense only when `overwrite_arrays = false`, otherwise array settings would be overwritten by default. Default: `nil`
+* `merge_nil_values` - `nil` values will overwrite an existing value when merging configs. Default: `true`.
+
+```ruby
+# merge_nil_values is true by default
+c = Config.load_files("./spec/fixtures/development.yml") # => #<Config::Options size=2, ...>
+c.size # => 2
+c.merge!(size: nil) => #<Config::Options size=nil, ...>
+c.size # => nil
+```
+
+```ruby
+# To reject nil values when merging settings:
+Config.setup do |config|
+  config.merge_nil_values = false
+end
+
+c = Config.load_files("./spec/fixtures/development.yml") # => #<Config::Options size=2, ...>
+c.size # => 2
+c.merge!(size: nil) => #<Config::Options size=nil, ...>
+c.size # => 2
+```
 
 Check [Deep Merge](https://github.com/danielsdeleo/deep_merge) for more details.
 
+### Validation
+
+With Ruby 2.1 or newer, you can optionally define a [schema](https://github.com/dry-rb/dry-schema) or [contract](https://github.com/dry-rb/dry-validation) (added in `config-2.1`) using [dry-rb](https://github.com/dry-rb) to validate presence (and type) of specific config values. Generally speaking contracts allow to describe more complex validations with depencecies between fields.
+
+If you provide either validation option (or both) it will automatically be used to validate your config. If validation fails it will raise a `Config::Validation::Error` containing information about all the mismatches between the schema and your config.
+
+Both examples below demonstrates how to ensure that the configuration has an optional `email` and the `youtube` structure with the `api_key` field filled. The contract adds an additional rule.
+
+#### Contract
+
+Leverage dry-validation, you can create a contract with a params schema and rules:
+
+```ruby
+class ConfigContract < Dry::Validation::Contract
+  params do
+    optional(:email).maybe(:str?)
+
+    required(:youtube).schema do
+      required(:api_key).filled
+    end
+  end
+
+  rule(:email) do
+    unless /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i.match?(value)
+      key.failure('has invalid format')
+    end
+  end
+end
+
+Config.setup do |config|
+  config.validation_contract = ConfigContract.new
+end
+```
+
+The above example adds a rule to ensure the `email` is valid by matching it against the provided regular expression.
+
+Check [dry-validation](https://github.com/dry-rb/dry-validation) for more details.
+
+#### Schema
+
+You may also specify a schema using [dry-schema](https://github.com/dry-rb/dry-schema):
+
+```ruby
+Config.setup do |config|
+  # ...
+  config.schema do
+    optional(:email).maybe(:str?)
+
+    required(:youtube).schema do
+      required(:api_key).filled
+    end
+  end
+end
+```
+
+Check [dry-schema](https://github.com/dry-rb/dry-schema) for more details.
+
+### Missing keys
+
+For an example settings file:
+
+```yaml
+size: 1
+server: google.com
+```
+
+You can test if a value was set for a given key using `key?` and its alias `has_key?`:
+
+```ruby
+Settings.key?(:path)
+# => false
+Settings.key?(:server)
+# => true
+```
+
+By default, accessing to a missing key returns `nil`:
+
+```ruby
+Settings.key?(:path)
+# => false
+Settings.path
+# => nil
+```
+
+This is not "typo-safe". To solve this problem, you can configure the `fail_on_missing` option:
+
+```ruby
+Config.setup do |config|
+  config.fail_on_missing = true
+  # ...
+end
+```
+
+So it will raise a `KeyError` when accessing a non-existing key (similar to `Hash#fetch` behaviour):
+
+```ruby
+Settings.path
+# => raises KeyError: key not found: :path
+```
+
 ### Environment variables
 
 See section below for more details.
 
 ## Working with environment variables
 
-To load environment variables from the `ENV` object, that will override any settings defined in files, set the `use_env`
-to true in your `config/initializers/config.rb` file:
+To load environment variables from the `ENV` object, that will override any settings defined in files, set the `use_env` to true in your `config/initializers/config.rb` file:
 
 ```ruby
 Config.setup do |config|
@@ -291,8 +411,7 @@ Config.setup do |config|
 end
 ```
 
-Now config would read values from the ENV object to the settings. For the example above it would look for keys starting
-with `Settings`:
+Now config would read values from the ENV object to the settings. For the example above it would look for keys starting with `Settings`:
 
 ```ruby
 ENV['Settings.section.size'] = 1
@@ -301,11 +420,24 @@ 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.
+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.
 
 To upload your local values to Heroku you could ran `bundle exec rake config:heroku`.
 
@@ -313,20 +445,19 @@ To upload your local values to Heroku you could ran `bundle exec rake config:her
 
 You can customize how environment variables are processed:
 
-* `env_prefix` (default: `SETTINGS`) - which ENV variables to load into config
-* `env_separator` (default: `.`)  - what string to use as level separator - 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 using
-  dots in variable names might not be allowed (eg. Bash)
+* `env_prefix` (default: `const_name`) - load only ENV variables starting with this prefix (case-sensitive)
+* `env_separator` (default: `'.'`)  - what string to use as level separator - 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 using   dots in variable names might not be allowed (eg. Bash)
 * `env_converter` (default: `:downcase`)  - how to process variables names:
   * `nil` - no change
   * `:downcase` - convert to lower case
-* `env_parse_values` (default: `true`) - try to parse values to a correct type (`Integer`, `Float`, `String`)
+* `env_parse_values` (default: `true`) - try to parse values to a correct type (`Boolean`, `Integer`, `Float`, `String`)
 
 For instance, given the following environment:
 
 ```bash
 SETTINGS__SECTION__SERVER_SIZE=1
 SETTINGS__SECTION__SERVER=google.com
+SETTINGS__SECTION__SSL_ENABLED=false
 ```
 
 And the following configuration:
@@ -334,7 +465,7 @@ And the following configuration:
 ```ruby
 Config.setup do |config|
   config.use_env = true
-  config.env_prefix = 'Settings'
+  config.env_prefix = 'SETTINGS'
   config.env_separator = '__'
   config.env_converter = :downcase
   config.env_parse_values = true
@@ -346,28 +477,59 @@ The following settings will be available:
 ```ruby
 Settings.section.server_size # => 1
 Settings.section.server # => 'google.com'
+Settings.section.ssl_enabled # => false
 ```
 
-## Contributing
+### Working with AWS Secrets Manager
 
-Bootstrap
+It is possible to parse variables stored in an AWS Secrets Manager Secret as if they were environment variables by using `Config::Sources::EnvSource`.
 
-```bash
-appraisal install
+For example, the plaintext secret might look like this:
+
+```json
+{
+  "Settings.foo": "hello",
+  "Settings.bar": "world",
+}
 ```
 
-Run the test suite:
+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.
 
-```bash
-appraisal rspec
+```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!
 ```
 
-If you modified any of the documentation files verify their format:
+In this case, the following settings will be available:
 
-```bash
-mdl --style .mdlstyle.rb *.md
+```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)
@@ -375,6 +537,28 @@ mdl --style .mdlstyle.rb *.md
 * [Jacques Crocker](http://github.com/railsjedi)
 * Inherited from [AppConfig](http://github.com/cjbottaro/app_config) by [Christopher J. Bottaro](http://github.com/cjbottaro)
 
+## Contributors
+
+### Code Contributors
+
+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).
+
+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.
+
+[![Contributors](https://opencollective.com/rubyconfig/contributors.svg?width=890&button=false)](https://github.com/rubyconfig/config/graphs/contributors)
+
+### Financial Contributors
+
+[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! 🙏
+
+[![Backers](https://opencollective.com/rubyconfig/backers.svg?width=890)](https://opencollective.com/rubyconfig)
+
+#### Sponsors
+
+Support this project by becoming a [sponsor](https://opencollective.com/rubyconfig#sponsor). Your logo will show up here with a link to your website.
+
+[![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).