Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tilfin/konfig-yaml-rb
Loader of YAML configuration for each execution enviroments
https://github.com/tilfin/konfig-yaml-rb
config configuration ruby settings yaml
Last synced: 14 days ago
JSON representation
Loader of YAML configuration for each execution enviroments
- Host: GitHub
- URL: https://github.com/tilfin/konfig-yaml-rb
- Owner: tilfin
- License: mit
- Created: 2018-02-11T08:39:37.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-16T12:36:08.000Z (almost 7 years ago)
- Last Synced: 2024-12-11T16:30:12.761Z (2 months ago)
- Topics: config, configuration, ruby, settings, yaml
- Language: Ruby
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# konfig-yaml for Ruby
[](https://badge.fury.io/rb/konfig-yaml)
[](http://www.rubydoc.info/gems/konfig-yaml/)
[](https://travis-ci.org/tilfin/konfig-yaml-rb)
[](https://codeclimate.com/github/tilfin/konfig-yaml-rb)
[](https://codeclimate.com/github/tilfin/konfig-yaml-rb/coverage)
The loader of YAML configuration for each execution environments like [settingslogic](https://github.com/settingslogic/settingslogic).
- Expand environment variables like bash (ex. `storage-${RUBY_ENV}`)
- If an environment variable is not set, it is to be emtpy string.
- If `${DB_USER:-user}` or `${DB_USER:user}` is defined, `user` is expanded unless DB_USER does not exists.
- Deep merge the environment settings and default settings (except array items)
- Support YAML Anchor `&something` / Reference `<<: *something`
- Ruby version of [konfig-yaml](https://github.com/tilfin/konfig-yaml)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'konfig-yaml'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install konfig-yaml
## Usage
### Load a configuration instance
```ruby
require 'konfig-yaml'
config = KonfigYaml.new([name], [opts]);
```
* `name` specifys the name of `config/.yml` ( default `app` )
* `opts`
* `:path` config directory path resolved from the process current one ( default `config` )
* `:erb` whether expand ERB or not ( default `false` )
* `:env` Execution environment ( default **RUBY_ENV** value, **RAILS_ENV** value, **RACK_ENV** value, or `development` )
### Load a configuration as Static class
```ruby
require 'konfig-yaml'
KonfigYaml.setup do |config|
config.const_name = 'Config' # default is 'Settings'
end
p Config.log.level
```
### Access the values
#### by accessor method
```ruby
port = config.port
log_lv = config.log.level
```
#### by symbol key
```ruby
port = config[:port]
log_lv = config.log[:level]
```
#### by string key
```ruby
port = config['port']
log_lv = config['log'].level
```
### Dynamically change settings
Support only symbol or string key if adding new field
```ruby
config[:port] = 80
config.log['level'] = 'fatal'
config[:backend] = { host: 'cms.example.com', "port" => 7080 }
p config.port # 80
p config.log.level # "fatal"
p config.backend.host # "cms.example.com"
p config.backend.port # 7080
```
## Example
### Setup
#### config/app.yml
```
default:
port: 8080
log:
level: info
db:
name: ${BRAND:-normal}-app-${RUBY_ENV}
user: user
pass: pass
production:
port: 1080
log:
level: error
db:
pass: Password
```
#### main.rb
```
require 'konfig-yaml'
config = KonfigYaml.new
puts config.port
puts config.log.level
puts config.db.user
puts config[:db]['name']
puts config['db'].password
```
### Run
#### In development
```
$ RUBY_ENV=development ruby main.rb
8080
info
normal-app-development
user
pass
```
#### In production
```
$ RUBY_ENV=production BRAND=awesome ruby main.rb
1080
error
awesome-app-production
user
Password
```
## License
[MIT](LICENSE)
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/tilfin/konfig-yaml-rb.