1 package Class::C3::Componentised;
5 Class::C3::Componentised - Load mix-ins or components to your C3-based class
14 use base 'Class::C3::Componentised';
16 sub component_base_class { "MyModule::Component" }
20 MyModule->load_components( qw/Foo Bar/ );
21 # Will load MyModule::Component::Foo and MyModule::Component::Bar
25 This will inject base classes to your module using the L<Class::C3> method
28 Please note: these are not plugins that can take precedence over methods
29 declared in MyModule. If you want something like that, consider
30 L<MooseX::Object::Pluggable>.
39 # This will prime the Class::C3 namespace (either by loading it proper on 5.8
40 # or by installing compat shims on 5.10+). A user might have a reasonable
41 # expectation that using Class::C3::<something> will give him access to
42 # Class::C3 itself, and this module has been providing this historically.
43 # Therefore leaving it in indefinitely.
49 our $VERSION = '1.001000';
52 my $invalid_class = qr/(?: \b:\b | \:{3,} | \:\:$ )/x;
54 =head2 load_components( @comps )
56 Loads the given components into the current module. If a module begins with a
57 C<+> character, it is taken to be a fully qualified class name, otherwise
58 C<< $class->component_base_class >> is prepended to it.
60 Calling this will call C<Class::C3::reinitialize>.
66 $class->_load_components( map {
69 : join ('::', $class->component_base_class, $_)
70 } grep { $_ !~ /^#/ } @_
74 =head2 load_own_components( @comps )
76 Similar to L<load_components>, but assumes every class is C<"$class::$comp">.
80 sub load_own_components {
82 $class->_load_components( map { "${class}::$_" } grep { $_ !~ /^#/ } @_ );
85 sub _load_components {
89 $class->ensure_class_loaded($_) for @_;
90 $class->inject_base($class => @_);
91 Class::C3::reinitialize();
94 =head2 load_optional_components
96 As L<load_components>, but will silently ignore any components that cannot be
101 sub load_optional_components {
103 $class->_load_components( grep
104 { $class->load_optional_class( $_ ) }
108 : join ('::', $class->component_base_class, $_)
110 grep { $_ !~ /^#/ } @_
115 =head2 ensure_class_loaded
117 Given a class name, tests to see if it is already loaded or otherwise
118 defined. If it is not yet loaded, the package is require'd, and an exception
119 is thrown if the class is still not loaded.
121 BUG: For some reason, packages with syntax errors are added to %INC on
125 sub ensure_class_loaded {
126 my ($class, $f_class) = @_;
130 # ripped from Class::Inspector for speed
131 # note that the order is important (faster items are first)
132 return if ${"${f_class}::VERSION"};
134 return if @{"${f_class}::ISA"};
136 my $file = (join ('/', split ('::', $f_class) ) ) . '.pm';
137 return if $INC{$file};
139 for ( keys %{"${f_class}::"} ) {
140 return if ( *{"${f_class}::$_"}{CODE} );
143 # require always returns true on success
144 # ill-behaved modules might very well obliterate $_
145 eval { local $_; require($file) } or do {
147 $@ = "Invalid class name '$f_class'" if $f_class =~ $invalid_class;
149 if ($class->can('throw_exception')) {
150 $class->throw_exception($@);
159 =head2 ensure_class_found
161 Returns true if the specified class is installed or already loaded, false
164 Note that the underlying mechanism (Class::Inspector->installed()) used by this
165 sub will not, at the time of writing, correctly function when @INC includes
166 coderefs. Since PAR relies upon coderefs in @INC, this function should be
167 avoided in modules that are likely to be included within a PAR.
171 sub ensure_class_found {
172 #my ($class, $f_class) = @_;
173 require Class::Inspector;
174 return Class::Inspector->loaded($_[1]) ||
175 Class::Inspector->installed($_[1]);
181 Does the actual magic of adjusting @ISA on the target module.
189 mro::set_mro($target, 'c3');
191 for my $comp (reverse @_) {
194 sub { unshift ( @{"${target}::ISA"}, $comp ) };
196 unless ($target eq $comp || $target->isa($comp)) {
199 = List::Util::first { $APPLICATOR_FOR{$_} } @{mro::get_linear_isa($comp)}
201 $APPLICATOR_FOR{$apply_class}->_apply_component_to_class($comp,$target,$apply);
209 =head2 load_optional_class
211 Returns a true value if the specified class is installed and loaded
212 successfully, throws an exception if the class is found but not loaded
213 successfully, and false if the class is not installed
217 sub load_optional_class {
218 my ($class, $f_class) = @_;
220 # ensure_class_loaded either returns a () (*not* true) or throws
222 $class->ensure_class_loaded($f_class);
226 my $err = $@; # so we don't lose it
228 if ($f_class =~ $invalid_class) {
229 $err = "Invalid class name '$f_class'";
232 my $fn = quotemeta( (join ('/', split ('::', $f_class) ) ) . '.pm' );
233 return 0 if ($err =~ /Can't locate ${fn} in \@INC/ );
236 if ($class->can('throw_exception')) {
237 $class->throw_exception($err);
246 Matt S. Trout and the L<DBIx::Class team|DBIx::Class/CONTRIBUTORS>
248 Pulled out into separate module by Ash Berlin C<< <ash@cpan.org> >>
250 Optimizations and overall bolt-tightening by Peter "ribasushi" Rabbitson
251 C<< <ribasushi@cpan.org> >>
255 Copyright (c) 2006 - 2011 the Class::C3::Componentised L</AUTHORS> as listed
260 You may distribute this code under the same terms as Perl itself.