Doc update

[perl/modules/rgit.git] / lib / App / Rgit / Command.pm

diff --git a/lib/App/Rgit/Command.pm b/lib/App/Rgit/Command.pm
index b32095f8a581302093aacf6f0414123648e350e7..cf58e94b80e8f241a00ecdccb101221d80686a1a 100644 (file)
--- a/lib/App/Rgit/Command.pm
+++ b/lib/App/Rgit/Command.pm
@@ -5,10 +5,9 @@ use warnings;
 
 use Carp qw/croak/;
 
-use Object::Tiny qw/cmd cwd_as_repo args repos/;
+use Object::Tiny qw/cmd args policy/;
 
-use App::Rgit::Utils qw/validate/;
-use App::Rgit::Repository;
+use App::Rgit::Utils qw/validate :codes/;
 
 =head1 NAME
 
@@ -16,11 +15,11 @@ App::Rgit::Command - Base class for App::Rgit commands.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.03
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.03';
 
 =head1 DESCRIPTION
 
@@ -30,32 +29,31 @@ This is an internal class to L<rgit>.
 
 =head1 METHODS
 
-=head2 C<< new cmd => $cmd, args => \@args, repos => \@repos >>
+=head2 C<< new cmd => $cmd, args => \@args >>
 
-Creates a new command object for C<$cmd> that will called for all repositories C<@repos> with arguments C<@args>.
+Creates a new command object for C<$cmd> that is bound to be called with arguments C<@args>.
 
 =cut
 
 my %commands;
-__PACKAGE__->action($_ => 'Once') for qw/version help daemon init/, ' ';
+__PACKAGE__->action($_ => 'Once') for qw/daemon gui help init version/, ' ';
 
 sub new {
  my ($class, %args) = &validate;
  my $cmd = $args{cmd};
- return unless defined $cmd;
+ $cmd = ' ' unless defined $cmd;
  my $action = $class->action($cmd);
- croak "Command $cmd shouldn't be executed as an $action"
-                           unless $class eq __PACKAGE__ or $class->isa($action);
- my @repos = grep $_->isa('App::Rgit::Repository'),
-              ref $args{repos} eq 'ARRAY' ? @{$args{repos}} : $args{repos};
+ if ($class eq __PACKAGE__) {
+  $class = $action;
+ } else {
+  croak "Command $cmd should be executed as a $action"
+                               unless $class->isa($action);
+ }
  eval "require $action; 1" or croak "Couldn't load $action: $@";
- my $r = App::Rgit::Repository->new(fake => 1);
- return unless defined $r;
- $action->SUPER::new(
-  cmd         => $cmd,
-  args        => $args{args} || [ ],
-  repos       => \@repos,
-  cwd_as_repo => $r,
+ $class->SUPER::new(
+  cmd    => $cmd,
+  args   => $args{args} || [ ],
+  policy => $args{policy},
  );
 }
 
@@ -68,9 +66,10 @@ Otherwise, returns the current class for C<$cmd>.
 
 sub action {
  my ($self, $cmd, $pkg) = @_;
- $cmd = $self->cmd if !defined $cmd
-                   and defined $self and $self->isa(__PACKAGE__);
- return unless defined $cmd;
+ if (not defined $cmd) {
+  return unless defined $self and ref $self and $self->isa(__PACKAGE__);
+  $cmd = $self->cmd;
+ }
  unless (defined $pkg) {
   return __PACKAGE__ . '::Each' unless defined $commands{$cmd};
   return $commands{$cmd}
@@ -79,21 +78,30 @@ sub action {
  $commands{$cmd} = $pkg;
 }
 
-=head2 C<cmd>
+=head2 C<report $conf, $repo, $status>
+
+=cut
+
+sub report {
+ my ($self) = @_;
+ my $cb = $self->policy;
+ return $_[3] ? LAST : NEXT unless $cb;
+ my $code = $cb->(@_);
+ return defined $code ? $code : NEXT;
+}
 
-=head2 C<cwd_as_repo>
+=head2 C<cmd>
 
 =head2 C<args>
 
-=head2 C<repos>
+=head2 C<policy>
 
 Accessors.
 
 =head2 C<run $conf>
 
 Runs the command with a L<App::Rgit::Config> configuration object.
-Stops as soon as one of the executed commands fails, and returns the corresponding exit code.
-Returns zero when all went fine.
+Handles back the code to return to the system and the last policy.
 Implemented in subclasses.
 
 =head1 SEE ALSO