Configly is a lightweight ruby Hash object with dot notation access.
It is designed for loading and using YAML configuration files.
$ gem install configly
Initialize a Configly object from Hash:
# Initialize from hash
require 'configly'
hash = {server: {host: 'localhost', port: 3000}}
configly = hash.to_configlyor by loading one or more YAML files:
# Initialize by merging in YAML files
config = Configly.new
config << 'spec/fixtures/settings.yml'
puts config.imported.settings.also
#=> workYou can append additional YAML files by using either #<< or #load.
The '.yml' extension is optional.
In addition, you may load YAML files to nested keys:
# Loading nested YAMLs
config = Configly.new
config << 'spec/fixtures/settings'
p config.imported.settings
#=> {:also=>"work"}
config.nested.settings.load 'spec/fixtures/settings'
p config.nested.settings
#=> {:imported=>{:settings=>{:also=>"work"}}}Configly objects inherit from Hash:
puts configly.is_a? Configly #=> true
puts configly.is_a? Hash #=> trueRead values using dot notation:
# Dot notation access
puts configly.server.host
#=> localhostReading nonexistent deep values will not raise an error:
# Deep dot notation access
p configly.some.deeply.nested_value
#=> {}To check if a key exists, use ?
# Check if a key exists
p configly.some.deeply.nested_value?
#=> false
p configly.server.port?
#=> trueTo get the value or nil if it does not exist, use !:
# Get value or nil
p configly.some.deeply.nested_value!
#=> nil
p configly.server.port!
#=> 3000Writing values is just as easy:
# Dot notation write access
configly.production.server.port = 4000
puts configly.production.server.port
#=> 4000Arrays with hashes as values, will also work (as the nested hashes will be coerced into Configly objects):
# Arrays of hashes
configly.servers = [
{ host: 'prod1.example.com', port: 3000 },
{ host: 'prod2.example.com', port: 4000 },
]
puts configly.servers.first.host
#=> prod1.example.com
puts configly.servers.first.is_a? Configly
#=> trueConfigly allows read/write access using the usual array/hash syntax #[] using
either a string a symbol key:
# Array access
puts configly.server.port #=> 3000
puts configly.server[:port] #=> 3000
puts configly.server['port'] #=> 3000
configly.server[:port] = 4000
puts configly.server.port #=> 4000Due to the fact that Configly is inheriting from Hash, and using
method_missing to allow dot notation access, your settings hashes cannot
use keys that are defined as methods in the Hash object.
When this case is identified, a KeyError will be raised.
# Reserved keys
configly.api.key = '53cr3t'
#=> #<KeyError: Reserved key: key>
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent