1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
package MooseX::ConfigFromFile;
use Moose::Role;
use MooseX::Types::Path::Class qw( File );
use Try::Tiny qw/ try /;
use Carp qw(croak);
use namespace::autoclean;
our $VERSION = '0.04';
requires 'get_config_from_file';
has configfile => (
is => 'ro',
isa => File,
coerce => 1,
predicate => 'has_configfile',
);
sub new_with_config {
my ($class, %opts) = @_;
my $configfile;
if(defined $opts{configfile}) {
$configfile = $opts{configfile}
}
else {
my $cfmeta = $class->meta->find_attribute_by_name('configfile');
$configfile = try { to_File($class->configfile) };
$configfile ||= $cfmeta->default if $cfmeta->has_default;
if (ref $configfile eq 'CODE') {
$configfile = &$configfile($class);
}
}
if (defined $configfile) {
my $hash = $class->get_config_from_file($configfile);
no warnings 'uninitialized';
croak "get_config_from_file($configfile) did not return a hash (got $hash)"
unless ref $hash eq 'HASH';
%opts = (%$hash, %opts);
}
$class->new(%opts);
}
no Moose::Role; 1;
__END__
=pod
=head1 NAME
MooseX::ConfigFromFile - An abstract Moose role for setting attributes from a configfile
=head1 SYNOPSIS
########
## A real role based on this abstract role:
########
package MooseX::SomeSpecificConfigRole;
use Moose::Role;
with 'MooseX::ConfigFromFile';
use Some::ConfigFile::Loader ();
sub get_config_from_file {
my ($class, $file) = @_;
my $options_hashref = Some::ConfigFile::Loader->load($file);
return $options_hashref;
}
########
## A class that uses it:
########
package Foo;
use Moose;
with 'MooseX::SomeSpecificConfigRole';
# optionally, default the configfile:
sub configfile { '/tmp/foo.yaml' }
# ... insert your stuff here ...
########
## A script that uses the class with a configfile
########
my $obj = Foo->new_with_config(configfile => '/etc/foo.yaml', other_opt => 'foo');
=head1 DESCRIPTION
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.
It declares an attribute C<configfile> and a class method C<new_with_config>,
and requires that concrete roles derived from it implement the class method
C<get_config_from_file>.
Attributes specified directly as arguments to C<new_with_config> supercede those
in the configfile.
L<MooseX::Getopt> knows about this abstract role, and will use it if available
to load attributes from the file specified by the commandline flag C<--configfile>
during its normal C<new_with_options>.
=head1 Attributes
=head2 configfile
This is a L<Path::Class::File> 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 class using the role and it will be honored at the appropriate time:
has +configfile ( default => '/etc/myapp.yaml' );
Note that you can alternately just provide a C<configfile> method which returns
the config file when called - this will be used in preference to the default of
the attribute.
=head1 Class Methods
=head2 new_with_config
This is an alternate constructor, which knows to look for the C<configfile> option
in its arguments and use that to set attributes. It is much like L<MooseX::Getopts>'s
C<new_with_options>. Example:
my $foo = SomeClass->new_with_config(configfile => '/etc/foo.yaml');
Explicit arguments will overide 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
a hashref of arguments to pass to C<new()> which are sourced from the configfile.
=head1 COPYRIGHT
Copyright (c) 2007 - 2009 the MooseX::ConfigFromFile "AUTHOR" and "CONTRIBUTORS" as listed below.
=head1 AUTHOR
Brandon L. Black, E<lt>blblack@gmail.comE<gt>
=head1 CONTRIBUTORS
=over
=item Tomas Doran C<< <bobtfish@bobtfish.net> >> (current maintainer).
=item Karen Etheridge
=item Chris Prather
=item Zbigniew Lukasiak
=back
=head1 LICENSE
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|
