File Coverage

blib/lib/IPC/Open3/Callback/CommandRunner.pm

Criterion	Covered	Total	%
statement	58	63	92.0
branch	8	12	66.6
condition			n/a
subroutine	15	16	93.7
pod	5	5	100.0
total	86	96	89.5

use strict;
use warnings;

package IPC::Open3::Callback::CommandRunner;
$IPC::Open3::Callback::CommandRunner::VERSION = '1.19';
# ABSTRACT: A utility class that wraps IPC::Open3::Callback with available output buffers and an option to die on failure instead of returning exit code.

use Hash::Util qw(lock_keys);
use IPC::Open3::Callback;
use IPC::Open3::Callback::CommandFailedException;

sub new {
    return bless( {}, shift )->_init(@_);
}

sub _build_callback {
    my ( $self, $out_or_err, $options ) = @_;

    if ( defined( $options->{ $out_or_err . '_callback' } ) ) {
        return $options->{ $out_or_err . '_callback' };
    }
    elsif ( $options->{ $out_or_err . '_buffer' } ) {
        $self->{ $out_or_err . '_buffer' } = ();
        return sub {
            push( @{ $self->{ $out_or_err . '_buffer' } }, shift );
        };
    }
    return;
}

sub _clear_buffers {
    my ($self) = @_;
    delete( $self->{out_buffer} );
    delete( $self->{err_buffer} );
}

sub _condense {
    my ( $self, $buffer ) = @_;

    if ( $self->{$buffer} ) {
        $self->{$buffer} = [ join( '', @{ $self->{$buffer} } ) ];
        return $self->{$buffer}[0];
    }

    return;
}

sub get_err_buffer {
    return $_[0]->_condense('err_buffer');
}

sub _init {
    my ( $self, @options ) = @_;

    $self->{command_runner} = IPC::Open3::Callback->new(@options);

    lock_keys( %{$self}, keys( %{$self} ), 'out_buffer', 'err_buffer' );

    return $self;
}

sub _options {
    my ( $self, %options ) = @_;

    $options{out_callback} = $self->_build_callback( 'out', \%options );
    $options{err_callback} = $self->_build_callback( 'err', \%options );

    return %options;
}

sub get_out_buffer {
    return $_[0]->_condense('out_buffer');
}

sub run {
    my ( $self, @command ) = @_;
    my %options = ();

    # if last arg is hashref, its command options not arg...
    if ( ref( $command[-1] ) eq 'HASH' ) {
        %options = $self->_options( %{ pop(@command) } );
    }

    $self->_clear_buffers();

    return $self->{command_runner}->run_command( @command, \%options );
}

sub run_or_die {
    my ( $self, @command ) = @_;
    my %options = ();

    # if last arg is hashref, its command options not arg...
    if ( ref( $command[-1] ) eq 'HASH' ) {
        %options = $self->_options( %{ pop(@command) } );
    }

    $self->_clear_buffers();

    my $exit_code = $self->{command_runner}->run_command( @command, \%options );
    if ($exit_code) {
        my $exception = IPC::Open3::Callback::CommandFailedException->new(
            \@command, $exit_code,
            scalar( $self->get_out_buffer() ),
            scalar( $self->get_err_buffer() )
        );
        die($exception);
    }

    return $self->get_out_buffer();
}

1;

__END__