anyway_config 2.0.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b904056fa9aacdea82b6f1637842533d7def209c93f567b0367f286ea80f9d03
-  data.tar.gz: 711e2db3dbf53098621d145c260967a529a0a384c4431f26f361b6a32f064730
+  metadata.gz: 87d32ae676d03c8a9fd3a0b22efe3321d76661f226438f52fd313f4d73b1876d
+  data.tar.gz: 82f2ab5d663b03622f650fbcf8e37216a71d81fdfd9270d54f539fd6253ada9d
 SHA512:
-  metadata.gz: 77df85ae073e7b919e0f54b4bbb8626cef280745302f22f5771f7b14033404b8414ddc8b91e2ddc5fba7a6f1a01e8a0b380a112aa5d4ef7129521c5cdf218888
-  data.tar.gz: 2c101d67759f17b04cba5fbadfffb224ce54cb39a96d369784d291b9c6991801a2dc5a4cd422a52dfd4a1e9c46d219629588e744c527846f720089250cb8c5a7
+  metadata.gz: 9f7952609c7964cc9866fe530a9a519cf981f0551f9979c72f38b2acd31e59edd98d6234f095da99419acd462bcfc7c6b7d5016c41ded3bb0206d7f1e03550b3
+  data.tar.gz: 1559b8e140b7df15164134233fd6c65e11d9283f94c9495a0d92f6afdcc69271cec68a7bc6f5052b8ec06dab35e33f1cadd32f4f044701156bfcc0ca4676ba41

data/CHANGELOG.md

@@ -1,5 +1,79 @@
 # Change log
 
+## master
+
+## 2.2.0 ⛓
+
+- Add RBS signatures and generator. ([@palkan][])
+
+Anyway Config now ships with the basic RBS support. To use config types with Steep, add `library "anyway_config"` to your Steepfile.
+
+We also provide an API to generate a signature for you config class: `MyConfig.to_rbs`. You can use this method to generate a scaffold for your config class.
+
+- Add type coercion support. ([@palkan][])
+
+Example:
+
+```ruby
+class CoolConfig < Anyway::Config
+  attr_config :port, :user
+
+  coerce_types port: :string, user: {dob: :date}
+end
+
+ENV["COOL_USER__DOB"] = "1989-07-01"
+
+config = CoolConfig.new({port: 8080})
+config.port == "8080" #=> true
+config.user["dob"] == Date.new(1989, 7, 1) #=> true
+```
+
+You can also add `.disable_auto_cast!` to your config class to disable automatic conversion.
+
+**Warning** Now values from all sources are coerced (e.g., YAML files). That could lead to a different behaviour.
+
+- Do not dup modules/classes passed as configuration values. ([@palkan][])
+
+- Handle loading empty YAML config files. ([@micahlee][])
+
+## 2.1.0 (2020-12-29)
+
+- Drop deprecated `attr_config` instance variables support.
+
+Config setters no longer write instance variables.
+
+- Add `config.anyway_config.future` to allow enabling upcoming features. ([@palkan][])
+
+For smoother upgrades, we provide a mechanism to opt-out to the new defaults beforehand.
+Currently, only `:unwrap_known_environments` feature could be enabled (see below):
+
+```ruby
+config.anyway_config.future.use :unwrap_known_environments
+```
+
+- Allow to skip environment keys completely (e.g., `development:`, `test:`) in a config YML when used with Rails. In that case same config is loaded in all known environments (same mechanism as for non-Rails applications)
+
+- Add the `known_environments` property to Anyway::Settings under Rails. Use `config.anyway_config.known_environments << "staging"` to make the gem aware of custom environments. ([@progapandist][])
+
+- Make it possible to specify default YML configs directory. ([@palkan][])
+
+For example:
+
+```ruby
+Anyway::Settings.default_config_path = "path/to/configs"
+
+# or in Rails
+config.anyway_config.default_config_path = Rails.root.join("my/configs")
+```
+
+## 2.0.6 (2020-07-7)
+
+- Fix Ruby 2.7 warnings. ([@palkan][])
+
+## 2.0.5 (2020-05-15)
+
+- Use `YAML.load` instead of `YAML.safe_laad`. ([@palkan][])
+
 ## 2.0.4 (2020-05-15)
 
 - Fix regression with adding `ruby-next` as a runtime dependency even for RubyGems release. ([@palkan][])
