https://github.com/mjgardner/mousex-simpleconfig
A Mouse role for setting attributes from a simple configfile
https://github.com/mjgardner/mousex-simpleconfig
Last synced: 2 months ago
JSON representation
A Mouse role for setting attributes from a simple configfile
- Host: GitHub
- URL: https://github.com/mjgardner/mousex-simpleconfig
- Owner: mjgardner
- Created: 2011-03-05T17:08:11.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2011-03-06T00:00:47.000Z (about 14 years ago)
- Last Synced: 2025-03-20T02:48:41.898Z (3 months ago)
- Language: Perl
- Homepage: http://search.cpan.org/dist/MouseX-SimpleConfig/
- Size: 137 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.pod
- Changelog: Changes
Awesome Lists containing this project
README
=pod
=for :stopwords Brandon L. Black Mark Gardner Infinity Interactive
=head1 NAME
MouseX::SimpleConfig - A Mouse role for setting attributes from a simple configfile
=head1 VERSION
version 0.11
=head1 SYNOPSIS
## 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
=head1 DESCRIPTION
This role loads simple configfiles to set object attributes. It
is based on the abstract role
L, and uses
L to load your configfile.
L will in
turn support any of a variety of different config formats, detected
by the file extension. See L for more details about
supported formats.
Like all L -derived configfile
loaders, this
module is automatically supported by the L role
as
well, which allows specifying C<-configfile> on the commandline.
=head1 ATTRIBUTES
=head2 configfile
Provided by the base role L.
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.
=head1 METHODS
=head2 new_with_config
Class method provided by the base role
L. Acts just like
regular C, but also accepts an argument C to specify
the configfile from which to load other attributes. Explicit arguments
to C will override anything loaded from the configfile.
=head2 get_config_from_file
Class method called internally by either C or
L's
C. Invokes L to parse
C.
=head1 BUGS
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.
=head1 AUTHORS
=over 4
=item *
Brandon L. Black
=item *
Mark Gardner
=back
=head1 COPYRIGHT AND LICENSE
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.