X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMooseX%2FConfigFromFile.pm;h=5fa8cac5d8e745583bb0a135c9a35efe25aa67f2;hb=eb27f7e786f04d44cdc18de8b9dc16eae4c6f66c;hp=a298dcfd19aceddfccf954dce453a0e0040e8b53;hpb=6210e5a52d5fba351a2d5f1a0e0d8d592a59d091;p=gitmo%2FMooseX-ConfigFromFile.git diff --git a/lib/MooseX/ConfigFromFile.pm b/lib/MooseX/ConfigFromFile.pm index a298dcf..5fa8cac 100644 --- a/lib/MooseX/ConfigFromFile.pm +++ b/lib/MooseX/ConfigFromFile.pm @@ -1,21 +1,27 @@ package MooseX::ConfigFromFile; use Moose::Role; -use MooseX::Types::Path::Class qw( File ); -use Try::Tiny qw/ try /; +use MooseX::Types::Path::Tiny 'Path'; +use MooseX::Types::Moose 'Undef'; +use Try::Tiny; use Carp qw(croak); use namespace::autoclean; -our $VERSION = '0.04'; - requires 'get_config_from_file'; has configfile => ( is => 'ro', - isa => File, + isa => Path|Undef, coerce => 1, predicate => 'has_configfile', do { try { require MooseX::Getopt; (traits => ['Getopt']) } }, + lazy => 1, + # it sucks that we have to do this rather than using a builder, but some old code + # simply swaps in a new default sub into the attr definition + default => sub { + my $class = shift; + $class->_get_default_configfile if $class->can('_get_default_configfile'); + }, ); sub new_with_config { @@ -28,18 +34,22 @@ sub new_with_config { } else { # This would only succeed if the consumer had defined a new configfile - # sub to override the generated reader + # sub to override the generated reader - as suggested in old + # documentation $configfile = try { $class->configfile }; # this is gross, but since a lot of users have swapped in their own # default subs, we have to keep calling it rather than calling a # builder sub directly - and it might not even be a coderef either my $cfmeta = $class->meta->find_attribute_by_name('configfile'); - $configfile ||= $cfmeta->default if $cfmeta->has_default; + $configfile = $cfmeta->default if not defined $configfile and $cfmeta->has_default; if (ref $configfile eq 'CODE') { $configfile = $configfile->($class); } + + my $init_arg = $cfmeta->init_arg; + $opts{$init_arg} = $configfile if defined $configfile and defined $init_arg; } if (defined $configfile) { @@ -73,9 +83,9 @@ MooseX::ConfigFromFile - An abstract Moose role for setting attributes from a co package MooseX::SomeSpecificConfigRole; use Moose::Role; - + with 'MooseX::ConfigFromFile'; - + use Some::ConfigFile::Loader (); sub get_config_from_file { @@ -95,7 +105,7 @@ MooseX::ConfigFromFile - An abstract Moose role for setting attributes from a co with 'MooseX::SomeSpecificConfigRole'; # optionally, default the configfile: - around configfile => sub { '/tmp/foo.yaml' }; + sub _get_default_configfile { '/tmp/foo.yaml' } # ... insert your stuff here ... @@ -107,37 +117,31 @@ MooseX::ConfigFromFile - An abstract Moose role for setting attributes from a co =head1 DESCRIPTION -This is an abstract role which provides an alternate constructor for creating +This is an abstract role which provides an alternate constructor for creating objects using parameters passed in from a configuration file. The actual implementation of reading the configuration file is left to -concrete subroles. +concrete sub-roles. It declares an attribute C and a class method C, and requires that concrete roles derived from it implement the class method C. -Attributes specified directly as arguments to C supercede those +Attributes specified directly as arguments to C supersede those in the configfile. L knows about this abstract role, and will use it if available -to load attributes from the file specified by the commandline flag C<--configfile> +to load attributes from the file specified by the command line flag C<--configfile> during its normal C. =head1 Attributes =head2 configfile -This is a L object which can be coerced from a regular pathname -string. This is the file your attributes are loaded from. You can add a default -configfile in the consuming class and it will be honored at the appropriate time -(note that a simple sub declaration is not sufficient, as there is already a -sub by that name being added by Moose as the attribute reader) - - around configfile => sub { '/etc/myapp.yaml' }; - -Note that you can alternately just provide a C method which returns -the config file when called - this will be used in preference to the default of -the attribute. +This is a L object which can be coerced from a regular path +string or any object that supports stringification. +This is the file your attributes are loaded from. You can add a default +configfile in the consuming class and it will be honored at the appropriate +time; see below at L. If you have L installed, this attribute will also have the C trait supplied, so you can also set the configfile from the @@ -153,14 +157,21 @@ C. Example: my $foo = SomeClass->new_with_config(configfile => '/etc/foo.yaml'); -Explicit arguments will overide anything set by the configfile. +Explicit arguments will override anything set by the configfile. =head2 get_config_from_file -This class method is not implemented in this role, but it is required of all subroles. -Its two arguments are the classname and the configfile, and it is expected to return +This class method is not implemented in this role, but it is required of all +classes or roles that consume this role. +Its two arguments are the class name and the configfile, and it is expected to return a hashref of arguments to pass to C which are sourced from the configfile. +=head2 _get_default_configfile + +This class method is not implemented in this role, but can and should be defined +in a consuming class or role to return the default value of the configfile (if not +passed into the constructor explicitly). + =head1 COPYRIGHT Copyright (c) - the MooseX::ConfigFromFile "AUTHOR" and "CONTRIBUTORS" as listed below.