@@ -12,13 +86,13 @@
 
 - Make sure configs are eager loaded in Rails when `config.eager_load = true`. ([@palkan][])
 
-  Fixes [#58](https://github.com/palkan/anyway_config/issues/58).
+Fixes [#58](https://github.com/palkan/anyway_config/issues/58).
 
 ## 2.0.1 (2020-04-15)
 
 - Fix loading Railtie when application has been already initialized. ([@palkan][])
 
-  Fixes [#56](https://github.com/palkan/anyway_config/issues/56).
+Fixes [#56](https://github.com/palkan/anyway_config/issues/56).
 
 ## 2.0.0 (2020-04-14)
 
@@ -28,166 +102,166 @@
 
 - Add predicate methods for attributes with boolean defaults. ([@palkan][])
 
-  For example:
+For example:
 
-  ```ruby
-  class MyConfig < Anyway::Config
-    attr_config :key, :secret, debug: false
-  end
+```ruby
+class MyConfig < Anyway::Config
+  attr_config :key, :secret, debug: false
+end
 
-  MyConfig.new.debug? #=> false
-  MyConfig.new(debug: true).debug? #=> true
-  ```
+MyConfig.new.debug? #=> false
+MyConfig.new(debug: true).debug? #=> true
+```
 
 - Add `Config#deconstruct_keys`. ([@palkan][])
 
-  Now you can use configs in pattern matching:
+Now you can use configs in pattern matching:
 
-  ```ruby
-  case AWSConfig.new
-  in bucket:, region: "eu-west-1"
-    setup_eu_storage(bucket)
-  in bucket:, region: "us-east-1"
-    setup_us_storage(bucket)
-  end
-  ```
+```ruby
+case AWSConfig.new
+in bucket:, region: "eu-west-1"
+  setup_eu_storage(bucket)
+in bucket:, region: "us-east-1"
+  setup_us_storage(bucket)
+end
+```
 
 - Add pretty_print support. ([@palkan][])
 
-  Whenever you use `pp`, the output would contain pretty formatted config information
-  including the sources.
+Whenever you use `pp`, the output would contain pretty formatted config information
+including the sources.
 
-  Example:
+Example:
 
-  ```ruby
-  pp CoolConfig.new
+```ruby
+pp CoolConfig.new
 
-  # #<CoolConfig
-  #   config_name="cool"
-  #   env_prefix="COOL"
-  #   values:
-  #     port => 3334 (type=load),
-  #     host => "test.host" (type=yml path=./config/cool.yml),
-  #     user =>
-  #       name => "john" (type=env key=COOL_USER__NAME),
-  #       password => "root" (type=yml path=./config/cool.yml)>
-  ```
+# #<CoolConfig
+#   config_name="cool"
+#   env_prefix="COOL"
+#   values:
+#     port => 3334 (type=load),
+#     host => "test.host" (type=yml path=./config/cool.yml),
+#     user =>
+#       name => "john" (type=env key=COOL_USER__NAME),
+#       password => "root" (type=yml path=./config/cool.yml)>
+```
 
 - Add source tracing support. ([@palkan][])
 
-  You can get the information on where a particular parameter value came from
-  (which loader) through via `#to_source_trace` method:
-
-  ```ruby
-  conf = MyConfig.new
-  conf.to_source_trace
-  # {
-  #  "host" => {value: "test.host", source: {type: :user, called_from: "/rails/root/config/application.rb:21"}},
-  #  "user" => {
-  #    "name" => {value: "john", source: {type: :env, key: "COOL_USER__NAME"}},
-  #    "password" => {value: "root", source: {type: :yml, path: "config/cool.yml"}}
-  #  },
-  #  "port" => {value: 9292, source: {type: :defaults}}
-  # }
-  ```
+You can get the information on where a particular parameter value came from
+(which loader) through via `#to_source_trace` method:
+
+```ruby
+conf = MyConfig.new
+conf.to_source_trace
+# {
+#  "host" => {value: "test.host", source: {type: :user, called_from: "/rails/root/config/application.rb:21"}},
+#  "user" => {
+#    "name" => {value: "john", source: {type: :env, key: "COOL_USER__NAME"}},
+#    "password" => {value: "root", source: {type: :yml, path: "config/cool.yml"}}
+#  },
+#  "port" => {value: 9292, source: {type: :defaults}}
+# }
+```
 
 - Change the way Rails configs autoloading works. ([@palkan][])
 
-  In Rails 6, autoloading before initialization is [deprecated](https://github.com/rails/rails/commit/3e66ba91d511158e22f90ff96b594d61f40eda01). We can still
-  make it work by using our own autoloading mechanism (custom Zeitwerk loader).
+In Rails 6, autoloading before initialization is [deprecated](https://github.com/rails/rails/commit/3e66ba91d511158e22f90ff96b594d61f40eda01). We can still
+make it work by using our own autoloading mechanism (custom Zeitwerk loader).
 
-  This forces us to use a custom directory (not `app/`) for configs required at the boot time.
-  By default, we put _static_ configs into `config/configs` but you can still use `app/configs` for
-  _dynamic_ (runtime) configs.
+This forces us to use a custom directory (not `app/`) for configs required at the boot time.
+By default, we put _static_ configs into `config/configs` but you can still use `app/configs` for
+_dynamic_ (runtime) configs.
 
-  **NOTE:** if you used `app/configs` with 2.0.0.preX and relied on configs during initialization,
-  you can set static configs path to `app/configs`:
+**NOTE:** if you used `app/configs` with 2.0.0.preX and relied on configs during initialization,
+you can set static configs path to `app/configs`:
 
-  ```ruby
-  config.anyway_config.autoload_static_config_path = "app/configs"
-  ```
+```ruby
+config.anyway_config.autoload_static_config_path = "app/configs"
+```
 
-  You can do this by running the generator:
+You can do this by running the generator:
 
-  ```sh
-  rails g anyway:install --configs-path=app/configs
-  ```
+```sh
+rails g anyway:install --configs-path=app/configs
+```
 
 - Add Rails generators. ([@palkan][])
 
-  You can create config classes with the predefined attributes like this:
+You can create config classes with the predefined attributes like this:
 
-  ```sh
-  rails generate config aws access_key_id secret_access_key region
-  ```
+```sh
+rails generate config aws access_key_id secret_access_key region
+```
 
 - **BREAKING** The accessors generated by `attr_config` are not longer `attr_accessor`-s. ([@palkan][])
 
-  You cannot rely on instance variables anymore. Instead, you can use `super` when overriding accessors or
-  `values[name]`:
+You cannot rely on instance variables anymore. Instead, you can use `super` when overriding accessors or
+`values[name]`:
 
-  ```ruby
-  attr_config :host, :port, :url, :meta
+```ruby
+attr_config :host, :port, :url, :meta
 
-  # override writer to handle type coercion
-  def meta=(val)
-    super JSON.parse(val)
-  end
+# override writer to handle type coercion
+def meta=(val)
+  super JSON.parse(val)
+end
 
-  # or override reader to handle missing values
-  def url
-    values[:url] ||= "#{host}:#{port}"
-  end
+# or override reader to handle missing values
+def url
+  values[:url] ||= "#{host}:#{port}"
+end
 
-  # in <2.1 it's still possible to read instance variables,
-  # i.e. the following would also work
-  def url
-    @url ||= "#{host}:#{port}"
-  end
-  ```
+# in <2.1 it's still possible to read instance variables,
+# i.e. the following would also work
+def url
+  @url ||= "#{host}:#{port}"
+end
+```
 
-  **NOTE**: we still set instance variables in writers (for backward compatibility), but that would
-  be removed in 2.1.
+**NOTE**: we still set instance variables in writers (for backward compatibility), but that would
+be removed in 2.1.
 
 - Add `Config#dig` method. ([@palkan][])
 
 - Add ability to specify types for OptionParser options. ([@palkan][])
 
-  ```ruby
-  describe_options(
-    concurrency: {
-      desc: "number of threads to use",
-      type: String
-    }
-  )
-  ```
+```ruby
+describe_options(
+  concurrency: {
+    desc: "number of threads to use",
+    type: String
+  }
+)
+```
 
 - Add param presence validation. ([@palkan][])
 
-  You can specify some params as required, and the validation
-  error would be raised if they're missing or empty (only for strings):
+You can specify some params as required, and the validation
+error would be raised if they're missing or empty (only for strings):
 
-  ```ruby
-  class MyConfig < Anyway::Config
-    attr_config :api_key, :api_secret, :debug
+```ruby
+class MyConfig < Anyway::Config
+  attr_config :api_key, :api_secret, :debug
 
-    required :api_key, :api_secret
-  end
+  required :api_key, :api_secret
+end
 
-  MyConfig.new(api_secret: "") #=> raises Anyway::Config::ValidationError
-  ```
+MyConfig.new(api_secret: "") #=> raises Anyway::Config::ValidationError
+```
 
-  You can change the validation behaviour by overriding the `#validate!` method in your config class.
+You can change the validation behaviour by overriding the `#validate!` method in your config class.
 
 - Validate config attribute names. ([@palkan][])
 
-  Do not allow using reserved names (`Anyway::Config` method names).
-  Allow only alphanumeric names (matching `/^[a-z_]([\w]+)?$/`).
+Do not allow using reserved names (`Anyway::Config` method names).
+Allow only alphanumeric names (matching `/^[a-z_]([\w]+)?$/`).
 
 - Add Loaders API. ([@palkan][])
 
-  All config sources have standardized via _loaders_ API. It's possible to define
-  custom loaders or change the sources order.
+All config sources have standardized via _loaders_ API. It's possible to define
+custom loaders or change the sources order.
 
 ## 2.0.0.pre2 (2019-04-26)
 
@@ -197,73 +271,58 @@
 
 - **BREAKING** Changed the way of providing explicit values. ([@palkan][])
 
-  ```ruby
-  # BEFORE
-  Config.new(overrides: data)
+```ruby
+# BEFORE
+Config.new(overrides: data)
 
-  # AFTER
-  Config.new(data)
-  ```
+# AFTER
+Config.new(data)
+```
 
 - Add Railtie. ([@palkan][])
 
-  `Anyway::Railtie` provides `Anyway::Settings` access via `Rails.applicaiton.configuration.anyway_config`.
+`Anyway::Railtie` provides `Anyway::Settings` access via `Rails.applicaiton.configuration.anyway_config`.
 
-  It also adds `app/configs` path to autoload paths (low-level, `ActiveSupport::Dependencies`) to
-  make it possible to use configs in the app configuration files.
+It also adds `app/configs` path to autoload paths (low-level, `ActiveSupport::Dependencies`) to
+make it possible to use configs in the app configuration files.
 
 - Add test helpers. ([@palkan][])
 
-  Added `with_env` helper to test code in the context of the specified
-  environment variables.
+Added `with_env` helper to test code in the context of the specified
+environment variables.
 
-  Included automatically in RSpec for examples with the `type: :config` meta
-  or with the `spec/configs` path.
+Included automatically in RSpec for examples with the `type: :config` meta
+or with the `spec/configs` path.
 
 - Add support for _local_ files. ([@palkan][])
 
-  Now users can store their personal configurations in _local_ files:
-  - `<config_name>.local.yml`
-  - `config/credentials/local.yml.enc` (for Rails 6).
+Now users can store their personal configurations in _local_ files:
+
+- `<config_name>.local.yml`
+- `config/credentials/local.yml.enc` (for Rails 6).
 
-  Local configs are meant for using in development and only loaded if
-  `Anyway::Settings.use_local_files` is `true` (which is true by default if
-  `RACK_ENV` or `RAILS_ENV` env variable is equal to `"development"`).
+Local configs are meant for using in development and only loaded if
+`Anyway::Settings.use_local_files` is `true` (which is true by default if
+`RACK_ENV` or `RAILS_ENV` env variable is equal to `"development"`).
 
 - Add Rails credentials support. ([@palkan][])
 
-  The data from credentials is loaded after the data from YAML config and secrets,
-  but before environmental variables (i.e. env variables are _stronger_)
+The data from credentials is loaded after the data from YAML config and secrets,
+but before environmental variables (i.e. env variables are _stronger_)
 
 - Update config name inference logic. ([@palkan][])
 
-  Config name is automatically inferred only if:
-  - the class name has a form of `<Module>::Config` (`SomeModule::Config => "some_module"`)
-  - the class name has a form of `<Something>Config` (`SomeConfig => "some"`)
-
-- Fix config classes inheritance. ([@palkan][])
+Config name is automatically inferred only if:
 
-  Previously, inheritance didn't work due to the lack of proper handling of class-level
-  configuration (naming, option parses settings, defaults).
+- the class name has a form of `<Module>::Config` (`SomeModule::Config => "some_module"`)
+- the class name has a form of `<Something>Config` (`SomeConfig => "some"`)
 
-  Now it's possible to extend config classes without breaking the original classes functionality.
-
-  Noticeable features:
-  - if `config_name` is explicitly defined on class, it's inherited by subclasses:
-
-  ```ruby
-  class MyAppBaseConfig < Anyway::Config
-    config_name :my_app
-  end
-
-  class MyServiceConfig < MyAppBaseConfig
-  end
+- Fix config classes inheritance. ([@palkan][])
 
-  MyServiceConfig.config_name #=> "my_app"
-  ```
+Previously, inheritance didn't work due to the lack of proper handling of class-level
+configuration (naming, option parses settings, defaults).
 
-  - defaults are merged leaving the parent class defaults unchanged
-  - option parse extension are not overriden, but added to the parent class extensions
+Now it's possible to extend config classes without breaking the original classes functionality.
 
 - **Require Ruby >= 2.5.0.**
 
@@ -283,26 +342,26 @@
 
 - Add OptionParse integration ([@jastkand][])
 
-  See more [PR#18](https://github.com/palkan/anyway_config/pull/18).
+See more [PR#18](https://github.com/palkan/anyway_config/pull/18).
 
 - Use underscored config name as an env prefix. ([@palkan][])
 
-  For a config class:
+For a config class:
 
-  ```ruby
-  class MyApp < Anyway::Config
-  end
-  ```
+```ruby
+class MyApp < Anyway::Config
+end
+```
 
-  Before this change we use `MYAPP_` prefix, now it's `MY_APP_`.
+Before this change we use `MYAPP_` prefix, now it's `MY_APP_`.
 
-  You can specify the prefix explicitly:
+You can specify the prefix explicitly:
 
-  ```ruby
-  class MyApp < Anyway::Config
-    env_prefix "MYAPP_"
-  end
-  ```
+```ruby
+class MyApp < Anyway::Config
+  env_prefix "MYAPP_"
+end
+```
 
 ## 1.3.0 (2018-06-15)
 
@@ -318,18 +377,18 @@ Now works on JRuby 9.1+.
 
 - Allow to pass raw hash with explicit values to `Config.new`. ([@dsalahutdinov][])
 
-  Example:
+Example:
 
-  ```ruby
-  Sniffer::Config.new(
-    overrides: {
-      enabled: true,
-      storage: {capacity: 500}
-    }
-  )
-  ```
+```ruby
+Sniffer::Config.new(
+  overrides: {
+    enabled: true,
+    storage: {capacity: 500}
+  }
+)
+```
 
-  See more [PR#10](https://github.com/palkan/anyway_config/pull/10).
+See more [PR#10](https://github.com/palkan/anyway_config/pull/10).
 
 ## 1.1.2 (2017-11-19)
 
@@ -343,7 +402,7 @@ Now works on JRuby 9.1+.
 
 - Add `#to_h` method. ([@palkan][])
 
-  See [#4](https://github.com/palkan/anyway_config/issues/4).
+See [#4](https://github.com/palkan/anyway_config/issues/4).
 
 - Make it possible to extend configuration parameters. ([@palkan][])
 
@@ -357,17 +416,18 @@ Now works on JRuby 9.1+.
 
 - Drop `active_support` dependency. ([@palkan][])
 
-  Use custom refinements instead of requiring `active_support`.
+Use custom refinements instead of requiring `active_support`.
 
-  No we're dependency-free!
+No we're dependency-free!
 
 ## 0.1.0 (2015-01-20)
 
-  Initial version.
+- Initial version.
 
 [@palkan]: https://github.com/palkan
 [@onemanstartup]: https://github.com/onemanstartup
 [@dsalahutdinov]: https://github.com/dsalahutdinov
 [@charlie-wasp]: https://github.com/charlie-wasp
 [@jastkand]: https://github.com/jastkand
-[@Envek]: https://github.com/Envek
+[@envek]: https://github.com/Envek
+[@progapandist]: https://github.com/progapandist