File Coverage

blib/lib/Piper/Queue.pm

Criterion	Covered	Total	%
statement	30	30	100.0
branch			n/a
condition	2	2	100.0
subroutine	10	10	100.0
pod	4	4	100.0
total	46	46	100.0

#####################################################################
## AUTHOR: Mary Ehlers, [e-mail]
## ABSTRACT: Simple FIFO queue used by Piper
#####################################################################

package Piper::Queue;

use v5.10;
use strict;
use warnings;

use Types::Standard qw(ArrayRef);

use Moo;
use namespace::clean;

with 'Piper::Role::Queue';

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

#pod =head1 SYNOPSIS
#pod
#pod =for stopwords dequeued
#pod
#pod   use Piper::Queue;
#pod
#pod   my $queue = Piper::Queue->new();
#pod   $queue->enqueue(qw(x y));
#pod   $queue->ready;         # 2
#pod   $queue->dequeue;       # 'x'
#pod   $queue->requeue('x');
#pod   $queue->dequeue;       # 'x'
#pod
#pod =head1 CONSTRUCTOR
#pod
#pod =head2 new
#pod
#pod =cut

has queue => (
    is => 'ro',
    isa => ArrayRef,
    default => sub { [] },
);

#pod =head1 METHODS
#pod
#pod =head2 dequeue($num)
#pod
#pod Remove and return at most C<$num> items from the queue.  The default S is 1>.
#pod
#pod If C<$num> is greater than the number of items remaining in the queue, only the number remaining will be dequeued.
#pod
#pod Returns an array of items if wantarray, otherwise returns the last of the dequeued items, which allows singleton dequeues:
#pod
#pod     my @results = $queue->dequeue($num);
#pod     my $single  = $queue->dequeue;
#pod
#pod =cut

sub dequeue {
    my ($self, $num) = @_;
    $num //= 1;
    splice @{$self->queue}, 0, $num;
}

#pod =head2 enqueue(@items)
#pod
#pod Add C<@items> to the queue.
#pod
#pod =cut

sub enqueue {
    my $self = shift;
    push @{$self->queue}, @_;
}

#pod =head2 ready
#pod
#pod Returns the number of elements in the queue.
#pod
#pod =cut

sub ready {
    my ($self) = @_;
    return scalar @{$self->queue};
}

#pod =head2 requeue(@items)
#pod
#pod Inserts C<@items> to the top of the queue in an order such that C would subsequently return C<$items[0]> and so forth.
#pod
#pod =cut

sub requeue {
    my $self = shift;
    unshift @{$self->queue}, @_;
}

1;

__END__