-#!/usr/bin/env perl
package Mouse;
use strict;
use warnings;
-
-our $VERSION = '0.06';
use 5.006;
+use base 'Exporter';
+
+our $VERSION = '0.33_01';
-use Sub::Exporter;
use Carp 'confess';
use Scalar::Util 'blessed';
-use Class::Method::Modifiers ();
-use Mouse::Meta::Attribute;
+use Mouse::Util qw(load_class is_class_loaded not_supported);
+
+use Mouse::Meta::Module;
use Mouse::Meta::Class;
+use Mouse::Meta::Role;
+use Mouse::Meta::Attribute;
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 {
- my $caller = $CALLER;
-
- return sub {
- my $meta = $caller->meta;
-
- my $names = shift;
- $names = [$names] if !ref($names);
-
- for my $name (@$names) {
- if ($name =~ s/^\+//) {
- Mouse::Meta::Attribute->clone_parent($meta, $name, @_);
- }
- else {
- Mouse::Meta::Attribute->create($meta, $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;
- },
-
- with => sub {
- my $caller = $CALLER;
-
- return sub {
- my $role = shift;
- my $class = $caller->meta;
-
- confess "Mouse::Role only supports 'with' on individual roles at a time" if @_;
-
- Mouse::load_class($role);
- $role->meta->apply($class);
- };
- },
- );
+use Mouse::Util::TypeConstraints ();
- my $exporter = Sub::Exporter::build_exporter({
- exports => \%exports,
- groups => { default => [':all'] },
- });
+our @EXPORT = qw(
+ extends with
+ has
+ before after around
+ override super
+ augment inner
+
+ blessed confess
+);
- sub import {
- $CALLER = caller;
+our %is_removable = map{ $_ => undef } @EXPORT;
+delete $is_removable{blessed};
+delete $is_removable{confess};
- strict->import;
- warnings->import;
+sub extends { Mouse::Meta::Class->initialize(scalar caller)->superclasses(@_) }
- my $meta = Mouse::Meta::Class->initialize($CALLER);
- $meta->superclasses('Mouse::Object')
- unless $meta->superclasses;
+sub has {
+ my $meta = Mouse::Meta::Class->initialize(scalar caller);
+ my $name = shift;
+
+ $meta->add_attribute($_ => @_) for ref($name) ? @{$name} : $name;
+}
- goto $exporter;
+sub before {
+ my $meta = Mouse::Meta::Class->initialize(scalar caller);
+
+ my $code = pop;
+
+ for (@_) {
+ $meta->add_before_method_modifier($_ => $code);
}
+}
- sub unimport {
- my $caller = caller;
+sub after {
+ my $meta = Mouse::Meta::Class->initialize(scalar caller);
- no strict 'refs';
- for my $keyword (keys %exports) {
- next if $keyword eq 'meta'; # we don't delete this one
- delete ${ $caller . '::' }{$keyword};
- }
+ my $code = pop;
+
+ for (@_) {
+ $meta->add_after_method_modifier($_ => $code);
}
-};
+}
-sub load_class {
- my $class = shift;
+sub around {
+ my $meta = Mouse::Meta::Class->initialize(scalar caller);
+
+ my $code = pop;
- if (ref($class) || !defined($class) || !length($class)) {
- my $display = defined($class) ? $class : 'undef';
- confess "Invalid class name ($display)";
+ for (@_) {
+ $meta->add_around_method_modifier($_ => $code);
}
+}
+
+sub with {
+ Mouse::Util::apply_all_roles(scalar(caller), @_);
+}
+
+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;
- return 1 if is_class_loaded($class);
+ my $name = shift;
+ my $code = shift;
- (my $file = "$class.pm") =~ s{::}{/}g;
+ my $body = $pkg->can($name)
+ or confess "You cannot override '$name' because it has no super method";
- eval { CORE::require($file) };
- confess "Could not load class ($class) because : $@" if $@;
+ $meta->add_method($name => sub {
+ local $SUPER_PACKAGE = $pkg;
+ local @SUPER_ARGS = @_;
+ local $SUPER_BODY = $body;
- return 1;
+ $code->(@_);
+ });
}
-sub is_class_loaded {
- my $class = shift;
+sub inner { not_supported }
+sub augment{ not_supported }
+
+sub init_meta {
+ shift;
+ my %args = @_;
+
+ my $class = $args{for_class}
+ or confess("Cannot call init_meta without specifying a for_class");
+ my $base_class = $args{base_class} || 'Mouse::Object';
+ my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
+
+ confess("The Metaclass $metaclass must be a subclass of Mouse::Meta::Class.")
+ unless $metaclass->isa('Mouse::Meta::Class');
+
+ # make a subtype for each Mouse class
+ Mouse::Util::TypeConstraints::class_type($class)
+ unless Mouse::Util::TypeConstraints::find_type_constraint($class);
+
+ my $meta = $metaclass->initialize($class);
+
+ $meta->add_method(meta => sub{
+ return $metaclass->initialize(ref($_[0]) || $_[0]);
+ });
+
+ $meta->superclasses($base_class)
+ unless $meta->superclasses;
+
+ return $meta;
+}
- return 0 if ref($class) || !defined($class) || !length($class);
+sub import {
+ my $class = shift;
- # walk the symbol table tree to avoid autovififying
- # \*{${main::}{"Foo::"}} == \*main::Foo::
+ strict->import;
+ warnings->import;
- my $pack = \*::;
- foreach my $part (split('::', $class)) {
- return 0 unless exists ${$$pack}{"${part}::"};
- $pack = \*{${$$pack}{"${part}::"}};
+ 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;
}
- # check for $VERSION or @ISA
- return 1 if exists ${$$pack}{VERSION}
- && defined *{${$$pack}{VERSION}}{SCALAR};
- return 1 if exists ${$$pack}{ISA}
- && defined *{${$$pack}{ISA}}{ARRAY};
+ $class->init_meta(
+ for_class => $caller,
+ );
- # check for any method
- foreach ( keys %{$$pack} ) {
- next if substr($_, -2, 2) eq '::';
- return 1 if defined *{${$$pack}{$_}}{CODE};
+ if (@_) {
+ __PACKAGE__->export_to_level( $level+1, $class, @_);
+ } else {
+ # shortcut for the common case of no type character
+ no strict 'refs';
+ for my $keyword (@EXPORT) {
+ *{ $caller . '::' . $keyword } = *{__PACKAGE__ . '::' . $keyword};
+ }
}
+}
+
+sub unimport {
+ my $caller = caller;
- # fail
- return 0;
+ my $stash = do{
+ no strict 'refs';
+ \%{$caller . '::'}
+ };
+
+ for my $keyword (@EXPORT) {
+ my $code;
+ if(exists $is_removable{$keyword}
+ && ($code = $caller->can($keyword))
+ && (Mouse::Util::get_code_info($code))[0] eq __PACKAGE__){
+
+ delete $stash->{$keyword};
+ }
+ }
}
1;
=head1 DESCRIPTION
-L<Moose> is wonderful.
+L<Moose> is wonderful. B<Use Moose instead of Mouse.>
+
+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 very specific applications. If you are writing a command-line application
+or CGI script where startup time is essential, you may not be able to use
+Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
+latter, if possible.
-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
-applications.
+Mouse aims to alleviate this by providing a subset of Moose's functionality,
+faster.
-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.
+We're also going as light on dependencies as possible.
+L<Class::Method::Modifiers::Fast> or L<Class::Method::Modifiers> 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 97%. 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
-
-We're working on fixing this one! stevan has suggested an implementation
-strategy. Mouse currently ignores methods, so that needs to be fixed next.
-Roles that consist entirely of attributes may be usable in this very version.
+we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
+in which case it will act as Moose. Since Mouse is a little sloppier than
+Moose, if you run into weird errors, it would be worth running:
-=head3 Complex types
+ ANY_MOOSE=Moose perl your-script.pl
-User-defined type constraints and parameterized types may be implemented. Type
-coercions probably not (patches welcome).
+to see if the bug is caused by Mouse. Moose's diagnostics and validation are
+also much better.
-=head3 Bootstrapped meta world
+=head2 MouseX
-Very handy for extensions to the MOP. Not pressing, but would be nice to have.
+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 Modification of attribute metaclass
+If you really must write a Mouse extension, please contact the Moose mailing
+list or #moose on IRC beforehand.
-When you declare an attribute with L</has>, you get the inlined accessors
-installed immediately. Modifying the attribute metaclass, even if possible,
-does nothing.
+=head2 Maintenance
-=head3 Lots more..
-
-MouseX?
+The original author of this module has mostly stepped down from maintaining
+Mouse. See L<http://www.nntp.perl.org/group/perl.moose/2009/04/msg653.html>.
+If you would like to help maintain this module, please get in touch with us.
=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.
+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.
-Mouse 0.05 supported more complex triggers, but this behavior is now deprecated.
+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
+
+Goro Fuji (gfx) C<< <gfuji at cpan.org> >>
+
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
=head1 COPYRIGHT AND LICENSE
-Copyright 2008 Shawn M Moore.
+Copyright 2008-2009 Infinity Interactive, Inc.
+
+http://www.iinteractive.com/
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
projects / gitmo/Mouse.git / blobdiff