This is 1.19

[perl/modules/Test-Valgrind.git] / lib / Test / Valgrind / Action.pm

diff --git a/lib/Test/Valgrind/Action.pm b/lib/Test/Valgrind/Action.pm
index d680855ae9bbd8aa3ec98fe8922bc0bf8692343e..b1bf352f0530f96c378b31e70608d64cdb5b4ee3 100644 (file)
--- a/lib/Test/Valgrind/Action.pm
+++ b/lib/Test/Valgrind/Action.pm
@@ -9,11 +9,11 @@ Test::Valgrind::Action - Base class for Test::Valgrind actions.
 
 =head1 VERSION
 
-Version 1.01
+Version 1.19
 
 =cut
 
-our $VERSION = '1.01';
+our $VERSION = '1.19';
 
 =head1 DESCRIPTION
 
@@ -23,11 +23,15 @@ Actions are called each time a tool encounter an error and decide what to do wit
 
 =cut
 
-use base qw/Test::Valgrind::Carp/;
+use Test::Valgrind::Util;
+
+use base qw<Test::Valgrind::Component Test::Valgrind::Carp>;
 
 =head1 METHODS
 
-=head2 C<< new action => $action >>
+=head2 C<new>
+
+    my $tva = Test::Valgrind::Action->new(action => $action);
 
 Creates a new action object of type C<$action> by requiring and redispatching the method call to the module named C<$action> if it contains C<'::'> or to C<Test::Valgrind::Action::$action> otherwise.
 The class represented by C<$action> must inherit this class.
@@ -41,19 +45,14 @@ sub new {
  my %args = @_;
 
  if ($class eq __PACKAGE__) {
-  my $action = delete $args{action} || 'Test';
-  $action =~ s/[^\w:]//g;
-  $action = __PACKAGE__ . "::$action" if $action !~ /::/;
-  $class->_croak("Couldn't load action $action: $@")
-                                               unless eval "require $action; 1";
+  my ($action, $msg) = Test::Valgrind::Util::validate_subclass(
+   $args{action} || 'Test',
+  );
+  $class->_croak($msg) unless defined $action;
   return $action->new(%args);
  }
 
- my $self = bless { }, $class;
-
- $self->started(undef);
-
- $self;
+ $class->SUPER::new(@_);
 }
 
 =head2 C<do_suppressions>
@@ -64,37 +63,22 @@ Indicates if the action wants C<valgrind> to run in suppression-generating mode
 
 sub do_suppressions { 0 }
 
-=head2 C<started>
-
-Specifies whether the action is running (C<1>), stopped (C<0>) or was never started (C<undef>).
-
-=cut
-
-sub started { @_ <= 1 ? $_[0]->{started} : ($_[0]->{started} = $_[1]) }
+=head2 C<start>
 
-=head2 C<start $session>
+    $tva->start($session);
 
 Called when the C<$session> starts.
 
-Defaults to set L</started>.
-
-=cut
-
-sub start {
- my ($self) = @_;
-
- $self->_croak('Action already started') if $self->started;
- $self->started(1);
+Defaults to set L<Test::Valgrind::Component/started>.
 
- return;
-}
+=head2 C<report>
 
-=head2 C<report $session, $report>
+    $tva->report($session, $report);
 
 Invoked each time the C<valgrind> process attached to the C<$session> spots an error.
 C<$report> is a L<Test::Valgrind::Report> object describing the error.
 
-Defaults to check L</started>.
+Defaults to check L<Test::Valgrind::Component/started>.
 
 =cut
 
@@ -106,7 +90,9 @@ sub report {
  return;
 }
 
-=head2 C<abort $session, $msg>
+=head2 C<abort>
+
+    $tva->abort($session, $msg);
 
 Triggered when the C<$session> has to interrupt the action.
 
@@ -116,24 +102,17 @@ Defaults to croak.
 
 sub abort { $_[0]->_croak($_[2]) }
 
-=head2 C<finish $session>
-
-Called when the C<$session> finishes.
-
-Defaults to clear L</started>.
+=head2 C<finish>
 
-=cut
+    $tva->finish($session);
 
-sub finish {
- my ($self) = @_;
+Called when the C<$session> finishes.
 
- return unless $self->started;
- $self->started(0);
+Defaults to clear L<Test::Valgrind::Component/started>.
 
- return;
-}
+=head2 C<status>
 
-=head2 C<status $session>
+    $tva->status($session);
 
 Returns the status code corresponding to the last run of the action.
 
@@ -152,7 +131,7 @@ sub status {
 
 =head1 SEE ALSO
 
-L<Test::Valgrind>, L<Test::Valgrind::Session>.
+L<Test::Valgrind>, L<Test::Valgrind::Component>, L<Test::Valgrind::Session>.
 
 =head1 AUTHOR
 
@@ -173,7 +152,7 @@ You can find documentation for this module with the perldoc command.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2009 Vincent Pit, all rights reserved.
+Copyright 2009,2010,2011,2013,2015,2016 Vincent Pit, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.