1 package Catalyst::Helper;
13 use Catalyst::Exception;
14 use Path::Class qw/dir file/;
15 use File::ShareDir qw/dist_dir/;
17 use namespace::autoclean;
19 with 'MooseX::Emulate::Class::Accessor::Fast';
21 # Change Catalyst/Devel.pm also
22 our $VERSION = '1.34';
28 Catalyst::Helper - Bootstrap a Catalyst application
32 catalyst.pl <myappname>
36 sub get_sharedir_file {
37 my ($self, @filename) = @_;
39 if (exists $ENV{CATALYST_DEVEL_SHAREDIR}) {
40 $dist_dir = $ENV{CATALYST_DEVEL_SHAREDIR};
42 elsif (-d "inc/.author" && -f "lib/Catalyst/Helper.pm"
43 ) { # Can't use sharedir if we're in a checkout
44 # this feels horrible, better ideas?
48 $dist_dir = dist_dir('Catalyst-Devel');
50 my $file = file( $dist_dir, @filename);
51 Carp::confess("Cannot find $file") unless -r $file;
52 my $contents = $file->slurp;
56 # Do not touch this method, *EVER*, it is needed for back compat.
58 my ( $self, $class, $file ) = @_;
59 unless ( $cache{$class} ) {
61 $cache{$class} = eval "package $class; <DATA>";
63 my $data = $cache{$class};
64 Carp::confess("Could not get data from __DATA__ segment for $class")
66 my @files = split /^__(.+)__\r?\n/m, $data;
69 my ( $name, $content ) = splice @files, 0, 2;
70 return $content if $name eq $file;
77 my ( $self, $name ) = @_;
79 # Needs to be here for PAR
84 system perl => 'Makefile.PL'
85 and Catalyst::Exception->throw(message => q(
86 Failed to run "perl Makefile.PL".
90 $name = YAML::Tiny->read('META.yml')->[0]->{'name'};
95 if ( $name =~ /[^\w:]/ || $name =~ /^\d/ || $name =~ /\b:\b|:{3,}/) {
96 warn "Error: Invalid application name.\n";
101 if(!defined $self->{'dir'}) {
102 $self->{dir} = $name;
103 $self->{dir} =~ s/\:\:/-/g;
106 $self->{name } = $name;
107 $self->{script } = dir( $self->{dir}, 'script' );
108 $self->{appprefix } = Catalyst::Utils::appprefix($name);
109 $self->{appenv } = Catalyst::Utils::class2env($name);
110 $self->{startperl } = -r '/usr/bin/env'
111 ? '#!/usr/bin/env perl'
112 : "#!$Config{perlpath}";
113 $self->{scriptgen } = $Catalyst::Devel::CATALYST_SCRIPT_GEN;
114 $self->{catalyst_version} = $Catalyst::VERSION;
115 $self->{author } ||= $ENV{'AUTHOR'}
116 || eval { @{ [ getpwuid($<) ] }[6] }
117 || 'Catalyst developer';
119 my $gen_scripts = ( $self->{makefile} ) ? 0 : 1;
120 my $gen_makefile = ( $self->{scripts} ) ? 0 : 1;
121 my $gen_app = ( $self->{scripts} || $self->{makefile} ) ? 0 : 1;
124 for ( qw/ _mk_dirs _mk_config _mk_psgi _mk_appclass _mk_rootclass
125 _mk_readme _mk_changes _mk_apptest _mk_podtest _mk_podcoveragetest
126 _mk_images _mk_favicon/ ) {
134 for ( qw/ _mk_cgi _mk_fastcgi _mk_server
135 _mk_test _mk_create _mk_information
143 ## not much of this can really be changed, mk_compclass must be left for
149 $self->{author} = $self->{author} = $ENV{'AUTHOR'}
150 || eval { @{ [ getpwuid($<) ] }[6] }
152 $self->{base} ||= dir( $FindBin::Bin, '..' );
153 unless ( $_[0] =~ /^(?:model|view|controller)$/i ) {
156 my $class = "Catalyst::Helper::$helper";
157 eval "require $class";
160 Catalyst::Exception->throw(
161 message => qq/Couldn't load helper "$class", "$@"/ );
164 if ( $class->can('mk_stuff') ) {
165 return 1 unless $class->mk_stuff( $self, @args );
170 my $name = shift || "Missing name for model/view/controller";
173 return 0 if $name =~ /[^\w\:]/;
175 $self->{long_type} = ucfirst $type;
176 $type = 'M' if $type =~ /model/i;
177 $type = 'V' if $type =~ /view/i;
178 $type = 'C' if $type =~ /controller/i;
179 my $appdir = dir( split /\:\:/, $app );
181 dir( $self->{base}, 'lib', $appdir, 'C' );
182 $type = $self->{long_type} unless -d $test_path;
183 $self->{type} = $type;
184 $self->{name} = $name;
185 $self->{class} = "$app\::$type\::$name";
189 dir( $self->{base}, 'lib', $appdir, $type );
191 if ( $name =~ /\:/ ) {
192 my @path = split /\:\:/, $name;
194 $path = dir( $path, @path );
196 $self->mk_dir($path);
197 $file = file( $path, "$file.pm" );
198 $self->{file} = $file;
201 $self->{test_dir} = dir( $self->{base}, 't' );
202 $self->{test} = $self->next_test;
206 my $comp = $self->{long_type};
207 my $class = "Catalyst::Helper::$comp\::$helper";
208 eval "require $class";
211 Catalyst::Exception->throw(
212 message => qq/Couldn't load helper "$class", "$@"/ );
215 if ( $class->can('mk_compclass') ) {
216 return 1 unless $class->mk_compclass( $self, @args );
219 return 1 unless $self->_mk_compclass
222 if ( $class->can('mk_comptest') ) {
223 $class->mk_comptest( $self, @args );
232 return 1 unless $self->_mk_compclass;
240 my ( $self, $dir ) = @_;
242 print qq/ exists "$dir"\n/;
245 if ( mkpath [$dir] ) {
246 print qq/created "$dir"\n/;
250 Catalyst::Exception->throw( message => qq/Couldn't create "$dir", "$!"/ );
254 my ( $self, $file, $content ) = @_;
255 if ( -e $file && -s _ ) {
256 print qq/ exists "$file"\n/;
258 unless ( $self->{'.newfiles'}
260 || $self->{makefile} );
261 if ( $self->{'.newfiles'} ) {
262 if ( my $f = IO::File->new("< $file") ) {
263 my $oldcontent = join( '', (<$f>) );
264 return 0 if $content eq $oldcontent;
270 if ( my $f = IO::File->new("> $file") ) {
273 print qq/created "$file"\n/;
277 Catalyst::Exception->throw( message => qq/Couldn't create "$file", "$!"/ );
281 my ( $self, $tname ) = @_;
282 if ($tname) { $tname = "$tname.t" }
284 my $name = $self->{name};
288 $tname = $prefix . '.t';
289 $self->{prefix} = $prefix;
290 $prefix = lc $prefix;
292 $self->{uri} = "/$prefix";
294 my $dir = $self->{test_dir};
295 my $type = lc $self->{type};
297 return file( $dir, "$type\_$tname" );
300 # Do not touch this method, *EVER*, it is needed for back compat.
301 ## addendum: we had to split this method so we could have backwards
302 ## compatability. otherwise, we'd have no way to pass stuff from __DATA__
305 my ( $self, $file, $path, $vars, $perms ) = @_;
306 my $template = $self->get_file( ( caller(0) )[0], $file );
307 $self->render_file_contents($template, $path, $vars, $perms);
310 sub render_sharedir_file {
311 my ( $self, $file, $path, $vars, $perms ) = @_;
312 my $template = $self->get_sharedir_file( $file );
313 die("Cannot get template from $file for $self\n") unless $template;
314 $self->render_file_contents($template, $path, $vars, $perms);
317 sub render_file_contents {
318 my ( $self, $template, $path, $vars, $perms ) = @_;
320 my $t = Template->new;
321 return 0 unless $template;
323 $t->process( \$template, { %{$self}, %$vars }, \$output )
324 || Catalyst::Exception->throw(
325 message => qq/Couldn't process "$template", / . $t->error() );
326 my $file = $self->mk_file( $path, $output );
327 chmod $perms, file($file) if defined $perms;
331 sub _mk_information {
333 print qq/Change to application directory and Run "perl Makefile.PL" to make sure your install is complete\n/;
338 $self->mk_dir( $self->{dir} );
339 $self->mk_dir( $self->{script} );
340 $self->{lib} = dir( $self->{dir}, 'lib' );
341 $self->mk_dir( $self->{lib} );
342 $self->{root} = dir( $self->{dir}, 'root' );
343 $self->mk_dir( $self->{root} );
344 $self->{static} = dir( $self->{root}, 'static' );
345 $self->mk_dir( $self->{static} );
346 $self->{images} = dir( $self->{static}, 'images' );
347 $self->mk_dir( $self->{images} );
348 $self->{t} = dir( $self->{dir}, 't' );
349 $self->mk_dir( $self->{t} );
351 $self->{class} = dir( split( /\:\:/, $self->{name} ) );
352 $self->{mod} = dir( $self->{lib}, $self->{class} );
353 $self->mk_dir( $self->{mod} );
355 if ( $self->{short} ) {
356 $self->{m} = dir( $self->{mod}, 'M' );
357 $self->mk_dir( $self->{m} );
358 $self->{v} = dir( $self->{mod}, 'V' );
359 $self->mk_dir( $self->{v} );
360 $self->{c} = dir( $self->{mod}, 'C' );
361 $self->mk_dir( $self->{c} );
364 $self->{m} = dir( $self->{mod}, 'Model' );
365 $self->mk_dir( $self->{m} );
366 $self->{v} = dir( $self->{mod}, 'View' );
367 $self->mk_dir( $self->{v} );
368 $self->{c} = dir( $self->{mod}, 'Controller' );
369 $self->mk_dir( $self->{c} );
371 my $name = $self->{name};
373 $self->{short} ? "$name\::C::Root" : "$name\::Controller::Root";
374 $self->{base} = dir( $self->{dir} )->absolute;
379 my $mod = $self->{mod};
380 $self->render_sharedir_file( file('lib', 'MyApp.pm.tt'), "$mod.pm" );
385 $self->render_sharedir_file( file('lib', 'MyApp', 'Controller', 'Root.pm.tt'),
386 file( $self->{c}, "Root.pm" ) );
391 $self->{path} = dir( 'lib', split( '::', $self->{name} ) );
392 $self->{path} .= '.pm';
393 my $dir = $self->{dir};
394 $self->render_sharedir_file( 'Makefile.PL.tt', file($dir, "Makefile.PL") );
396 if ( $self->{makefile} ) {
398 # deprecate the old Build.PL file when regenerating Makefile.PL
399 $self->_deprecate_file(
400 file( $self->{dir}, 'Build.PL' ) );
406 my $dir = $self->{dir};
407 my $appprefix = $self->{appprefix};
408 $self->render_sharedir_file( 'myapp.psgi.tt',
409 file( $dir, "$appprefix.psgi" ) );
414 my $dir = $self->{dir};
415 my $appprefix = $self->{appprefix};
416 $self->render_sharedir_file( 'myapp.conf.tt',
417 file( $dir, "$appprefix.conf" ) );
422 my $dir = $self->{dir};
423 $self->render_sharedir_file( 'README.tt', file($dir, "README") );
428 my $dir = $self->{dir};
429 my $time = strftime('%Y-%m-%d %H:%M:%S', localtime time);
430 $self->render_sharedir_file( 'Changes.tt', file($dir, "Changes"), { time => $time } );
436 $self->render_sharedir_file( file('t', '01app.t.tt'), file($t, "01app.t") );
442 $self->render_sharedir_file( file('t', '02pod.t.tt'), file($t, "02pod.t") );
445 sub _mk_podcoveragetest {
448 $self->render_sharedir_file( file('t', '03podcoverage.t.tt'), file($t, "03podcoverage.t") );
453 my $script = $self->{script};
454 my $appprefix = $self->{appprefix};
455 $self->render_sharedir_file( file('script', 'myapp_cgi.pl.tt'),
456 file($script,"$appprefix\_cgi.pl"), undef, 0755 );
461 my $script = $self->{script};
462 my $appprefix = $self->{appprefix};
463 $self->render_sharedir_file( file('script', 'myapp_fastcgi.pl.tt'),
464 file($script, "$appprefix\_fastcgi.pl"), undef, 0755 );
469 my $script = $self->{script};
470 my $appprefix = $self->{appprefix};
471 $self->render_sharedir_file( file('script', 'myapp_server.pl.tt'),
472 file($script, "$appprefix\_server.pl"), undef, 0755 );
477 my $script = $self->{script};
478 my $appprefix = $self->{appprefix};
479 $self->render_sharedir_file( file('script', 'myapp_test.pl.tt'),
480 file($script, "$appprefix\_test.pl"), undef, 0755 );
485 my $script = $self->{script};
486 my $appprefix = $self->{appprefix};
487 $self->render_sharedir_file( file('script', 'myapp_create.pl.tt'),
488 file($script, "$appprefix\_create.pl"), undef, 0755 );
493 my $file = $self->{file};
494 return $self->render_sharedir_file( file('lib', 'Helper', 'compclass.pm.tt'), $file );
499 my $test = $self->{test};
500 $self->render_sharedir_file( file('t', 'comptest.tt'), $test ); ## wtf do i rename this to?
505 my $images = $self->{images};
507 qw/catalyst_logo btn_120x50_built btn_120x50_built_shadow
508 btn_120x50_powered btn_120x50_powered_shadow btn_88x31_built
509 btn_88x31_built_shadow btn_88x31_powered btn_88x31_powered_shadow/;
510 for my $name (@images) {
511 my $image = $self->get_sharedir_file("root", "static", "images", "$name.png.bin");
512 $self->mk_file( file( $images, "$name.png" ), $image );
518 my $root = $self->{root};
519 my $favicon = $self->get_sharedir_file( 'root', 'favicon.ico.bin' );
520 my $dest = dir( $root, "favicon.ico" );
521 $self->mk_file( $dest, $favicon );
525 sub _deprecate_file {
526 my ( $self, $file ) = @_;
528 my ($f, $oldcontent);
529 if ( $f = IO::File->new("< $file") ) {
530 $oldcontent = join( '', (<$f>) );
532 my $newfile = $file . '.deprecated';
533 if ( $f = IO::File->new("> $newfile") ) {
535 print $f $oldcontent;
536 print qq/created "$newfile"\n/;
538 print qq/removed "$file"\n/;
541 Catalyst::Exception->throw(
542 message => qq/Couldn't create "$file", "$!"/ );
548 This module is used by B<catalyst.pl> to create a set of scripts for a
549 new catalyst application. The scripts each contain documentation and
550 will output help on how to use them if called incorrectly or in some
551 cases, with no arguments.
553 It also provides some useful methods for a Helper module to call when
554 creating a component. See L</METHODS>.
560 Used to create new components for a catalyst application at the
565 The catalyst test server, starts an HTTPD which outputs debugging to
570 A script for running tests from the command-line.
574 Run your application as a CGI.
578 Run the application as a fastcgi app. Either by hand, or call this
579 from FastCgiServer in your http server config.
583 The L</_create.pl> script creates application components using Helper
584 modules. The Catalyst team provides a good number of Helper modules
585 for you to use. You can also add your own.
587 Helpers are classes that provide two methods.
589 * mk_compclass - creates the Component class
590 * mk_comptest - creates the Component test
592 So when you call C<scripts/myapp_create.pl view MyView TT>, create
593 will try to execute Catalyst::Helper::View::TT->mk_compclass and
594 Catalyst::Helper::View::TT->mk_comptest.
596 See L<Catalyst::Helper::View::TT> and
597 L<Catalyst::Helper::Model::DBIC::Schema> for examples.
599 All helper classes should be under one of the following namespaces.
601 Catalyst::Helper::Model::
602 Catalyst::Helper::View::
603 Catalyst::Helper::Controller::
605 =head2 COMMON HELPERS
611 L<Catalyst::Helper::Model::DBIC::Schema> - DBIx::Class models
615 L<Catalyst::Helper::View::TT> - Template Toolkit view
619 L<Catalyst::Helper::Model::LDAP>
623 L<Catalyst::Helper::Model::Adaptor> - wrap any class into a Catalyst model
629 The helpers will read author name from /etc/passwd by default.
630 To override, please export the AUTHOR variable.
636 This method in your Helper module is called with C<$helper>
637 which is a L<Catalyst::Helper> object, and whichever other arguments
638 the user added to the command-line. You can use the $helper to call methods
641 If the Helper module does not contain a C<mk_compclass> method, it
642 will fall back to calling L</render_file>, with an argument of
647 This method in your Helper module is called with C<$helper>
648 which is a L<Catalyst::Helper> object, and whichever other arguments
649 the user added to the command-line. You can use the $helper to call methods
652 If the Helper module does not contain a C<mk_compclass> method, it
653 will fall back to calling L</render_file>, with an argument of
658 This method is called if the user does not supply any of the usual
659 component types C<view>, C<controller>, C<model>. It is passed the
660 C<$helper> object (an instance of L<Catalyst::Helper>), and any other
661 arguments the user typed.
663 There is no fallback for this method.
665 =head1 INTERNAL METHODS
667 These are the methods that the Helper classes can call on the
668 <$helper> object passed to them.
670 =head2 render_file ($file, $path, $vars, $perms)
672 Render and create a file from a template in DATA using Template
673 Toolkit. $file is the relevent chunk of the __DATA__ section, $path is
674 the path to the file, $vars is the hashref as expected by
675 L<Template Toolkit|Template> and $perms are desired permissions (or system
676 defaults if not set).
678 =head2 get_file ($class, $file)
680 Fetch file contents from the DATA section. This is used internally by
681 L</render_file>. $class is the name of the class to get the DATA
682 section from. __PACKAGE__ or ( caller(0) )[0] might be sensible
687 Create the main application skeleton. This is called by L<catalyst.pl>.
689 =head2 mk_component ($app)
691 This method is called by L<create.pl> to make new components
692 for your application.
694 =head2 mk_dir ($path)
696 Surprisingly, this function makes a directory.
698 =head2 mk_file ($file, $content)
700 Writes content to a file. Called by L</render_file>.
702 =head2 next_test ($test_name)
704 Calculates the name of the next numbered test file and returns it.
705 Don't give the number or the .t suffix for the test name.
709 =head2 get_sharedir_file
711 Method for getting a file out of share/
715 =head2 render_file_contents
717 Process a L<Template::Toolkit> template.
721 =head2 render_sharedir_file
723 Render a template/image file from our share directory
729 The helpers will read author name from /etc/passwd by default.
730 To override, please export the AUTHOR variable.
734 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
735 L<Catalyst::Response>, L<Catalyst>
739 Catalyst Contributors, see Catalyst.pm
743 This library is free software. You can redistribute it and/or modify
744 it under the same terms as Perl itself.