File Coverage

blib/lib/Console/ProgressBar.pm

Criterion	Covered	Total	%
statement	46	52	88.4
branch	4	6	66.6
condition			n/a
subroutine	13	14	92.8
pod	5	8	62.5
total	68	80	85.0

package Console::ProgressBar;
use 5.008001;
use strict;
use warnings;
use utf8;

our $VERSION = "1.01";

sub new {
    my ($class,$_title,$_maxValue,$configuration) = @_;
    my $this = {
        _index => 0,
        title => $_title,
        titleMaxSize => 30,
        maxValue => $_maxValue,
        length => 20,
        segment => '#'
    };
    bless($this,$class);

    if(defined($configuration)) {
        my %conf = %{ $configuration };
        foreach my $parameter (keys %conf) {
            $this->{$parameter} = $conf{$parameter};
        }
    }

    return $this;
}

sub _calculateCurrentValue {
    my($this) = @_;
    return int( ( $this->{_index} / $this->{maxValue} ) * 100 );
}

sub _getGraphicBars {
    my($this,$percentage) = @_;
    my $bars = "";
    my $nbrBars = int( ($percentage / 100) * $this->{length} );
    $bars = $this->{segment} x $nbrBars;

    return $bars;
}

sub reset {
    my ($this) = @_;
    $this->{_index} = 0;

    return $this;
}

sub setTitle {
    my ($this,$title) = @_;
    $this->{title} = $title;

    return $this;
}

sub setIndex {
    my ($this,$value) = @_;
    $this->{_index} = $value;

    return $this;
}

sub getIndex {
    my ($this)= @_;
    return $this->{_index};
}

sub next {
    my ($this) = @_;
    if( $this->{_index} < $this->{maxValue} ) {
        $this->{_index}++;
    }
    return $this;
}

sub back {
    my ($this) = @_;
    if($this->{_index} > 0) {
        $this->{_index}--;
    }
    return $this;
}

sub render {
    my ($this) = @_;

    my $percentage = $this->_calculateCurrentValue();
    my $bars = $this->_getGraphicBars($percentage);

    my $progressBar = sprintf("%-$this->{titleMaxSize}s [%-$this->{length}s] %d%%",$this->{title},$bars,$percentage);
    print "$progressBar\r";
    $|++;
}

1;
__END__