Docs on Mouse::Util

[gitmo/Mouse.git] / lib / Mouse / Util.pm

diff --git a/lib/Mouse/Util.pm b/lib/Mouse/Util.pm
index c941263..076ca34 100644 (file)
--- a/lib/Mouse/Util.pm
+++ b/lib/Mouse/Util.pm
@@ -1,9 +1,11 @@
 package Mouse::Util;
 use Mouse::Exporter; # enables strict and warnings
 
-sub get_linear_isa($;$); # must be here
+# must be here because it will be refered by other modules loaded
+sub get_linear_isa($;$); ## no critic
 
-sub install_subroutines { # must be here
+# must be here because it will called in Mouse::Exporter
+sub install_subroutines {
     my $into = shift;
 
     while(my($name, $code) = splice @_, 0, 2){
@@ -46,21 +48,18 @@ BEGIN{
         },
     );
 
+    our $VERSION = '0.70';
 
-    # Because Mouse::Util is loaded first in all the Mouse sub-modules,
-    # XS loader is placed here, not in Mouse.pm.
-
-    our $VERSION = '0.50_03';
-
-    my $xs = !(exists $INC{'Mouse/PurePerl.pm'} || $ENV{MOUSE_PUREPERL});
+    my $xs = !(defined(&is_valid_class_name) || $ENV{MOUSE_PUREPERL} || $ENV{PERL_ONLY});
 
+    # Because Mouse::Util is loaded first in all the Mouse sub-modules,
+    # XSLoader must be placed here, not in Mouse.pm.
     if($xs){
         # XXX: XSLoader tries to get the object path from caller's file name
         #      $hack_mouse_file fools its mechanism
-
         (my $hack_mouse_file = __FILE__) =~ s/.Util//; # .../Mouse/Util.pm -> .../Mouse.pm
         $xs = eval sprintf("#line %d %s\n", __LINE__, $hack_mouse_file) . q{
-            local $^W = 0; # work around 'redefine' warning to &install_subroutines
+            local $^W = 0; # workaround 'redefine' warning to &install_subroutines
             require XSLoader;
             XSLoader::load('Mouse', $VERSION);
             Mouse::Util->import({ into => 'Mouse::Meta::Method::Constructor::XS' }, ':meta');
@@ -154,7 +153,7 @@ BEGIN {
         {
             package # hide from PAUSE
                 Class::C3;
-            our %MRO; # work around 'once' warnings
+            our %MRO; # avoid 'once' warnings
         }
 
         # MRO::Compat::__get_linear_isa has no prototype, so
@@ -242,7 +241,6 @@ sub load_first_existing_class {
 }
 
 # taken from Class/MOP.pm
-my %is_class_loaded_cache;
 sub _try_load_one_class {
     my $class = shift;
 
@@ -251,7 +249,7 @@ sub _try_load_one_class {
         Carp::confess "Invalid class name ($display)";
     }
 
-    return undef if $is_class_loaded_cache{$class} ||= is_class_loaded($class);
+    return '' if is_class_loaded($class);
 
     $class  =~ s{::}{/}g;
     $class .= '.pm';
@@ -347,6 +345,7 @@ sub dump :method {
     my $dd = Data::Dumper->new([$self]);
     $dd->Maxdepth(defined($maxdepth) ? $maxdepth : 3);
     $dd->Indent(1);
+    $dd->Sortkeys(1);
     return $dd->Dump();
 }
 
@@ -360,47 +359,63 @@ __END__
 
 =head1 NAME
 
-Mouse::Util - Features, with or without their dependencies
+Mouse::Util - Utilities for working with Mouse classes
 
 =head1 VERSION
 
-This document describes Mouse version 0.50_03
+This document describes Mouse version 0.70
+
+=head1 SYNOPSIS
+
+    use Mouse::Util; # turns on strict and warnings
+
+=head1 DESCRIPTION
+
+This module provides a set of utility functions. Many of these
+functions are intended for use in Mouse itself or MouseX modules, but
+some of them may be useful for use in your own code.
 
 =head1 IMPLEMENTATIONS FOR
 
-=head2 Moose::Util
+=head2 Moose::Util functions
+
+The following functions are exportable.
+
+=head3 C<find_meta($class_or_obj)>
+
+The same as C<Mouse::Util::class_of()>.
 
-=head3 C<find_meta>
+=head3 C<does_role($class_or_obj, $role_or_obj)>
 
-=head3 C<does_role>
+=head3 C<resolve_metaclass_alias($category, $name, %options)>
 
-=head3 C<resolve_metaclass_alias>
+=head3 C<apply_all_roles($applicant, @roles)>
 
-=head3 C<apply_all_roles>
+=head3 C<english_listi(@items)>
 
-=head3 C<english_list>
+=head2 Class::MOP functions
 
-=head2 Class::MOP
+The followign functions are not exportable.
 
-=head3 C<< is_class_loaded(ClassName) -> Bool >>
+=head3 C<< Mouse::Util::is_class_loaded($classname) -> Bool >>
 
-Returns whether C<ClassName> 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.
+Returns whether I<$classname> 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.
 
-=head3 C<< load_class(ClassName) >>
+=head3 C<< Mouse::Util::load_class($classname) -> ClassName >>
 
-This will load a given C<ClassName> (or die if it is not loadable).
+This will load a given I<$classname> (or die if it is not loadable).
 This function can be used in place of tricks like
-C<eval "use $module"> or using C<require>.
+C<eval "use $module ()"> or using C<require>.
 
-=head3 C<< Mouse::Util::class_of(ClassName or Object) >>
+=head3 C<< Mouse::Util::class_of($classname_or_object) -> MetaClass >>
 
-=head3 C<< Mouse::Util::get_metaclass_by_name(ClassName) >>
+=head3 C<< Mouse::Util::get_metaclass_by_name($classname) -> MetaClass >>
 
-=head3 C<< Mouse::Util::get_all_metaclass_instances() >>
+=head3 C<< Mouse::Util::get_all_metaclass_instances() -> (MetaClasses) >>
 
-=head3 C<< Mouse::Util::get_all_metaclass_names() >>
+=head3 C<< Mouse::Util::get_all_metaclass_names() -> (ClassNames) >>
 
 =head2 MRO::Compat