X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FUtils.pm;h=9e389e36d39bb88cba1e512ca4da0170aedf041d;hb=264bac8c94a84d7dbac9912946d1a639fa37d1cd;hp=e4c5db800c3d65320edfdf36d0923d2359f95589;hpb=d837e1a7eadff19ff04373ad19d22fa293e19db5;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Utils.pm b/lib/Catalyst/Utils.pm index e4c5db8..9e389e3 100644 --- a/lib/Catalyst/Utils.pm +++ b/lib/Catalyst/Utils.pm @@ -1,10 +1,12 @@ package Catalyst::Utils; use strict; -use attributes (); +use Catalyst::Exception; +use File::Spec; use HTTP::Request; use Path::Class; use URI; +use Class::Inspector; =head1 NAME @@ -18,19 +20,20 @@ See L. =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 @@ -46,9 +49,7 @@ sub class2appclass { 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 @@ -64,9 +65,7 @@ sub class2classprefix { return $prefix; } -=item class2classsuffix($class); - -Returns the classsuffix for class. +=head2 class2classsuffix($class); MyApp::C::Foo::Bar becomes C::Foo::Bar @@ -79,55 +78,128 @@ sub class2classsuffix { return $class; } -=item class2prefix($class); +=head2 class2env($class); -Returns the prefix for class. +Returns the environment name for class. - My::App::C::Foo::Bar becomes /foo/bar + 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 uri prefix for a class. If case is false the prefix is converted to lowercase. + + My::App::C::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 = $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::C::Foo::Bar, yada becomes foo/bar/yada =cut @@ -138,53 +210,89 @@ sub prefix { return $name; } -=item reflect_actions($class); - -Returns an arrayref containing all actions of a component class. - -=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; -} - -=back - -=item request($string); +=head2 request($uri) -Returns an C from a string. +Returns an L object for a uri. =cut sub request { my $request = shift; - unless ( ref $request ) { - - if ( $request =~ m/http/i ) { + if ( $request =~ m/^http/i ) { $request = URI->new($request)->canonical; } else { $request = URI->new( 'http://localhost' . $request )->canonical; } } - unless ( ref $request eq 'HTTP::Request' ) { $request = HTTP::Request->new( 'GET', $request ); } - return $request; } -=back +=head2 ensure_class_loaded($class_name) + +Loads the class unless it already has been loaded. + +=cut + +sub ensure_class_loaded { + my $class = shift; + my $opts = shift; + + 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 = $@; + } + + 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 { + $merged{ $key } = $righthash->{ $key }; + } + } + + return \%merged; +} + =head1 AUTHOR Sebastian Riedel, C +Yuval Kogman, C =head1 COPYRIGHT