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.
177 # make an $INC{ $key } style string from the class name
178 (my $file = "$class.pm") =~ s{::}{/}g;
180 if ( my $inc_entry = $INC{$file} ) {
182 # look for an uninstalled Catalyst app
184 # find the @INC entry in which $file was found
185 (my $path = $inc_entry) =~ s/$file$//;
186 $path ||= cwd() if !defined $path || !length $path;
187 my $home = dir($path)->absolute->cleanup;
189 # pop off /lib and /blib if they're there
190 $home = $home->parent while $home =~ /b?lib$/;
192 # only return the dir if it has a Makefile.PL or Build.PL or dist.ini
193 if (any { $_ } map { -f $home->file($_) } dist_indicator_file_list()) {
195 # clean up relative path:
196 # MyApp/script/.. -> MyApp
199 my @dir_list = $home->dir_list();
200 while (($dir = pop(@dir_list)) && $dir eq '..') {
201 $home = dir($home)->parent->parent;
204 return $home->stringify;
209 # look for an installed Catalyst app
211 # trim the .pm off the thing ( Foo/Bar.pm -> Foo/Bar/ )
212 ( my $path = $inc_entry) =~ s/\.pm$//;
213 my $home = dir($path)->absolute->cleanup;
215 # return if if it's a valid directory
216 return $home->stringify if -d $home;
224 =head2 prefix($class, $name);
226 Returns a prefixed action.
228 MyApp::Controller::Foo::Bar, yada becomes foo/bar/yada
233 my ( $class, $name ) = @_;
234 my $prefix = &class2prefix($class);
235 $name = "$prefix/$name" if $prefix;
241 Returns an L<HTTP::Request> object for a uri.
247 unless ( ref $request ) {
248 if ( $request =~ m/^http/i ) {
249 $request = URI->new($request);
252 $request = URI->new( 'http://localhost' . $request );
255 unless ( ref $request eq 'HTTP::Request' ) {
256 $request = HTTP::Request->new( 'GET', $request );
261 =head2 ensure_class_loaded($class_name, \%opts)
263 Loads the class unless it already has been loaded.
265 If $opts{ignore_loaded} is true always tries the require whether the package
266 already exists or not. Only pass this if you're either (a) sure you know the
267 file exists on disk or (b) have code to catch the file not found exception
268 that will result if it doesn't.
272 sub ensure_class_loaded {
276 croak "Malformed class Name $class"
277 if $class =~ m/(?:\b\:\b|\:{3,})/;
279 croak "Malformed class Name $class"
280 if $class =~ m/[^\w:]/;
282 croak "ensure_class_loaded should be given a classname, not a filename ($class)"
283 if $class =~ m/\.pm$/;
285 # $opts->{ignore_loaded} can be set to true, and this causes the class to be required, even
286 # if it already has symbol table entries. This is to support things like Schema::Loader, which
287 # part-generate classes in memory, but then also load some of their contents from disk.
288 return if !$opts->{ ignore_loaded }
289 && Class::MOP::is_class_loaded($class); # if a symbol entry exists we don't load again
291 # this hack is so we don't overwrite $@ if the load did not generate an error
295 my $file = $class . '.pm';
297 eval { CORE::require($file) };
301 die $error if $error;
303 warn "require $class was successful but the package is not defined."
304 unless Class::MOP::is_class_loaded($class);
309 =head2 merge_hashes($hashref, $hashref)
311 Base code to recursively merge two hashes together with right-hand precedence.
316 my ( $lefthash, $righthash ) = @_;
318 return $lefthash unless defined $righthash;
320 my %merged = %$lefthash;
321 for my $key ( keys %$righthash ) {
322 my $right_ref = ( ref $righthash->{ $key } || '' ) eq 'HASH';
323 my $left_ref = ( ( exists $lefthash->{ $key } && ref $lefthash->{ $key } ) || '' ) eq 'HASH';
324 if( $right_ref and $left_ref ) {
325 $merged{ $key } = merge_hashes(
326 $lefthash->{ $key }, $righthash->{ $key }
330 $merged{ $key } = $righthash->{ $key };
337 =head2 env_value($class, $key)
339 Checks for and returns an environment value. For instance, if $key is
340 'home', then this method will check for and return the first value it finds,
341 looking at $ENV{MYAPP_HOME} and $ENV{CATALYST_HOME}.
346 my ( $class, $key ) = @_;
349 my @prefixes = ( class2env($class), 'CATALYST' );
351 for my $prefix (@prefixes) {
352 if ( defined( my $value = $ENV{"${prefix}_${key}"} ) ) {
362 Try to guess terminal width to use with formatting of debug output
364 All you need to get this work, is:
366 1) Install Term::Size::Any, or
368 2) Export $COLUMNS from your shell.
370 (Warning to bash users: 'echo $COLUMNS' may be showing you the bash
371 variable, not $ENV{COLUMNS}. 'export COLUMNS=$COLUMNS' and you should see
372 that 'env' now lists COLUMNS.)
374 As last resort, default value of 80 chars will be used.
381 return $_term_width if $_term_width;
385 my ($columns, $rows) = Term::Size::Any::chars;
390 $width = $ENV{COLUMNS}
391 if exists($ENV{COLUMNS})
392 && $ENV{COLUMNS} =~ m/^\d+$/;
395 $width = 80 unless ($width && $width >= 80);
396 return $_term_width = $width;
400 =head2 resolve_namespace
402 Method which adds the namespace for plugins and actions.
404 __PACKAGE__->setup(qw(MyPlugin));
406 # will load Catalyst::Plugin::MyPlugin
411 sub resolve_namespace {
412 my $appnamespace = shift;
413 my $namespace = shift;
415 return String::RewritePrefix->rewrite({
416 q[] => qq[${namespace}::],
418 (defined $appnamespace
419 ? (q[~] => qq[${appnamespace}::])
428 Catalyst Contributors, see Catalyst.pm
432 This library is free software. You can redistribute it and/or modify it under
433 the same terms as Perl itself.