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
178
179
180
181
182
183
184
185
186
187
188
189
190
|
package Bread::Board::Service::WithParameters;
our $AUTHORITY = 'cpan:STEVAN';
# ABSTRACT: Services with parameters
$Bread::Board::Service::WithParameters::VERSION = '0.37';
use Moose::Role;
use MooseX::Params::Validate qw(validated_hash);
use Bread::Board::Types;
with 'Bread::Board::Service';
has 'parameters' => (
traits => [ 'Hash', 'Copy' ],
is => 'ro',
isa => 'Bread::Board::Service::Parameters',
lazy => 1,
coerce => 1,
builder => '_build_parameters',
handles => {
'has_parameters' => 'count'
}
);
has '_parameter_keys_to_remove' => (
is => 'rw',
isa => 'ArrayRef',
clearer => '_clear_parameter_keys_to_remove',
predicate => '_has_parameter_keys_to_remove',
);
before 'get' => sub {
my $self = shift;
my %params = $self->check_parameters(@_);
$self->_parameter_keys_to_remove( [ keys %params ] );
$self->params({ %{ $self->params }, %params });
};
after 'get' => sub {
my $self = shift;
return unless $self->_has_parameter_keys_to_remove;
map { $self->_clear_param( $_ ) } @{ $self->_parameter_keys_to_remove };
$self->_clear_parameter_keys_to_remove;
};
sub _build_parameters { +{} }
sub check_parameters {
my $self = shift;
return validated_hash(\@_, (
%{ $self->parameters },
# NOTE:
# cache the parameters in a per-service
# basis, this should be more than adequate
# since each service can only have one set
# of parameters at a time. If this does end
# up breaking then we can give it a better
# key at that point.
# - SL
(MX_PARAMS_VALIDATE_CACHE_KEY => Scalar::Util::refaddr($self))
)) if $self->has_parameters;
return ();
}
sub has_required_parameters {
my $self = shift;
scalar grep { ! $_->{optional} } values %{ $self->parameters };
}
sub has_parameter_defaults {
my $self = shift;
scalar grep { $_->{default} } values %{ $self->parameters };
}
no Moose::Role; 1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Bread::Board::Service::WithParameters - Services with parameters
=head1 VERSION
version 0.37
=head1 DESCRIPTION
This is a sub-role of L<Bread::Board::Service>, for parameterized
services. These are services that will instantiate different values
depending on parameters that are passed to the C<get> method. You can
pass those parameters via the L<< C<service_params> attribute of
C<Bread::Board::Dependency>|Bread::Board::Dependency/service_params
>>, or via the L<< C<inflate> method of
C<Bread::Board::Service::Deferred::Thunk>|Bread::Board::Service::Deferred::Thunk/inflate
>>.
=head1 ATTRIBUTES
=head2 C<parameters>
Read-only hashref, will be passed as-is to L<<
C<MooseX::Params::Validate>'s
C<validated_hash>|MooseX::Params::Validate/validated_hash >>, so you
can use things like C<optional> and C<default> in addition to type
constraints:
service something => (
class => 'Thing',
parameters => {
type => { isa => 'Str', default => 'text' },
},
);
This attribute uses coercions on L<<
C<Bread::Board::Service::Parameters>|Bread::Board::Types/Bread::Board::Service::Parameters
>> so that you can also say:
service something => (
class => 'Thing',
parameters => ['type'],
);
and it will be equivalent to:
service something => (
class => 'Thing',
parameters => {
type => { optional => 0 },
},
);
=head1 METHODS
=head2 C<has_parameters>
Predicate for the L</parameters> attribute.
=head2 C<has_parameter_defaults>
Returns true if any of the L</parameters> have a C<default> value.
=head2 C<has_required_parameters>
Returns true if any of the L</parameters> does I<not> have C<optional>
set to true.
=head2 C<check_parameters>
my %parameters = $service->check_parameters(name1=>$value1,name2=>$value2);
my %parameters = $service->check_parameters({name1=>$value1,name2=>$value2});
If any L</parameters> are defined, this function validates its
arguments against the parameters' definitions (using
L<MooseX::Params::Validate>). It will die if the validation fails, or
return the validated parameters (including default value) if it
succeeds.
=head2 C<get>
I<Before> the C<get> method, arguments to C<get> are passed through
L</check_parameters> and added to the L<<
C<params>|Bread::Board::Service/params >> hashref. I<After> the C<get>
method, those keys/values will be removed. In practice, this makes all
parameters available to the actual C<get> method body.
=head1 AUTHOR
Stevan Little <stevan@iinteractive.com>
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website
https://github.com/stevan/BreadBoard/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 COPYRIGHT AND LICENSE
This software is copyright (c) 2019, 2017, 2016, 2015, 2014, 2013, 2011, 2009 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.
=cut
|
