X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FHelper.pm;h=17989955ca8ef80a8f381b772e0e1843a0ba7fad;hb=5ad5350a3aec742ee638fabbc4a8e9fa2c806311;hp=3d46c3fb5450da6946393cd2da367af4d11f8364;hpb=042ba90ae159721686eeb1df9115990342de5cec;p=catagits%2FCatalyst-Devel.git diff --git a/lib/Catalyst/Helper.pm b/lib/Catalyst/Helper.pm index 3d46c3f..1798995 100644 --- a/lib/Catalyst/Helper.pm +++ b/lib/Catalyst/Helper.pm @@ -48,7 +48,7 @@ sub mk_app { # Needs to be here for PAR require Catalyst; - if ( $name =~ /[^\w\:]/ ) { + if ( $name =~ /[^\w:]/ || $name =~ /^\d/ || $name =~ /\b:\b|:{3,}/) { warn "Error: Invalid application name.\n"; return 0; } @@ -58,7 +58,9 @@ sub mk_app { $self->{script } = File::Spec->catdir( $self->{dir}, 'script' ); $self->{appprefix } = Catalyst::Utils::appprefix($name); $self->{appenv } = Catalyst::Utils::class2env($name); - $self->{startperl } = "#!$Config{perlpath} -w"; + $self->{startperl } = -r '/usr/bin/env' + ? '#!/usr/bin/env perl' + : "#!$Config{perlpath} -w"; $self->{scriptgen } = $Catalyst::Devel::CATALYST_SCRIPT_GEN || 4; $self->{catalyst_version} = $Catalyst::VERSION; $self->{author } = $self->{author} = $ENV{'AUTHOR'} @@ -89,6 +91,7 @@ sub mk_app { $self->_mk_server; $self->_mk_test; $self->_mk_create; + $self->_mk_information; } return $self->{dir}; } @@ -256,6 +259,11 @@ sub render_file { $self->mk_file( $path, $output ); } +sub _mk_information { + my $self = shift; + print qq/Change to application directory and Run "perl Makefile.PL" to make sure your install is complete\n/; +} + sub _mk_dirs { my $self = shift; $self->mk_dir( $self->{dir} ); @@ -508,6 +516,34 @@ All helper classes should be under one of the following namespaces. Catalyst::Helper::View:: Catalyst::Helper::Controller:: +=head2 COMMON HELPERS + +=over + +=item * + +L - DBIx::Class models + +=item * + +L - Template Toolkit view + +=item * + +L + +=item * + +L - wrap any class into a Catalyst model + +=back + +=head3 NOTE + +The helpers will read author name from /etc/passwd by default. + To override, please export the AUTHOR variable. + +=head1 METHODS + =head2 mk_compclass This method in your Helper module is called with C<$helper> @@ -539,7 +575,7 @@ arguments the user typed. There is no fallback for this method. -=head1 METHODS +=head1 INTERNAL METHODS These are the methods that the Helper classes can call on the <$helper> object passed to them. @@ -596,7 +632,7 @@ Catalyst Contributors, see Catalyst.pm =head1 LICENSE -This library is free software, you can redistribute it and/or modify +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =begin pod_to_ignore @@ -612,7 +648,7 @@ package [% name %]; use strict; use warnings; -use Catalyst::Runtime '5.70'; +use Catalyst::Runtime 5.80; # Set flags and add plugins for the application # @@ -665,7 +701,7 @@ L<[% rootname %]>, L =head1 LICENSE -This library is free software, you can redistribute it and/or modify +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut @@ -727,15 +763,16 @@ sub end : ActionClass('RenderView') {} =head1 LICENSE -This library is free software, you can redistribute it and/or modify +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut 1; __makefile__ +[% startperl %] # IMPORTANT: if you delete this file your app will not work as -# expected. you have been warned +# expected. You have been warned. use inc::Module::Install; name '[% dir %]'; @@ -754,8 +791,8 @@ install_script glob('script/*.pl'); auto_install; WriteAll; __config__ -# rename this file to [% name %].yml and put a : in front of "name" if -# you want to use yaml like in old versions of Catalyst +# rename this file to [% name %].yml and put a ':' in front of 'name' if +# you want to use YAML like in old versions of Catalyst name [% name %] __readme__ Run script/[% appprefix %]_server.pl to test the application. @@ -765,6 +802,7 @@ This file documents the revision history for Perl extension [% name %]. 0.01 [% time %] - initial revision, generated by Catalyst __apptest__ +[% startperl %] use strict; use warnings; use Test::More tests => 2; @@ -773,6 +811,7 @@ BEGIN { use_ok 'Catalyst::Test', '[% name %]' } ok( request('/')->is_success, 'Request should succeed' ); __podtest__ +[% startperl %] use strict; use warnings; use Test::More; @@ -783,6 +822,7 @@ plan skip_all => 'set TEST_POD to enable this test' unless $ENV{TEST_POD}; all_pod_files_ok(); __podcoveragetest__ +[% startperl %] use strict; use warnings; use Test::More; @@ -826,7 +866,7 @@ Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This library is free software, you can redistribute it and/or modify +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut @@ -864,7 +904,7 @@ pod2usage(1) if $help; pidfile => $pidfile, manager => $manager, detach => $detach, - keep_stderr => $keep_stderr, + keep_stderr => $keep_stderr, } ); @@ -906,7 +946,7 @@ Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This library is free software, you can redistribute it and/or modify +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut @@ -933,50 +973,92 @@ my $host = undef; my $port = $ENV{[% appenv %]_PORT} || $ENV{CATALYST_PORT} || 3000; my $keepalive = 0; my $restart = $ENV{[% appenv %]_RELOAD} || $ENV{CATALYST_RELOAD} || 0; -my $restart_delay = 1; -my $restart_regex = '(?:/|^)(?!\.#).+(?:\.yml$|\.yaml$|\.conf|\.pm)$'; -my $restart_directory = undef; -my $follow_symlinks = 0; +my $background = 0; +my $pidfile = undef; + +my $check_interval; +my $file_regex; +my $watch_directory; +my $follow_symlinks; my @argv = @ARGV; GetOptions( 'debug|d' => \$debug, - 'fork' => \$fork, + 'fork|f' => \$fork, 'help|?' => \$help, 'host=s' => \$host, - 'port=s' => \$port, + 'port|p=s' => \$port, 'keepalive|k' => \$keepalive, 'restart|r' => \$restart, - 'restartdelay|rd=s' => \$restart_delay, - 'restartregex|rr=s' => \$restart_regex, - 'restartdirectory=s@' => \$restart_directory, + 'restartdelay|rd=s' => \$check_interval, + 'restartregex|rr=s' => \$file_regex, + 'restartdirectory=s@' => \$watch_directory, 'followsymlinks' => \$follow_symlinks, + 'background' => \$background, + 'pidfile=s' => \$pidfile, ); pod2usage(1) if $help; -if ( $restart && $ENV{CATALYST_ENGINE} eq 'HTTP' ) { - $ENV{CATALYST_ENGINE} = 'HTTP::Restarter'; -} if ( $debug ) { $ENV{CATALYST_DEBUG} = 1; } -# This is require instead of use so that the above environment -# variables can be set at runtime. -require [% name %]; - -[% name %]->run( $port, $host, { - argv => \@argv, - 'fork' => $fork, - keepalive => $keepalive, - restart => $restart, - restart_delay => $restart_delay, - restart_regex => qr/$restart_regex/, - restart_directory => $restart_directory, - follow_symlinks => $follow_symlinks, -} ); +# If we load this here, then in the case of a restarter, it does not +# need to be reloaded for each restart. +require Catalyst; + +# If this isn't done, then the Catalyst::Devel tests for the restarter +# fail. +$| = 1 if $ENV{HARNESS_ACTIVE}; + +my $runner = sub { + # This is require instead of use so that the above environment + # variables can be set at runtime. + require [% name %]; + + [% name %]->run( + $port, $host, + { + argv => \@argv, + 'fork' => $fork, + keepalive => $keepalive, + background => $background, + pidfile => $pidfile, + } + ); +}; + +if ( $restart ) { + die "Cannot run in the background and also watch for changed files.\n" + if $background; + + require Catalyst::Restarter; + + my $subclass = Catalyst::Restarter->pick_subclass; + + my %args; + $args{follow_symlinks} = 1 + if $follow_symlinks; + $args{directories} = $watch_directory + if defined $watch_directory; + $args{sleep_interval} = $check_interval + if defined $check_interval; + $args{filter} = qr/$file_regex/ + if defined $file_regex; + + my $restarter = $subclass->new( + %args, + start_sub => $runner, + argv => \@argv, + ); + + $restarter->run_and_watch; +} +else { + $runner->(); +} 1; @@ -999,6 +1081,7 @@ require [% name %]; -r -restart restart when files get modified (defaults to false) -rd -restartdelay delay between file checks + (ignored if you have Linux::Inotify2 installed) -rr -restartregex regex match files that trigger a restart when modified (defaults to '\.yml$|\.yaml$|\.conf|\.pm$') @@ -1007,6 +1090,9 @@ require [% name %]; (defaults to '[SCRIPT_DIR]/..') -follow_symlinks follow symlinks in search directories (defaults to false. this is a no-op on Win32) + -background run the process in the background + -pidfile specify filename for pid file + See also: perldoc Catalyst::Manual perldoc Catalyst::Manual::Intro @@ -1021,7 +1107,7 @@ Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This library is free software, you can redistribute it and/or modify +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut @@ -1075,7 +1161,7 @@ Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This library is free software, you can redistribute it and/or modify +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut @@ -1086,7 +1172,7 @@ use strict; use warnings; use Getopt::Long; use Pod::Usage; -eval "use Catalyst::Devel;"; +eval "use Catalyst::Helper;"; if ($@) { die <mk_component( '[% name %]', @ARGV ); Examples: [% appprefix %]_create.pl controller My::Controller - [% appprefix %]_create.pl controller My::Controller BindLex [% appprefix %]_create.pl -mechanize controller My::Controller [% appprefix %]_create.pl view My::View [% appprefix %]_create.pl view MyView TT @@ -1162,7 +1247,7 @@ Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT -This library is free software, you can redistribute it and/or modify +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut @@ -1203,7 +1288,7 @@ sub index :Path :Args(0) { =head1 LICENSE -This library is free software, you can redistribute it and/or modify +This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. =cut