1 package Catalyst::Utils;
4 use Catalyst::Exception;
13 Catalyst::Utils - The Catalyst Utils
23 =head2 appprefix($class)
25 MyApp::Foo becomes myapp_foo
36 =head2 class2appclass($class);
38 MyApp::C::Foo::Bar becomes MyApp
39 My::App::C::Foo::Bar becomes My::App
44 my $class = shift || '';
46 if ( $class =~ /^(.*)::([MVC]|Model|View|Controller)?::.*$/ ) {
52 =head2 class2classprefix($class);
54 MyApp::C::Foo::Bar becomes MyApp::C
55 My::App::C::Foo::Bar becomes My::App::C
59 sub class2classprefix {
60 my $class = shift || '';
62 if ( $class =~ /^(.*::[MVC]|Model|View|Controller)?::.*$/ ) {
68 =head2 class2classsuffix($class);
70 MyApp::C::Foo::Bar becomes C::Foo::Bar
74 sub class2classsuffix {
75 my $class = shift || '';
76 my $prefix = class2appclass($class) || '';
77 $class =~ s/$prefix\:\://;
81 =head2 class2env($class);
83 Returns the environment name for class.
86 My::App becomes MY_APP
91 my $class = shift || '';
96 =head2 class2prefix( $class, $case );
98 Returns the uri prefix for a class. If case is false the prefix is converted to lowercase.
100 My::App::C::Foo::Bar becomes foo/bar
105 my $class = shift || '';
106 my $case = shift || 0;
108 if ( $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/ ) {
109 $prefix = $case ? $2 : lc $2;
110 $prefix =~ s/\:\:/\//g;
115 =head2 class2tempdir( $class [, $create ] );
117 Returns a tempdir for a class. If create is true it will try to create the path.
119 My::App becomes /tmp/my/app
120 My::App::C::Foo::Bar becomes /tmp/my/app/c/foo/bar
125 my $class = shift || '';
126 my $create = shift || 0;
127 my @parts = split '::', lc $class;
129 my $tmpdir = dir( File::Spec->tmpdir, @parts )->cleanup;
131 if ( $create && !-e $tmpdir ) {
133 eval { $tmpdir->mkpath };
136 Catalyst::Exception->throw(
137 message => qq/Couldn't create tmpdir '$tmpdir', "$@"/ );
141 return $tmpdir->stringify;
146 Returns home directory for given class.
152 $name =~ s/\:\:/\//g;
154 if ( my $path = $INC{"$name.pm"} ) {
155 $home = file($path)->absolute->dir;
158 my $subdir = dir($home)->subdir($append);
159 for ( split '/', $name ) { $home = dir($home)->parent }
160 if ( $home =~ /blib$/ ) { $home = dir($home)->parent }
161 elsif (!-f file( $home, 'Makefile.PL' )
162 && !-f file( $home, 'Build.PL' ) )
167 # clean up relative path:
168 # MyApp/script/.. -> MyApp
169 my ($lastdir) = $home->dir_list( -1, 1 );
170 if ( $lastdir eq '..' ) {
171 $home = dir($home)->parent->parent;
177 =head2 prefix($class, $name);
179 Returns a prefixed action.
181 MyApp::C::Foo::Bar, yada becomes foo/bar/yada
186 my ( $class, $name ) = @_;
187 my $prefix = &class2prefix($class);
188 $name = "$prefix/$name" if $prefix;
194 Returns an L<HTTP::Request> object for a uri.
200 unless ( ref $request ) {
201 if ( $request =~ m/^http/i ) {
202 $request = URI->new($request)->canonical;
205 $request = URI->new( 'http://localhost' . $request )->canonical;
208 unless ( ref $request eq 'HTTP::Request' ) {
209 $request = HTTP::Request->new( 'GET', $request );
214 =head2 ensure_class_loaded($class_name)
216 Loads the class unless it already has been loaded.
220 sub ensure_class_loaded {
223 return if Class::Inspector->loaded( $class ); # if a symbol entry exists we don't load again
225 # this hack is so we don't overwrite $@ if the load did not generate an error
229 eval "require $class";
233 die $error if $error;
234 die "require $class was successful but the package is not defined"
235 unless Class::Inspector->loaded($class);
243 Sebastian Riedel, C<sri@cpan.org>
244 Yuval Kogman, C<nothingmuch@woobling.org>
248 This program is free software, you can redistribute it and/or modify it under
249 the same terms as Perl itself.