File Coverage

blib/lib/Amon2/Config/Simple.pm

Criterion	Covered	Total	%
statement	12	23	52.1
branch	0	8	0.0
condition	0	2	0.0
subroutine	4	5	80.0
pod	0	1	0.0
total	16	39	41.0

package Amon2::Config::Simple;
use strict;
use warnings;
use File::Spec;
use Carp ();

sub load {
    my ($class, $c) = (shift, shift);
    my %conf = @_ == 1 ? %{$_[0]} : @_;

    my $env = $conf{environment} || $c->mode_name || 'development';
    my $fname = File::Spec->catfile($c->base_dir, 'config', "${env}.pl");
    my $config = do $fname;
    Carp::croak("$fname: $@") if $@;
    Carp::croak("$fname: $!") unless defined $config;
    unless ( ref($config) eq 'HASH' ) {
        Carp::croak("$fname does not return HashRef.");
    }
    return $config;
}

1;
__END__

=encoding utf-8

=head1 NAME

Amon2::Config::Simple - Default configuration file loader

=head1 SYNOPSIS

    package MyApp2;
    # do "config/@{{ $c->mode_name ]}.pl"
    use Amon2::Config::Simple;
    sub load_config { Amon2::Config::Simple->load(shift) }

=head1 DESCRIPTION

This is a default configuration file loader for L<Amon2>.

This module loads the configuration by C<< do >> function. Yes, it's just plain perl code structure.

Amon2 using configuration file in C<< "config/@{[ $c->mode_name ]}.pl" >>.

=head1 HOW DO YOU USE YOUR OWN ENVIRONMENT VARIABLE FOR DETECTING CONFIGURATION FILE?

If you want to use C<< config/$ENV{RUN_MODE}.pl >> for the configuration file, you can write code as following:

    package MyApp;
    use Amon2::Config::Simple;
    sub load_config { Amon2::Config::Simple->load(shift, +{ environment => $ENV{RUN_MODE} } ) }