1 package MooseX::SimpleConfig;
4 with 'MooseX::ConfigFromFile';
10 sub get_config_from_file {
11 my ($class, $file) = @_;
13 my $files_ref = ref $file eq 'ARRAY' ? $file : [$file];
15 my $can_config_any_args = $class->can('config_any_args');
16 my $extra_args = $can_config_any_args ?
17 $can_config_any_args->($class, $file) : {};
19 my $raw_cfany = Config::Any->load_files({
27 foreach my $file_tested ( reverse @{$files_ref} ) {
28 if ( ! exists $raw_cfany->{$file_tested} ) {
29 warn qq{Specified configfile '$file_tested' does not exist, } .
30 qq{is empty, or is not readable\n};
34 my $cfany_hash = $raw_cfany->{$file_tested};
35 die "configfile must represent a hash structure in file: $file_tested"
36 unless $cfany_hash && ref $cfany_hash && ref $cfany_hash eq 'HASH';
38 %raw_config = ( %raw_config, %{$cfany_hash} );
52 MooseX::SimpleConfig - A Moose role for setting attributes from a simple configfile
56 ## A YAML configfile named /etc/my_app.yaml:
64 with 'MooseX::SimpleConfig';
66 has 'foo' => (is => 'ro', isa => 'Str', required => 1);
67 has 'baz' => (is => 'rw', isa => 'Int', required => 1);
69 # ... rest of the class here
76 my $app = My::App->new_with_config(configfile => '/etc/my_app.yaml');
77 # ... rest of the script here
80 ###### combined with MooseX::Getopt:
86 with 'MooseX::SimpleConfig';
87 with 'MooseX::Getopt';
89 has 'foo' => (is => 'ro', isa => 'Str', required => 1);
90 has 'baz' => (is => 'rw', isa => 'Int', required => 1);
92 # ... rest of the class here
99 my $app = My::App->new_with_options();
100 # ... rest of the script here
102 ## on the command line
103 % perl my_app_script.pl -configfile /etc/my_app.yaml -otherthing 123
107 This role loads simple configfiles to set object attributes. It
108 is based on the abstract role L<MooseX::ConfigFromFile>, and uses
109 L<Config::Any> to load your configfile. L<Config::Any> will in
110 turn support any of a variety of different config formats, detected
111 by the file extension. See L<Config::Any> for more details about
114 Like all L<MooseX::ConfigFromFile> -derived configfile loaders, this
115 module is automatically supported by the L<MooseX::Getopt> role as
116 well, which allows specifying C<-configfile> on the commandline.
122 Provided by the base role L<MooseX::ConfigFromFile>. You can
123 provide a default configfile pathname like so:
125 has '+configfile' => ( default => '/etc/myapp.yaml' );
127 You can pass an array of filenames if you want, but as usual the array
128 has to be wrapped in a sub ref.
130 has '+configfile' => ( default => sub { [ '/etc/myapp.yaml', '/etc/myapp_local.yml' ] } );
132 Config files are trivially merged at the top level, with the right-hand files taking precedence.
136 =head2 new_with_config
138 Provided by the base role L<MooseX::ConfigFromFile>. Acts just like
139 regular C<new()>, but also accepts an argument C<configfile> to specify
140 the configfile from which to load other attributes. Explicit arguments
141 to C<new_with_config> will override anything loaded from the configfile.
143 =head2 get_config_from_file
145 Called internally by either C<new_with_config> or L<MooseX::Getopt>'s
146 C<new_with_options>. Invokes L<Config::Any> to parse C<configfile>.
150 Brandon L. Black, E<lt>blblack@gmail.comE<gt>
154 This library is free software; you can redistribute it and/or modify
155 it under the same terms as Perl itself.