Konfiguracja

Konfiguracja is a flexible DSL for configurations inspired by anyway_config gem and powered by dry-rb stack.

Install the gem and add to the application's Gemfile by executing:

$ bundle add konfiguracja

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install konfiguracja

To define a config inherit from Konfiguracja::Config and declare attributes with dry-struct DSL:

class AppConfig < Konfiguracja::Config
  attribute :foo, Dry.Types::String
  attribute :nested do
    attribute :bar, Dry.Types::Boolean
  end
end

Such config will load data from (last one wins):

• config/app.yml
• config/app.local.yml
• APP_FOO, APP_NESTED__BAR environment variables
• explicit values passed to initializer

By default it loads data from ./config/config_name.yml. You can change the path by initializing a new loader:

Konfiguracja.loaders.replace(:yaml, Konfiguracja::Loaders::Yaml.new(config_path: "path/to/yaml/files"))

By default it loads data from ./config/config_name.local.yml. You can change the path by initializing a new loader:

Konfiguracja.loaders.replace(:local_yaml, Konfiguracja::Loaders::LocalYaml.new(config_path: "path/to/local/yaml/files"))

You should also add *.local.yml to .gitignore - the idea is that local yaml config files allows you to define values specific for developers machine.

Env loader will read envs prefixed with CONFIG_NAME_. Nested keys has to be separated by double underscore __ e.g. CONFIG_NAME_FOO__BAR will end up with ConfigName(foo: {bar: val}).

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/konfiguracja. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Konfiguracja project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.