X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FHelper.pm;h=14af0d1a9a82468f935d07457be58d1817f50ea5;hp=81258bcca6339624a5da1790d937cada6f1965cb;hb=ab2374d3a68f4d44601813f351b38222822b7c39;hpb=d7c505f31a1c555f2cc3bee7ddfb550a808cd091 diff --git a/lib/Catalyst/Helper.pm b/lib/Catalyst/Helper.pm index 81258bc..14af0d1 100644 --- a/lib/Catalyst/Helper.pm +++ b/lib/Catalyst/Helper.pm @@ -2,10 +2,16 @@ package Catalyst::Helper; use strict; use base 'Class::Accessor::Fast'; +use Config; use File::Spec; use File::Path; use IO::File; use FindBin; +use Template; +use Catalyst; +use Catalyst::Exception; + +my %cache; =head1 NAME @@ -17,12 +23,36 @@ See L =head1 DESCRIPTION -Bootstrap a Catalyst application. +Bootstrap a Catalyst application. Autogenerates scripts =head2 METHODS +=head3 get_file + +Slurp file from DATA. + +=cut + +sub get_file { + my ( $self, $class, $file ) = @_; + unless ( $cache{$class} ) { + local $/; + $cache{$class} = eval "package $class; "; + } + my $data = $cache{$class}; + my @files = split /^__(.+)__\r?\n/m, $data; + shift @files; + while (@files) { + my ( $name, $content ) = splice @files, 0, 2; + return $content if $name eq $file; + } + return 0; +} + =head3 mk_app +Create the main application skeleton. + =cut sub mk_app { @@ -31,166 +61,650 @@ sub mk_app { $self->{name} = $name; $self->{dir} = $name; $self->{dir} =~ s/\:\:/-/g; + $self->{appprefix} = lc $self->{dir}; + $self->{appprefix} =~ s/-/_/g; + $self->{startperl} = $Config{startperl}; + $self->{scriptgen} = $Catalyst::CATALYST_SCRIPT_GEN || 4; + $self->{author} = $self->{author} = $ENV{'AUTHOR'} + || eval { @{ [ getpwuid($<) ] }[6] } + || 'Catalyst developer'; $self->_mk_dirs; $self->_mk_appclass; + $self->_mk_build; $self->_mk_makefile; + $self->_mk_readme; + $self->_mk_changes; $self->_mk_apptest; + $self->_mk_cgi; + $self->_mk_fastcgi; $self->_mk_server; $self->_mk_test; $self->_mk_create; return 1; } +=head3 mk_component + +This method is called by create.pl to make new components +for your application. + +=cut + +sub mk_component { + my $self = shift; + my $app = shift; + $self->{app} = $app; + $self->{author} = $self->{author} = $ENV{'AUTHOR'} + || eval { @{ [ getpwuid($<) ] }[6] } + || 'A clever guy'; + $self->{base} = File::Spec->catdir( $FindBin::Bin, '..' ); + unless ( $_[0] =~ /^(?:model|m|view|v|controller|c)$/i ) { + my $helper = shift; + my @args = @_; + my $class = "Catalyst::Helper::$helper"; + eval "require $class"; + + if ($@) { + Catalyst::Exception->throw( + message => qq/Couldn't load helper "$class", "$@"/ ); + } + + if ( $class->can('mk_stuff') ) { + return 1 unless $class->mk_stuff( $self, @args ); + } + } + else { + my $type = shift; + my $name = shift || "Missing name for model/view/controller"; + my $helper = shift; + my @args = @_; + return 0 if $name =~ /[^\w\:]/; + $type = 'M' if $type =~ /model|m/i; + $type = 'V' if $type =~ /view|v/i; + $type = 'C' if $type =~ /controller|c/i; + $self->{type} = $type; + $self->{name} = $name; + $self->{class} = "$app\::$type\::$name"; + + # Class + my $appdir = File::Spec->catdir( split /\:\:/, $app ); + my $path = + File::Spec->catdir( $FindBin::Bin, '..', 'lib', $appdir, $type ); + my $file = $name; + if ( $name =~ /\:/ ) { + my @path = split /\:\:/, $name; + $file = pop @path; + $path = File::Spec->catdir( $path, @path ); + mkpath [$path]; + } + $file = File::Spec->catfile( $path, "$file.pm" ); + $self->{file} = $file; + + # Test + $self->{test_dir} = File::Spec->catdir( $FindBin::Bin, '..', 't' ); + $self->{test} = $self->next_test; + + # Helper + if ($helper) { + my $comp = 'Model'; + $comp = 'View' if $type eq 'V'; + $comp = 'Controller' if $type eq 'C'; + my $class = "Catalyst::Helper::$comp\::$helper"; + eval "require $class"; + + if ($@) { + Catalyst::Exception->throw( + message => qq/Couldn't load helper "$class", "$@"/ ); + } + + if ( $class->can('mk_compclass') ) { + return 1 unless $class->mk_compclass( $self, @args ); + } + else { return 1 unless $self->_mk_compclass } + + if ( $class->can('mk_comptest') ) { + $class->mk_comptest( $self, @args ); + } + else { $self->_mk_comptest } + } + + # Fallback + else { + return 1 unless $self->_mk_compclass; + $self->_mk_comptest; + } + } + return 1; +} + +=head3 mk_dir + +Surprisingly, this function makes a directory. + +=cut + +sub mk_dir { + my ( $self, $dir ) = @_; + if ( -d $dir ) { + print qq/ exists "$dir"\n/; + return 0; + } + if ( mkpath [$dir] ) { + print qq/created "$dir"\n/; + return 1; + } + + Catalyst::Exception->throw( message => qq/Couldn't create "$dir", "$!"/ ); +} + +=head3 mk_file + +writes content to a file. + +=cut + +sub mk_file { + my ( $self, $file, $content ) = @_; + if ( -e $file ) { + print qq/ exists "$file"\n/; + return 0 unless $self->{'.newfiles'}; + if ( my $f = IO::File->new("< $file") ) { + my $oldcontent = join( '', (<$f>) ); + return 0 if $content eq $oldcontent; + } + $file .= '.new'; + } + if ( my $f = IO::File->new("> $file") ) { + print $f $content; + print qq/created "$file"\n/; + return 1; + } + + Catalyst::Exception->throw( message => qq/Couldn't create "$file", "$!"/ ); +} + +=head3 next_test + +=cut + +sub next_test { + my ( $self, $tname ) = @_; + if ($tname) { $tname = "$tname.t" } + else { + my $name = $self->{name}; + my $prefix = $name; + $prefix =~ s/::/-/g; + $prefix = $prefix; + $tname = $prefix . '.t'; + $self->{prefix} = $prefix; + $prefix = lc $prefix; + $prefix =~ s/-/\//g; + $self->{uri} = $prefix; + } + my $dir = $self->{test_dir}; + my $type = $self->{type}; + return File::Spec->catfile( $dir, $type, $tname ); +} + +=head3 render_file + +Render and create a file from a template in DATA using +Template Toolkit. + +=cut + +sub render_file { + my ( $self, $file, $path, $vars ) = @_; + $vars ||= {}; + my $t = Template->new; + my $template = $self->get_file( ( caller(0) )[0], $file ); + return 0 unless $template; + my $output; + $t->process( \$template, { %{$self}, %$vars }, \$output ) + || Catalyst::Exception->throw( + message => qq/Couldn't process "$file", / . $t->error() ); + $self->mk_file( $path, $output ); +} + sub _mk_dirs { my $self = shift; - mkpath $self->{dir} unless -d $self->{dir}; - $self->{bin} = File::Spec->catdir( $self->{dir}, 'bin' ); - mkpath $self->{bin}; + $self->mk_dir( $self->{dir} ); + $self->{script} = File::Spec->catdir( $self->{dir}, 'script' ); + $self->mk_dir( $self->{script} ); $self->{lib} = File::Spec->catdir( $self->{dir}, 'lib' ); - mkpath $self->{lib}; + $self->mk_dir( $self->{lib} ); $self->{root} = File::Spec->catdir( $self->{dir}, 'root' ); - mkpath $self->{root}; + $self->mk_dir( $self->{root} ); $self->{t} = File::Spec->catdir( $self->{dir}, 't' ); - mkpath $self->{t}; + $self->mk_dir( $self->{t} ); + $self->mk_dir( File::Spec->catdir( $self->{t}, 'M' ) ); + $self->mk_dir( File::Spec->catdir( $self->{t}, 'V' ) ); + $self->mk_dir( File::Spec->catdir( $self->{t}, 'C' ) ); $self->{class} = File::Spec->catdir( split( /\:\:/, $self->{name} ) ); $self->{mod} = File::Spec->catdir( $self->{lib}, $self->{class} ); - mkpath $self->{mod}; + $self->mk_dir( $self->{mod} ); $self->{m} = File::Spec->catdir( $self->{mod}, 'M' ); - mkpath $self->{m}; + $self->mk_dir( $self->{m} ); $self->{v} = File::Spec->catdir( $self->{mod}, 'V' ); - mkpath $self->{v}; + $self->mk_dir( $self->{v} ); $self->{c} = File::Spec->catdir( $self->{mod}, 'C' ); - mkpath $self->{c}; + $self->mk_dir( $self->{c} ); $self->{base} = File::Spec->rel2abs( $self->{dir} ); } sub _mk_appclass { - my $self = shift; - my $mod = $self->{mod}; - my $name = $self->{name}; - my $base = $self->{base}; - my $class = IO::File->new("> $mod.pm") - or die qq/Couldn't open "$mod.pm", "$!"/; - print $class <<"EOF"; -package $name; + my $self = shift; + my $mod = $self->{mod}; + $self->render_file( 'appclass', "$mod.pm" ); +} -use strict; -use Catalyst qw/-Debug/; +sub _mk_build { + my $self = shift; + my $dir = $self->{dir}; + $self->render_file( 'build', "$dir\/Build.PL" ); +} + +sub _mk_makefile { + my $self = shift; + my $dir = $self->{dir}; + $self->render_file( 'makefile', "$dir\/Makefile.PL" ); +} -our \$VERSION = '0.01'; +sub _mk_readme { + my $self = shift; + my $dir = $self->{dir}; + $self->render_file( 'readme', "$dir\/README" ); +} -$name->config( - name => '$name', - root => '$base/root', -); +sub _mk_changes { + my $self = shift; + my $dir = $self->{dir}; + my $time = localtime time; + $self->render_file( 'changes', "$dir\/Changes", { time => $time } ); +} + +sub _mk_apptest { + my $self = shift; + my $t = $self->{t}; + $self->render_file( 'apptest', "$t\/01app.t" ); + $self->render_file( 'podtest', "$t\/02pod.t" ); + $self->render_file( 'podcoveragetest', "$t\/03podcoverage.t" ); +} -$name->action( +sub _mk_cgi { + my $self = shift; + my $script = $self->{script}; + my $appprefix = $self->{appprefix}; + $self->render_file( 'cgi', "$script\/$appprefix\_cgi.pl" ); + chmod 0700, "$script/$appprefix\_cgi.pl"; +} - '!default' => sub { - my ( \$self, \$c ) = \@_; - \$c->res->output('Congratulations, $name is on Catalyst!'); - }, +sub _mk_fastcgi { + my $self = shift; + my $script = $self->{script}; + my $appprefix = $self->{appprefix}; + $self->render_file( 'fastcgi', "$script\/$appprefix\_fastcgi.pl" ); + chmod 0700, "$script/$appprefix\_fastcgi.pl"; +} -); +sub _mk_server { + my $self = shift; + my $script = $self->{script}; + my $appprefix = $self->{appprefix}; + $self->render_file( 'server', "$script\/$appprefix\_server.pl" ); + chmod 0700, "$script/$appprefix\_server.pl"; +} + +sub _mk_test { + my $self = shift; + my $script = $self->{script}; + my $appprefix = $self->{appprefix}; + $self->render_file( 'test', "$script/$appprefix\_test.pl" ); + chmod 0700, "$script/$appprefix\_test.pl"; +} + +sub _mk_create { + my $self = shift; + my $script = $self->{script}; + my $appprefix = $self->{appprefix}; + $self->render_file( 'create', "$script\/$appprefix\_create.pl" ); + chmod 0700, "$script/$appprefix\_create.pl"; +} + +sub _mk_compclass { + my $self = shift; + my $file = $self->{file}; + return $self->render_file( 'compclass', "$file" ); +} + +sub _mk_comptest { + my $self = shift; + my $test = $self->{test}; + $self->render_file( 'comptest', "$test" ); +} + +=head1 HELPERS + +Helpers are classes that provide two methods. + + * mk_compclass - creates the Component class + * mk_comptest - creates the Component test + +So when you call C, create would try to execute +Catalyst::Helper::View::TT->mk_compclass and +Catalyst::Helper::View::TT->mk_comptest. + +See L and L for +examples. + +All helper classes should be under one of the following namespaces. + + Catalyst::Helper::Model:: + Catalyst::Helper::View:: + Catalyst::Helper::Controller:: + +=head1 NOTE + +The helpers will read author name from /etc/passwd by default. +To override, please export the AUTHOR variable. + +=head1 SEE ALSO + +L, L, L, +L, L + +=head1 AUTHOR + +Sebastian Riedel, C + +=head1 LICENSE + +This library is free software . You can redistribute it and/or modify +it under the same terms as perl itself. + +=cut + +1; +__DATA__ + +__appclass__ +package [% name %]; + +use strict; +use Catalyst qw/-Debug/; + +our $VERSION = '0.01'; + +[% name %]->config( name => '[% name %]' ); + +[% name %]->setup; =head1 NAME -$name - A very nice application +[% name %] - Catalyst based application =head1 SYNOPSIS - Very simple to use + script/[% appprefix %]_server.pl =head1 DESCRIPTION -Very nice application. +Catalyst based application. + +=head1 METHODS + +=over 4 + +=item default + +=cut + +sub default : Private { + my ( $self, $c ) = @_; + + # Hello World + $c->response->output( $c->welcome_message ); +} + +#=item end +# +#=cut +# +#sub end : Private { +# my ( $self, $c ) = @_; +# +# # Forward to View unless response body is already defined +# $c->forward('MyApp::V::') unless $c->response->body; +#} + +=back =head1 AUTHOR -Clever guy +[% author %] =head1 LICENSE -This library is free software . You can redistribute it and/or modify it under -the same terms as perl itself. +This library is free software . You can redistribute it and/or modify +it under the same terms as perl itself. =cut 1; -EOF -} +__makefile__ + unless ( eval "use Module::Build::Compat 0.02; 1" ) { + print "This module requires Module::Build to install itself.\n"; -sub _mk_makefile { - my $self = shift; - my $name = $self->{name}; - my $dir = $self->{dir}; - my $class = $self->{class}; - my $makefile = IO::File->new("> $dir/Makefile.PL") - or die qq/Couldn't open "$dir\/Makefile.PL", "$!"/; - print $makefile <<"EOF"; -use ExtUtils::MakeMaker; - -WriteMakefile( - NAME => '$name', - VERSION_FROM => 'lib/$class.pm', - PREREQ_PM => { Catalyst => 0 } -); -EOF -} + require ExtUtils::MakeMaker; + my $yn = + ExtUtils::MakeMaker::prompt( ' Install Module::Build now from CPAN?', 'y' ); -sub _mk_apptest { - my $self = shift; - my $t = $self->{t}; - my $name = $self->{name}; - my $test = IO::File->new("> $t/01app.t") - or die qq/Couldn't open "$t\/01app.t", "$!"/; - print $test <<"EOF"; + unless ( $yn =~ /^y/i ) { + die " *** Cannot install without Module::Build. Exiting ...\n"; + } + + require Cwd; + require File::Spec; + require CPAN; + + # Save this 'cause CPAN will chdir all over the place. + my $cwd = Cwd::cwd(); + my $makefile = File::Spec->rel2abs($0); + + CPAN::Shell->install('Module::Build::Compat') + or die " *** Cannot install without Module::Build. Exiting ...\n"; + + chdir $cwd or die "Cannot chdir() back to $cwd: $!"; + } + eval "use Module::Build::Compat 0.02; 1" or die $@; + use lib '_build/lib'; + Module::Build::Compat->run_build_pl( args => \@ARGV ); + require Module::Build; + Module::Build::Compat->write_makefile( build_class => 'Module::Build' ); +__build__ +use strict; +use Catalyst::Build; + +my $build = Catalyst::Build->new( + create_makefile_pl => 'passthrough', + license => 'perl', + module_name => '[% name %]', + requires => { Catalyst => '5.10' }, + create_makefile_pl => 'passthrough', + script_files => [ glob('script/*') ], + test_files => [ glob('t/*.t'), glob('t/*/*.t') ] +); +$build->create_build_script; +__readme__ +Run script/[% appprefix %]_server.pl to test the application. +__changes__ +This file documents the revision history for Perl extension [% name %]. +0.01 [% time %] + - initial revision, generated by Catalyst +__apptest__ use Test::More tests => 2; -use_ok( Catalyst::Test, '$name' ); +use_ok( Catalyst::Test, '[% name %]' ); ok( request('/')->is_success ); -EOF -} +__podtest__ +use Test::More; -sub _mk_server { - my $self = shift; - my $name = $self->{name}; - my $bin = $self->{bin}; - my $server = IO::File->new("> $bin/server") - or die qq/Could't open "$bin\/server", "$!"/; - print $server <<"EOF"; -#!/usr/bin/perl -w +eval "use Test::Pod 1.14"; +plan skip_all => 'Test::Pod 1.14 required' if $@; +plan skip_all => 'set TEST_POD to enable this test' unless $ENV{TEST_POD}; + +all_pod_files_ok(); +__podcoveragetest__ +use Test::More; + +eval "use Test::Pod::Coverage 1.04"; +plan skip_all => 'Test::Pod::Coverage 1.04 required' if $@; +plan skip_all => 'set TEST_POD to enable this test' unless $ENV{TEST_POD}; + +all_pod_coverage_ok(); +__cgi__ +[% startperl %] -w + +BEGIN { $ENV{CATALYST_ENGINE} ||= 'CGI' } + +use strict; +use FindBin; +use lib "$FindBin::Bin/../lib"; +use [% name %]; + +[% name %]->run; + +1; + +=head1 NAME + +[% appprefix %]_cgi.pl - Catalyst CGI + +=head1 SYNOPSIS + +See L + +=head1 DESCRIPTION + +Run a Catalyst application as cgi. + +=head1 AUTHOR + +Sebastian Riedel, C + +=head1 COPYRIGHT + +Copyright 2004 Sebastian Riedel. All rights reserved. + +This library is free software. You can redistribute it and/or modify +it under the same terms as perl itself. + +=cut +__fastcgi__ +[% startperl %] -w + +BEGIN { $ENV{CATALYST_ENGINE} ||= 'FastCGI' } use strict; -use Getopt::Long; -use Pod::Usage; use FindBin; -use lib "\$FindBin::Bin/../lib"; -use Catalyst::Test '$name'; +use lib "$FindBin::Bin/../lib"; +use [% name %]; + +[% name %]->run; + +1; + +=head1 NAME + +[% appprefix %]_fastcgi.pl - Catalyst FastCGI + +=head1 SYNOPSIS + +See L + +=head1 DESCRIPTION + +Run a Catalyst application as fastcgi. + +=head1 AUTHOR + +Sebastian Riedel, C + +=head1 COPYRIGHT + +Copyright 2004 Sebastian Riedel. All rights reserved. -my \$help = 0; -my \$port = 3000; +This library is free software. You can redistribute it and/or modify +it under the same terms as perl itself. -GetOptions( 'help|?' => \\\$help, 'port=s' => \\\$port ); +=cut +__server__ +[% startperl %] -w -pod2usage(1) if \$help; +BEGIN { + $ENV{CATALYST_ENGINE} ||= 'HTTP'; + $ENV{CATALYST_SCRIPT_GEN} = [% scriptgen %]; +} -Catalyst::Test::server(\$port); +use strict; +use Getopt::Long; +use Pod::Usage; +use FindBin; +use lib "$FindBin::Bin/../lib"; +use [% name %]; + +my $fork = 0; +my $help = 0; +my $host = undef; +my $port = 3000; +my $restart = 0; +my $restart_delay = 1; +my $restart_regex = '\.yml$|\.yaml$|\.pm$'; + +my @argv = @ARGV; + +GetOptions( + 'fork' => \$fork, + 'help|?' => \$help, + 'host=s' => \$host, + 'port=s' => \$port, + 'restart|r' => \$restart, + 'restartdelay|rd=s' => \$restart_delay, + 'restartregex|rr=s' => \$restart_regex +); + +pod2usage(1) if $help; + +[% name %]->run( $port, $host, { + argv => \@argv, + 'fork' => $fork, + restart => $restart, + restart_delay => $restart_delay, + restart_regex => qr/$restart_regex/ +} ); 1; -__END__ =head1 NAME -server - Catalyst Testserver +[% appprefix %]_server.pl - Catalyst Testserver =head1 SYNOPSIS -server [options] +[% appprefix %]_server.pl [options] Options: - -help display this help and exits - -port port (defaults to 3000) + -f -fork handle each request in a new process + (defaults to false) + -? -help display this help and exits + -host host (defaults to all) + -p -port port (defaults to 3000) + -r -restart restart when files got modified + (defaults to false) + -rd -restartdelay delay between file checks + -rr -restartregex regex match files that trigger + a restart when modified + (defaults to '\.yml$|\.yaml$|\.pm$') See also: perldoc Catalyst::Manual @@ -202,63 +716,52 @@ Run a Catalyst Testserver for this application. =head1 AUTHOR -Sebastian Riedel, C +Sebastian Riedel, C =head1 COPYRIGHT Copyright 2004 Sebastian Riedel. All rights reserved. -This library is free software. You can redistribute it and/or modify it under -the same terms as perl itself. +This library is free software. You can redistribute it and/or modify +it under the same terms as perl itself. =cut -EOF - chmod 0700, "$bin/server"; -} +__test__ +[% startperl %] -w -sub _mk_test { - my $self = shift; - my $name = $self->{name}; - my $bin = $self->{bin}; - my $test = IO::File->new("> $bin/test") - or die qq/Could't open "$bin\/test", "$!"/; - print $test <<"EOF"; -#!/usr/bin/perl -w +BEGIN { $ENV{CATALYST_ENGINE} ||= 'Test' } use strict; use Getopt::Long; use Pod::Usage; use FindBin; -use lib "\$FindBin::Bin/../lib"; +use lib "$FindBin::Bin/../lib"; +use [% name %]; -my \$help = 0; +my $help = 0; -GetOptions( 'help|?' => \\\$help ); - -pod2usage(1) if ( \$help || !\$ARGV[0] ); +GetOptions( 'help|?' => \$help ); -require Catalyst::Test; -import Catalyst::Test '$name'; +pod2usage(1) if ( $help || !$ARGV[0] ); -print get(\$ARGV[0]) . "\n"; +print [% name %]->run($ARGV[0])->content . "\n"; 1; -__END__ =head1 NAME -test - Catalyst Test +[% appprefix %]_test.pl - Catalyst Test =head1 SYNOPSIS -test [options] uri +[% appprefix %]_test.pl [options] uri Options: -help display this help and exits Examples: - perl test http://localhost/some_action - perl test /some_action + [% appprefix %]_test.pl http://localhost/some_action + [% appprefix %]_test.pl /some_action See also: perldoc Catalyst::Manual @@ -266,69 +769,61 @@ test [options] uri =head1 DESCRIPTION -Run a Catalyst action from the comand line. +Run a Catalyst action from the command line. =head1 AUTHOR -Sebastian Riedel, C +Sebastian Riedel, C =head1 COPYRIGHT Copyright 2004 Sebastian Riedel. All rights reserved. -This library is free software. You can redistribute it and/or modify it under -the same terms as perl itself. +This library is free software. You can redistribute it and/or modify +it under the same terms as perl itself. =cut -EOF - chmod 0700, "$bin/test"; -} - -sub _mk_create { - my $self = shift; - my $name = $self->{name}; - my $bin = $self->{bin}; - my $create = IO::File->new("> $bin/create") - or die qq/Could't open "$bin\/create", "$!"/; - print $create <<"EOF"; -#!/usr/bin/perl -w +__create__ +[% startperl %] -w use strict; use Getopt::Long; use Pod::Usage; use Catalyst::Helper; -my \$help = 0; +my $help = 0; +my $nonew = 0; -GetOptions( 'help|?' => \$help ); +GetOptions( 'help|?' => \$help, + 'nonew' => \$nonew ); -pod2usage(1) if ( \$help || !\$ARGV[1] ); +pod2usage(1) if ( $help || !$ARGV[0] ); -my \$helper = Catalyst::Helper->new; -pod2usage(1) unless \$helper->mk_component( '$name', \@ARGV ); +my $helper = Catalyst::Helper->new({'.newfiles' => !$nonew}); +pod2usage(1) unless $helper->mk_component( '[% name %]', @ARGV ); 1; -__END__ =head1 NAME -create - Create a new Catalyst Component +[% appprefix %]_create.pl - Create a new Catalyst Component =head1 SYNOPSIS -create [options] model|view|controller name [helper] [options] +[% appprefix %]_create.pl [options] model|view|controller name [helper] [options] Options: -help display this help and exits + -nonew don't create a .new file where a file to be created exists Examples: - perl create controller My::Controller - perl create view My::View - perl create view MyView TT - perl create view TT TT - perl create model My::Model - perl create model SomeDB CDBI dbi:SQLite:/tmp/my.db - perl create model AnotherDB CDBI dbi:Pg:dbname=foo root 4321 + [% appprefix %]_create.pl controller My::Controller + [% appprefix %]_create.pl view My::View + [% appprefix %]_create.pl view MyView TT + [% appprefix %]_create.pl view TT TT + [% appprefix %]_create.pl model My::Model + [% appprefix %]_create.pl model SomeDB CDBI dbi:SQLite:/tmp/my.db + [% appprefix %]_create.pl model AnotherDB CDBI dbi:Pg:dbname=foo root 4321 See also: perldoc Catalyst::Manual @@ -338,6 +833,10 @@ create [options] model|view|controller name [helper] [options] Create a new Catalyst Component. +Existing component files are not overwritten. If any of the component files +to be created already exist the file will be written with a '.new' suffix. +This behavior can be suppressed with the C<-nonew> option. + =head1 AUTHOR Sebastian Riedel, C @@ -346,182 +845,66 @@ Sebastian Riedel, C Copyright 2004 Sebastian Riedel. All rights reserved. -This library is free software. You can redistribute it and/or modify it under -the same terms as perl itself. - -=cut -EOF - chmod 0700, "$bin/create"; -} - -=head3 mk_component +This library is free software. You can redistribute it and/or modify +it under the same terms as perl itself. =cut - -sub mk_component { - my ( $self, $app, $type, $name, $helper, @args ) = @_; - return 0 - if ( $name =~ /[^\w\:]/ || !\$type =~ /^model|m|view|v|controller|c\$/i ); - return 0 if $name =~ /[^\w\:]/; - $type = 'M' if $type =~ /model|m/i; - $type = 'V' if $type =~ /view|v/i; - $type = 'C' if $type =~ /controller|c/i; - $self->{type} = $type; - $self->{name} = $name; - $self->{class} = "$app\::$type\::$name"; - $self->{app} = $app; - - # Class - my $appdir = File::Spec->catdir( split /\:\:/, $app ); - my $path = File::Spec->catdir( $FindBin::Bin, '..', 'lib', $appdir, $type ); - my $file = $name; - if ( $name =~ /\:/ ) { - my @path = split /\:\:/, $name; - $file = pop @path; - $path = File::Spec->catdir( $path, @path ); - mkpath $path; - } - $file = File::Spec->catfile( $path, "$file.pm" ); - $self->{file} = $file; - - # Test - my $dir = File::Spec->catdir( $FindBin::Bin, '..', 't' ); - my $num = '01'; - for my $i (<$dir/*.t>) { - $i =~ /(\d+)[^\/]*.t$/; - my $j = $1 || $num; - $num = $j if $j > $num; - } - $num++; - $num = sprintf '%02d', $num; - my $prefix = $name; - $prefix =~ s/::/_/g; - $prefix = lc $prefix; - my $tname = lc( $num . $type . '_' . $prefix . '.t' ); - $self->{prefix} = $prefix; - $self->{test_dir} = $dir; - $self->{test} = "$dir/$tname"; - - # Helper - if ($helper) { - my $comp = 'Model'; - $comp = 'View' if $type eq 'V'; - $comp = 'Controller' if $type eq 'C'; - my $class = "Catalyst::Helper::$comp\::$helper"; - eval "require $class"; - die qq/Couldn't load helper "$class", "$@"/ if $@; - if ( $class->can('mk_compclass') ) { - $class->mk_compclass( $self, @args ); - } - else { $self->_mk_compclass } - - if ( $class->can('mk_comptest') ) { - $class->mk_comptest( $self, @args ); - } - else { $self->_mk_comptest } - } - - # Fallback - else { - $self->_mk_compclass; - $self->_mk_comptest; - } - return 1; -} - -sub _mk_compclass { - my $self = shift; - my $app = $self->{app}; - my $class = $self->{class}; - my $type = $self->{type}; - my $action = ''; - $action = <<"EOF" if $type eq 'C'; - -$app->action( - - '!?default' => sub { - my ( \$self, \$c ) = \@_; - \$c->res->output('Congratulations, $class is on Catalyst!'); - }, - -); -EOF - my $file = $self->{file}; - my $comp = IO::File->new("> $file") - or die qq/Couldn't open "$file", "$!"/; - print $comp <<"EOF"; -package $class; +__compclass__ +package [% class %]; use strict; use base 'Catalyst::Base'; -$action + =head1 NAME -$class - A Component +[% class %] - Catalyst component =head1 SYNOPSIS - Very simple to use +See L<[% app %]> =head1 DESCRIPTION -Very nice component. - -=head1 AUTHOR - -Clever guy +Catalyst component. +[% IF type == 'C' %] +=head1 METHODS -=head1 LICENSE +=over 4 -This library is free software . You can redistribute it and/or modify it under -the same terms as perl itself. +=item default =cut -1; -EOF -} +sub default : Private { + my ( $self, $c ) = @_; -sub _mk_comptest { - my $self = shift; - my $prefix = $self->{prefix}; - my $type = $self->{type}; - my $class = $self->{class}; - my $app = $self->{app}; - my $test = $self->{test}; - my $t = IO::File->new("> $test") or die qq/Couldn't open "$test", "$!"/; - - if ( $self->{type} eq 'C' ) { - print $t <<"EOF"; -use Test::More tests => 3; -use_ok( Catalyst::Test, '$app' ); -use_ok('$class'); - -ok( request('$prefix')->is_success ); -EOF - } - else { - print $t <<"EOF"; -use Test::More tests => 1; -use_ok('$class'); -EOF - } + # Hello World + $c->response->output('Congratulations, [% class %] is on Catalyst!'); } -=head1 SEE ALSO - -L, L, L, -L, L +=back +[% END %] =head1 AUTHOR -Sebastian Riedel, C +[%author%] =head1 LICENSE -This library is free software . You can redistribute it and/or modify it under -the same terms as perl itself. +This library is free software . You can redistribute it and/or modify +it under the same terms as perl itself. =cut 1; +__comptest__ +[% IF type == 'C' %] +use Test::More tests => 3; +use_ok( Catalyst::Test, '[% app %]' ); +use_ok('[% class %]'); + +ok( request('[% uri %]')->is_success ); +[% ELSE %] +use Test::More tests => 1; +use_ok('[% class %]'); +[% END %]