File Coverage

blib/lib/Term/Twiddle/Quiet.pm

Criterion	Covered	Total	%
statement	23	23	100.0
branch	1	2	50.0
condition			n/a
subroutine	7	7	100.0
pod	1	1	100.0
total	32	33	96.9

#
# This file is part of Term-Twiddle-Quiet
#
# This software is copyright (c) 2010 by Jerome Quelin.
#
# This is free software; you can redistribute it and/or modify it under
# the same terms as the Perl 5 programming language system itself.
#
use 5.008;
use strict;
use warnings;

package Term::Twiddle::Quiet;
our $VERSION = '1.100110';
# ABSTRACT: Twiddles a thingy while-u-wait if run interactively

use IO::Interactive qw{ is_interactive };
use Term::Twiddle;
use Test::MockObject;


# -- public methods


sub new {
    my $class = shift;

    # interactive: return the real object
    return Term::Twiddle->new(@_) if is_interactive;

    # not interactive: let's mock it
    my $mock = Test::MockObject->new;
    $mock->set_true($_) for qw{
        start stop thingy rate probability random stream
        type width delay
    };
    return $mock;
}

1;


=pod

=head1 NAME

Term::Twiddle::Quiet - Twiddles a thingy while-u-wait if run interactively

=head1 VERSION

version 1.100110

=head1 SYNOPSIS

    use Term::Twiddle::Quiet;
    my $tw = Term::Twiddle::Quiet->new( \%params );
    $tw->start;
    # do some stuff taking a long time in here
    $tw->stop;

=head1 DESCRIPTION

L is a nice module for showing spinning thingies on the
terminal while waiting for an action to complete.

L acts very much like that module when it is run
interactively. However, when it isn't run interactively (for example, as
a cron job) then it does not show the twiddle.

Other than this difference, it really act as a L with all
its options, methods and restrictions (of course, it supports the same
API) - cf its documentation for more information.

=head1 METHODS

=head2 my $tw = Term::Twiddle::Quiet->new( \%params );

Create and return twiddle. The twiddle will do nothing when activated if
the program is ran non-interactively, otherwise it'll return a plain
L object.

=head1 AUTHOR

  Jerome Quelin

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Jerome Quelin.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut


__END__