1 package Catalyst::Utils;
11 use String::RewritePrefix;
17 Catalyst::Utils - The Catalyst Utils
29 =head2 appprefix($class)
31 MyApp::Foo becomes myapp_foo
42 =head2 class2appclass($class);
44 MyApp::Controller::Foo::Bar becomes MyApp
45 My::App::Controller::Foo::Bar becomes My::App
50 my $class = shift || '';
52 if ( $class =~ /^(.+?)::([MVC]|Model|View|Controller)::.+$/ ) {
58 =head2 class2classprefix($class);
60 MyApp::Controller::Foo::Bar becomes MyApp::Controller
61 My::App::Controller::Foo::Bar becomes My::App::Controller
65 sub class2classprefix {
66 my $class = shift || '';
68 if ( $class =~ /^(.+?::([MVC]|Model|View|Controller))::.+$/ ) {
74 =head2 class2classsuffix($class);
76 MyApp::Controller::Foo::Bar becomes Controller::Foo::Bar
80 sub class2classsuffix {
81 my $class = shift || '';
82 my $prefix = class2appclass($class) || '';
83 $class =~ s/$prefix\:://;
87 =head2 class2env($class);
89 Returns the environment name for class.
92 My::App becomes MY_APP
97 my $class = shift || '';
102 =head2 class2prefix( $class, $case );
104 Returns the uri prefix for a class. If case is false the prefix is converted to lowercase.
106 My::App::Controller::Foo::Bar becomes foo/bar
111 my $class = shift || '';
112 my $case = shift || 0;
114 if ( $class =~ /^.+?::([MVC]|Model|View|Controller)::(.+)$/ ) {
115 $prefix = $case ? $2 : lc $2;
116 $prefix =~ s{::}{/}g;
121 =head2 class2tempdir( $class [, $create ] );
123 Returns a tempdir for a class. If create is true it will try to create the path.
125 My::App becomes /tmp/my/app
126 My::App::Controller::Foo::Bar becomes /tmp/my/app/c/foo/bar
131 my $class = shift || '';
132 my $create = shift || 0;
133 my @parts = split '::', lc $class;
135 my $tmpdir = dir( File::Spec->tmpdir, @parts )->cleanup;
137 if ( $create && !-e $tmpdir ) {
139 eval { $tmpdir->mkpath };
142 # don't load Catalyst::Exception as a BEGIN in Utils,
143 # because Utils often gets loaded before MyApp.pm, and if
144 # Catalyst::Exception is loaded before MyApp.pm, it does
146 # $Catalyst::Exception::CATALYST_EXCEPTION_CLASS in
148 require Catalyst::Exception;
149 Catalyst::Exception->throw(
150 message => qq/Couldn't create tmpdir '$tmpdir', "$@"/ );
154 return $tmpdir->stringify;
159 Returns home directory for given class.
161 =head2 dist_indicator_file_list
163 Returns a list of files which can be tested to check if you're inside
164 a CPAN distribution which is not yet installed.
180 sub dist_indicator_file_list {
181 qw{Makefile.PL Build.PL dist.ini};
187 # make an $INC{ $key } style string from the class name
188 (my $file = "$class.pm") =~ s{::}{/}g;
190 if ( my $inc_entry = $INC{$file} ) {
192 # look for an uninstalled Catalyst app
194 # find the @INC entry in which $file was found
195 (my $path = $inc_entry) =~ s/$file$//;
196 $path ||= cwd() if !defined $path || !length $path;
197 my $home = dir($path)->absolute->cleanup;
199 # pop off /lib and /blib if they're there
200 $home = $home->parent while $home =~ /b?lib$/;
202 # only return the dir if it has a Makefile.PL or Build.PL or dist.ini
203 if (grep { -f $home->file($_) } dist_indicator_file_list()) {
204 # clean up relative path:
205 # MyApp/script/.. -> MyApp
208 my @dir_list = $home->dir_list();
209 while (($dir = pop(@dir_list)) && $dir eq '..') {
210 $home = dir($home)->parent->parent;
213 return $home->stringify;
218 # look for an installed Catalyst app
220 # trim the .pm off the thing ( Foo/Bar.pm -> Foo/Bar/ )
221 ( my $path = $inc_entry) =~ s/\.pm$//;
222 my $home = dir($path)->absolute->cleanup;
224 # return if if it's a valid directory
225 return $home->stringify if -d $home;
233 =head2 prefix($class, $name);
235 Returns a prefixed action.
237 MyApp::Controller::Foo::Bar, yada becomes foo/bar/yada
242 my ( $class, $name ) = @_;
243 my $prefix = &class2prefix($class);
244 $name = "$prefix/$name" if $prefix;
250 Returns an L<HTTP::Request> object for a uri.
256 unless ( ref $request ) {
257 if ( $request =~ m/^http/i ) {
258 $request = URI->new($request);
261 $request = URI->new( 'http://localhost' . $request );
264 unless ( ref $request eq 'HTTP::Request' ) {
265 $request = HTTP::Request->new( 'GET', $request );
270 =head2 ensure_class_loaded($class_name, \%opts)
272 Loads the class unless it already has been loaded.
274 If $opts{ignore_loaded} is true always tries the require whether the package
275 already exists or not. Only pass this if you're either (a) sure you know the
276 file exists on disk or (b) have code to catch the file not found exception
277 that will result if it doesn't.
281 sub ensure_class_loaded {
285 croak "Malformed class Name $class"
286 if $class =~ m/(?:\b\:\b|\:{3,})/;
288 croak "Malformed class Name $class"
289 if $class =~ m/[^\w:]/;
291 croak "ensure_class_loaded should be given a classname, not a filename ($class)"
292 if $class =~ m/\.pm$/;
294 # $opts->{ignore_loaded} can be set to true, and this causes the class to be required, even
295 # if it already has symbol table entries. This is to support things like Schema::Loader, which
296 # part-generate classes in memory, but then also load some of their contents from disk.
297 return if !$opts->{ ignore_loaded }
298 && Class::MOP::is_class_loaded($class); # if a symbol entry exists we don't load again
300 # this hack is so we don't overwrite $@ if the load did not generate an error
304 my $file = $class . '.pm';
306 eval { CORE::require($file) };
310 die $error if $error;
312 warn "require $class was successful but the package is not defined."
313 unless Class::MOP::is_class_loaded($class);
318 =head2 merge_hashes($hashref, $hashref)
320 Base code to recursively merge two hashes together with right-hand precedence.
325 my ( $lefthash, $righthash ) = @_;
327 return $lefthash unless defined $righthash;
329 my %merged = %$lefthash;
330 for my $key ( keys %$righthash ) {
331 my $right_ref = ( ref $righthash->{ $key } || '' ) eq 'HASH';
332 my $left_ref = ( ( exists $lefthash->{ $key } && ref $lefthash->{ $key } ) || '' ) eq 'HASH';
333 if( $right_ref and $left_ref ) {
334 $merged{ $key } = merge_hashes(
335 $lefthash->{ $key }, $righthash->{ $key }
339 $merged{ $key } = $righthash->{ $key };
346 =head2 env_value($class, $key)
348 Checks for and returns an environment value. For instance, if $key is
349 'home', then this method will check for and return the first value it finds,
350 looking at $ENV{MYAPP_HOME} and $ENV{CATALYST_HOME}.
355 my ( $class, $key ) = @_;
358 my @prefixes = ( class2env($class), 'CATALYST' );
360 for my $prefix (@prefixes) {
361 if ( defined( my $value = $ENV{"${prefix}_${key}"} ) ) {
371 Try to guess terminal width to use with formatting of debug output
373 All you need to get this work, is:
375 1) Install Term::Size::Any, or
377 2) Export $COLUMNS from your shell.
379 (Warning to bash users: 'echo $COLUMNS' may be showing you the bash
380 variable, not $ENV{COLUMNS}. 'export COLUMNS=$COLUMNS' and you should see
381 that 'env' now lists COLUMNS.)
383 As last resort, default value of 80 chars will be used.
390 return $_term_width if $_term_width;
394 my ($columns, $rows) = Term::Size::Any::chars;
399 $width = $ENV{COLUMNS}
400 if exists($ENV{COLUMNS})
401 && $ENV{COLUMNS} =~ m/^\d+$/;
404 $width = 80 unless ($width && $width >= 80);
405 return $_term_width = $width;
409 =head2 resolve_namespace
411 Method which adds the namespace for plugins and actions.
413 __PACKAGE__->setup(qw(MyPlugin));
415 # will load Catalyst::Plugin::MyPlugin
420 sub resolve_namespace {
421 my $appnamespace = shift;
422 my $namespace = shift;
424 return String::RewritePrefix->rewrite({
425 q[] => qq[${namespace}::],
427 (defined $appnamespace
428 ? (q[~] => qq[${appnamespace}::])
437 Catalyst Contributors, see Catalyst.pm
441 This library is free software. You can redistribute it and/or modify it under
442 the same terms as Perl itself.