1 package Catalyst::Utils;
11 use String::RewritePrefix;
12 use List::MoreUtils qw/ any /;
18 Catalyst::Utils - The Catalyst Utils
30 =head2 appprefix($class)
32 MyApp::Foo becomes myapp_foo
43 =head2 class2appclass($class);
45 MyApp::Controller::Foo::Bar becomes MyApp
46 My::App::Controller::Foo::Bar becomes My::App
51 my $class = shift || '';
53 if ( $class =~ /^(.+?)::([MVC]|Model|View|Controller)::.+$/ ) {
59 =head2 class2classprefix($class);
61 MyApp::Controller::Foo::Bar becomes MyApp::Controller
62 My::App::Controller::Foo::Bar becomes My::App::Controller
66 sub class2classprefix {
67 my $class = shift || '';
69 if ( $class =~ /^(.+?::([MVC]|Model|View|Controller))::.+$/ ) {
75 =head2 class2classsuffix($class);
77 MyApp::Controller::Foo::Bar becomes Controller::Foo::Bar
81 sub class2classsuffix {
82 my $class = shift || '';
83 my $prefix = class2appclass($class) || '';
84 $class =~ s/$prefix\:://;
88 =head2 class2env($class);
90 Returns the environment name for class.
93 My::App becomes MY_APP
98 my $class = shift || '';
103 =head2 class2prefix( $class, $case );
105 Returns the uri prefix for a class. If case is false the prefix is converted to lowercase.
107 My::App::Controller::Foo::Bar becomes foo/bar
112 my $class = shift || '';
113 my $case = shift || 0;
115 if ( $class =~ /^.+?::([MVC]|Model|View|Controller)::(.+)$/ ) {
116 $prefix = $case ? $2 : lc $2;
117 $prefix =~ s{::}{/}g;
122 =head2 class2tempdir( $class [, $create ] );
124 Returns a tempdir for a class. If create is true it will try to create the path.
126 My::App becomes /tmp/my/app
127 My::App::Controller::Foo::Bar becomes /tmp/my/app/c/foo/bar
132 my $class = shift || '';
133 my $create = shift || 0;
134 my @parts = split '::', lc $class;
136 my $tmpdir = dir( File::Spec->tmpdir, @parts )->cleanup;
138 if ( $create && !-e $tmpdir ) {
140 eval { $tmpdir->mkpath };
143 # don't load Catalyst::Exception as a BEGIN in Utils,
144 # because Utils often gets loaded before MyApp.pm, and if
145 # Catalyst::Exception is loaded before MyApp.pm, it does
147 # $Catalyst::Exception::CATALYST_EXCEPTION_CLASS in
149 require Catalyst::Exception;
150 Catalyst::Exception->throw(
151 message => qq/Couldn't create tmpdir '$tmpdir', "$@"/ );
155 return $tmpdir->stringify;
158 =head2 dist_indicator_file_list
160 Returns a list of files which can be tested to check if you're inside a checkout
164 sub dist_indicator_file_list {
165 qw/ Makefile.PL Build.PL dist.init /;
170 Returns home directory for given class.
172 Note that the class must be loaded for the home directory to be found using this function.
179 # make an $INC{ $key } style string from the class name
180 (my $file = "$class.pm") =~ s{::}{/}g;
182 if ( my $inc_entry = $INC{$file} ) {
184 # look for an uninstalled Catalyst app
186 # find the @INC entry in which $file was found
187 (my $path = $inc_entry) =~ s/$file$//;
188 my $home = find_home_unloaded_in_checkout($path);
189 return $home if $home;
193 # look for an installed Catalyst app
195 # trim the .pm off the thing ( Foo/Bar.pm -> Foo/Bar/ )
196 ( my $path = $inc_entry) =~ s/\.pm$//;
197 my $home = dir($path)->absolute->cleanup;
199 # return if if it's a valid directory
200 return $home->stringify if -d $home;
208 =head2 find_home_unloaded_in_checkout ($path)
210 Tries to determine if C<$path> (or the current directory if not supplied)
211 looks like a checkout. Any leading lib or blib components
212 will be removed, then the directory produced will be checked
213 for the existence of a C<< dist_indicator_file_list() >>.
215 If one is found, the directory will be returned, otherwise false.
219 sub find_home_unloaded_in_checkout {
221 $path ||= cwd() if !defined $path || !length $path;
222 my $home = dir($path)->absolute->cleanup;
224 # pop off /lib and /blib if they're there
225 $home = $home->parent while $home =~ /b?lib$/;
227 # only return the dir if it has a Makefile.PL or Build.PL or dist.ini
228 if (any { $_ } map { -f $home->file($_) } dist_indicator_file_list()) {
230 # clean up relative path:
231 # MyApp/script/.. -> MyApp
234 my @dir_list = $home->dir_list();
235 while (($dir = pop(@dir_list)) && $dir eq '..') {
236 $home = dir($home)->parent->parent;
239 return $home->stringify;
244 =head2 prefix($class, $name);
246 Returns a prefixed action.
248 MyApp::Controller::Foo::Bar, yada becomes foo/bar/yada
253 my ( $class, $name ) = @_;
254 my $prefix = &class2prefix($class);
255 $name = "$prefix/$name" if $prefix;
261 Returns an L<HTTP::Request> object for a uri.
267 unless ( ref $request ) {
268 if ( $request =~ m/^http/i ) {
269 $request = URI->new($request);
272 $request = URI->new( 'http://localhost' . $request );
275 unless ( ref $request eq 'HTTP::Request' ) {
276 $request = HTTP::Request->new( 'GET', $request );
281 =head2 ensure_class_loaded($class_name, \%opts)
283 Loads the class unless it already has been loaded.
285 If $opts{ignore_loaded} is true always tries the require whether the package
286 already exists or not. Only pass this if you're either (a) sure you know the
287 file exists on disk or (b) have code to catch the file not found exception
288 that will result if it doesn't.
292 sub ensure_class_loaded {
296 croak "Malformed class Name $class"
297 if $class =~ m/(?:\b\:\b|\:{3,})/;
299 croak "Malformed class Name $class"
300 if $class =~ m/[^\w:]/;
302 croak "ensure_class_loaded should be given a classname, not a filename ($class)"
303 if $class =~ m/\.pm$/;
305 # $opts->{ignore_loaded} can be set to true, and this causes the class to be required, even
306 # if it already has symbol table entries. This is to support things like Schema::Loader, which
307 # part-generate classes in memory, but then also load some of their contents from disk.
308 return if !$opts->{ ignore_loaded }
309 && Class::MOP::is_class_loaded($class); # if a symbol entry exists we don't load again
311 # this hack is so we don't overwrite $@ if the load did not generate an error
315 my $file = $class . '.pm';
317 eval { CORE::require($file) };
321 die $error if $error;
323 warn "require $class was successful but the package is not defined."
324 unless Class::MOP::is_class_loaded($class);
329 =head2 merge_hashes($hashref, $hashref)
331 Base code to recursively merge two hashes together with right-hand precedence.
336 my ( $lefthash, $righthash ) = @_;
338 return $lefthash unless defined $righthash;
340 my %merged = %$lefthash;
341 for my $key ( keys %$righthash ) {
342 my $right_ref = ( ref $righthash->{ $key } || '' ) eq 'HASH';
343 my $left_ref = ( ( exists $lefthash->{ $key } && ref $lefthash->{ $key } ) || '' ) eq 'HASH';
344 if( $right_ref and $left_ref ) {
345 $merged{ $key } = merge_hashes(
346 $lefthash->{ $key }, $righthash->{ $key }
350 $merged{ $key } = $righthash->{ $key };
357 =head2 env_value($class, $key)
359 Checks for and returns an environment value. For instance, if $key is
360 'home', then this method will check for and return the first value it finds,
361 looking at $ENV{MYAPP_HOME} and $ENV{CATALYST_HOME}.
366 my ( $class, $key ) = @_;
369 my @prefixes = ( class2env($class), 'CATALYST' );
371 for my $prefix (@prefixes) {
372 if ( defined( my $value = $ENV{"${prefix}_${key}"} ) ) {
382 Try to guess terminal width to use with formatting of debug output
384 All you need to get this work, is:
386 1) Install Term::Size::Any, or
388 2) Export $COLUMNS from your shell.
390 (Warning to bash users: 'echo $COLUMNS' may be showing you the bash
391 variable, not $ENV{COLUMNS}. 'export COLUMNS=$COLUMNS' and you should see
392 that 'env' now lists COLUMNS.)
394 As last resort, default value of 80 chars will be used.
401 return $_term_width if $_term_width;
405 my ($columns, $rows) = Term::Size::Any::chars;
410 $width = $ENV{COLUMNS}
411 if exists($ENV{COLUMNS})
412 && $ENV{COLUMNS} =~ m/^\d+$/;
415 $width = 80 unless ($width && $width >= 80);
416 return $_term_width = $width;
420 =head2 resolve_namespace
422 Method which adds the namespace for plugins and actions.
424 __PACKAGE__->setup(qw(MyPlugin));
426 # will load Catalyst::Plugin::MyPlugin
431 sub resolve_namespace {
432 my $appnamespace = shift;
433 my $namespace = shift;
435 return String::RewritePrefix->rewrite({
436 q[] => qq[${namespace}::],
438 (defined $appnamespace
439 ? (q[~] => qq[${appnamespace}::])
448 Catalyst Contributors, see Catalyst.pm
452 This library is free software. You can redistribute it and/or modify it under
453 the same terms as Perl itself.