Fix Path actions debug screen to display number of arguments
[catagits/Catalyst-Runtime.git] / lib / Catalyst / ScriptRole.pm
index cd23d89..7ae3d7d 100644 (file)
@@ -2,36 +2,37 @@ package Catalyst::ScriptRole;
 use Moose::Role;
 use MooseX::Types::Moose qw/Str Bool/;
 use Pod::Usage;
+use MooseX::Getopt;
 use namespace::autoclean;
 
-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},
-);
+sub _getopt_spec_exception {}
+
+sub _getopt_spec_warnings {
+    shift;
+    warn @_;
+}
 
-sub _display_help {
+sub _getopt_full_usage {
     my $self = shift;
     pod2usage();
     exit 0;
 }
 
-before run => sub {
-    my $self = shift;
-    $self->_display_help if $self->help;
-};
-
 sub run {
     my $self = shift;
     $self->_run_application;
@@ -49,3 +50,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<Catalyst>
+
+L<MooseX::Getopt>
+
+=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