NAME

Honeydew::Config - A config singleton for Honeydew

VERSION

version 0.08

SYNOPSIS

In config.ini:

[passwords]
a=b
c=d

In App.pm:

use Honeydew::Config;

my $config = Honeydew::Config->instance( file => 'config.ini' );
print $config->{passwords}->{a}; # 'b'

DESCRIPTION

A simple config singleton - it will read in a configuration file as described by "file". There's also the option to use config/feature flags & toggles, if your app needs them.

Note that only groups are stored at the top level, and the default group is "", an empty string. If no file is provided during the initial call to instance, we'll try to initialize from /opt/honeydew/honeydew.ini if the file exists; otherwise, you'll get the following default configurations:

# Add perl libraries to include when running Honeydew, in case it's
# installed in a non-standard location
[perl]
libs=-I/home/honeydew/perl5/lib/perl5

# Describe the directory configuration for the server
[honeydew]
basedir=/opt/honeydew/
screenshotsdir=/tmp

# Configure the MySQL report database parameters
[mysql]
host=127.0.0.1
database=test
username=root
password=password

# Tell Honeydew where to find the proxy
[proxy]
proxy_server_addr=127.0.0.1
proxy_server_port=8080

# Tell Honeydew where to find Redis
[redis]
redis_server=127.0.0.1
redis_port=6379
redis_background_channel=no_channel

# Which users jobs to should be sent to redis
[flags]
redis=all

This will be represented in memory like

my $config = {
    perl => {
        libs => '-I/home/honeydew/perl5/lib/perl'
    },
    honeydew => {
        basedir => '/opt/honeydew',
        screenshotsdir => '/tmp'
    },
    mysql => {
        host => '127.0.0.1',
        database => 'test',
        username => 'root',
        password => 'password'
    },
    proxy => {
        proxy_server_addr => '127.0.0.1',
        proxy_server_port => '8080'
    },
    redis => {
        redis_server => '127.0.0.1',
        redis_port => '6379',
        redis_background_channel => 'no_channel'
    },
    flags => {
        redis => 'all'
    }
};

such that the following is true, assuming that /opt/honeydew/honeydew.ini does not exist:

my $config = Honeydew::Config->instance;
is($config->{flags}->{redis}, 'all');

ATTRIBUTES

file

Defaults to /opt/honeydew/honeydew.ini, but you can point this module to any ini file by using this attribute during start up. Since this is a singleton, we strongly discourage you from changing it after construction for the sake of not confusing yourself, and additionally because nothing will happen to the config data in memory.

If no file is specified, we will still try to load from the default file at /opt/honeydew/honeydew.ini if it exists before falling back to the default configuration data as specified in the "DESCRIPTION".

METHODS

features_dir

sets_dir

phrases_dir

Specify where the Honeydew features/sets/phrases are located. This uses $config-{honeydew}->{basedir}> and appends the appropriate directory name to it. In your inifile, you might do

[honeydew]
basedir=/opt/honeydew

And that would result in a sets_dir of /opt/honeydew/sets, and analogous directories for features and phrases.

is_tester

One header is treated specially:

[flags]
feature=flags
can=go,here

If you'd like to put your config flags in a section with the header flags, you can use this function to test whether a user qualifies to use the feature described by the flag. With the above setup, the following would work:

$config->is_tester('feature', 'flags'); # true
$config->is_tester('can', 'go'); # true
$config->is_tester('can', 'here'); # true

$config->is_tester('feature', 'normal-user'); # false

redis_addr

A convenience method that concatenates the redis_server and redis_port in the redis group.

mysql_dsn

A convenience method for constructing the dsn for a MySQL database connection. It uses the following values from the [mysql] section of the config file to construct the dsn.

[mysql]
host=host_address
database=database
username=username
password=password

would create a dsn like

(
    'DBI:mysql:database=database;host=host',
    'username',
    'password',
    { RaiseError => 1 }
)

Usage looks like:

my $config = Honeydew::Config->instance;
my $dbh = DBI->connect( $config->dsn );

choose_gmail_account

Returns the username and password for the email account that you pass in, already in the proper format for use as the arguments in the constructor to "new" in Honeydew::CheckGmail.

For the following config entry,

[gmail]
account=user:pass
account2=user2:pass2
account3=user3:pass3

this subroutine would satisfy the following:

# default behavior is to return the creds from the "account" key
my $default = $config->choose_account;
is($default, { user => 'user', password => 'pass' };

my $b_account = $config->choose_account('user2');
is($b_account, { user => 'user2', password => 'pass2' };

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/honeydew-sc/Honeydew-Config/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

Daniel Gempesaw [email protected]

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Daniel Gempesaw.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.