Filename | /usr/share/perl5/Class/C3/Componentised.pm |
Statements | Executed 519 statements in 1.39ms |
Calls | P | F | Exclusive Time |
Inclusive Time |
Subroutine |
---|---|---|---|---|---|
1182 | 8 | 6 | 251ms | 1.30s | ensure_class_loaded (recurses: max depth 3, inclusive time 220ms) | Class::C3::Componentised::
1 | 1 | 1 | 5.23ms | 5.36ms | BEGIN@48 | Class::C3::Componentised::
16 | 1 | 1 | 394µs | 394µs | __ANON__[:199] | Class::C3::Componentised::
4 | 2 | 1 | 136µs | 143ms | _load_components (recurses: max depth 2, inclusive time 71.9ms) | Class::C3::Componentised::
3 | 3 | 3 | 110µs | 143ms | load_components (recurses: max depth 1, inclusive time 49.3ms) | Class::C3::Componentised::
1 | 1 | 1 | 22µs | 22.7ms | load_own_components | Class::C3::Componentised::
1 | 1 | 1 | 17µs | 29µs | BEGIN@133 | Class::C3::Componentised::
1 | 1 | 1 | 16µs | 23µs | BEGIN@40 | Class::C3::Componentised::
1 | 1 | 1 | 14µs | 1.73ms | load_optional_class | Class::C3::Componentised::
1 | 1 | 1 | 9µs | 13µs | BEGIN@41 | Class::C3::Componentised::
1 | 1 | 1 | 9µs | 15µs | BEGIN@198 | Class::C3::Componentised::
1 | 1 | 1 | 8µs | 8µs | BEGIN@50 | Class::C3::Componentised::
1 | 1 | 1 | 4µs | 4µs | BEGIN@51 | Class::C3::Componentised::
0 | 0 | 0 | 0s | 0s | __ANON__[:204] | Class::C3::Componentised::
0 | 0 | 0 | 0s | 0s | ensure_class_found | Class::C3::Componentised::
0 | 0 | 0 | 0s | 0s | inject_base | Class::C3::Componentised::
0 | 0 | 0 | 0s | 0s | load_optional_components | Class::C3::Componentised::
Line | State ments |
Time on line |
Calls | Time in subs |
Code |
---|---|---|---|---|---|
1 | package Class::C3::Componentised; | ||||
2 | |||||
3 | =head1 NAME | ||||
4 | |||||
5 | Class::C3::Componentised - load mix-ins or components to your C3-based class | ||||
6 | |||||
7 | =head1 DESCRIPTION | ||||
8 | |||||
9 | Load mix-ins or components to your C3-based class. | ||||
10 | |||||
11 | =head1 SYNOPSIS | ||||
12 | |||||
13 | package MyModule; | ||||
14 | |||||
15 | use strict; | ||||
16 | use warnings; | ||||
17 | |||||
18 | use base 'Class::C3::Componentised'; | ||||
19 | |||||
20 | sub component_base_class { "MyModule::Component" } | ||||
21 | |||||
22 | package main; | ||||
23 | |||||
24 | MyModule->load_components( qw/Foo Bar/ ); | ||||
25 | # Will load MyModule::Component::Foo and MyModule::Component::Bar | ||||
26 | |||||
27 | =head1 DESCRIPTION | ||||
28 | |||||
29 | This will inject base classes to your module using the L<Class::C3> method | ||||
30 | resolution order. | ||||
31 | |||||
32 | Please note: these are not plugins that can take precedence over methods | ||||
33 | declared in MyModule. If you want something like that, consider | ||||
34 | L<MooseX::Object::Pluggable>. | ||||
35 | |||||
36 | =head1 METHODS | ||||
37 | |||||
38 | =cut | ||||
39 | |||||
40 | 2 | 30µs | # spent 23µs (16+7) within Class::C3::Componentised::BEGIN@40 which was called:
# once (16µs+7µs) by base::import at line 40 # spent 23µs making 1 call to Class::C3::Componentised::BEGIN@40
# spent 7µs making 1 call to strict::import | ||
41 | 2 | 17µs | # spent 13µs (9+4) within Class::C3::Componentised::BEGIN@41 which was called:
# once (9µs+4µs) by base::import at line 41 # spent 13µs making 1 call to Class::C3::Componentised::BEGIN@41
# spent 4µs making 1 call to warnings::import | ||
42 | |||||
43 | # This will prime the Class::C3 namespace (either by loading it proper on 5.8 | ||||
44 | # or by installing compat shims on 5.10+). A user might have a reasonable | ||||
45 | # expectation that using Class::C3::<something> will give him access to | ||||
46 | # Class::C3 itself, and this module has been providing this historically. | ||||
47 | # Therefore leaving it in indefinitely. | ||||
48 | 1 | 5.36ms | # spent 5.36ms (5.23+132µs) within Class::C3::Componentised::BEGIN@48 which was called:
# once (5.23ms+132µs) by base::import at line 48 # spent 5.36ms making 1 call to Class::C3::Componentised::BEGIN@48 | ||
49 | |||||
50 | 1 | 8µs | # spent 8µs within Class::C3::Componentised::BEGIN@50 which was called:
# once (8µs+0s) by base::import at line 50 # spent 8µs making 1 call to Class::C3::Componentised::BEGIN@50 | ||
51 | 1 | 4µs | # spent 4µs within Class::C3::Componentised::BEGIN@51 which was called:
# once (4µs+0s) by base::import at line 51 # spent 4µs making 1 call to Class::C3::Componentised::BEGIN@51 | ||
52 | |||||
53 | our $VERSION = '1.001000'; | ||||
54 | |||||
55 | 1 | 2µs | $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases # spent 2µs making 1 call to Class::C3::Componentised::CORE:match | ||
56 | |||||
57 | 1 | 2µs | my $invalid_class = qr/(?: \b:\b | \:{3,} | \:\:$ )/x; # spent 2µs making 1 call to Class::C3::Componentised::CORE:qr | ||
58 | |||||
59 | =head2 load_components( @comps ) | ||||
60 | |||||
61 | Loads the given components into the current module. If a module begins with a | ||||
62 | C<+> character, it is taken to be a fully qualified class name, otherwise | ||||
63 | C<< $class->component_base_class >> is prepended to it. | ||||
64 | |||||
65 | Calling this will call C<Class::C3::reinitialize>. | ||||
66 | |||||
67 | =cut | ||||
68 | |||||
69 | # spent 143ms (110µs+143) within Class::C3::Componentised::load_components which was called 3 times, avg 47.8ms/call:
# once (48µs+143ms) by base::import at line 8 of DBIx/Class/Core.pm
# once (38µs+-38µs) by Class::C3::Componentised::ensure_class_loaded at line 9 of DBIx/Class/Relationship/Helpers.pm
# once (24µs+-24µs) by DBIx::Class::ResultSourceProxy::Table::BEGIN@8 at line 9 of DBIx/Class/ResultSource/Table.pm | ||||
70 | my $class = shift; | ||||
71 | 22 | 13µs | $class->_load_components( map { # spent 10µs making 11 calls to DBIx::Class::component_base_class, avg 891ns/call
# spent 3µs making 11 calls to Class::C3::Componentised::CORE:match, avg 273ns/call | ||
72 | 11 | 7µs | /^\+(.*)$/ # spent 7µs making 11 calls to Class::C3::Componentised::CORE:match, avg 600ns/call | ||
73 | ? $1 | ||||
74 | : join ('::', $class->component_base_class, $_) | ||||
75 | 3 | 143ms | } grep { $_ !~ /^#/ } @_ # spent 193ms making 3 calls to Class::C3::Componentised::_load_components, avg 64.2ms/call, recursion: max depth 2, sum of overlapping time 49.2ms | ||
76 | ); | ||||
77 | } | ||||
78 | |||||
79 | =head2 load_own_components( @comps ) | ||||
80 | |||||
81 | Similar to L<load_components>, but assumes every class is C<"$class::$comp">. | ||||
82 | |||||
83 | =cut | ||||
84 | |||||
85 | # spent 22.7ms (22µs+22.7) within Class::C3::Componentised::load_own_components which was called:
# once (22µs+22.7ms) by Class::C3::Componentised::ensure_class_loaded at line 8 of DBIx/Class/Relationship.pm | ||||
86 | my $class = shift; | ||||
87 | 6 | 2µs | $class->_load_components( map { "${class}::$_" } grep { $_ !~ /^#/ } @_ ); # spent 2µs making 5 calls to Class::C3::Componentised::CORE:match, avg 340ns/call
# spent 22.7ms making 1 call to Class::C3::Componentised::_load_components, recursion: max depth 1, sum of overlapping time 22.7ms | ||
88 | } | ||||
89 | |||||
90 | sub _load_components { | ||||
91 | my $class = shift; | ||||
92 | return unless @_; | ||||
93 | |||||
94 | 16 | 0s | $class->ensure_class_loaded($_) for @_; # spent 214ms making 16 calls to Class::C3::Componentised::ensure_class_loaded, avg 13.4ms/call, recursion: max depth 3, sum of overlapping time 214ms | ||
95 | 4 | 1.28ms | $class->inject_base($class => @_); # spent 1.28ms making 4 calls to DBIx::Class::Componentised::inject_base, avg 321µs/call | ||
96 | 4 | 8µs | Class::C3::reinitialize(); # spent 8µs making 4 calls to MRO::Compat::__ANON__[MRO/Compat.pm:41], avg 2µs/call | ||
97 | } | ||||
98 | |||||
99 | =head2 load_optional_components | ||||
100 | |||||
101 | As L<load_components>, but will silently ignore any components that cannot be | ||||
102 | found. | ||||
103 | |||||
104 | =cut | ||||
105 | |||||
106 | sub load_optional_components { | ||||
107 | my $class = shift; | ||||
108 | $class->_load_components( grep | ||||
109 | { $class->load_optional_class( $_ ) } | ||||
110 | ( map | ||||
111 | { /^\+(.*)$/ | ||||
112 | ? $1 | ||||
113 | : join ('::', $class->component_base_class, $_) | ||||
114 | } | ||||
115 | grep { $_ !~ /^#/ } @_ | ||||
116 | ) | ||||
117 | ); | ||||
118 | } | ||||
119 | |||||
120 | =head2 ensure_class_loaded | ||||
121 | |||||
122 | Given a class name, tests to see if it is already loaded or otherwise | ||||
123 | defined. If it is not yet loaded, the package is require'd, and an exception | ||||
124 | is thrown if the class is still not loaded. | ||||
125 | |||||
126 | BUG: For some reason, packages with syntax errors are added to %INC on | ||||
127 | require | ||||
128 | =cut | ||||
129 | |||||
130 | # spent 1.30s (251ms+1.05) within Class::C3::Componentised::ensure_class_loaded which was called 1182 times, avg 1.10ms/call:
# 637 times (5.12ms+0s) by DBIx::Class::ResultSet::result_class at line 1558 of DBIx/Class/ResultSet.pm, avg 8µs/call
# 177 times (3.00ms+8.94ms) by DBIx::Class::AccessorGroup::get_component_class at line 19 of DBIx/Class/AccessorGroup.pm, avg 67µs/call
# 174 times (182ms+1.03s) by DBIx::Class::Schema::load_namespaces at line 239 of DBIx/Class/Schema.pm, avg 6.99ms/call
# 174 times (994µs+-994µs) by DBIx::Class::ResultSourceProxy::Table::table at line 87 of DBIx/Class/ResultSourceProxy/Table.pm, avg 0s/call
# 16 times (44.5ms+-44.5ms) by Class::C3::Componentised::_load_components at line 94, avg 0s/call
# 2 times (1.25ms+-1.25ms) by DBIx::Class::Relationship::BelongsTo::belongs_to at line 43 of DBIx/Class/Relationship/BelongsTo.pm, avg 0s/call
# once (13.1ms+51.1ms) by Try::Tiny::try at line 807 of DBIx/Class/Schema.pm
# once (1.37ms+344µs) by Class::C3::Componentised::load_optional_class at line 227 | ||||
131 | 173 | 56µs | my ($class, $f_class) = @_; | ||
132 | |||||
133 | 2 | 40µs | # spent 29µs (17+11) within Class::C3::Componentised::BEGIN@133 which was called:
# once (17µs+11µs) by base::import at line 133 # spent 29µs making 1 call to Class::C3::Componentised::BEGIN@133
# spent 11µs making 1 call to strict::unimport | ||
134 | |||||
135 | # ripped from Class::Inspector for speed | ||||
136 | # note that the order is important (faster items are first) | ||||
137 | 173 | 590µs | return if ${"${f_class}::VERSION"}; | ||
138 | |||||
139 | 173 | 740µs | return if @{"${f_class}::ISA"}; | ||
140 | |||||
141 | my $file = (join ('/', split ('::', $f_class) ) ) . '.pm'; | ||||
142 | return if $INC{$file}; | ||||
143 | |||||
144 | for ( keys %{"${f_class}::"} ) { | ||||
145 | return if ( *{"${f_class}::$_"}{CODE} ); | ||||
146 | } | ||||
147 | |||||
148 | # require always returns true on success | ||||
149 | # ill-behaved modules might very well obliterate $_ | ||||
150 | eval { local $_; require($file) } or do { | ||||
151 | |||||
152 | $@ = "Invalid class name '$f_class'" if $f_class =~ $invalid_class; | ||||
153 | |||||
154 | if ($class->can('throw_exception')) { | ||||
155 | $class->throw_exception($@); | ||||
156 | } else { | ||||
157 | Carp::croak $@; | ||||
158 | } | ||||
159 | }; | ||||
160 | |||||
161 | return; | ||||
162 | } | ||||
163 | |||||
164 | =head2 ensure_class_found | ||||
165 | |||||
166 | Returns true if the specified class is installed or already loaded, false | ||||
167 | otherwise. | ||||
168 | |||||
169 | Note that the underlying mechanism (Class::Inspector->installed()) used by this | ||||
170 | sub will not, at the time of writing, correctly function when @INC includes | ||||
171 | coderefs. Since PAR relies upon coderefs in @INC, this function should be | ||||
172 | avoided in modules that are likely to be included within a PAR. | ||||
173 | |||||
174 | =cut | ||||
175 | |||||
176 | sub ensure_class_found { | ||||
177 | #my ($class, $f_class) = @_; | ||||
178 | require Class::Inspector; | ||||
179 | return Class::Inspector->loaded($_[1]) || | ||||
180 | Class::Inspector->installed($_[1]); | ||||
181 | } | ||||
182 | |||||
183 | |||||
184 | =head2 inject_base | ||||
185 | |||||
186 | Does the actual magic of adjusting @ISA on the target module. | ||||
187 | |||||
188 | =cut | ||||
189 | |||||
190 | sub inject_base { | ||||
191 | my $class = shift; | ||||
192 | my $target = shift; | ||||
193 | |||||
194 | 4 | 11µs | mro::set_mro($target, 'c3'); # spent 11µs making 4 calls to mro::set_mro, avg 3µs/call | ||
195 | |||||
196 | for my $comp (reverse @_) { | ||||
197 | my $apply = do { | ||||
198 | 2 | 21µs | # spent 15µs (9+6) within Class::C3::Componentised::BEGIN@198 which was called:
# once (9µs+6µs) by base::import at line 198 # spent 15µs making 1 call to Class::C3::Componentised::BEGIN@198
# spent 6µs making 1 call to strict::unimport | ||
199 | # spent 394µs within Class::C3::Componentised::__ANON__[/usr/share/perl5/Class/C3/Componentised.pm:199] which was called 16 times, avg 25µs/call:
# 16 times (394µs+0s) by DBIx::Class::Componentised::inject_base at line 208, avg 25µs/call | ||||
200 | }; | ||||
201 | 16 | 35µs | unless ($target eq $comp || $target->isa($comp)) { # spent 35µs making 16 calls to UNIVERSAL::isa, avg 2µs/call | ||
202 | our %APPLICATOR_FOR; | ||||
203 | 32 | 58µs | if (my $apply_class # spent 36µs making 16 calls to List::Util::first, avg 2µs/call
# spent 22µs making 16 calls to mro::get_linear_isa, avg 1µs/call | ||
204 | = List::Util::first { $APPLICATOR_FOR{$_} } @{mro::get_linear_isa($comp)} | ||||
205 | ) { | ||||
206 | $APPLICATOR_FOR{$apply_class}->_apply_component_to_class($comp,$target,$apply); | ||||
207 | } else { | ||||
208 | 16 | 394µs | $apply->(); # spent 394µs making 16 calls to Class::C3::Componentised::__ANON__[Class/C3/Componentised.pm:199], avg 25µs/call | ||
209 | } | ||||
210 | } | ||||
211 | } | ||||
212 | } | ||||
213 | |||||
214 | =head2 load_optional_class | ||||
215 | |||||
216 | Returns a true value if the specified class is installed and loaded | ||||
217 | successfully, throws an exception if the class is found but not loaded | ||||
218 | successfully, and false if the class is not installed | ||||
219 | |||||
220 | =cut | ||||
221 | |||||
222 | # spent 1.73ms (14µs+1.71) within Class::C3::Componentised::load_optional_class which was called:
# once (14µs+1.71ms) by DBIx::Class::Storage::DBI::_determine_driver at line 1264 of DBIx/Class/Storage/DBI.pm | ||||
223 | my ($class, $f_class) = @_; | ||||
224 | |||||
225 | # ensure_class_loaded either returns a () (*not* true) or throws | ||||
226 | eval { | ||||
227 | 1 | 1.71ms | $class->ensure_class_loaded($f_class); # spent 1.71ms making 1 call to Class::C3::Componentised::ensure_class_loaded | ||
228 | 1; | ||||
229 | } && return 1; | ||||
230 | |||||
231 | my $err = $@; # so we don't lose it | ||||
232 | |||||
233 | if ($f_class =~ $invalid_class) { | ||||
234 | $err = "Invalid class name '$f_class'"; | ||||
235 | } | ||||
236 | else { | ||||
237 | my $fn = quotemeta( (join ('/', split ('::', $f_class) ) ) . '.pm' ); | ||||
238 | return 0 if ($err =~ /Can't locate ${fn} in \@INC/ ); | ||||
239 | } | ||||
240 | |||||
241 | if ($class->can('throw_exception')) { | ||||
242 | $class->throw_exception($err); | ||||
243 | } | ||||
244 | else { | ||||
245 | die $err; | ||||
246 | } | ||||
247 | } | ||||
248 | |||||
249 | =head1 AUTHORS | ||||
250 | |||||
251 | Matt S. Trout and the L<DBIx::Class team|DBIx::Class/CONTRIBUTORS> | ||||
252 | |||||
253 | Pulled out into separate module by Ash Berlin C<< <ash@cpan.org> >> | ||||
254 | |||||
255 | Optimizations and overall bolt-tightening by Peter "ribasushi" Rabbitson | ||||
256 | C<< <ribasushi@cpan.org> >> | ||||
257 | |||||
258 | =head1 COPYRIGHT | ||||
259 | |||||
260 | Copyright (c) 2006 - 2011 the Class::C3::Componentised L</AUTHORS> as listed | ||||
261 | above. | ||||
262 | |||||
263 | =head1 LICENSE | ||||
264 | |||||
265 | You may distribute this code under the same terms as Perl itself. | ||||
266 | |||||
267 | =cut | ||||
268 | |||||
269 | 1; |