runger_config 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 769d4ae4e5cf48c70701615843b3e742d33512032bba7d3afa8ae11da226167d
-  data.tar.gz: 907144a5f9e471c6b7acc9160c9190b7c233df2db0506e11b62c992078ba9db9
+  metadata.gz: 1b64cf53f84cf85e579523fa523e04afdd2c32dd75b219cf5a700df552368ded
+  data.tar.gz: 59459b83f4aff3789c5289a1ed5c33b686dd5012a73eff0ae4627e5eb2e3a3a2
 SHA512:
-  metadata.gz: 2ae86779e72a7e88f0a1d74818204831569b6aed3f1a66962cd696c6681ecfd3a419304431da61fe843f68975bac8bd65db08969f123476d2825b2c8e4b57026
-  data.tar.gz: e4ef30331ed5ea04a1503df074d27fadef00c94f1dff99540e5588d11f3152d49c09724acc8ad1b7042f7b608ba894ca3869e48a0090ea1251ee2176395bca9d
+  metadata.gz: f7b719cb241b1e1d5c4d7d12d1563179e38e68f7aa777142c4ae8d497d13542f1a07c3b17f9ac7c6c9b9117a5b2bb20cbaab5a8b46a07bbab239cda1f3b5703e
+  data.tar.gz: 6f2156c5baecc455d4747a70351844c5161e9bb266743ed372dcde9634b6a6054524c354f85629863094e56b9311aa1e706b914ac405412008bb2980ac645bc8

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-# Changelog
+## v4.0.0 (2023-11-19)
+
+- [BREAKING] Rename from Anyway Config to Runger Config
+  - You will now need to `require 'runger_config'`, rather than `require 'anyway_config'`
+
+## v3.0.1 (2023-11-19)
+
+- Fix specs broken by 3.0 release
+
+- Suppress linting errors in docs
 
 ## v3.0.0 (2023-11-19)
 
@@ -34,19 +43,19 @@
 
 - Fix Rails detection. ([@palkan][])
 
