File Coverage

blib/lib/Assert/Refute/T/Deep.pm

Criterion	Covered	Total	%
statement	19	19	100.0
branch			n/a
condition	2	3	66.6
subroutine	7	7	100.0
pod			n/a
total	28	29	96.5

package Assert::Refute::T::Deep;

use 5.006;
use strict;
use warnings;
our $VERSION = '0.03';

=head1 NAME

Assert::Refute::T::Deep - Test::Deep plugin for Assert::Refute

=head1 SYNOPSIS

See L for what a C block is for.
In a nutshell, it's a set of L-like assertions
that appends its results to a "report" object
rather than standard output.

This module allows to use L with L:

    use Assert::Refute;
    use Assert::Refute::T::Deep;

    my $report = try_refute {
        cmp_deeply $my_data, $spec, "Data is as expected";
    };

    if (!$report->is_passing) {
        warn $report->get_tap;
    };


=head1 EXPORT

Whatever is exported by L is also re-exported by this module.

=cut

use parent qw(Exporter);
use Assert::Refute::Build;
use Test::Deep::NoTest qw(:all);

# Blindly reexport whatever Test::Deep has
our @EXPORT      = @Test::Deep::EXPORT;
our @EXPORT_OK   = @Test::Deep::EXPORT_OK;
our %EXPORT_TAGS = %Test::Deep::EXPORT_TAGS;

=head2 cmp_deeply $got, $expected, "Message"

Compare data and report discrepancies if found.
This only works if an L contract in being executed.

=cut

# Remove the implementation imported from Test::Deep
#     to avoid redefine warnings.
undef *cmp_deeply;

build_refute cmp_deeply => sub {
    my ($ok, $stack) = cmp_details( @_ );
    return !$ok && deep_diag($stack);
}, args => 2, export => 1;

=head1 AUTHOR

Konstantin S. Uvarin, C<<  >>

=head1 BUGS

This module should be merged into either Assert::Refute or Test::Deep.
Suggestions welcome.

Please report bugs via github or RT:

=over

=item * L

=item * C

=item * L

=back

=head1 SUPPORT

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

    perldoc Assert::Refute::T::Deep

You can also look for information at:

=over 4

=item * Github: L

=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 ACKNOWLEDGEMENTS


=head1 LICENSE AND COPYRIGHT

Copyright 2018 Konstantin S. Uvarin.

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 Assert::Refute::T::Deep