]> git.vpit.fr Git - perl/modules/rgit.git/blob - Command.pm
a873b9a6a694c9d09252822a42b41b67cc1448a9
[perl/modules/rgit.git] / Command.pm
1 package App::Rgit::Command;
2
3 use strict;
4 use warnings;
5
6 use Carp ();
7
8 use App::Rgit::Utils qw/:codes/;
9
10 =head1 NAME
11
12 App::Rgit::Command - Base class for App::Rgit commands.
13
14 =head1 VERSION
15
16 Version 0.06
17
18 =cut
19
20 our $VERSION = '0.06';
21
22 =head1 DESCRIPTION
23
24 Base class for L<App::Rgit> commands.
25
26 This is an internal class to L<rgit>.
27
28 =head1 METHODS
29
30 =head2 C<< new cmd => $cmd, args => \@args >>
31
32 Creates a new command object for C<$cmd> that is bound to be called with arguments C<@args>.
33
34 =cut
35
36 my %commands;
37 __PACKAGE__->action($_ => 'Once') for qw/daemon gui help init version/, ' ';
38
39 sub new {
40  my $class = shift;
41  $class = ref $class || $class;
42
43  my %args = @_;
44
45  my $cmd = $args{cmd};
46  $cmd = ' ' unless defined $cmd;
47
48  my $action = $class->action($cmd);
49
50  if ($class eq __PACKAGE__) {
51   $class = $action;
52  } else {
53   Carp::confess("Command $cmd should be executed as a $action")
54                                                     unless $class->isa($action);
55  }
56
57  eval "require $action; 1" or Carp::confess("Couldn't load $action: $@");
58
59  bless {
60   cmd    => $cmd,
61   args   => $args{args} || [ ],
62   policy => $args{policy},
63  }, $class;
64 }
65
66 =head2 C<< action $cmd [ => $pkg ] >>
67
68 If C<$pkg> is supplied, handles command C<$cmd> with C<$pkg> objects.
69 Otherwise, returns the current class for C<$cmd>.
70
71 =cut
72
73 sub action {
74  my ($self, $cmd, $pkg) = @_;
75  if (not defined $cmd) {
76   return unless defined $self and ref $self and $self->isa(__PACKAGE__);
77   $cmd = $self->cmd;
78  }
79  unless (defined $pkg) {
80   return __PACKAGE__ . '::Each' unless defined $commands{$cmd};
81   return $commands{$cmd}
82  }
83  $pkg = __PACKAGE__ . '::' . $pkg unless $pkg =~ /:/;
84  $commands{$cmd} = $pkg;
85 }
86
87 =head2 C<report $conf, $repo, $status>
88
89 Reports that the execution of the command in C<$repo> exited with C<$status> to the current command's policy.
90 Returns what policy C<report> method returned, which should be one of the policy codes listed in C<App::Rgit::Utils>.
91
92 =cut
93
94 sub report {
95  my ($self) = @_;
96
97  my $code = $self->policy->handle(@_);
98
99  return defined $code ? $code : NEXT;
100 }
101
102 =head2 C<cmd>
103
104 =head2 C<args>
105
106 =head2 C<policy>
107
108 Read-only accessors.
109
110 =cut
111
112 BEGIN {
113  eval "sub $_ { \$_[0]->{$_} }" for qw/cmd args policy/;
114 }
115
116 =head2 C<run $conf>
117
118 Runs the command with a L<App::Rgit::Config> configuration object.
119 Handles back the code to return to the system and the last policy.
120 Implemented in subclasses.
121
122 =head1 SEE ALSO
123
124 L<rgit>.
125
126 =head1 AUTHOR
127
128 Vincent Pit, C<< <perl at profvince.com> >>, L<http://profvince.com>.
129
130 You can contact me by mail or on C<irc.perl.org> (vincent).
131
132 =head1 BUGS
133
134 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.
135
136 =head1 SUPPORT
137
138 You can find documentation for this module with the perldoc command.
139
140     perldoc App::Rgit::Command
141
142 =head1 COPYRIGHT & LICENSE
143
144 Copyright 2008-2009 Vincent Pit, all rights reserved.
145
146 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
147
148 =cut
149
150 1; # End of App::Rgit::Command