User Configuration Files are configuration files which located in preference/your_environment/setting directory.

You may configure some constant values such as configuration for middlewares. They can be referenced from Handler classes or templates.

Setting Values

User configuration files are YAML files.

The following example configures the some middlewares through the user configuration file.

preference/your_environment/setting/server.yml

server:
    mysql:
        host: mysql.example.com
        port: 3306
        user: user
        password: password
        socket: /path/to/socket
    memcached:
        host: memcached.example.com
        port: 11211

Field names in top level among files are not supposed to be duplicate.

Getting Values

All of files located in preference/your_environment/setting directory are loaded automatically and recursively.

Getting Values From Handlers

handler/example.rb

class ExampleHandler < BaseHandler
    def index
        # This returns Hash => {"mysql"=>{"host"=>"mysql.example.com", "port"=>3306, "user"=>"user", "password"=>"password", "socket"=>"/path/to/socket"}, "memcached"=>{"host"=>"memcached.example.com", "port"=>11211}}
        Nekonote::Setting.get :server

        # This returns Hash => {"host"=>"mysql.example.com", "port"=>3306, "user"=>"user", "password"=>"password", "socket"=>"/path/to/socket"}
        Nekonote::Setting.get :server, :mysql

        # This returns String => "mysql.example.com"
        Nekonote::Setting.get :server, :mysql, :host

        # It's possible to use __setting_get instead of Nekonote::Setting.get.
        # This returns Hash => {"host"=>"memcached.example.com", "port"=>11211}
        __setting_get :server, :memcached
    end
end

Getting the values from templates

You may use a special liquid tag called __setting_get to get the values declared in user configuration files.

template/example.tml

server: {% setting_get server %}<br />
server, mysql: {% setting_get server, mysql %}<br />
server, mysql, host: {% setting_get server, mysql, host %}

The result on blowser must be the following:

server: {"mysql"=>{"host"=>"mysql.example.com", "port"=>3306, "user"=>"user", "password"=>"password", "socket"=>"/path/to/socket"}, "memcached"=>{"host"=>"memcached.example.com", "port"=>11211}}
server, mysql: {"host"=>"mysql.example.com", "port"=>3306, "user"=>"user", "password"=>"password", "socket"=>"/path/to/socket"}
server, mysql, host: mysql.example.com

Nekonote::Setting Class

Nekonote::Setting is the class to get some values from user configuration files.

The following is the list of class methods of Nekonote::Setting.

Nekonote::Setting.get(field_name [,…])

Returns values from user configuration files by some specific field names.

The first field name must be in top level. The next field name must be placed under the first field name.

Return Values:

It returns mixed types if the given field_name was found.

It returns nil if field_name was not found or given no field_name.

Nekonote::Setting.keys

Returns all field names in the top level from user configuration files.

Return Values:

It returns array.

Nekonote::Setting.get_all

Returns all field names and values from user configuration files.

Return Values:

It returns hash.

More Examples

Getting Values As Array

preference/your_environment/example.yml

data:
    - foo
    - bar
    - baz

preference/handler/example.rb

Nekonote::Setting.get :data # It returns => ["foo", "bar", "baz"]