X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FScriptRole.pm;h=535ed3d68cb819d468e68aa54f4922afe96c16f1;hb=b89d8b9875b08957089b2758fb3533bf8fc1e0c6;hp=ca7055d93e46159af24ac26375e2a1c09dca96f4;hpb=d3082facb5273f9970121638c0385ecfc0f7b090;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/ScriptRole.pm b/lib/Catalyst/ScriptRole.pm index ca7055d..535ed3d 100644 --- a/lib/Catalyst/ScriptRole.pm +++ b/lib/Catalyst/ScriptRole.pm @@ -2,28 +2,40 @@ package Catalyst::ScriptRole; use Moose::Role; use MooseX::Types::Moose qw/Str Bool/; use Pod::Usage; +use MooseX::Getopt; use namespace::autoclean; -requires 'run'; - -with 'MooseX::Getopt'; +with 'MooseX::Getopt' => { + excludes => [qw/ + _getopt_spec_warnings + _getopt_spec_exception + _getopt_full_usage + /], +}; has application_name => ( - traits => ['NoGetopt'], - isa => Str, - is => 'ro', + traits => ['NoGetopt'], + isa => Str, + is => 'ro', required => 1, ); has help => ( - traits => ['Getopt'], - cmd_aliases => 'h', - isa => Bool, - is => 'ro', - documentation => q{Display this help and exit}, + traits => ['Getopt'], + isa => Bool, + is => 'ro', + documentation => 'Display this help and exit', + cmd_aliases => ['?', 'h'], ); -sub _display_help { +sub _getopt_spec_exception {} + +sub _getopt_spec_warnings { + shift; + warn @_; +} + +sub _getopt_full_usage { my $self = shift; pod2usage(); exit 0; @@ -31,7 +43,7 @@ sub _display_help { before run => sub { my $self = shift; - $self->_display_help if $self->help; + $self->_getopt_full_usage if $self->help; }; sub run { @@ -51,3 +63,50 @@ sub _run_application { } 1; + +=head1 NAME + +Catalyst::ScriptRole - Common functionality for Catalyst scripts. + +=head1 SYNOPSIS + + package MyApp::Script::Foo; + use Moose; + use namespace::autoclean; + + with 'Catalyst::ScriptRole'; + + sub _application_args { ... } + +=head1 DESCRIPTION + +Role with the common functionality of Catalyst scripts. + +=head1 METHODS + +=head2 run + +The method invoked to run the application. + +=head1 ATTRIBUTES + +=head2 application_name + +The name of the application class, e.g. MyApp + +=head1 SEE ALSO + +L + +L + +=head1 AUTHORS + +Catalyst Contributors, see Catalyst.pm + +=head1 COPYRIGHT + +This library is free software, you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut