Changeset 11708 for lang/perl/Config-Multi

Timestamp:

05/17/08 00:29:44 (5 years ago)

Author:

tomyhero

Message:

lang/perl/Config-Muti : add POD.

Location:

lang/perl/Config-Multi/trunk

Files:

• Makefile.PL (modified) (1 diff)
• lib/Config/Multi.pm (modified) (4 diffs)
• t/01-loadling.t (modified) (1 diff)
• t/04-env.t (added)
• t/conf/env-prefix.yml (added)
• t/conf/env.yml (added)
• t/spelling.t (modified) (1 diff)

lang/perl/Config-Multi/trunk/Makefile.PL

@@ -6 +6 @@
 author 'Tomohiro Teranishi <tomohiro.teranishi@gmail.com>';
 all_from 'lib/Config/Multi.pm';
-requires 'Test::More'            => 0;
+requires 'Test::Base'            => 0;
 requires 'Test::Spelling'        => 0;
 requires 'DirHandle'             => 0;
 requires 'Config::Any'           => 0;
+requires 'Class::Accessor'       => 0;
 requires 'YAML::Syck'            => 0; # for testing
 recommends 'Test::Pod::Coverage' => 0;

lang/perl/Config-Multi/trunk/lib/Config/Multi.pm

@@ -5 +5 @@
 use DirHandle;
 use File::Spec;
-use YAML::Syck;
 use FindBin;
 use Config::Any ;
@@ -15 +14 @@
     my $self = shift;
     my @files = ();
-    my $app_files    = $self->find_files( $self->{app_name} ) ;
-    my $prefix_files = $self->find_files( $self->{prefix} . '_' . $self->{app_name} );
-    my $local_files = $self->local_files;
+    $self->{extension} ||= 'yml';
+    my $app_files    = $self->_find_files( $self->{app_name} ) ;
+    my $prefix_files = $self->_find_files( $self->{prefix} . '_' . $self->{app_name} );
+    my $local_files = $self->_local_files;
 
     my $config = {};
@@ -48 +48 @@
 
 
-sub local_files {
+sub _local_files {
     my $self = shift;
-    my $config_key_name = uc($self->{prefix}) . '_' . uc($self->{app_name}) . '_CONFIG_MULTI';
-    if ( $ENV{ $config_key_name } ) {
-        return ( -e $ENV{ $config_key_name } ) ? [ $ENV{ $config_key_name } ] : [] ; 
-    }
-    else {
-        my @files = ();
-        my $app_lcoal    = File::Spec->catfile( $self->dir ,  $self->{app_name} . '_local.' . $self->extension ) ;
-        my $prefix_local = File::Spec->catfile( $self->dir ,  $self->{prefix} . '_' . $self->{app_name} . '_local.' . $self->extension );
+    my $env_app_key    = 'CONFIG_MULTI_' .uc($self->{app_name})  ;
+    my $env_prefix_key = 'CONFIG_MULTI_' . uc($self->{prefix}) . '_' . uc($self->{app_name})  ;
+    my @files = ();
+    my $app_lcoal    = $ENV{ $env_app_key } || File::Spec->catfile( $self->dir ,  $self->{app_name} . '_local.' . $self->extension ) ;
+    my $prefix_local = $ENV{ $env_prefix_key} || File::Spec->catfile( $self->dir ,  $self->{prefix} . '_' . $self->{app_name} . '_local.' . $self->extension );
 
-        push @files  , $app_lcoal if -e $app_lcoal;
-        push @files  , $prefix_local if -e $prefix_local;
+    push @files  , $app_lcoal if -e $app_lcoal;
+    push @files  , $prefix_local if -e $prefix_local;
 
-        return \@files;
-    }
+    return \@files;
 }
 
-sub find_files {
+sub _find_files {
     my $self = shift;
     my $path = $self->dir;
@@ -90 +86 @@
 =head1 NAME
 
-Config::Multi - my module Config::Multi !!
+Config::Multi - load multiple config files.
 
 =head1 SYNOPSIS
 
+ use Config::Multi;
+ use File::Spec;
+ use FindBin;
+ 
+ my $dir = File::Spec->catfile( $FindBin::Bin , 'conf' );
+ my $cm =  Config::Multi->new({dir => $dir , app_name => 'myapp' , prefix => 'web' , extension => 'yml' });
+ my $config = $cm->load();
+ my $loaded_config_files = $cm->files;
+
 =head1 DESCRIPTION
+
+
+
+=head1 METHODS
+
+=head2 new
+ 
+constructor SEE CONSTRUCTOR ARGUMENT section.
+
+=head2 load
+
+load config files and return config data.
+
+=head2 files
+
+get array references of loaded config files. You can use this method after call load() method.
+
+=head1 CONSTRUCTOR ARGUMENT
+
+=head2 app_name
+
+your application name. use [a-z]+ for format. 
+
+=head2 prefix
+
+prefix name . use [a-z]+ for format.
+
+=head2 dir
+
+specify directory where your config files are located.
+
+=head2 extension
+
+you must specify extension for your config files. default is yml.
 
 =head1 AUTHOR

lang/perl/Config-Multi/trunk/t/01-loadling.t

@@ -13 +13 @@
 run { 
     my $block = shift;
-    my $config = Config::Multi->new({dir => $dir , app_name => 'myapp' , prefix => $block->prefix , extension => 'yml' });
+    my $config = Config::Multi->new({dir => $dir , app_name => 'myapp' , prefix => $block->prefix  });
     $config->load();
     my $paths = $config->files;

lang/perl/Config-Multi/trunk/t/spelling.t

@@ -19 +19 @@
 
 __END__
-
+Teranishi
+Tomohiro
+dir
+yml