/ 
Assert-Refute-T-Array-0.17
River stage zero No dependents
/ Assert::Refute::T::Array

NAME

Assert::Refute::T::Array - Assertions about arrays for Assert::Refute suite

SYNOPSIS

Add array_of and is_sorted checks to both runtime checks and unit test scripts.

use Test::More;
use Assert::Refute qw(:core);
use Assert::Refute::T::Array;

Testing that array consists of given values:

array_of [ "foo", "bar", "baz" ], qr/ba/, "This fails because of foo";

array_of [
    { id => 42, name => "Answer to life" },
    { id => 137 },
], contract {
    package T;
    use Assert::Refute::T::Basic;
    like $_[0]->{name}, qr/^\w+$/;
    like $_[0]->{id}, qr/^\d+$/;
}, "This also fails";

Testing that array is ordered:

is_sorted { $a lt $b } [sort qw(foo bar bar baz)],
    "This fails because of repetition";
is_sorted { $a le $b } [sort qw(foo bar bar baz)],
    "This passes though";

Not only sorting, but other types of partial order can be tested:

is_sorted { $b->{start_date} eq $a->{end_date} }, \@reservations,
    "Next reservation aligned with the previous one";

EXPORTS

All of the below functions are exported by default:

array_of

array_of \@list, $criteria, [ "message" ]

Check that every item in the list matches criteria, which may be one of:

  • regex - just match against regular expression;

  • a functions - execute that function inside a single subcontract;

  • Assert::Refute::Contract - pass each element as argument to a separate subcontract.

is_sorted

is_sorted { $a ... $b } \@list, "message";

Check that condition about ($a, $b) holds for every two subsequent items in array.

Consider using reduce_subtest{ $a ... $b } instead if there's a complex condition inside.

map_subtest { ok $_ } \@list, "message";

Execute a subcontract that applies checks in { ... } to every element of an array.

Return value of code block is ignored.

Automatically succeeds if there are no elements.

reduce_subtest { $a ... $b } \@list, "message";

Applies checks in { ... } to every pair of subsequent elements in list. The element with lower number is $a, and with higher number is $b.

reduce_subtest { ... } [1,2,3,4];

would induce pairs:

($a = 1, $b = 2), ($a = 2, $b = 3), ($a = 3, $b = 4)

Return value of code block is ignored.

Automatically succeeds if list has less than 2 elements.

AUTHOR

Konstantin S. Uvarin, <khedin at gmail.com>

BUGS

Please report bugs via github or RT:

SUPPORT

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

perldoc Assert::Refute::T::Array

You can also look for information at:

ACKNOWLEDGEMENTS

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:

http://www.perlfoundation.org/artistic_license_2_0

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.