0.01
No release in over a year
Provides a way to manage environment specific configuration settings.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

>= 0
>= 0
~> 3.9
~> 1.14

Runtime

>= 0
~> 5.2, >= 5.2.1
 Project Readme

ConfigReader

Maintainability Specs Ruby 3.0+

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: noreply@example.com
  site_name: example
  admin_email: admin@example.com

production:
  site_url: http://example.com

Sekrets

Includes Sekrets integration. See https://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    #=> noreply@example.com
MyConfig[:mail_from]  #=> noreply@example.com
MyConfig["mail_from"] #=> noreply@example.com

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

Copyright (c) Michael Moen. See LICENSE for details.