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=6b8d4822d332fb849fe2db126edbd5824edb81d2;hp=4e5571e1536dc1384886fbb2018a3a3b02625041;hb=f7ac80efdfe4ef8e676df86d3b3a967d509ecb7f;hpb=e9902daeaa20fcd6a3dc8fcb53407dbe7a6fd761 diff --git a/lib/Catalyst/Utils.pm b/lib/Catalyst/Utils.pm index 4e5571e..6b8d482 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 Class::Inspector; use Carp qw/croak/; +use FindBin qw/ $Bin /; +use Class::MOP; +use String::RewritePrefix; +use List::MoreUtils qw/ any /; + +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 @@ -134,6 +140,13 @@ sub class2tempdir { eval { $tmpdir->mkpath }; if ($@) { + # 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', "$@"/ ); } @@ -142,10 +155,22 @@ sub class2tempdir { return $tmpdir->stringify; } +=head2 dist_indicator_file_list + +Returns a list of files which can be tested to check if you're inside a checkout + +=cut + +sub dist_indicator_file_list { + qw/ Makefile.PL Build.PL dist.ini /; +} + =head2 home($class) Returns home directory for given class. +Note that the class must be loaded for the home directory to be found using this function. + =cut sub home { @@ -160,25 +185,8 @@ sub home { # 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 $dir; - my @dir_list = $home->dir_list(); - while (($dir = pop(@dir_list)) && $dir eq '..') { - $home = dir($home)->parent->parent; - } - - return $home->stringify; - } + my $home = find_home_unloaded_in_checkout($path); + return $home if $home; } { @@ -197,6 +205,44 @@ sub home { return 0; } +=head2 find_home_unloaded_in_checkout ($path) + +Tries to determine if C<$path> (or $FindBin::Bin if not supplied) +looks like a checkout. Any leading lib, script or blib components +will be removed, then the directory produced will be checked +for the existence of a C<< dist_indicator_file_list() >>. + +If one is found, the directory will be returned, otherwise false. + +=cut + +sub find_home_unloaded_in_checkout { + my ($path) = @_; + $path ||= $Bin if !defined $path || !length $path; + my $home = dir($path)->absolute->cleanup; + + # pop off /lib and /blib if they're there + $home = $home->parent while $home =~ /b?lib$/; + # pop off /script if it's there. + $home = $home->parent while $home =~ /b?script$/; + + # only return the dir if it has a Makefile.PL or Build.PL or dist.ini + if (any { $_ } map { -f $home->file($_) } dist_indicator_file_list()) { + + # clean up relative path: + # MyApp/script/.. -> MyApp + + my $dir; + my @dir_list = $home->dir_list(); + while (($dir = pop(@dir_list)) && $dir eq '..') { + $home = dir($home)->parent->parent; + } + + return $home->stringify; + } + +} + =head2 prefix($class, $name); Returns a prefixed action. @@ -258,8 +304,11 @@ sub ensure_class_loaded { croak "ensure_class_loaded should be given a classname, not a filename ($class)" if $class =~ m/\.pm$/; + # $opts->{ignore_loaded} can be set to true, and this causes the class to be required, even + # 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::Inspector->loaded( $class ); # if a symbol entry exists we don't load again + && Class::MOP::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; @@ -272,8 +321,9 @@ sub ensure_class_loaded { } die $error if $error; - die "require $class was successful but the package is not defined" - unless Class::Inspector->loaded($class); + + warn "require $class was successful but the package is not defined." + unless Class::MOP::is_class_loaded($class); return 1; } @@ -288,7 +338,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'; @@ -302,7 +352,7 @@ sub merge_hashes { $merged{ $key } = $righthash->{ $key }; } } - + return \%merged; } @@ -329,14 +379,79 @@ sub env_value { return; } -=head1 AUTHOR +=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 ' + use Term::Size::Any; + my ($columns, $rows) = Term::Size::Any::chars; + return $columns; + '; + + if ($@) { + $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); +} + + +=head1 AUTHORS -Sebastian Riedel, C -Yuval Kogman, C +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