Always load Mouse::Util first, which will be load Mouse::XS in the future
[gitmo/Mouse.git] / lib / Mouse.pm
index 708b0a5..34108fb 100644 (file)
@@ -1,65 +1,40 @@
-
 package Mouse;
 use strict;
 use warnings;
 use 5.006;
 use base 'Exporter';
 
-our $VERSION;
-our $PurePerl;
-
-BEGIN {
-    $VERSION  = '0.12';
-
-    if ($ENV{MOUSE_DEBUG}) {
-        *DEBUG = sub (){ 1 };
-    } else {
-        *DEBUG = sub (){ 0 };
-    }
-
-    if (! defined $PurePerl && $ENV{MOUSE_PUREPERL} && $ENV{MOUSE_PUREPERL} =~ /^(.+)$/) {
-        $PurePerl = $1;
-    }
+our $VERSION = '0.32';
 
-    if (! $PurePerl) {
-        local $@;
-        local $^W = 0;
-        require XSLoader;
-        $PurePerl = ! eval{ XSLoader::load(__PACKAGE__, $VERSION); 1 };
-        warn "Failed to load XS mode: $@" if $@; #  && Mouse::DEBUG();
-    }
-}
+sub moose_version(){ 0.90 } # which Mouse is a subset of
 
 use Carp 'confess';
-use Mouse::Util 'blessed';
+use Scalar::Util 'blessed';
 
-use Mouse::Meta::Attribute;
+use Mouse::Util qw(load_class is_class_loaded);
+
+use Mouse::Meta::Module;
 use Mouse::Meta::Class;
+use Mouse::Meta::Role;
+use Mouse::Meta::Attribute;
 use Mouse::Object;
-use Mouse::TypeRegistry;
-
-our @EXPORT = qw(extends has before after around blessed confess with);
+use Mouse::Util::TypeConstraints ();
 
-sub extends { Mouse::Meta::Class->initialize(caller)->superclasses(@_) }
+our @EXPORT = qw(extends has before after around override super blessed confess with);
 
