-#!perl
package Mouse;
use strict;
use warnings;
-
-our $VERSION = '0.04';
use 5.006;
+use base 'Exporter';
+
+our $VERSION = '0.24';
-use Sub::Exporter;
use Carp 'confess';
use Scalar::Util 'blessed';
-use Class::Method::Modifiers ();
+use Mouse::Util;
use Mouse::Meta::Attribute;
use Mouse::Meta::Class;
use Mouse::Object;
-use Mouse::TypeRegistry;
-
-do {
- my $CALLER;
-
- my %exports = (
- meta => sub {
- my $meta = Mouse::Meta::Class->initialize($CALLER);
- return sub { $meta };
- },
-
- extends => sub {
- my $caller = $CALLER;
- return sub {
- $caller->meta->superclasses(@_);
- };
- },
-
- has => sub {
- return sub {
- my $package = caller;
- my $names = shift;
- $names = [$names] if !ref($names);
-
- for my $name (@$names) {
- if ($name =~ s/^\+//) {
- Mouse::Meta::Attribute->clone_parent($package, $name, @_);
- }
- else {
- Mouse::Meta::Attribute->create($package, $name, @_);
- }
- }
- };
- },
-
- confess => sub {
- return \&confess;
- },
-
- blessed => sub {
- return \&blessed;
- },
-
- before => sub {
- return \&Class::Method::Modifiers::before;
- },
-
- after => sub {
- return \&Class::Method::Modifiers::after;
- },
-
- around => sub {
- return \&Class::Method::Modifiers::around;
- },
- );
-
- my $exporter = Sub::Exporter::build_exporter({
- exports => \%exports,
- groups => { default => [':all'] },
- });
+use Mouse::Util::TypeConstraints;
+
+our @EXPORT = qw(extends has before after around override super blessed confess with);
+
+sub extends { Mouse::Meta::Class->initialize(caller)->superclasses(@_) }
+
+sub has {
+ my $meta = Mouse::Meta::Class->initialize(caller);
+ $meta->add_attribute(@_);
+}
+
+sub before {
+ my $meta = Mouse::Meta::Class->initialize(caller);
+
+ my $code = pop;
+
+ for (@_) {
+ $meta->add_before_method_modifier($_ => $code);
+ }
+}
+
+sub after {
+ my $meta = Mouse::Meta::Class->initialize(caller);
+
+ my $code = pop;
+
+ for (@_) {
+ $meta->add_after_method_modifier($_ => $code);
+ }
+}
+
+sub around {
+ my $meta = Mouse::Meta::Class->initialize(caller);
- sub import {
- $CALLER = caller;
+ my $code = pop;
- strict->import;
- warnings->import;
+ for (@_) {
+ $meta->add_around_method_modifier($_ => $code);
+ }
+}
+
+sub with {
+ Mouse::Util::apply_all_roles((caller)[0], @_);
+}
+
+our $SUPER_PACKAGE;
+our $SUPER_BODY;
+our @SUPER_ARGS;
+
+sub super {
+ # This check avoids a recursion loop - see
+ # t/100_bugs/020_super_recursion.t
+ return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
+ return unless $SUPER_BODY; $SUPER_BODY->(@SUPER_ARGS);
+}
+
+sub override {
+ my $meta = Mouse::Meta::Class->initialize(caller);
+ my $pkg = $meta->name;
+
+ my $name = shift;
+ my $code = shift;
- my $meta = Mouse::Meta::Class->initialize($CALLER);
- $meta->superclasses('Mouse::Object')
- unless $meta->superclasses;
+ my $body = $pkg->can($name)
+ or confess "You cannot override '$name' because it has no super method";
- goto $exporter;
+ $meta->add_method($name => sub {
+ local $SUPER_PACKAGE = $pkg;
+ local @SUPER_ARGS = @_;
+ local $SUPER_BODY = $body;
+
+ $code->(@_);
+ });
+}
+
+sub import {
+ my $class = shift;
+
+ strict->import;
+ warnings->import;
+
+ my $opts = do {
+ if (ref($_[0]) && ref($_[0]) eq 'HASH') {
+ shift @_;
+ } else {
+ +{ };
+ }
+ };
+ my $level = delete $opts->{into_level};
+ $level = 0 unless defined $level;
+ my $caller = caller($level);
+
+ # we should never export to main
+ if ($caller eq 'main') {
+ warn qq{$class does not export its sugar to the 'main' package.\n};
+ return;
}
- sub unimport {
- my $caller = caller;
+ my $meta = Mouse::Meta::Class->initialize($caller);
+ $meta->superclasses('Mouse::Object')
+ unless $meta->superclasses;
+ # make a subtype for each Mouse class
+ class_type($caller) unless find_type_constraint($caller);
+
+ no strict 'refs';
+ no warnings 'redefine';
+ *{$caller.'::meta'} = sub { $meta };
+
+ if (@_) {
+ __PACKAGE__->export_to_level( $level+1, $class, @_);
+ } else {
+ # shortcut for the common case of no type character
no strict 'refs';
- for my $keyword (keys %exports) {
- next if $keyword eq 'meta'; # we don't delete this one
- delete ${ $caller . '::' }{$keyword};
+ for my $keyword (@EXPORT) {
+ *{ $caller . '::' . $keyword } = *{__PACKAGE__ . '::' . $keyword};
}
}
-};
+}
+
+sub unimport {
+ my $caller = caller;
+
+ no strict 'refs';
+ for my $keyword (@EXPORT) {
+ delete ${ $caller . '::' }{$keyword};
+ }
+}
sub load_class {
my $class = shift;
confess "Invalid class name ($display)";
}
+ return 1 if $class eq 'Mouse::Object';
return 1 if is_class_loaded($class);
(my $file = "$class.pm") =~ s{::}{/}g;
return 0;
}
+sub class_of {
+ return unless defined $_[0];
+ my $class = blessed($_[0]) || $_[0];
+ return Mouse::Meta::Class::get_metaclass_by_name($class);
+}
+
1;
__END__
=head1 DESCRIPTION
-L<Moose> is wonderful.
+L<Moose> is wonderful. B<Use Moose instead of Mouse.>
-Unfortunately, it's a little slow. Though significant progress has been made
-over the years, the compile time penalty is a non-starter for some
+Unfortunately, Moose has a compile-time penalty. Though significant progress has
+been made over the years, the compile time penalty is a non-starter for some
applications.
-Mouse aims to alleviate this by providing a subset of Moose's
-functionality, faster. In particular, L<Moose/has> is missing only a few
-expert-level features.
+Mouse aims to alleviate this by providing a subset of Moose's functionality,
+faster.
+
+We're also going as light on dependencies as possible.
+L<Class::Method::Modifiers> or L<Data::Util> is required if you want support
+for L</before>, L</after>, and L</around>.
=head2 MOOSE COMPAT
Compatibility with Moose has been the utmost concern. Fewer than 1% of the
tests fail when run against Moose instead of Mouse. Mouse code coverage is also
-over 99%. Even the error messages are taken from Moose. The Mouse code just
-runs the test suite 3x-4x faster.
+over 96%. Even the error messages are taken from Moose. The Mouse code just
+runs the test suite 4x faster.
The idea is that, if you need the extra power, you should be able to run
C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
-nothingmuch has written L<Squirrel> (part of this distribution) which will act
-as Mouse unless Moose is loaded, in which case it will act as Moose.
-
-Mouse also has the blessings of Moose's author, stevan.
-
-=head2 MISSING FEATURES
-
-=head3 Roles
-
-Fixing this one slightly less soon. stevan has suggested an implementation
-strategy. Mouse currently mostly ignores methods.
-
-=head3 Complex types
-
-User-defined type constraints and parameterized types may be implemented. Type
-coercions probably not (patches welcome).
-
-=head3 Bootstrapped meta world
-
-Very handy for extensions to the MOP. Not pressing, but would be nice to have.
+we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
+in which case it will act as Moose.
-=head3 Modification of attribute metaclass
+=head2 MouseX
-When you declare an attribute with L</has>, you get the inlined accessors
-installed immediately. Modifying the attribute metaclass, even if possible,
-does nothing.
+Please don't copy MooseX code to MouseX. If you need extensions, you really
+should upgrade to Moose. We don't need two parallel sets of extensions!
-=head3 Lots more..
-
-MouseX?
+If you really must write a Mouse extension, please contact the Moose mailing
+list or #moose on IRC beforehand.
=head1 KEYWORDS
Installs a "before" method modifier. See L<Moose/before> or
L<Class::Method::Modifiers/before>.
+Use of this feature requires L<Class::Method::Modifiers>!
+
=head2 after (method|methods) => Code
Installs an "after" method modifier. See L<Moose/after> or
L<Class::Method::Modifiers/after>.
+Use of this feature requires L<Class::Method::Modifiers>!
+
=head2 around (method|methods) => Code
Installs an "around" method modifier. See L<Moose/around> or
L<Class::Method::Modifiers/around>.
+Use of this feature requires L<Class::Method::Modifiers>!
+
=head2 has (name|names) => parameters
Adds an attribute (or if passed an arrayref of names, multiple attributes) to
=item isa => TypeConstraint
-Provides basic type checking in the constructor and accessor. Basic types such
-as C<Int>, C<ArrayRef>, C<Defined> are supported. Any unknown type is taken to
-be a class check (e.g. isa => 'DateTime' would accept only L<DateTime>
-objects).
+Provides type checking in the constructor and accessor. The following types are
+supported. Any unknown type is taken to be a class check (e.g. isa =>
+'DateTime' would accept only L<DateTime> objects).
+
+ Any Item Bool Undef Defined Value Num Int Str ClassName
+ Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
+ FileHandle Object
+
+For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
+
=item required => 0|1
has a builder, then providing a value for the attribute in the constructor is
optional.
-=item init_arg => Str
+=item init_arg => Str | Undef
-Allows you to use a different key name in the constructor.
+Allows you to use a different key name in the constructor. If undef, the
+attribue can't be passed to the constructor.
=item default => Value | CodeRef
Lets you automatically weaken any reference stored in the attribute.
-=item trigger => Coderef
+Use of this feature requires L<Scalar::Util>!
+
+=item trigger => CodeRef
+
+Any time the attribute's value is set (either through the accessor or the constructor), the trigger is called on it. The trigger receives as arguments the instance, the new value, and the attribute instance.
-Any time the attribute's value is set (either through the accessor or the
-constructor), the trigger is called on it. The trigger receives as arguments
-the instance, the new value, and the attribute instance.
+Mouse 0.05 supported more complex triggers, but this behavior is now removed.
=item builder => Str
bucket status). You must specify an appropriate type constraint to use
auto_deref.
+=item lazy_build => 0|1
+
+Automatically define lazy => 1 as well as builder => "_build_$attr", clearer =>
+"clear_$attr', predicate => 'has_$attr' unless they are already defined.
+
=back
=head2 confess error -> BOOM
involves checking for the existence of C<$VERSION>, C<@ISA>, and any
locally-defined method.
-=head1 AUTHOR
+=head1 SOURCE CODE ACCESS
+
+We have a public git repo:
+
+ git clone git://jules.scsys.co.uk/gitmo/Mouse.git
+
+=head1 AUTHORS
Shawn M Moore, C<< <sartak at gmail.com> >>
+Yuval Kogman, C<< <nothingmuch at woobling.org> >>
+
+tokuhirom
+
+Yappo
+
+wu-lee
+
with plenty of code borrowed from L<Class::MOP> and L<Moose>
=head1 BUGS
-No known bugs.
+There is a known issue with Mouse on 5.6.2 regarding the @ISA tests. Until
+this is resolve the minimum version of Perl for Mouse is set to 5.8.0. Patches
+to resolve these tests are more than welcome.
Please report any bugs through RT: email
C<bug-mouse at rt.cpan.org>, or browse
projects / gitmo/Mouse.git / blobdiff