Commit | Line | Data |
d3082fac |
1 | package Catalyst::ScriptRole; |
2 | use Moose::Role; |
44d28c7d |
3 | use Plack::Runner; |
d3082fac |
4 | use MooseX::Types::Moose qw/Str Bool/; |
5 | use Pod::Usage; |
0e4038c6 |
6 | use MooseX::Getopt; |
d3082fac |
7 | use namespace::autoclean; |
8 | |
19529022 |
9 | with 'MooseX::Getopt' => { |
10 | excludes => [qw/ |
11 | _getopt_spec_warnings |
12 | _getopt_spec_exception |
2b8d5598 |
13 | _getopt_full_usage |
19529022 |
14 | /], |
15 | }; |
d3082fac |
16 | |
17 | has application_name => ( |
ad8b4c91 |
18 | traits => ['NoGetopt'], |
19 | isa => Str, |
20 | is => 'ro', |
d3082fac |
21 | required => 1, |
22 | ); |
23 | |
24 | has help => ( |
ad8b4c91 |
25 | traits => ['Getopt'], |
26 | isa => Bool, |
27 | is => 'ro', |
28 | documentation => 'Display this help and exit', |
29 | cmd_aliases => ['?', 'h'], |
d3082fac |
30 | ); |
31 | |
19529022 |
32 | sub _getopt_spec_exception {} |
33 | |
34 | sub _getopt_spec_warnings { |
35 | shift; |
36 | warn @_; |
37 | } |
38 | |
2b8d5598 |
39 | sub _getopt_full_usage { |
d3082fac |
40 | my $self = shift; |
41 | pod2usage(); |
42 | exit 0; |
43 | } |
44 | |
45 | before run => sub { |
46 | my $self = shift; |
2b8d5598 |
47 | $self->_getopt_full_usage if $self->help; |
d3082fac |
48 | }; |
49 | |
50 | sub run { |
51 | my $self = shift; |
52 | $self->_run_application; |
53 | } |
54 | |
55 | sub _application_args { |
56 | () |
57 | } |
58 | |
59 | sub _run_application { |
60 | my $self = shift; |
61 | my $app = $self->application_name; |
62 | Class::MOP::load_class($app); |
a1791811 |
63 | $app->run($self->_application_args); |
d3082fac |
64 | } |
65 | |
66 | 1; |
1628b022 |
67 | |
68 | =head1 NAME |
69 | |
70 | Catalyst::ScriptRole - Common functionality for Catalyst scripts. |
71 | |
72 | =head1 SYNOPSIS |
73 | |
12aa6ca4 |
74 | package MyApp::Script::Foo; |
75 | use Moose; |
76 | use namespace::autoclean; |
111d3c9a |
77 | |
2c298960 |
78 | with 'Catalyst::ScriptRole'; |
111d3c9a |
79 | |
ad8b4c91 |
80 | sub _application_args { ... } |
111d3c9a |
81 | |
1628b022 |
82 | =head1 DESCRIPTION |
83 | |
12aa6ca4 |
84 | Role with the common functionality of Catalyst scripts. |
85 | |
86 | =head1 METHODS |
87 | |
88 | =head2 run |
89 | |
90 | The method invoked to run the application. |
91 | |
92 | =head1 ATTRIBUTES |
93 | |
94 | =head2 application_name |
95 | |
96 | The name of the application class, e.g. MyApp |
97 | |
98 | =head1 SEE ALSO |
99 | |
100 | L<Catalyst> |
101 | |
102 | L<MooseX::Getopt> |
1628b022 |
103 | |
104 | =head1 AUTHORS |
105 | |
106 | Catalyst Contributors, see Catalyst.pm |
107 | |
108 | =head1 COPYRIGHT |
109 | |
110 | This library is free software, you can redistribute it and/or modify |
111 | it under the same terms as Perl itself. |
112 | |
113 | =cut |