Config::Loader renamed to Config::Processor

Also improoved unit tests and added a half of POD documentation.

Author: Eugene Ponizovsky

Changes

@@ -1,6 +1,6 @@
-Revision history for Perl extension Config::Loader.
+Revision history for Perl extension Config::Processor.
 
 0.01  Tue Apr 19 11:22:20 2016
 	- original version; created by h2xs 1.23 with options
-		-AXO --skip-exporter --skip-autoloader -b5.8.0 -n Config::Loader
+		-AXO --skip-exporter --skip-autoloader -b5.8.0 -n Config::Processor
 

Makefile.PL

@@ -2,8 +2,8 @@ use 5.008000;
 use ExtUtils::MakeMaker;
 
 WriteMakefile(
-  NAME               => 'Config::Loader',
-  VERSION_FROM       => 'lib/Config/Loader.pm',
+  NAME               => 'Config::Processor',
+  VERSION_FROM       => 'lib/Config/Processor.pm',
   PREREQ_PM          => {
     'File::Spec'       => '0',
     'YAML::XS'         => '0.62',
@@ -21,13 +21,13 @@ WriteMakefile(
   },
   META_MERGE => {
     resources => {
-      homepage   => 'https://github.com/iph0/Config-Loader',
-      bugtracker => 'https://github.com/iph0/Config-Loader/issues',
-      repository => 'https://github.com/iph0/Config-Loader',
+      homepage   => 'https://github.com/iph0/Config-Processor',
+      bugtracker => 'https://github.com/iph0/Config-Processor/issues',
+      repository => 'https://github.com/iph0/Config-Processor',
       license    => 'http://dev.perl.org/licenses/',
     },
   },
-  ABSTRACT_FROM => 'lib/Config/Loader.pm',
+  ABSTRACT_FROM => 'lib/Config/Processor.pm',
   AUTHOR        => 'Eugene Ponizovsky <[email protected]>',
   LICENSE       => 'perl',
 );

README

@@ -1,4 +1,4 @@
-Config-Loader version 0.01_01
+Config-Processor version 0.01_01
 ========================
 
 INSTALLATION
@@ -12,7 +12,7 @@ To install this module type the following:
 
 DESCRIPTION
 
-Config::Loader is the cascading configuration files parser with file inclusions
+Config::Processor is the cascading configuration files parser with file inclusions
 and variables interpolation support.
 
 AUTHOR

examples/example.pl

@@ -3,15 +3,15 @@
 use strict;
 use warnings;
 
-use Config::Loader;
+use Config::Processor;
 use Data::Dumper;
 
-my $config_loader = Config::Loader->new(
-  dirs => [qw( examples/etc )],
+my $config_processor = Config::Processor->new(
+  dirs => [ qw( examples/etc ) ],
 );
 
 # Load all configuration sections
-my $config = $config_loader->load(
+my $config = $config_processor->load(
   qw( users.yml db.json passwords/* pathes.yml ),
 
   { db => {

lib/Config/Loader.pm renamed to lib/Config/Processor.pm

@@ -1,4 +1,4 @@
-package Config::Loader;
+package Config::Processor;
 
 use 5.008000;
 use strict;
@@ -299,22 +299,105 @@ __END__
 
 =head1 NAME
 
-Config::Loader - Cascading configuration files parser with file inclusions
+Config::Processor - Cascading configuration files processor with file inclusions
 and variables interpolation support
 
 =head1 SYNOPSIS
 
 =head1 DESCRIPTION
 
+=head1 CONSTRUCTOR
+
+=head2 new( %params )
+
+  my $config_processor = Config::Processor->new(
+    dirs => [ qw( /etc/myapp /home/username/myapp/etc ) ],
+  );
+
+  my $another_config_processor = Config::Processor->new(
+    dirs                  => [ qw( /etc/myapp /home/username/myapp/etc ) ],
+    interpolate_variables => 0,
+    process_directives    => 0,
+  );
+
+=over
+
+=item dirs => \@dirs
+
+List of directories in which configuration files will be serched.
+
+=item interpolate_variables => $boolean
+
+Enables or disables variable interpolation in configuration files.
+
+Enabled by default.
+
+=item process_directives => $boolean
+
+Enables or disables directive processing in configuration files.
+
+Enabled by default.
+
+=back
+
 =head1 METHODS
 
-=head2 new()
+=head2 load( @config_sections )
 
-=head2 load()
+  my $config = $config_processor->load(
+    qw( users.yml db.json passwords/* pathes.yml ),
 
-=head2 interpolate_variables
+    { db => {
+        frontend_master => {
+          host => 'localhost',
+          port => '5000',
+        },
 
-=head2 process_directives
+        frontend_slave => {
+          host => 'localhost',
+          port => '5000',
+        }
+      },
+    }
+  );
+
+Attempts to load all configuration sections and returns reference to resulting
+configuration tree.
+
+Configuration section can be specified in three ways: as a relative filename,
+as a filename with wildcard characters or as a hash reference. Filenames with
+wildcard characters is processed by C<glob> function.
+
+=head2 interpolate_variables( [ $boolean ] )
+
+Enables or disables variable interpolation in configurations files.
+
+=head2 process_directives( [ $boolean ] )
+
+Enables or disables directive processing in configuration files.
+
+=head1 MERGING RULES
+
+Configuration parser merges all specified configuration sections in one
+resulting configuration tree by following rules:
+
+  Left value  Right value  Result value
+
+  SCALAR $a   SCALAR $b    SCALAR $b
+  SCALAR $a   ARRAY  \@b   ARRAY  \@b
+  SCALAR $a   HASH   \%b   HASH   \%b
+
+  ARRAY \@a   SCALAR $b    SCALAR $b
+  ARRAY \@a   ARRAY  \@b   ARRAY  \@b
+  ARRAY \@a   HASH   \%b   HASH   \%b
+
+  HASH \%a    SCALAR $b    SCALAR $b
+  HASH \%a    ARRAY  \@b   ARRAY  \@b
+  HASH \%a    HASH   \%b   HASH   { %a, %b }
+
+=head1 INTERPOLATION
+
+=head1 DIRECTIVES
 
 =head1 AUTHOR
 
@@ -329,4 +412,3 @@ This module is free software; you can redistribute it and/or modify it under
 the same terms as Perl itself.
 
 =cut
-

t/00-base.t

@@ -7,9 +7,9 @@ use Test::More tests => 3;
 my $T_CLASS;
 
 BEGIN {
-  $T_CLASS = 'Config::Loader';
+  $T_CLASS = 'Config::Processor';
   use_ok($T_CLASS);
 }
 
 can_ok( $T_CLASS, 'new' );
-my $config_loader = new_ok($T_CLASS);
+my $config_processor = new_ok($T_CLASS);

t/01-accessors.t

@@ -3,46 +3,46 @@ use strict;
 use warnings;
 
 use Test::More tests => 8;
-use Config::Loader;
+use Config::Processor;
 
-my $CONFIG_LOADER = Config::Loader->new();
+my $CONFIG_PROCESSOR = Config::Processor->new();
 
-can_ok( $CONFIG_LOADER, 'interpolate_variables' );
-can_ok( $CONFIG_LOADER, 'process_directives' );
+can_ok( $CONFIG_PROCESSOR, 'interpolate_variables' );
+can_ok( $CONFIG_PROCESSOR, 'process_directives' );
 
-t_interpolate_variables($CONFIG_LOADER);
-t_process_directives($CONFIG_LOADER);
+t_interpolate_variables($CONFIG_PROCESSOR);
+t_process_directives($CONFIG_PROCESSOR);
 
 
 sub t_interpolate_variables {
-  my $config_loader = shift;
+  my $config_processor = shift;
 
-  my $interpolate_variables = $config_loader->interpolate_variables;
+  my $interpolate_variables = $config_processor->interpolate_variables;
   is( $interpolate_variables, 1, 'get variable interpolation switch value' );
 
-  $config_loader->interpolate_variables(undef);
-  is( $config_loader->interpolate_variables,
+  $config_processor->interpolate_variables(undef);
+  is( $config_processor->interpolate_variables,
       undef, 'disable variable interpolation' );
 
-  $config_loader->interpolate_variables(1);
-  is( $config_loader->interpolate_variables, 1,
+  $config_processor->interpolate_variables(1);
+  is( $config_processor->interpolate_variables, 1,
       "enable variable interpolation" );
 
   return;
 }
 
 sub t_process_directives {
-  my $config_loader = shift;
+  my $config_processor = shift;
 
-  my $process_directives = $config_loader->process_directives;
+  my $process_directives = $config_processor->process_directives;
   is( $process_directives, 1, 'get directive processing switch value' );
 
-  $config_loader->process_directives(undef);
-  is( $config_loader->process_directives,
+  $config_processor->process_directives(undef);
+  is( $config_processor->process_directives,
       undef, 'disable directive processing' );
 
-  $config_loader->process_directives(1);
-  is( $config_loader->process_directives, 1, "enable directive processing" );
+  $config_processor->process_directives(1);
+  is( $config_processor->process_directives, 1, "enable directive processing" );
 
   return;
 }