-Fixes [#134](https://github.com/palkan/anyway_config/issues/134).
+Fixes [#134](https://github.com/palkan/runger_config/issues/134).
 
 ## 2.5.0 (2023-07-24)
 
 - Generators: Add `config_name` to generated classes if name contains underscore. ([@palkan][])
 
-- Load Rails extensions even if Rails was loaded after Anyway Config. ([@palkan][])
+- Load Rails extensions even if Rails was loaded after Runger Config. ([@palkan][])
 
 - Fix handling `config.credentials.content_path` provided as String. ([@palkan][])
 
 ## 2.4.2 (2023-06-07)
 
-- Use ANYWAY_ENV as the current environment if defined. ([@palkan][])
+- Use RUNGER_ENV as the current environment if defined. ([@palkan][])
 
 It can be used to specify environment for configs independently of Rails environment.
 
@@ -63,11 +72,11 @@ It can be used to specify environment for configs independently of Rails environ
 - Added experimental support for sub-configs via coercion. ([@palkan][])
 
 ```ruby
-class AnotherConfig < Anyway::Config
+class AnotherConfig < Runger::Config
   attr_config foo: "bar"
 end
 
-class MyConfig < Anyway::Config
+class MyConfig < Runger::Config
   attr_config :another_config
 
   coerce_types another_config: "AnotherConfig"
@@ -86,7 +95,7 @@ MyConfig.new.another_config.foo #=> "baz"
 The API is inspired by Rails permitted params:
 
 ```ruby
-class AppConfig < Anyway::Config
+class AppConfig < Runger::Config
   attr_config :assets_host, database: {host: nil, port: nil}
 
   required :assets_host, database: [:host, :port]
@@ -95,7 +104,7 @@ end
 
 - Add support for using `env_prefix ""` to load from unprefixed env vars. ([@palkan][])
 
-See [#118](https://github.com/palkan/anyway_config/issues/118).
+See [#118](https://github.com/palkan/runger_config/issues/118).
 
 - Added EJSON support. ([@inner-whisper])
 
@@ -103,7 +112,7 @@ See [#118](https://github.com/palkan/anyway_config/issues/118).
 
 ## 2.3.1 (2023-01-17)
 
-- [Fixes [#110](https://github.com/palkan/anyway_config/issues/110)] Fix setting up autoloader for the same folder. ([@palkan][])
+- [Fixes [#110](https://github.com/palkan/runger_config/issues/110)] Fix setting up autoloader for the same folder. ([@palkan][])
 
 - RBS: Now `.on_load` automatically pass block context type (instance), so no need to add annotations! ([@palkan][])
 
@@ -115,10 +124,10 @@ Steep 1.2+ is required. Read more about the [feature](https://hackmd.io/xLrYaqUt
 
 - Add ability to load configurations under specific environments in pure Ruby apps. ([@fargelus][]).
 
-Before loading environment configurations you need to specify variable `Anyway::Settings.current_environment`. In Rails apps this variable is same as `Rails.env` value.
+Before loading environment configurations you need to specify variable `Runger::Settings.current_environment`. In Rails apps this variable is same as `Rails.env` value.
 After adding yaml loader will try to load params under this environment.
 
-Also required env option was added to `Anyway::Config`.
+Also required env option was added to `Runger::Config`.
 
 ## 2.2.3 (2022-01-21)
 
@@ -126,8 +135,8 @@ Also required env option was added to `Anyway::Config`.
 
 - Add ability to set default key for environmental YAML files. ([@skryukov])
 
-Define a key for environmental yaml files to read default values from with `config.anyway_config.default_environmental_key = "default"`.
-This way Anyway Config will try to read settings under the `"default"` key and then merge environmental settings into them.
+Define a key for environmental yaml files to read default values from with `config.runger_config.default_environmental_key = "default"`.
+This way Runger Config will try to read settings under the `"default"` key and then merge environmental settings into them.
 
 ## 2.2.2 (2020-10-26)
 
@@ -141,7 +150,7 @@ This way Anyway Config will try to read settings under the `"default"` key and t
 
 - 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.
+Runger Config now ships with the basic RBS support. To use config types with Steep, add `library "runger_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.
 
@@ -150,7 +159,7 @@ We also provide an API to generate a signature for you config class: `MyConfig.t
 Example:
 
 ```ruby
-class CoolConfig < Anyway::Config
+class CoolConfig < Runger::Config
   attr_config :port, :user
 
   coerce_types port: :string, user: {dob: :date}
@@ -177,28 +186,28 @@ You can also add `.disable_auto_cast!` to your config class to disable automatic
 
 Config setters no longer write instance variables.
 
-- Add `config.anyway_config.future` to allow enabling upcoming features. ([@palkan][])
+- Add `config.runger_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
+config.runger_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][])
+- Add the `known_environments` property to Runger::Settings under Rails. Use `config.runger_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"
+Runger::Settings.default_config_path = "path/to/configs"
 
 # or in Rails
-config.anyway_config.default_config_path = Rails.root.join("my/configs")
+config.runger_config.default_config_path = Rails.root.join("my/configs")
 ```
 
 ## 2.0.6 (2020-07-7)
@@ -221,13 +230,13 @@ config.anyway_config.default_config_path = Rails.root.join("my/configs")
 
 - 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/runger_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/runger_config/issues/56).
 
 ## 2.0.0 (2020-04-14)
 
@@ -240,7 +249,7 @@ Fixes [#56](https://github.com/palkan/anyway_config/issues/56).
 For example:
 
 ```ruby
-class MyConfig < Anyway::Config
+class MyConfig < Runger::Config
   attr_config :key, :secret, debug: false
 end
 
@@ -313,13 +322,13 @@ _dynamic_ (runtime) configs.
 you can set static configs path to `app/configs`:
 
 ```ruby
-config.anyway_config.autoload_static_config_path = "app/configs"
+config.runger_config.autoload_static_config_path = "app/configs"
 ```
 
 You can do this by running the generator:
 
 ```sh
-rails g anyway:install --configs-path=app/configs
+rails g runger:install --configs-path=app/configs
 ```
 
 - Add Rails generators. ([@palkan][])
@@ -377,20 +386,20 @@ 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
+class MyConfig < Runger::Config
   attr_config :api_key, :api_secret, :debug
 
   required :api_key, :api_secret
 end
 
-MyConfig.new(api_secret: "") #=> raises Anyway::Config::ValidationError
+MyConfig.new(api_secret: "") #=> raises Runger::Config::ValidationError
 ```
 
 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).
+Do not allow using reserved names (`Runger::Config` method names).
 Allow only alphanumeric names (matching `/^[a-z_]([\w]+)?$/`).
 
 - Add Loaders API. ([@palkan][])
@@ -416,7 +425,7 @@ Config.new(data)
 
 - Add Railtie. ([@palkan][])
 
-`Anyway::Railtie` provides `Anyway::Settings` access via `Rails.applicaiton.configuration.anyway_config`.
+`Runger::Railtie` provides `Runger::Settings` access via `Rails.applicaiton.configuration.runger_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.
@@ -437,7 +446,7 @@ Now users can store their personal configurations in _local_ files:
 - `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
+`Runger::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][])
@@ -477,14 +486,14 @@ Now it's possible to extend config classes without breaking the original classes
 
 - Add OptionParse integration ([@jastkand][])
 
-See more [PR#18](https://github.com/palkan/anyway_config/pull/18).
+See more [PR#18](https://github.com/palkan/runger_config/pull/18).
 
 - Use underscored config name as an env prefix. ([@palkan][])
 
 For a config class:
 
 ```ruby
-class MyApp < Anyway::Config
+class MyApp < Runger::Config
 end
 ```
 
@@ -493,7 +502,7 @@ Before this change we use `MYAPP_` prefix, now it's `MY_APP_`.
 You can specify the prefix explicitly:
 
 ```ruby
-class MyApp < Anyway::Config
+class MyApp < Runger::Config
   env_prefix "MYAPP_"
 end
 ```
@@ -502,7 +511,7 @@ end
 
 - Ruby 2.2 is no longer supported.
 
-- `Anyway::Config.env_prefix` method is introduced. ([@charlie-wasp][])
+- `Runger::Config.env_prefix` method is introduced. ([@charlie-wasp][])
 
 ## 1.2.0 (2018-02-19)
 
@@ -523,7 +532,7 @@ Sniffer::Config.new(
 )
 ```
 
-See more [PR#10](https://github.com/palkan/anyway_config/pull/10).
+See more [PR#10](https://github.com/palkan/runger_config/pull/10).
 
 ## 1.1.2 (2017-11-19)
 
@@ -537,7 +546,7 @@ See more [PR#10](https://github.com/palkan/anyway_config/pull/10).
 
 - Add `#to_h` method. ([@palkan][])
 
-See [#4](https://github.com/palkan/anyway_config/issues/4).
+See [#4](https://github.com/palkan/runger_config/issues/4).
 
 - Make it possible to extend configuration parameters. ([@palkan][])