ConfigReader

<img src=“https://codeclimate.com/github/UnderpantsGnome/config_reader-gem.png” /> <img src=“https://travis-ci.org/UnderpantsGnome/config_reader-gem.svg?branch=master” alt=“Build Status” />

Provides a way to manage environment specific configuration settings. It will use the defaults for any environment and override any values you specify for an environment.

Example config file:

defaults:
  site_url: http://localhost:3000
  host_name: example.com
  mail_from: [email protected]
  site_name: example
  admin_email: [email protected]
  blackbird: true

production:
  site_url: http://example.com
  blackbird: false

test:
  blackbird: false

Sekrets

Includes Sekrets integration. See github.com/ahoward/sekrets for more information.

The format of the sekrets file is the same as the regular file.

Setup

class MyConfig < ConfigReader
  configure do |config|
    config.environment = Rails.env # (set this however you access the env in your app)
    config.config_file = 'config/my_config.yml'
    config.sekrets_file = 'config/my_config.yml.enc' # (default nil)
    config.ignore_missing_keys = true # (default false, raises KeyError)
  end
end

Usage

MyConfig.mail_from   #=> [email protected]
MyConfig[:mail_from] #=> [email protected]
MyConfig['mail_from'] #=> [email protected]

Note on Patches/Pull Requests

  • Fork the project.

  • Make your feature addition or bug fix.

  • Add tests for it. This is important so I don’t break it in a future version unintentionally.

  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

  • Send me a pull request. Bonus points for topic branches.

Copyright © 2008-2018 Michael Moen. See LICENSE for details.