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=31773b7ce725226a17eac120cfa97206f3a0c266;hp=13c2a0255964a4e217cbbb4e3fe5fa24690d6971;hb=35b3434762d426e0cd5e04eb735291f8ca7ea08e;hpb=11c270bdda5402dc39e2ca54dfd65af42dedbe3c diff --git a/lib/Catalyst/Utils.pm b/lib/Catalyst/Utils.pm index 13c2a02..31773b7 100644 --- a/lib/Catalyst/Utils.pm +++ b/lib/Catalyst/Utils.pm @@ -1,13 +1,17 @@ package Catalyst::Utils; use strict; -use Catalyst::Exception; use File::Spec; use HTTP::Request; use Path::Class; use URI; use Carp qw/croak/; use Cwd; +use Class::Load 'is_class_loaded'; +use String::RewritePrefix; +use Class::Load (); + +use namespace::clean; =head1 NAME @@ -19,6 +23,8 @@ See L. =head1 DESCRIPTION +Catalyst Utilities. + =head1 METHODS =head2 appprefix($class) @@ -118,7 +124,7 @@ sub class2prefix { 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 + My::App::Controller::Foo::Bar becomes /tmp/my/app/c/foo/bar =cut @@ -131,9 +137,15 @@ sub class2tempdir { if ( $create && !-e $tmpdir ) { - eval { $tmpdir->mkpath }; - - if ($@) { + eval { $tmpdir->mkpath; 1 } + or do { + # don't load Catalyst::Exception as a BEGIN in Utils, + # because Utils often gets loaded before MyApp.pm, and if + # Catalyst::Exception is loaded before MyApp.pm, it does + # not honor setting + # $Catalyst::Exception::CATALYST_EXCEPTION_CLASS in + # MyApp.pm + require Catalyst::Exception; Catalyst::Exception->throw( message => qq/Couldn't create tmpdir '$tmpdir', "$@"/ ); } @@ -146,8 +158,31 @@ sub class2tempdir { Returns home directory for given class. +=head2 dist_indicator_file_list + +Returns a list of files which can be tested to check if you're inside +a CPAN distribution which is not yet installed. + +These are: + +=over + +=item Makefile.PL + +=item Build.PL + +=item dist.ini + +=item L + +=back + =cut +sub dist_indicator_file_list { + qw{Makefile.PL Build.PL dist.ini cpanfile}; +} + sub home { my $class = shift; @@ -166,9 +201,8 @@ sub home { # 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")) { - + # only return the dir if it has a Makefile.PL or Build.PL or dist.ini + if (grep { -f $home->file($_) } dist_indicator_file_list()) { # clean up relative path: # MyApp/script/.. -> MyApp @@ -263,7 +297,7 @@ sub ensure_class_loaded { # if it already has symbol table entries. This is to support things like Schema::Loader, which # part-generate classes in memory, but then also load some of their contents from disk. return if !$opts->{ ignore_loaded } - && Class::MOP::is_class_loaded($class); # if a symbol entry exists we don't load again + && is_class_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; @@ -278,7 +312,7 @@ sub ensure_class_loaded { die $error if $error; warn "require $class was successful but the package is not defined." - unless Class::MOP::is_class_loaded($class); + unless is_class_loaded($class); return 1; } @@ -293,7 +327,7 @@ 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'; @@ -307,7 +341,7 @@ sub merge_hashes { $merged{ $key } = $righthash->{ $key }; } } - + return \%merged; } @@ -334,13 +368,129 @@ sub env_value { return; } +=head2 term_width + +Try to guess terminal width to use with formatting of debug output + +All you need to get this work, is: + +1) Install Term::Size::Any, or + +2) Export $COLUMNS from your shell. + +(Warning to bash users: 'echo $COLUMNS' may be showing you the bash +variable, not $ENV{COLUMNS}. 'export COLUMNS=$COLUMNS' and you should see +that 'env' now lists COLUMNS.) + +As last resort, default value of 80 chars will be used. + +=cut + +my $_term_width; + +sub term_width { + return $_term_width if $_term_width; + + my $width; + eval ' + require Term::Size::Any; + my ($columns, $rows) = Term::Size::Any::chars; + $width = $columns; + 1; + ' or do { + $width = $ENV{COLUMNS} + if exists($ENV{COLUMNS}) + && $ENV{COLUMNS} =~ m/^\d+$/; + }; + + $width = 80 unless ($width && $width >= 80); + return $_term_width = $width; +} + + +=head2 resolve_namespace + +Method which adds the namespace for plugins and actions. + + __PACKAGE__->setup(qw(MyPlugin)); + + # will load Catalyst::Plugin::MyPlugin + +=cut + + +sub resolve_namespace { + my $appnamespace = shift; + my $namespace = shift; + my @classes = @_; + return String::RewritePrefix->rewrite({ + q[] => qq[${namespace}::], + q[+] => q[], + (defined $appnamespace + ? (q[~] => qq[${appnamespace}::]) + : () + ), + }, @classes); +} + +=head2 build_middleware (@args) + +Internal application that converts a single middleware definition (see +L) into an actual instance of middleware. + +=cut + +sub build_middleware { + my ($class, $namespace, @init_args) = @_; + + if( + $namespace =~s/^\+// || + $namespace =~/^Plack::Middleware/ || + $namespace =~/^$class/ + ) { ## the string is a full namespace + return Class::Load::try_load_class($namespace) ? + $namespace->new(@init_args) : + die "Can't load class $namespace"; + } else { ## the string is a partial namespace + if(Class::Load::try_load_class($class .'::Middleware::'. $namespace)) { ## Load Middleware from Project namespace + my $ns = $class .'::Middleware::'. $namespace; + return $ns->new(@init_args); + } elsif(Class::Load::try_load_class("Plack::Middleware::$namespace")) { ## Act like Plack::Builder + return "Plack::Middleware::$namespace"->new(@init_args); + } + } + + return; ## be sure we can count on a proper return when valid +} + +=head2 apply_registered_middleware ($psgi) + +Given a $psgi reference, wrap all the L +around it and return the wrapped version. + +This exists to deal with the fact Catalyst registered middleware can be +either an object with a wrap method or a coderef. + +=cut + +sub apply_registered_middleware { + my ($class, $psgi) = @_; + my $new_psgi = $psgi; + foreach my $middleware ($class->registered_middlewares) { + $new_psgi = Scalar::Util::blessed $middleware ? + $middleware->wrap($new_psgi) : + $middleware->($new_psgi); + } + return $new_psgi; +} + =head1 AUTHORS Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This program is free software, you can redistribute it and/or modify it under +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut