MouseX::SimpleConfig - A Mouse role for setting attributes from a simple configfile
version 0.11
## A YAML configfile named /etc/my_app.yaml: foo: bar baz: 123 ## In your class package My::App; use Mouse; with 'MouseX::SimpleConfig'; has 'foo' => (is => 'ro', isa => 'Str', required => 1); has 'baz' => (is => 'rw', isa => 'Int', required => 1); # ... rest of the class here ## in your script #!/usr/bin/perl use My::App; my $app = My::App->new_with_config(configfile => '/etc/my_app.yaml'); # ... rest of the script here #################### ###### combined with MouseX::Getopt: ## In your class package My::App; use Mouse; with 'MouseX::SimpleConfig'; with 'MouseX::Getopt'; has 'foo' => (is => 'ro', isa => 'Str', required => 1); has 'baz' => (is => 'rw', isa => 'Int', required => 1); # ... rest of the class here ## in your script #!/usr/bin/perl use My::App; my $app = My::App->new_with_options(); # ... rest of the script here ## on the command line % perl my_app_script.pl -configfile /etc/my_app.yaml -otherthing 123
This role loads simple configfiles to set object attributes. It is based on the abstract role MouseX::ConfigFromFile, and uses Config::Any to load your configfile. Config::Any will in turn support any of a variety of different config formats, detected by the file extension. See Config::Any for more details about supported formats.
Like all MouseX::ConfigFromFile -derived configfile loaders, this module is automatically supported by the MouseX::Getopt role as well, which allows specifying -configfile on the commandline.
-configfile
Provided by the base role MouseX::ConfigFromFile. You can provide a default configfile pathname like so:
has '+configfile' => ( default => '/etc/myapp.yaml' );
You can pass an array of filenames if you want, but as usual the array has to be wrapped in a sub ref.
has '+configfile' => ( default => sub { [ '/etc/myapp.yaml', '/etc/myapp_local.yml' ] } );
Config files are trivially merged at the top level, with the right-hand files taking precedence.
Class method provided by the base role MouseX::ConfigFromFile. Acts just like regular new(), but also accepts an argument configfile to specify the configfile from which to load other attributes. Explicit arguments to new_with_config will override anything loaded from the configfile.
new()
configfile
new_with_config
Class method called internally by either new_with_config or MouseX::Getopt's new_with_options. Invokes Config::Any to parse configfile.
new_with_options
Please report any bugs or feature requests on the bugtracker website http://github.com/mjg/MouseX-SimpleConfig/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
Brandon L. Black <blblack@gmail.com>
Mark Gardner <mjgardner@cpan.org>
This software is copyright (c) 2011 by Infinity Interactive.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install MouseX::SimpleConfig, copy and paste the appropriate command in to your terminal.
cpanm
cpanm MouseX::SimpleConfig
CPAN shell
perl -MCPAN -e shell install MouseX::SimpleConfig
For more information on module installation, please visit the detailed CPAN module installation guide.