Mouse code has a lot of '{' and '}', q{} is dangerous.
[gitmo/Mouse.git] / lib / Mouse.pm
index 12e4707..7cdd243 100644 (file)
@@ -1,38 +1,27 @@
-#!/usr/bin/env perl
 package Mouse;
 use strict;
 use warnings;
+use 5.006;
 use base 'Exporter';
 
-our $VERSION = '0.13';
-use 5.006;
+our $VERSION = '0.24';
 
 use Carp 'confess';
-use Mouse::Util 'blessed';
+use Scalar::Util 'blessed';
+use Mouse::Util;
 
 use Mouse::Meta::Attribute;
 use Mouse::Meta::Class;
 use Mouse::Object;
-use Mouse::TypeRegistry;
+use Mouse::Util::TypeConstraints;
 
-our @EXPORT = qw(extends has before after around blessed confess with);
+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);
-
-    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, @_);
-        }
-    }
+    $meta->add_attribute(@_);
 }
 
 sub before {
@@ -66,31 +55,82 @@ sub around {
 }
 
 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 $role  = shift;
+    my $body = $pkg->can($name)
+        or confess "You cannot override '$name' because it has no super method";
 
-    confess "Mouse::Role only supports 'with' on individual roles at a time" if @_;
+    $meta->add_method($name => sub {
+        local $SUPER_PACKAGE = $pkg;
+        local @SUPER_ARGS = @_;
+        local $SUPER_BODY = $body;
 
-    Mouse::load_class($role);
-    $role->meta->apply($meta);
+        $code->(@_);
+    });
 }
 
 sub import {
+    my $class = shift;
+
     strict->import;
     warnings->import;
 
-    my $caller = caller;
+    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;
+    }
 
     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 };
 
-    Mouse->export_to_level(1, @_);
+    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 {
@@ -110,6 +150,7 @@ sub load_class {
         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;
@@ -150,6 +191,12 @@ sub is_class_loaded {
     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__
@@ -186,21 +233,18 @@ 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
+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. 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> or L<Data::Util> is required if you want support
+for L</before>, L</after>, and L</around>.
 
 =head2 MOOSE COMPAT
 
@@ -211,37 +255,16 @@ 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.
-
-=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
 
@@ -288,10 +311,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
 
@@ -401,17 +430,31 @@ 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
+
 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