File Coverage

blib/lib/Test/Ranger.pm

Criterion	Covered	Total	%
statement	66	66	100.0
branch	5	8	62.5
condition	2	2	100.0
subroutine	17	17	100.0
pod	5	7	71.4
total	95	100	95.0

package Test::Ranger;

use 5.010000;
use strict;
use warnings;
use Carp;

use version 0.77; our $VERSION = qv('0.0.4');

use Test::More;                 # Standard framework for writing test scripts
use Data::Lock qw( dlock );     # Declare locked scalars, arrays, and hashes
use Scalar::Util;               # General-utility scalar subroutines
use Scalar::Util::Reftype;      # Alternate reftype() interface

use Test::Ranger::List;

## use

# Alternate uses
#~ use Devel::Comments;

#============================================================================#

# Pseudo-globals

#~ # Literal hash keys
#~ dlock( my $coderef     = '-coderef');    # cref to code under test

#----------------------------------------------------------------------------#

#=========# CLASS METHOD
#
#   my $obj     = $class->new($self);
#   my $obj     = $class->new();
#   my $obj     = $class->new({ -a  => 'x' });
#   my $obj     = $class->new([ 1, 2, 3, 4 ]);
#
# Purpose   : Object constructor
# Parms     : $class    : Any subclass of this class
#           : $self     : Hashref or arrayref
# Returns   : $self
# Invokes   : init(), Test::Ranger::List::new()
#
# If invoked with $class only, blesses and returns an empty hashref.
# If invoked with $class and a hashref, blesses and returns it.
# If invoked with $class and an arrayref, invokes ::List::new().
#
sub new {
    my $class   = shift;
    my $self    = shift || {};      # default: hashref

    if ( (reftype $self)->array ) {
        $self       = Test::Ranger::List->new($self);
    }
    else {
        bless ($self => $class);
        $self->init();
    };

    return $self;
}; ## new

#=========# OBJECT METHOD
#
#   $obj->init();
#
# Purpose   : Initialize housekeeping info.
# Parms     : $class    : Any subclass of this class
#           : $self     : Hashref
# Returns   : $self
#
sub init {
    my $self        = shift;

    $self->{-plan_counter}      = 0;
    $self->{-expanded}          = 0;

    return $self;
}; ## init

#=========# OBJECT METHOD
#
#   $single->expand();
#
# Purpose   : Expand/parse declaration into canonical form.
# Parms     : $class
#           : $self
# Returns   : $self
#
sub expand {
    my $self        = shift;

    # Default givens
    if ( !$self->{-given}{-args} ) {
        $self->{-given}{-args}     = [];
    };

    # Default expectations
    if ( !$self->{-return}{-want} ) {
        $self->{-return}{-want}     = 1;
    };



    $self->{-expanded}          = 1;

    return $self;
}; ## expand

#=========# OBJECT METHOD
#
#   $single->execute();
#
#       Execute a $single object.
#
sub execute {
    my $self        = shift;

    $self->expand() if !$self->{-expanded};

    my $coderef     = $self->{-coderef};
    my @args        = @{ $self->{-given}{-args} };
    ### $coderef

    $self->{-return}{-got}    = &$coderef( @args );

    return $self;

}; ## execute

#=========# OBJECT METHOD
#
#   $single->check();
#
#       Check results in a $single object.
#
sub check {
    my $self        = shift;

    is( $self->{-return}{-got}, $self->{-return}{-want}, $self->{-fullname} );
    $self->{-plan_counter}++;

    return $self;

}; ## check

#=========# OBJECT METHOD
#
#   $single->test();
#
#       Execute and check a $single object.
#
sub test {
    my $self        = shift;

    $self->execute();
    $self->check();

    return $self;

}; ## test

#=========# OBJECT METHOD
#
#   $single->done();
#
#       Conclude testing.
#
sub done {
    my $self        = shift;

    done_testing( $self->{-done_counter} );

    return $self;

}; ## done


## END MODULE
1;
#============================================================================#
__END__