1 package Catalyst::Helper;
4 use base 'Class::Accessor::Fast';
13 Catalyst::Helper - Bootstrap a Catalyst application
17 See L<Catalyst::Manual::Intro>
21 Bootstrap a Catalyst application.
30 my ( $self, $name ) = @_;
31 return 0 if $name =~ /[^\w\:]/;
32 $self->{name} = $name;
34 $self->{dir} =~ s/\:\:/-/g;
57 $self->{base} = File::Spec->catdir( $FindBin::Bin, '..' );
58 unless ( $_[0] =~ /^model|m|view|v|controller|c\$/i ) {
61 my $class = "Catalyst::Helper::$helper";
62 eval "require $class";
63 die qq/Couldn't load helper "$class", "$@"/ if $@;
64 if ( $class->can('mk_stuff') ) {
65 return 1 unless $class->mk_stuff( $self, @args );
73 return 0 if $name =~ /[^\w\:]/;
74 $type = 'M' if $type =~ /model|m/i;
75 $type = 'V' if $type =~ /view|v/i;
76 $type = 'C' if $type =~ /controller|c/i;
77 $self->{type} = $type;
78 $self->{name} = $name;
79 $self->{class} = "$app\::$type\::$name";
82 my $appdir = File::Spec->catdir( split /\:\:/, $app );
84 File::Spec->catdir( $FindBin::Bin, '..', 'lib', $appdir, $type );
86 if ( $name =~ /\:/ ) {
87 my @path = split /\:\:/, $name;
89 $path = File::Spec->catdir( $path, @path );
92 $file = File::Spec->catfile( $path, "$file.pm" );
93 $self->{file} = $file;
96 $self->{test_dir} = File::Spec->catdir( $FindBin::Bin, '..', 't' );
97 $self->{test} = $self->next_test;
102 $comp = 'View' if $type eq 'V';
103 $comp = 'Controller' if $type eq 'C';
104 my $class = "Catalyst::Helper::$comp\::$helper";
105 eval "require $class";
106 die qq/Couldn't load helper "$class", "$@"/ if $@;
107 if ( $class->can('mk_compclass') ) {
108 return 1 unless $class->mk_compclass( $self, @args );
110 else { return 1 unless $self->_mk_compclass }
112 if ( $class->can('mk_comptest') ) {
113 $class->mk_comptest( $self, @args );
115 else { $self->_mk_comptest }
120 return 1 unless $self->_mk_compclass;
132 my ( $self, $dir ) = @_;
134 print qq/ exists "$dir"\n/;
138 print qq/created "$dir"\n/;
141 die qq/Couldn't create "$dir", "$!"/;
149 my ( $self, $file, $content ) = @_;
151 print qq/ exists "$file"\n/;
154 if ( my $f = IO::File->new("> $file") ) {
156 print qq/created "$file"\n/;
159 die qq/Couldn't create "$file", "$!"/;
167 my ( $self, $tname ) = @_;
168 if ($tname) { $tname = "$tname.t" }
170 my $name = $self->{name};
173 $prefix = lc $prefix;
174 $tname = $prefix . '.t';
175 $self->{prefix} = $prefix;
177 my $dir = $self->{test_dir};
178 my $type = lc $self->{type};
179 return File::Spec->catfile( $dir, $type, $tname );
184 $self->mk_dir( $self->{dir} );
185 $self->{script} = File::Spec->catdir( $self->{dir}, 'script' );
186 $self->mk_dir( $self->{script} );
187 $self->{lib} = File::Spec->catdir( $self->{dir}, 'lib' );
188 $self->mk_dir( $self->{lib} );
189 $self->{root} = File::Spec->catdir( $self->{dir}, 'root' );
190 $self->mk_dir( $self->{root} );
191 $self->{t} = File::Spec->catdir( $self->{dir}, 't' );
192 $self->mk_dir( $self->{t} );
193 $self->mk_dir( File::Spec->catdir( $self->{t}, 'm' ) );
194 $self->mk_dir( File::Spec->catdir( $self->{t}, 'v' ) );
195 $self->mk_dir( File::Spec->catdir( $self->{t}, 'c' ) );
196 $self->{class} = File::Spec->catdir( split( /\:\:/, $self->{name} ) );
197 $self->{mod} = File::Spec->catdir( $self->{lib}, $self->{class} );
198 $self->mk_dir( $self->{mod} );
199 $self->{m} = File::Spec->catdir( $self->{mod}, 'M' );
200 $self->mk_dir( $self->{m} );
201 $self->{v} = File::Spec->catdir( $self->{mod}, 'V' );
202 $self->mk_dir( $self->{v} );
203 $self->{c} = File::Spec->catdir( $self->{mod}, 'C' );
204 $self->mk_dir( $self->{c} );
205 $self->{base} = File::Spec->rel2abs( $self->{dir} );
210 my $mod = $self->{mod};
211 my $name = $self->{name};
212 my $base = $self->{base};
213 $self->mk_file( "$mod.pm", <<"EOF");
217 use Catalyst qw/-Debug/;
219 our \$VERSION = '0.01';
223 root => '$base/root',
226 sub default : Private {
227 my ( \$self, \$c ) = \@_;
228 \$c->res->output('Congratulations, $name is on Catalyst!');
233 $name - A very nice application
241 Very nice application.
249 This library is free software . You can redistribute it and/or modify it under
250 the same terms as perl itself.
260 my $name = $self->{name};
261 my $dir = $self->{dir};
262 my $class = $self->{class};
263 $self->mk_file( "$dir\/Makefile.PL", <<"EOF");
264 use ExtUtils::MakeMaker;
268 VERSION_FROM => 'lib/$class.pm',
269 PREREQ_PM => { Catalyst => 0 },
270 test => { TESTS => join ' ', ( glob('t/*.t'), glob('t/*/*.t') ) }
277 my $dir = $self->{dir};
278 $self->mk_file( "$dir\/README", <<"EOF");
279 Run script/server.pl to test the application.
285 my $name = $self->{name};
286 my $dir = $self->{dir};
287 my $time = localtime time;
288 $self->mk_file( "$dir\/Changes", <<"EOF");
289 This file documents the revision history for Perl extension $name.
292 - initial revision, generated by Catalyst
299 my $name = $self->{name};
300 $self->mk_file( "$t\/01app.t", <<"EOF");
301 use Test::More tests => 2;
302 use_ok( Catalyst::Test, '$name' );
304 ok( request('/')->is_success );
306 $self->mk_file( "$t\/02pod.t", <<"EOF");
309 eval "use Test::Pod 1.14";
310 plan skip_all => 'Test::Pod 1.14 required' if \$@;
311 plan skip_all => 'set TEST_POD to enable this test' unless \$ENV{TEST_POD};
315 $self->mk_file( "$t\/03podcoverage.t", <<"EOF");
318 eval "use Test::Pod::Coverage 1.04";
319 plan skip_all => 'Test::Pod::Coverage 1.04 required' if \$@;
320 plan skip_all => 'set TEST_POD to enable this test' unless \$ENV{TEST_POD};
322 all_pod_coverage_ok();
328 my $name = $self->{name};
329 my $script = $self->{script};
330 $self->mk_file( "$script\/cgi.pl", <<"EOF");
331 $Config{startperl} -w
333 BEGIN { \$ENV{CATALYST_ENGINE} = 'CGI' }
337 use lib "\$FindBin::Bin/../lib";
351 See L<Catalyst::Manual>
355 Run a Catalyst application as cgi.
359 Sebastian Riedel, C<sri\@oook.de>
363 Copyright 2004 Sebastian Riedel. All rights reserved.
365 This library is free software. You can redistribute it and/or modify it under
366 the same terms as perl itself.
370 chmod 0700, "$script/cgi.pl";
375 my $name = $self->{name};
376 my $script = $self->{script};
377 $self->mk_file( "$script\/fcgi.pl", <<"EOF");
378 $Config{startperl} -w
380 BEGIN { \$ENV{CATALYST_ENGINE} = 'FCGI' }
384 use lib "\$FindBin::Bin/../lib";
398 See L<Catalyst::Manual>
402 Run a Catalyst application as fcgi.
406 Sebastian Riedel, C<sri\@oook.de>
410 Copyright 2004 Sebastian Riedel. All rights reserved.
412 This library is free software. You can redistribute it and/or modify it under
413 the same terms as perl itself.
417 chmod 0700, "$script/fcgi.pl";
422 my $name = $self->{name};
423 my $script = $self->{script};
424 $self->mk_file( "$script\/server.pl", <<"EOF");
425 $Config{startperl} -w
427 BEGIN { \$ENV{CATALYST_ENGINE} = 'HTTP' }
433 use lib "\$FindBin::Bin/../lib";
439 GetOptions( 'help|?' => \\\$help, 'port=s' => \\\$port );
441 pod2usage(1) if \$help;
450 server - Catalyst Testserver
457 -? -help display this help and exits
458 -p -port port (defaults to 3000)
461 perldoc Catalyst::Manual
462 perldoc Catalyst::Manual::Intro
466 Run a Catalyst Testserver for this application.
470 Sebastian Riedel, C<sri\@oook.de>
474 Copyright 2004 Sebastian Riedel. All rights reserved.
476 This library is free software. You can redistribute it and/or modify it under
477 the same terms as perl itself.
481 chmod 0700, "$script/server.pl";
486 my $name = $self->{name};
487 my $script = $self->{script};
488 $self->mk_file( "$script/test.pl", <<"EOF");
489 $Config{startperl} -w
491 BEGIN { \$ENV{CATALYST_ENGINE} = 'Test' }
497 use lib "\$FindBin::Bin/../lib";
502 GetOptions( 'help|?' => \\\$help );
504 pod2usage(1) if ( \$help || !\$ARGV[0] );
506 print $name->run(\$ARGV[0])->content . "\n";
517 test.pl [options] uri
520 -help display this help and exits
523 test.pl http://localhost/some_action
527 perldoc Catalyst::Manual
528 perldoc Catalyst::Manual::Intro
532 Run a Catalyst action from the comand line.
536 Sebastian Riedel, C<sri\@oook.de>
540 Copyright 2004 Sebastian Riedel. All rights reserved.
542 This library is free software. You can redistribute it and/or modify it under
543 the same terms as perl itself.
547 chmod 0700, "$script/test.pl";
552 my $name = $self->{name};
553 my $script = $self->{script};
554 $self->mk_file( "$script\/create.pl", <<"EOF");
555 $Config{startperl} -w
560 use Catalyst::Helper;
564 GetOptions( 'help|?' => \$help );
566 pod2usage(1) if ( \$help || !\$ARGV[0] );
568 my \$helper = Catalyst::Helper->new;
569 pod2usage(1) unless \$helper->mk_component( '$name', \@ARGV );
576 create - Create a new Catalyst Component
580 create.pl [options] model|view|controller name [helper] [options]
583 -help display this help and exits
586 create.pl controller My::Controller
587 create.pl view My::View
588 create.pl view MyView TT
590 create.pl model My::Model
591 create.pl model SomeDB CDBI dbi:SQLite:/tmp/my.db
592 create.pl model AnotherDB CDBI dbi:Pg:dbname=foo root 4321
596 perldoc Catalyst::Manual
597 perldoc Catalyst::Manual::Intro
601 Create a new Catalyst Component.
605 Sebastian Riedel, C<sri\@oook.de>
609 Copyright 2004 Sebastian Riedel. All rights reserved.
611 This library is free software. You can redistribute it and/or modify it under
612 the same terms as perl itself.
616 chmod 0700, "$script/create.pl";
621 my $app = $self->{app};
622 my $class = $self->{class};
623 my $type = $self->{type};
625 $action = <<"EOF" if $type eq 'C';
627 sub default : Private {
628 my ( \$self, \$c ) = \@_;
629 \$c->res->output('Congratulations, $class is on Catalyst!');
633 my $file = $self->{file};
634 return $self->mk_file( "$file", <<"EOF");
638 use base 'Catalyst::Base';
658 This library is free software . You can redistribute it and/or modify it under
659 the same terms as perl itself.
669 my $prefix = $self->{prefix};
670 my $type = $self->{type};
671 my $class = $self->{class};
672 my $app = $self->{app};
673 my $test = $self->{test};
674 if ( $self->{type} eq 'C' ) {
675 $self->mk_file( "$test", <<"EOF");
676 use Test::More tests => 3;
677 use_ok( Catalyst::Test, '$app' );
680 ok( request('$prefix')->is_success );
684 $self->mk_file( "$test", <<"EOF");
685 use Test::More tests => 1;
693 Helpers are classes that provide two methods.
695 * mk_compclass - creates the Component class
696 * mk_comptest - creates the Component test
698 So when you call C<bin/create view MyView TT>, create would try to execute
699 Catalyst::Helper::View::TT->mk_compclass and
700 Catalyst::Helper::View::TT->mk_comptest.
702 See L<Catalyst::Helper::View::TT> and L<Catalyst::Helper::Model::CDBI> for
705 All helper classes should be under one of the following namespaces.
707 Catalyst::Helper::Model::
708 Catalyst::Helper::View::
709 Catalyst::Helper::Controller::
713 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
714 L<Catalyst::Response>, L<Catalyst>
718 Sebastian Riedel, C<sri@oook.de>
722 This library is free software . You can redistribute it and/or modify it under
723 the same terms as perl itself.