Support automatic configuration import from yaml files | adding doc to README

Author: matthieu88160

CHANGELOG_V1-x.md

@@ -0,0 +1,4 @@
+## Changelog for V1.x
+
+#### V1.1.0
+ * Support automatic configuration import from yaml files

README.md

@@ -1,2 +1,121 @@
 # perl-module-configurationManager
 The configuration manager perl module is used to dynamicaly load YAML configuration files with leazy load
+
+## Define the configuration repository:
+
+To define a repository, several ways exists:
+
+#### With use statement :
+
+The repositories defined by the use statement are shared between each configuration manager.
+
+```perl
+use FindBin;
+use configurationManager ["repo=".$FindBin::Bin."/conf", "repo=/an/other/config"];
+```
+
+#### With the 'new' subroutine
+
+By instanciate a new configurationManager with repositories, you assign to this manager a self repository that is not shared with the others.
+
+```perl
+use configurationManager;
+
+my $altConfig = configurationManager->new({
+	repositories => [$FindBin::Bin."/altConf"],
+});
+```
+
+## Get configuration
+
+The configurationManager offer access to the configuration behind the 'get' subroutine. The parameter to give as argument is the configuration filename without extension. If the file is into a recursive repository, give the relative path to it.
+
+### Example:
+```
+/path/to/the/repository:
+	-> myConfig.yaml
+	-> mySecondConfig.yaml
+	-> aDirectory:
+		-> anotherConfig.yaml
+```
+##### content of /path/to/the/repository/myConfig.yaml :
+```yaml
+hello: "world"
+my: "name"
+```
+
+##### content of /path/to/the/repository/aDirectory/anotherConfig.yaml :
+```yaml
+hello: "state"
+my: "purpose"
+```
+
+##### code :
+```perl
+use configurationManager;
+use Data::Dumper;
+
+my $manager = configurationManager->new({
+	repositories => ["/path/to/the/repository"],
+});
+
+print Dumper $manager->get("myConfig");
+# $VAR1 = {
+# 		'hello' => 'world',
+#		'my' => 'name'
+# };
+
+print Dumper $manager->get("aDirectory/anotherConfig");
+# $VAR2 = {
+# 		'hello' => 'state',
+#		'my' => 'purpose'
+# };
+```
+
+## Reserved keys :
+
+name | purpose | content
+---- | ------- | -------
+import | Import another configuration | scalar OR array
+
+### Import
+
+The import key is used to automatically load another configuration into the current one. Note, the importation is done by first level key, and the imported configuration never override the current.
+
+##### example:
+```
+/path/to/the/repository:
+	-> myConfig.yaml
+	-> mySecondConfig.yaml
+```
+##### content of /path/to/the/repository/myConfig.yaml :
+```yaml
+hello: "world"
+my: "name"
+import: "mySecondConfig"
+```
+##### content of /path/to/the/repository/mySecondConfig.yaml :
+```yaml
+is: "bergamote"
+and: 'I'
+eat: "strudle"
+```
+
+##### code :
+```perl
+use configurationManager;
+use Data::Dumper;
+
+my $manager = configurationManager->new({
+	repositories => ["/path/to/the/repository"],
+});
+
+print Dumper $manager->get("myConfig");
+# $VAR1 = {
+# 		'hello' => 'world',
+#		'my' => 'name',
+#		'is' => 'bergamote',
+#		'and' => 'I',
+#		'eat' => 'strudle'
+# };
+```

configurationManagerLib/Loader/ConfigurationImporter.pm

@@ -0,0 +1,42 @@
+package ConfigurationImporter;
+use strict;
+use warnings;
+require Exporter;
+
+sub import
+{
+	no strict 'refs';
+	no warnings 'once';
+	
+	my ($args) = @_;
+	return if(!exists $args->{"content"});
+	return if(!defined $args->{"content"});
+	
+	my $content = ${$args->{"content"}};
+	my $loader = $args->{"loader"};
+
+	foreach my $contentKey (keys($content)) {
+		next if ($contentKey ne "import");
+		
+		my @importedFiles;;
+		if (ref(\$content->{$contentKey}) eq "SCALAR") {
+			push(@importedFiles, $content->{$contentKey});
+		} elsif (ref($content->{$contentKey}) eq "ARRAY") {
+			push(@importedFiles, $_) foreach (@{$content->{$contentKey}});
+		}
+		
+		delete $content->{$contentKey};
+		foreach my $importedFile (@importedFiles) {
+			my $importedContent = $loader->load($importedFile);
+			
+			foreach my $importedContentKey (keys($importedContent)) {
+				if (!exists $content->{$importedContentKey}) {
+					$content->{$importedContentKey} = $importedContent->{$importedContentKey};
+				}
+			}
+		}
+	}
+}
+
+1;
+__END__

configurationManagerLib/Loader/ConfigurationLoader.pm

@@ -2,7 +2,8 @@ package ConfigurationLoader;
 use strict;
 use warnings;
 use ConfigException;
-use YAML qw/LoadFile/;
+use ConfigurationImporter qw/import/;
+use YAML qw/LoadFile Load/;
 
 sub new
 {
@@ -38,7 +39,14 @@ sub load
 		if ($config->{"loaded"}) {
 			return $config->{"content"};
 		} else {
-			$config->{"content"} = LoadFile($config->{"location"});
+			my $content = LoadFile($config->{"location"});
+			
+			ConfigurationImporter::import({
+				"content" => \$content,
+				"loader" => $self}
+			);
+			
+			$config->{"content"} = $content;
 			$config->{"loaded"} = 1;
 
 			return $config->{"content"};