]> git.vpit.fr Git - perl/modules/rgit.git/blob - App/Rgit/Command.pm
Update VPIT::TestHelpers to 15e8aee3
[perl/modules/rgit.git] / App / Rgit / Command.pm
1 package App::Rgit::Command;
2
3 use strict;
4 use warnings;
5
6 use Carp qw/croak/;
7
8 use Object::Tiny qw/cmd args/;
9
10 use App::Rgit::Utils qw/validate/;
11 use App::Rgit::Repository;
12
13 =head1 NAME
14
15 App::Rgit::Command - Base class for App::Rgit commands.
16
17 =head1 VERSION
18
19 Version 0.02
20
21 =cut
22
23 our $VERSION = '0.02';
24
25 =head1 DESCRIPTION
26
27 Base class for L<App::Rgit> commands.
28
29 This is an internal class to L<rgit>.
30
31 =head1 METHODS
32
33 =head2 C<< new cmd => $cmd, args => \@args >>
34
35 Creates a new command object for C<$cmd> that is bound to be called with arguments C<@args>.
36
37 =cut
38
39 my %commands;
40 __PACKAGE__->action($_ => 'Once') for qw/version help daemon init/, ' ';
41
42 sub new {
43  my ($class, %args) = &validate;
44  my $cmd = $args{cmd};
45  $cmd = ' ' unless defined $cmd;
46  my $action = $class->action($cmd);
47  if ($class eq __PACKAGE__) {
48   $class = $action;
49  } else {
50   croak "Command $cmd should be executed as a $action"
51                                unless $class->isa($action);
52  }
53  eval "require $action; 1" or croak "Couldn't load $action: $@";
54  $class->SUPER::new(
55   cmd  => $cmd,
56   args => $args{args} || [ ],
57  );
58 }
59
60 =head2 C<< action $cmd [ => $pkg ] >>
61
62 If C<$pkg> is supplied, handles command C<$cmd> with C<$pkg> objects.
63 Otherwise, returns the current class for C<$cmd>.
64
65 =cut
66
67 sub action {
68  my ($self, $cmd, $pkg) = @_;
69  if (not defined $cmd) {
70   return unless defined $self and ref $self and $self->isa(__PACKAGE__);
71   $cmd = $self->cmd;
72  }
73  unless (defined $pkg) {
74   return __PACKAGE__ . '::Each' unless defined $commands{$cmd};
75   return $commands{$cmd}
76  }
77  $pkg = __PACKAGE__ . '::' . $pkg unless $pkg =~ /:/;
78  $commands{$cmd} = $pkg;
79 }
80
81 =head2 C<cmd>
82
83 =head2 C<args>
84
85 Accessors.
86
87 =head2 C<run $conf>
88
89 Runs the command with a L<App::Rgit::Config> configuration object.
90 Stops as soon as one of the executed commands fails, and returns the corresponding exit code.
91 Returns zero when all went fine.
92 Implemented in subclasses.
93
94 =head1 SEE ALSO
95
96 L<rgit>.
97
98 =head1 AUTHOR
99
100 Vincent Pit, C<< <perl at profvince.com> >>, L<http://profvince.com>.
101    
102 You can contact me by mail or on C<irc.perl.org> (vincent).
103
104 =head1 BUGS
105
106 Please report any bugs or feature requests to C<bug-rgit at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=rgit>.  I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
107
108 =head1 SUPPORT
109
110 You can find documentation for this module with the perldoc command.
111
112     perldoc App::Rgit::Command
113
114 =head1 COPYRIGHT & LICENSE
115
116 Copyright 2008 Vincent Pit, all rights reserved.
117
118 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
119
120 =cut
121
122 1; # End of App::Rgit::Command