From: Florian Ragwitz Date: Sun, 29 Nov 2009 15:33:55 +0000 (+0000) Subject: Tidy things up a little and fix pod usage. X-Git-Tag: 5.80014_02~11 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=ad8b4c91d55aed722e199001632029005eeca60d Tidy things up a little and fix pod usage. --- diff --git a/lib/Catalyst/Script/Create.pm b/lib/Catalyst/Script/Create.pm index e65a597..7d318fe 100644 --- a/lib/Catalyst/Script/Create.pm +++ b/lib/Catalyst/Script/Create.pm @@ -1,35 +1,41 @@ package Catalyst::Script::Create; use Moose; -use MooseX::Types::Moose qw/Bool/; +use MooseX::Types::Moose qw/Bool Str/; use namespace::autoclean; with 'Catalyst::ScriptRole'; has force => ( - traits => [qw(Getopt)], - cmd_aliases => 'nonew', - isa => Bool, - is => 'ro', + traits => [qw(Getopt)], + cmd_aliases => 'nonew', + isa => Bool, + is => 'ro', documentation => 'Force new scripts', ); has debug => ( - traits => [qw(Getopt)], - cmd_aliases => 'd', - isa => Bool, - is => 'ro', + traits => [qw(Getopt)], + cmd_aliases => 'd', + isa => Bool, + is => 'ro', documentation => 'Force debug mode', ); has mechanize => ( - traits => [qw(Getopt)], - cmd_aliases => 'mech', - isa => Bool, - is => 'ro', + traits => [qw(Getopt)], + cmd_aliases => 'mech', + isa => Bool, + is => 'ro', documentation => 'use WWW::Mechanize', ); -has helper_class => ( isa => 'Str', is => 'ro', default => 'Catalyst::Helper' ); +has helper_class => ( + isa => Str, + is => 'ro', + builder => '_build_helper_class', +); + +sub _build_helper_class { 'Catalyst::Helper' } sub run { my ($self) = @_; @@ -55,9 +61,9 @@ Catalyst::Script::Create - Create a new Catalyst Component myapp_create.pl [options] model|view|controller name [helper] [options] Options: - -force don't create a .new file where a file to be created exists - -mechanize use Test::WWW::Mechanize::Catalyst for tests if available - -help display this help and exits + --force don't create a .new file where a file to be created exists + --mechanize use Test::WWW::Mechanize::Catalyst for tests if available + --help display this help and exits Examples: myapp_create.pl controller My::Controller @@ -82,7 +88,7 @@ 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<-force> option. +This behavior can be suppressed with the C<--force> option. =head1 AUTHORS diff --git a/lib/Catalyst/Script/FastCGI.pm b/lib/Catalyst/Script/FastCGI.pm index 11bc735..977bcd6 100644 --- a/lib/Catalyst/Script/FastCGI.pm +++ b/lib/Catalyst/Script/FastCGI.pm @@ -8,58 +8,58 @@ use namespace::autoclean; with 'Catalyst::ScriptRole'; has listen => ( - traits => [qw(Getopt)], - cmd_aliases => 'l', - isa => Str, - is => 'ro', + traits => [qw(Getopt)], + cmd_aliases => 'l', + isa => Str, + is => 'ro', documentation => 'Specify a listening port/socket', ); has pidfile => ( - traits => [qw(Getopt)], - cmd_aliases => 'pid', - isa => Str, - is => 'ro', + traits => [qw(Getopt)], + cmd_aliases => 'pid', + isa => Str, + is => 'ro', documentation => 'Specify a pidfile', ); has daemon => ( - traits => [qw(Getopt)], - isa => Bool, - is => 'ro', - cmd_aliases => 'd', + traits => [qw(Getopt)], + isa => Bool, + is => 'ro', + cmd_aliases => 'd', documentation => 'Daemonize (go into the background)', ); has manager => ( - traits => [qw(Getopt)], - isa => Str, - is => 'ro', - cmd_aliases => 'M', + traits => [qw(Getopt)], + isa => Str, + is => 'ro', + cmd_aliases => 'M', documentation => 'Use a different FastCGI process manager class', ); has keeperr => ( - traits => [qw(Getopt)], - cmd_aliases => 'e', - isa => Bool, - is => 'ro', + traits => [qw(Getopt)], + cmd_aliases => 'e', + isa => Bool, + is => 'ro', documentation => 'Log STDERR', ); has nproc => ( - traits => [qw(Getopt)], - cmd_aliases => 'n', - isa => Int, - is => 'ro', + traits => [qw(Getopt)], + cmd_aliases => 'n', + isa => Int, + is => 'ro', documentation => 'Specify a number of child processes', ); has detach => ( - traits => [qw(Getopt)], - cmd_aliases => 'det', - isa => Bool, - is => 'ro', + traits => [qw(Getopt)], + cmd_aliases => 'det', + isa => Bool, + is => 'ro', documentation => 'Detach this FastCGI process', ); @@ -88,22 +88,22 @@ Catalyst::Script::FastCGI - The FastCGI Catalyst Script myapp_fastcgi.pl [options] Options: - -? -help display this help and exits - -l -listen Socket path to listen on - (defaults to standard input) - can be HOST:PORT, :PORT or a - filesystem path - -n -nproc specify number of processes to keep - to serve requests (defaults to 1, - requires -listen) - -p -pidfile specify filename for pid file - (requires -listen) - -d -daemon daemonize (requires -listen) - -M -manager specify alternate process manager - (FCGI::ProcManager sub-class) - or empty string to disable - -e -keeperr send error messages to STDOUT, not - to the webserver + -? --help display this help and exits + -l --listen Socket path to listen on + (defaults to standard input) + can be HOST:PORT, :PORT or a + filesystem path + -n --nproc specify number of processes to keep + to serve requests (defaults to 1, + requires -listen) + -p --pidfile specify filename for pid file + (requires -listen) + -d --daemon daemonize (requires -listen) + -M --manager specify alternate process manager + (FCGI::ProcManager sub-class) + or empty string to disable + -e --keeperr send error messages to STDOUT, not + to the webserver =head1 DESCRIPTION diff --git a/lib/Catalyst/ScriptRole.pm b/lib/Catalyst/ScriptRole.pm index 1cd745f..535ed3d 100644 --- a/lib/Catalyst/ScriptRole.pm +++ b/lib/Catalyst/ScriptRole.pm @@ -14,18 +14,18 @@ with 'MooseX::Getopt' => { }; has application_name => ( - traits => ['NoGetopt'], - isa => Str, - is => 'ro', + traits => ['NoGetopt'], + isa => Str, + is => 'ro', required => 1, ); has help => ( - traits => ['Getopt'], - isa => Bool, - is => 'ro', - documentation => q{Display this help and exit}, - cmd_aliases => ['?', 'h'], + traits => ['Getopt'], + isa => Bool, + is => 'ro', + documentation => 'Display this help and exit', + cmd_aliases => ['?', 'h'], ); sub _getopt_spec_exception {} @@ -76,7 +76,7 @@ Catalyst::ScriptRole - Common functionality for Catalyst scripts. with 'Catalyst::ScriptRole'; - sub _application_args { ... } + sub _application_args { ... } =head1 DESCRIPTION @@ -110,4 +110,3 @@ This library is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut -