File Coverage

blib/lib/Beam/Runnable.pm

Criterion	Covered	Total	%
statement	12	12	100.0
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	16	16	100.0

package Beam::Runnable;
our $VERSION = '0.016';
# ABSTRACT: Role for runnable objects

#pod =head1 SYNOPSIS
#pod
#pod     package My::Runnable;
#pod     use Moo;
#pod     with 'Beam::Runnable';
#pod     sub run { ... }
#pod
#pod =head1 DESCRIPTION
#pod
#pod This role declares your object as runnable by the C command.
#pod Runnable objects will be listed by the C command, and their
#pod documentation displayed by the C command.
#pod
#pod =head2 The C method
#pod
#pod The C method is the main function of your object. See below for its
#pod arguments and return value.
#pod
#pod The C method should be as small as possible, ideally only parsing
#pod command-line arguments and delegating to other objects to do the real
#pod work. Though your runnable object can be used in other code, the API of
#pod the C method is a terrible way to do that, and it is better to keep
#pod your business logic and other important code in another class.
#pod
#pod =head2 Documentation
#pod
#pod The C command will display the documentation of your module:
#pod the C (abstract), C, C, C,
#pod C, and C sections. This is the same as what
#pod L produces by default.
#pod
#pod The C command, when listing runnable objects, will display
#pod either the C attribute or the C POD section (abstract)
#pod next to the service name.
#pod
#pod =head2 Additional Roles
#pod
#pod Additional roles can add common functionality to your runnable script.
#pod Some of these are included in the C distribution:
#pod
#pod =over
#pod
#pod =item L
#pod
#pod This role will add a timeout using Perl's built-in
#pod L function. Once the timeout is reached, the
#pod program will print a warning and exit with an error code.
#pod
#pod =back
#pod
#pod =head1 SEE ALSO
#pod
#pod L, L
#pod
#pod =cut

use strict;
use warnings;
use Moo::Role;
with 'Beam::Service';
use Types::Standard qw( Str );

#pod =attr summary
#pod
#pod A summary of the task to be run. This will be displayed by the C
#pod list> command in the list.
#pod
#pod =cut

has summary => (
    is => 'ro',
    isa => Str,
);

#pod =method run
#pod
#pod     my $exit_code = $obj->run( @argv );
#pod
#pod Execute the runnable object with the given arguments and returning the
#pod exit status. C<@argv> is passed-in from the command line and may contain
#pod options (which you can parse using L
#pod function|Getopt::Long/Parsing options from an arbitrary array>.
#pod
#pod =cut

requires 'run';

1;

__END__