Current File : //proc/thread-self/root/usr/share/perl5/vendor_perl/TAP/Parser/Scheduler/Job.pm
package TAP::Parser::Scheduler::Job;
use strict;
use warnings;
use Carp;
=head1 NAME
TAP::Parser::Scheduler::Job - A single testing job.
=head1 VERSION
Version 3.42
=cut
our $VERSION = '3.42';
=head1 SYNOPSIS
use TAP::Parser::Scheduler::Job;
=head1 DESCRIPTION
Represents a single test 'job'.
=head1 METHODS
=head2 Class Methods
=head3 C<new>
my $job = TAP::Parser::Scheduler::Job->new(
$filename, $description
);
Given the filename and description of a test as scalars, returns a new
L<TAP::Parser::Scheduler::Job> object.
=cut
sub new {
my ( $class, $name, $desc, @ctx ) = @_;
return bless {
filename => $name,
description => $desc,
@ctx ? ( context => \@ctx ) : (),
}, $class;
}
=head2 Instance Methods
=head3 C<on_finish>
$self->on_finish(\&method).
Register a closure to be called when this job is destroyed. The callback
will be passed the C<TAP::Parser::Scheduler::Job> object as it's only argument.
=cut
sub on_finish {
my ( $self, $cb ) = @_;
$self->{on_finish} = $cb;
}
=head3 C<finish>
$self->finish;
Called when a job is complete to unlock it. If a callback has been registered
with C<on_finish>, it calls it. Otherwise, it does nothing.
=cut
sub finish {
my $self = shift;
if ( my $cb = $self->{on_finish} ) {
$cb->($self);
}
}
=head2 Attributes
$self->filename;
$self->description;
$self->context;
These are all "getters" which return the data set for these attributes during object construction.
=head3 C<filename>
=head3 C<description>
=head3 C<context>
=cut
sub filename { shift->{filename} }
sub description { shift->{description} }
sub context { @{ shift->{context} || [] } }
=head3 C<as_array_ref>
For backwards compatibility in callbacks.
=cut
sub as_array_ref {
my $self = shift;
return [ $self->filename, $self->description, $self->{context} ||= [] ];
}
=head3 C<is_spinner>
$self->is_spinner;
Returns false indicating that this is a real job rather than a
'spinner'. Spinners are returned when the scheduler still has pending
jobs but can't (because of locking) return one right now.
=cut
sub is_spinner {0}
1;
Mini Shell