File Coverage

blib/lib/Piper/Config.pm

Criterion	Covered	Total	%
statement	26	26	100.0
branch			n/a
condition			n/a
subroutine	9	9	100.0
pod			n/a
total	35	35	100.0

#####################################################################
## AUTHOR: Mary Ehlers, [e-mail]
## ABSTRACT: Configuration object for Piper
#####################################################################

package Piper::Config;

use v5.10;
use strict;
use warnings;

use Carp;
use Types::Common::Numeric qw(PositiveInt);
use Types::LoadableClass qw(ClassDoes);
use Types::Standard qw(ClassName);

use Moo;
use namespace::clean;

our $VERSION = '0.03'; # from Piper-0.03.tar.gz

#pod =head1 SYNOPSIS
#pod
#pod =for stopwords queueing
#pod
#pod   # Defaults
#pod   use Piper (
#pod       batch_size   => 200,
#pod       logger_class => 'Piper::Logger',
#pod       queue_class  => 'Piper::Queue',
#pod   );
#pod
#pod =head1 DESCRIPTION
#pod
#pod A configuration object, instantiated during import of the L module according to any supplied import arguments.
#pod
#pod =head1 ATTRIBUTES
#pod
#pod =head2 batch_size
#pod
#pod The default batch size used by pipeline segments which do not have a locally defined C and do not have a parent segment with a defined C.
#pod
#pod The C attribute must be a positive integer.
#pod
#pod The default C is 200.
#pod
#pod =cut

has batch_size => (
    is => 'lazy',
    isa => PositiveInt,
    default => 200,
);

#pod =head2 logger_class
#pod
#pod The logger class is used for printing debug and info statements, issuing warnings, and throwing
#pod errors.
#pod
#pod The C attribute must be a valid class that does the role defined by L.
#pod
#pod The default C is L.
#pod
#pod =cut

has logger_class => (
    is => 'lazy',
    isa => ClassDoes['Piper::Role::Logger'],
    default => 'Piper::Logger',
);

#pod =head2 queue_class
#pod
#pod The queue class handles the queueing of data for each of the pipeline segments.
#pod
#pod The C attribute must be a valid class that does the role defined by L.
#pod
#pod The default C is L.
#pod
#pod =cut

has queue_class => (
    is => 'lazy',
    isa => ClassDoes['Piper::Role::Queue'],
    default => 'Piper::Queue',
);

1;

__END__