X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FUtils.pm;h=0598f535bd7f9ad8f1a9f33c8a63cf253b0a7e5c;hp=e4c5db800c3d65320edfdf36d0923d2359f95589;hb=85d9fce671016c9040775c8b4458cf9c72ec2208;hpb=d837e1a7eadff19ff04373ad19d22fa293e19db5

diff --git a/lib/Catalyst/Utils.pm b/lib/Catalyst/Utils.pm
index e4c5db8..0598f53 100644
--- a/lib/Catalyst/Utils.pm
+++ b/lib/Catalyst/Utils.pm
@@ -1,10 +1,13 @@
 package Catalyst::Utils;
 
 use strict;
-use attributes ();
+use Catalyst::Exception;
+use File::Spec;
 use HTTP::Request;
 use Path::Class;
 use URI;
+use Class::Inspector;
+use Carp qw/croak/;
 
 =head1 NAME
 
@@ -18,116 +21,186 @@ See L<Catalyst>.
 
 =head1 METHODS
 
-=over 4
+=head2 appprefix($class)
 
-=item attrs($coderef)
-
-Returns attributes for coderef in a arrayref
+    MyApp::Foo becomes myapp_foo
 
 =cut
 
-sub attrs { attributes::get( $_[0] ) || [] }
-
-=item class2appclass($class);
+sub appprefix {
+    my $class = shift;
+    $class =~ s/::/_/g;
+    $class = lc($class);
+    return $class;
+}
 
-Returns the appclass for class.
+=head2 class2appclass($class);
 
