forked from paultcochrane/app-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CLI.pm
326 lines (220 loc) · 6.88 KB
/
CLI.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
package App::CLI;
use strict;
use warnings;
use 5.006;
use Class::Load qw( load_class );
our $VERSION = '0.45';
=head1 NAME
App::CLI - Dispatcher module for command line interface programs
=head1 SYNOPSIS
package MyApp;
use base 'App::CLI'; # the DISPATCHER of your App
# it's not necessary putting the dispatcher
# on the top level of your App
package main;
MyApp->dispatch; # call dispatcher in where you want
package MyApp::List;
use base qw(App::CLI::Command); # any (SUB)COMMAND of your App
use constant options => (
"h|help" => "help",
"verbose" => "verbose",
'n|name=s' => 'name',
);
use constant subcommands => qw(User Nickname type); # if you want subcommands
# automatically dispatch to subcommands
# when invoke $ myapp list [user|nickname|--type]
# note 'type' is not capitalized
# it is a deprecated subcommand
sub run {
my ($self, @args) = @_;
print "verbose" if $self->{verbose};
my $name = $self->{name}; # get arg following long option --name
if ($self->{help}) {
# if $ myapp list --help or $ myapp list -h
# just only output PODs
} else {
# do something when imvoking $ my app list
# without subcommand and --help
}
}
package MyApp::List::User;
use base qw(App::CLI::Command);
use constant options => (
"h|help" => "help",
);
sub run {
my ($self,@args) = @_;
# code for listing user
}
pakcage MyApp::List::Nickname;
use base qw(App::CLI::Command);
use constant options => (
"sort=s" => "sort",
);
sub run {
my ($self,@args) = @_;
# code for listing nickname
}
package MyApp::List::type; # old genre of subcommand could not cascade infinitely
use base qw(MyApp::List); # should inherit its parent's command
sub run {
my ($self, @args);
# run to here when invoking $ myapp list --type
}
package MyApp::Help;
use base 'App::CLI::Command::Help';
use constant options => (
'verbose' => 'verbose',
);
sub run {
my ($self, @arg) = @_;
# do something
$self->SUPER(@_); # App::CLI::Command::Help would output POD of each command
}
=head1 DESCRIPTION
C<App::CLI> dispatches CLI (command line interface) based commands
into command classes. It also supports subcommand and per-command
options.
=cut
use App::CLI::Helper;
use Getopt::Long ();
use constant alias => ();
use constant global_options => ();
use constant options => ();
sub new {
my ($class, @args) = @_;
my $self = bless {@args}, $class;
$self->{'app_argv'} = undef;
return $self;
}
sub app_argv {
my $self = shift;
if (@_) {
$self->{'app_argv'} = shift;
}
return $self->{'app_argv'};
}
sub prepare {
my $self = shift;
my $data = {};
$self->get_opt(
[qw(no_ignore_case bundling pass_through)],
opt_map($data, $self->global_options)
);
my $command_name = shift @ARGV;
my $cmd = $self->get_cmd($command_name, @_, $data);
while ($cmd->cascadable) {
$cmd = $cmd->cascading;
}
$self->get_opt(
[qw(no_ignore_case bundling)],
opt_map($cmd, $cmd->command_options)
);
$cmd = $cmd->subcommand;
return $cmd;
}
=head3 get_opt([@config], %opt_map)
Give options map, processed by L<Getopt::Long::Parser>.
=cut
sub get_opt {
my ($self, $config, @app_options) = @_;
my $p = Getopt::Long::Parser->new;
$p->configure(@$config);
my $err = '';
local $SIG{__WARN__} = sub {
my $msg = shift;
$err .= "$msg"
};
my @current_argv = @ARGV;
$self->app_argv(\@current_argv);
die $self->error_opt($err) unless $p->getoptions(@app_options);
}
sub opt_map {
my ($self, %opt) = @_;
return map { $_ => ref($opt{$_}) ? $opt{$_} : \$self->{$opt{$_}}} keys %opt;
}
=head3
Interface of dispatcher
=cut
sub dispatch {
my ($self, @args) = @_;
$self = $self->new unless ref $self;
$self->app($self) if $self->can('app');
my $cmd = $self->prepare(@args);
$cmd->run_command(@ARGV);
}
=head3 cmd_map($cmd)
Find the name of the package implementing the requested command.
The command is first searched for in C<alias>. If the alias exists and points
to a package name starting with the C<+> sign, then that package name (minus
the C<+> sign) is returned. This makes it possible to map commands to arbitrary
packages.
Otherwise, the package is searched for in the result of calling C<commands>,
and a package name is constructed by upper-casing the first character of the
command name, and appending it to the package name of the app itself.
If both of these fail, and the command does not map to any package name,
C<undef> is returned instead.
=cut
sub cmd_map {
my ($self, $cmd) = @_;
my %alias = $self->alias;
if (exists $alias{$cmd}) {
$cmd = $alias{$cmd};
# Alias points to package name, return immediately
return $cmd if $cmd =~ s/^\+//;
}
($cmd) = grep { $_ eq $cmd } $self->commands;
# No such command
return unless $cmd;
my $base = ref $self->app;
return join '::', $base, ucfirst $cmd;
}
sub error_cmd {
my ($self, $pkg) = @_;
my $cmd;
if (defined($pkg)) {
$cmd = ref($pkg) || $pkg;
}
else {
$cmd = ${$self->app_argv}[0];
}
return "Command '$cmd' not recognized, try $0 --help.\n";
}
sub error_opt { $_[1] }
=head3 get_cmd($cmd, @arg)
Return subcommand of first level via C<$ARGV[0]>.
=cut
sub get_cmd {
my ($self, $cmd, $data) = @_;
die $self->error_cmd($cmd) unless $cmd && $cmd eq lc($cmd);
my $base = ref $self;
my $pkg = $self->cmd_map($cmd);
die $self->error_cmd($cmd) unless $pkg;
load_class $pkg;
die $self->error_cmd($cmd) unless $pkg->can('run');
my @arg = defined $data ? %$data : ();
$cmd = $pkg->new(@arg);
$cmd->app($self);
return $cmd;
}
=head1 SEE ALSO
=over 4
=item *
L<App::CLI::Command>
=item *
L<Getopt::Long>
=back
=head1 MODULES USE App::CLI
L<Jifty::Script>, L<App::gh>, L<App::I18N>
=head1 AUTHORS
Chia-liang Kao E<lt>clkao@clkao.orgE<gt>
Yo-An Lin E<lt>cornelius.howl@gmail.comE<gt>
Shelling E<lt>navyblueshellingford@gmail.comE<gt>
Paul Cochrane E<lt>paul@liekut.deE<gt> (current maintainer)
=head1 COPYRIGHT
Copyright 2005-2006 by Chia-liang Kao E<lt>clkao@clkao.orgE<gt>.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See L<http://www.perl.com/perl/misc/Artistic.html>
=cut
1;