-sub has {
-    my $meta = Mouse::Meta::Class->initialize(caller);
+our %is_removable = map{ $_ => undef } @EXPORT;
+delete $is_removable{blessed};
+delete $is_removable{confess};
 
-    my $names = shift;
-    $names = [$names] if !ref($names);
+sub extends { Mouse::Meta::Class->initialize(scalar caller)->superclasses(@_) }
 
-    for my $name (@$names) {
-        if ($name =~ s/^\+//) {
-            Mouse::Meta::Attribute->clone_parent($meta, $name, @_);
-        }
-        else {
-            Mouse::Meta::Attribute->create($meta, $name, @_);
-        }
-    }
+sub has {
+    my $meta = Mouse::Meta::Class->initialize(scalar caller);
+    $meta->add_attribute(@_);
 }
 
 sub before {
-    my $meta = Mouse::Meta::Class->initialize(caller);
+    my $meta = Mouse::Meta::Class->initialize(scalar caller);
 
     my $code = pop;
 
@@ -69,7 +44,7 @@ sub before {
 }
 
 sub after {
-    my $meta = Mouse::Meta::Class->initialize(caller);
+    my $meta = Mouse::Meta::Class->initialize(scalar caller);
 
     my $code = pop;
 
@@ -79,7 +54,7 @@ sub after {
 }
 
 sub around {
-    my $meta = Mouse::Meta::Class->initialize(caller);
+    my $meta = Mouse::Meta::Class->initialize(scalar caller);
 
     my $code = pop;
 
@@ -89,89 +64,133 @@ sub around {
 }
 
 sub with {
-    my $meta = Mouse::Meta::Class->initialize(caller);
-
-    my $role  = shift;
-    my $args  = shift || {};
+    Mouse::Util::apply_all_roles(scalar(caller), @_);
+}
 
-    confess "Mouse::Role only supports 'with' on individual roles at a time" if @_ || !ref $args;
+our $SUPER_PACKAGE;
+our $SUPER_BODY;
+our @SUPER_ARGS;
 
-    Mouse::load_class($role);
-    $role->meta->apply($meta, %$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 import {
-    strict->import;
-    warnings->import;
+sub override {
+    my $meta = Mouse::Meta::Class->initialize(caller);
+    my $pkg = $meta->name;
 
-    my $caller = caller;
+    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";
 
-    no strict 'refs';
-    no warnings 'redefine';
-    *{$caller.'::meta'} = sub { $meta };
+    $meta->add_method($name => sub {
+        local $SUPER_PACKAGE = $pkg;
+        local @SUPER_ARGS = @_;
+        local $SUPER_BODY = $body;
 
-    __PACKAGE__->export_to_level( 1, @_);
+        $code->(@_);
+    });
 }
 
-sub unimport {
-    my $caller = caller;
-
-    no strict 'refs';
-    for my $keyword (@EXPORT) {
-        delete ${ $caller . '::' }{$keyword};
+sub init_meta {
+    # This used to be called as a function. This hack preserves
+    # backwards compatibility.
+    if ( $_[0] ne __PACKAGE__ ) {
+        return __PACKAGE__->init_meta(
+            for_class  => $_[0],
+            base_class => $_[1],
+            metaclass  => $_[2],
+        );
     }
-}
 
-sub load_class {
-    my $class = shift;
+    shift;
+    my %args = @_;
 
-    if (ref($class) || !defined($class) || !length($class)) {
-        my $display = defined($class) ? $class : 'undef';
-        confess "Invalid class name ($display)";
-    }
+    my $class = $args{for_class}
+      or Carp::croak(
+        "Cannot call init_meta without specifying a for_class");
+    my $base_class = $args{base_class} || 'Mouse::Object';
+    my $metaclass  = $args{metaclass}  || 'Mouse::Meta::Class';
+
+    Carp::croak("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);
 
-    return 1 if is_class_loaded($class);
+    my $meta = $metaclass->initialize($class);
+    $meta->superclasses($base_class)
+        unless $meta->superclasses;
 
-    (my $file = "$class.pm") =~ s{::}{/}g;
+    $meta->add_method(meta => sub{
+        return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
+    });
 
-    eval { CORE::require($file) };
-    confess "Could not load class ($class) because : $@" if $@;
 
-    return 1;
+    return $meta;
 }
 
-sub is_class_loaded {
+sub import {
     my $class = shift;
 
-    return 0 if ref($class) || !defined($class) || !length($class);
-
-    # 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};
+    Mouse->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;
+
+    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__){
 
-    # fail
-    return 0;
+            delete $stash->{$keyword};
+        }
+    }
 }
 
 1;
@@ -210,21 +229,21 @@ Mouse - Moose minus the antlers
 
 =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
-applications.
+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.
 
-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. Most functions we use
-from L<Scalar::Util> are copied into this dist. L<Scalar::Util> is required if
-you'd like weak references; there's simply no way to do it from pure Perl.
-L<Class::Method::Modifiers> is required if you want support for L</before>,
-L</after>, and L</around>.
+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
 
@@ -235,37 +254,28 @@ 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 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:
 
-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.
+    ANY_MOOSE=Moose perl your-script.pl
 
-=head3 Complex types
+to see if the bug is caused by Mouse. Moose's diagnostics and validation are
+also much better.
 
-User-defined type constraints and parameterized types may be implemented. Type
-coercions probably not (patches welcome).
+=head2 MouseX
 
-=head3 Bootstrapped meta world
+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!
 
-Very handy for extensions to the MOP. Not pressing, but would be nice to have.
+If you really must write a Mouse extension, please contact the Moose mailing
+list or #moose on IRC beforehand.
 
-=head3 Modification of attribute metaclass
+=head2 Maintenance
 
-When you declare an attribute with L</has>, you get the inlined accessors
-installed immediately. Modifying the attribute metaclass, even if possible,
-does nothing.
-
-=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
 
@@ -312,10 +322,16 @@ the attribute.
 
 =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
 
@@ -425,17 +441,33 @@ Returns whether this class is actually loaded or not. It uses a heuristic which
 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
@@ -443,7 +475,9 @@ L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Mouse>.
 
 =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.