File Coverage

blib/lib/Acme/SGABRIEL/Utils/Test.pm

Criterion	Covered	Total	%
statement	15	19	78.9
branch	0	2	0.0
condition			n/a
subroutine	5	6	83.3
pod	1	1	100.0
total	21	28	75.0

package Acme::SGABRIEL::Utils::Test;

use 5.006;
use strict;
use warnings FATAL => 'all';
use Test::More;
use Test::Builder;

=head1 NAME

Acme::SGABRIEL::Utils::Test

=head1 VERSION

Version 0.01
This is following the book "Intermediate Perl"
I was told to do this, so I am doing it.
This is not meant for actual use. (which is why it is under "Acme")

=cut

our $VERSION = '0.01';


=head1 SYNOPSIS

Tests the Util::sum function or other value-based functions

    use Acme::SGABRIEL::Utils::Test qw( sum_ok );
	use Acme::SGABRIEL::Utils qw( sum );
	...
	sum_ok( sum(2,2,0), 4, "sum(2,2,0) gives us a value of (4)" )
    ...

=head1 EXPORT

 sum_ok (default)

=head1 SUBROUTINES/METHODS

=head2 sum_ok( $expected, $actual, $description )

$expected 		The expression or value that generates the expected value
$actual         Place the sum() call here, it will return the actual value
$description    (optional) describes the test

=cut

sub sum_ok {
	my ($expected, $actual, $description) = (@_);
	$description = "ensure expected ($expected) equals actual ($actual)"
		unless defined $description;
	my $tester = Test::Builder->new();
	return $tester->ok( $expected == $actual, $description );
}


=head1 AUTHOR

Gabriel Sharp, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.




=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Acme::SGABRIEL::Utils::Test


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker (report bugs here)

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back



=head1 LICENSE AND COPYRIGHT

Copyright 2014 Gabriel Sharp.

This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at:

L

Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


=cut

1; # End of Acme::SGABRIEL::Utils::Test