Flexible specifying of application settings
It is Ruby library for flexible specifying of application settings different ways:
- from YAML file(default and custom settings)
- from command line
Init version with base functionality
It was tested with Ruby 1.9.2, but assumes it should work with other Ruby version as well
gem install sexy_settings
Create 2 configuration files, for default and custom settings. For instance,
config\
default.yaml
overwritten.yaml
Place next code to boot executable ruby file:
require 'sexy_settings'
SexySettings.configure do |config|
config.path_to_default_settings = File.expand_path("config.yaml", File.join(File.dirname(__FILE__), '..', 'config')) # 'default.yml' by default
config.path_to_custom_settings = File.expand_path("overwritten.yaml", File.join(File.dirname(__FILE__), '..', 'config')) # 'custom.yml' by default
config.path_to_project = File.dirname(__FILE__) # '.' by default
config.env_variable_with_options = 'OPTIONS' # 'OPTS' by default
cmd_line_option_delimiter = '$$$' # ',' by default
endSpecify shortcut method for Settings object:
def settings
SexySettings::Base.instance()
endThere are 4 possible values of settings The priority ranks with respect to the setting places are as follows:
command line < custom < default < nil(in case setting was not specified anywhere)
Thus, specifying some setting in command line will override the same setting value specified in <default config file> or <custom config file>
Example:
default.yaml
foo: bar
foo1: default ${foo}
foo2: default valueoverwritten.yaml
foo1: custom ${foo}Set environment variable:
OPTIONS="foo2=10$$$foo3=:hi$$$foo4=true"
puts settings.foo # returns 'bar'
puts settings.foo1 # returns 'custom foo'
puts settings.foo2 # returns 10
puts settings.foo3 # returns :hi
puts settings.foo4 # returns true- Add <default config file> under version control system
- Add <custom config file> to ignore list
- Use command line with using Environment Variable for quick specifying setting in your Continuous Integration System
- Use next code for output all settings as pretty formatted text:
puts settings.as_formatted_text