-    MyApp::C::Foo::Bar becomes MyApp
-    My::App::C::Foo::Bar becomes My::App
+    MyApp::Controller::Foo::Bar becomes MyApp
+    My::App::Controller::Foo::Bar becomes My::App
 
 =cut
 
 sub class2appclass {
     my $class = shift || '';
     my $appname = '';
-    if ( $class =~ /^(.*)::([MVC]|Model|View|Controller)?::.*$/ ) {
+    if ( $class =~ /^(.+?)::([MVC]|Model|View|Controller)::.+$/ ) {
         $appname = $1;
     }
     return $appname;
 }
 
-=item class2classprefix($class);
-
-Returns the classprefix for class.
+=head2 class2classprefix($class);
 
-    MyApp::C::Foo::Bar becomes MyApp::C
-    My::App::C::Foo::Bar becomes My::App::C
+    MyApp::Controller::Foo::Bar becomes MyApp::Controller
+    My::App::Controller::Foo::Bar becomes My::App::Controller
 
 =cut
 
 sub class2classprefix {
     my $class = shift || '';
     my $prefix;
-    if ( $class =~ /^(.*::[MVC]|Model|View|Controller)?::.*$/ ) {
+    if ( $class =~ /^(.+?::([MVC]|Model|View|Controller))::.+$/ ) {
         $prefix = $1;
     }
     return $prefix;
 }
 
-=item class2classsuffix($class);
+=head2 class2classsuffix($class);
 
-Returns the classsuffix for class.
-
-    MyApp::C::Foo::Bar becomes C::Foo::Bar
+    MyApp::Controller::Foo::Bar becomes Controller::Foo::Bar
 
 =cut
 
 sub class2classsuffix {
     my $class = shift || '';
     my $prefix = class2appclass($class) || '';
-    $class =~ s/$prefix\:\://;
+    $class =~ s/$prefix\:://;
     return $class;
 }
 
-=item class2prefix($class);
+=head2 class2env($class);
+
+Returns the environment name for class.
+
+    MyApp becomes MYAPP
+    My::App becomes MY_APP
+
+=cut
+
+sub class2env {
+    my $class = shift || '';
+    $class =~ s/::/_/g;
+    return uc($class);
+}
+
+=head2 class2prefix( $class, $case );
 
-Returns the prefix for class.
+Returns the uri prefix for a class. If case is false the prefix is converted to lowercase.
 
-    My::App::C::Foo::Bar becomes /foo/bar
+    My::App::Controller::Foo::Bar becomes foo/bar
 
 =cut
 
 sub class2prefix {
     my $class = shift || '';
+    my $case  = shift || 0;
     my $prefix;
-    if ( $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/ ) {
-        $prefix = lc $2;
-        $prefix =~ s/\:\:/\//g;
+    if ( $class =~ /^.+?::([MVC]|Model|View|Controller)::(.+)$/ ) {
+        $prefix = $case ? $2 : lc $2;
+        $prefix =~ s{::}{/}g;
     }
     return $prefix;
 }
 
-=item home($class)
+=head2 class2tempdir( $class [, $create ] );
+
+Returns a tempdir for a class. If create is true it will try to create the path.
+
+    My::App becomes /tmp/my/app
+    My::App::C::Foo::Bar becomes /tmp/my/app/c/foo/bar
+
+=cut
+
+sub class2tempdir {
+    my $class  = shift || '';
+    my $create = shift || 0;
+    my @parts = split '::', lc $class;
+
+    my $tmpdir = dir( File::Spec->tmpdir, @parts )->cleanup;
+
+    if ( $create && !-e $tmpdir ) {
+
+        eval { $tmpdir->mkpath };
+
+        if ($@) {
+            Catalyst::Exception->throw(
+                message => qq/Couldn't create tmpdir '$tmpdir', "$@"/ );
+        }
+    }
+
+    return $tmpdir->stringify;
+}
+
+=head2 home($class)
 
 Returns home directory for given class.
 
 =cut
 
 sub home {
-    my $name = shift;
-    $name =~ s/\:\:/\//g;
-    my $home = 0;
-    if ( my $path = $INC{"$name.pm"} ) {
-        $home = file($path)->absolute->dir;
-        $name =~ /(\w+)$/;
-        my $append = $1;
-        my $subdir = dir($home)->subdir($append);
-        for ( split '/', $name ) { $home = dir($home)->parent }
-        if ( $home =~ /blib$/ ) { $home = dir($home)->parent }
-        elsif (!-f file( $home, 'Makefile.PL' )
-            && !-f file( $home, 'Build.PL' ) )
+    my $class = shift;
+
+    # make an $INC{ $key } style string from the class name
+    (my $file = "$class.pm") =~ s{::}{/}g;
+
+    if ( my $inc_entry = $INC{$file} ) {
         {
-            $home = $subdir;
+            # look for an uninstalled Catalyst app
+
+            # find the @INC entry in which $file was found
+            (my $path = $inc_entry) =~ s/$file$//;
+            my $home = dir($path)->absolute->cleanup;
+
+            # pop off /lib and /blib if they're there
+            $home = $home->parent while $home =~ /b?lib$/;
+
+            # only return the dir if it has a Makefile.PL or Build.PL
+            if (-f $home->file("Makefile.PL") or -f $home->file("Build.PL")) {
+
+                # clean up relative path:
+                # MyApp/script/.. -> MyApp
+
+                my ($lastdir) = $home->dir_list( -1, 1 );
+                if ( $lastdir eq '..' ) {
+                    $home = dir($home)->parent->parent;
+                }
+
+                return $home->stringify;
+            }
+        }
+
+        {
+            # look for an installed Catalyst app
+
+            # trim the .pm off the thing ( Foo/Bar.pm -> Foo/Bar/ )
+            ( my $path = $inc_entry) =~ s/\.pm$//;
+            my $home = dir($path)->absolute->cleanup;
+
+            # return if if it's a valid directory
+            return $home->stringify if -d $home;
         }
     }
-    return $home;
+
+    # we found nothing
+    return 0;
 }
 
-=item prefix($class, $name);
+=head2 prefix($class, $name);
 
 Returns a prefixed action.
 
-    MyApp::C::Foo::Bar, yada becomes /foo/bar/yada
+    MyApp::Controller::Foo::Bar, yada becomes foo/bar/yada
 
 =cut
 
@@ -138,53 +211,114 @@ sub prefix {
     return $name;
 }
 
-=item reflect_actions($class);
+=head2 request($uri)
 
-Returns an arrayref containing all actions of a component class.
+Returns an L<HTTP::Request> object for a uri.
 
 =cut
 
-sub reflect_actions {
-    my $class   = shift;
-    my $actions = [];
-    eval '$actions = $class->_action_cache';
-    die qq/Couldn't reflect actions of component "$class", "$@"/ if $@;
-    return $actions;
+sub request {
+    my $request = shift;
+    unless ( ref $request ) {
+        if ( $request =~ m/^http/i ) {
+            $request = URI->new($request);
+        }
+        else {
+            $request = URI->new( 'http://localhost' . $request );
+        }
+    }
+    unless ( ref $request eq 'HTTP::Request' ) {
+        $request = HTTP::Request->new( 'GET', $request );
+    }
+    return $request;
 }
 
-=back
+=head2 ensure_class_loaded($class_name)
 
-=item request($string);
-
-Returns an C<HTTP::Request> from a string.
+Loads the class unless it already has been loaded.
 
 =cut
 
-sub request {
-    my $request = shift;
+sub ensure_class_loaded {
+    my $class = shift;
+    my $opts  = shift;
 
-    unless ( ref $request ) {
+    croak "Malformed class Name $class"
+        if $class =~ m/(?:\b\:\b|\:{3,})/;
+
+    return if !$opts->{ ignore_loaded }
+        && Class::Inspector->loaded( $class ); # if a symbol entry exists we don't load again
+
+    # this hack is so we don't overwrite $@ if the load did not generate an error
+    my $error;
+    {
+        local $@;
+        eval "require $class";
+        $error = $@;
+    }
 
-        if ( $request =~ m/http/i ) {
-            $request = URI->new($request)->canonical;
+    die $error if $error;
+    die "require $class was successful but the package is not defined"
+        unless Class::Inspector->loaded($class);
+
+    return 1;
+}
+
+=head2 merge_hashes($hashref, $hashref)
+
+Base code to recursively merge two hashes together with right-hand precedence.
+
+=cut
+
+sub merge_hashes {
+    my ( $lefthash, $righthash ) = @_;
+
+    return $lefthash unless defined $righthash;
+    
+    my %merged = %$lefthash;
+    for my $key ( keys %$righthash ) {
+        my $right_ref = ( ref $righthash->{ $key } || '' ) eq 'HASH';
+        my $left_ref  = ( ( exists $lefthash->{ $key } && ref $lefthash->{ $key } ) || '' ) eq 'HASH';
+        if( $right_ref and $left_ref ) {
+            $merged{ $key } = merge_hashes(
+                $lefthash->{ $key }, $righthash->{ $key }
+            );
         }
         else {
-            $request = URI->new( 'http://localhost' . $request )->canonical;
+            $merged{ $key } = $righthash->{ $key };
         }
     }
+    
+    return \%merged;
+}
 
-    unless ( ref $request eq 'HTTP::Request' ) {
-        $request = HTTP::Request->new( 'GET', $request );
+=head2 env_value($class, $key)
+
+Checks for and returns an environment value. For instance, if $key is
+'home', then this method will check for and return the first value it finds,
+looking at $ENV{MYAPP_HOME} and $ENV{CATALYST_HOME}.
+
+=cut
+
+sub env_value {
+    my ( $class, $key ) = @_;
+
+    $key = uc($key);
+    my @prefixes = ( class2env($class), 'CATALYST' );
+
+    for my $prefix (@prefixes) {
+        if ( defined( my $value = $ENV{"${prefix}_${key}"} ) ) {
+            return $value;
+        }
     }
 
-    return $request;
+    return;
 }
 
-=back
-
 =head1 AUTHOR
 
 Sebastian Riedel, C<sri@cpan.org>
+Yuval Kogman, C<nothingmuch@woobling.org>
 
 =head1 COPYRIGHT