1 package Class::C3::Componentised;
5 Class::C3::Componentised
9 Load mix-ins or components to your C3-based class.
18 use base 'Class::C3::Componentised';
20 sub component_base_class { "MyModule::Component" }
24 MyModule->load_components( qw/Foo Bar/ );
25 # Will load MyModule::Component::Foo and MyModule::Component::Bar
29 This will inject base classes to your module using the L<Class::C3> method
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>.
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.
52 our $VERSION = 1.0007;
54 my $invalid_class = qr/(?: \b:\b | \:{3,} | \:\:$ )/x;
56 =head2 load_components( @comps )
58 Loads the given components into the current module. If a module begins with a
59 C<+> character, it is taken to be a fully qualified class name, otherwise
60 C<< $class->component_base_class >> is prepended to it.
62 Calling this will call C<Class::C3::reinitialize>.
68 $class->_load_components( map {
71 : join ('::', $class->component_base_class, $_)
72 } grep { $_ !~ /^#/ } @_
76 =head2 load_own_components( @comps )
78 Similar to L<load_components>, but assumes every class is C<"$class::$comp">.
82 sub load_own_components {
84 $class->_load_components( map { "${class}::$_" } grep { $_ !~ /^#/ } @_ );
87 sub _load_components {
91 $class->ensure_class_loaded($_) for @_;
92 $class->inject_base($class => @_);
93 Class::C3::reinitialize();
96 =head2 load_optional_components
98 As L<load_components>, but will silently ignore any components that cannot be
103 sub load_optional_components {
105 $class->_load_components( grep
106 { $class->load_optional_class( $_ ) }
110 : join ('::', $class->component_base_class, $_)
112 grep { $_ !~ /^#/ } @_
117 =head2 ensure_class_loaded
119 Given a class name, tests to see if it is already loaded or otherwise
120 defined. If it is not yet loaded, the package is require'd, and an exception
121 is thrown if the class is still not loaded.
123 BUG: For some reason, packages with syntax errors are added to %INC on
127 sub ensure_class_loaded {
128 my ($class, $f_class) = @_;
132 # ripped from Class::Inspector for speed
133 # note that the order is important (faster items are first)
134 return if ${"${f_class}::VERSION"};
136 return if @{"${f_class}::ISA"};
138 my $file = (join ('/', split ('::', $f_class) ) ) . '.pm';
139 return if $INC{$file};
141 for ( keys %{"${f_class}::"} ) {
142 return if ( *{"${f_class}::$_"}{CODE} );
146 # require always returns true on success
147 eval { require($file) } or do {
149 $@ = "Invalid class name '$f_class'" if $f_class =~ $invalid_class;
151 if ($class->can('throw_exception')) {
152 $class->throw_exception($@);
161 =head2 ensure_class_found
163 Returns true if the specified class is installed or already loaded, false
166 Note that the underlying mechanism (Class::Inspector->installed()) used by this
167 sub will not, at the time of writing, correctly function when @INC includes
168 coderefs. Since PAR relies upon coderefs in @INC, this function should be
169 avoided in modules that are likely to be included within a PAR.
173 sub ensure_class_found {
174 #my ($class, $f_class) = @_;
175 require Class::Inspector;
176 return Class::Inspector->loaded($_[1]) ||
177 Class::Inspector->installed($_[1]);
183 Does the actual magic of adjusting @ISA on the target module.
193 unshift ( @{"${target}::ISA"}, $_ )
194 unless ($target eq $_ || $target->isa($_));
197 mro::set_mro($target, 'c3');
200 =head2 load_optional_class
202 Returns a true value if the specified class is installed and loaded
203 successfully, throws an exception if the class is found but not loaded
204 successfully, and false if the class is not installed
208 sub load_optional_class {
209 my ($class, $f_class) = @_;
211 # ensure_class_loaded either returns a () (*not* true) or throws
213 $class->ensure_class_loaded($f_class);
217 my $err = $@; # so we don't lose it
219 if ($f_class =~ $invalid_class) {
220 $err = "Invalid class name '$f_class'";
223 my $fn = quotemeta( (join ('/', split ('::', $f_class) ) ) . '.pm' );
224 return 0 if ($err =~ /Can't locate ${fn} in \@INC/ );
227 if ($class->can('throw_exception')) {
228 $class->throw_exception($err);
237 Matt S. Trout and the DBIx::Class team
239 Pulled out into seperate module by Ash Berlin C<< <ash@cpan.org> >>
243 You may distribute this code under the same terms as Perl itself.