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

NAME

Assert::Refute::T::Hash - Assertions about hashes for Assert::Refute suite

SYNOPSIS

use Test::More;
use Assert::Refute::T::Hash;

keys_are { foo => 42, bar => 137 }, ["foo"], ["bar"], "Hash keys as expected";

EXPORTS

All of the below functions are exported by default:

keys_are \%hash, \@required, \@allowed, "Message"

Check that keys in hash are exactly as expected:

  • if \@required is present, make sure that all keys listed there exist;

  • if \@allowed is present, make sure no keys are present except those listed in either required or allowed.

values_are \%hash, \%spec

For each key in %spec, check corresponding value in %hash:

  • if spec is undef, only accept undefined or missing value;

  • if spec is a string or number, check exact match (is);

  • if spec is a regular expression, apply it (like);

  • if spec is a contract or sub, apply it to the value (subcontract);

[NOTE] This test should die if any other value appears in the spec. However, it does not yet, instead producing a warning and an unconditionally failed test.

SEE ALSO

If you are interested in validating hashes, Validator::LIVR may be handy even though it has nothing to do with testing/assertions.

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::Hash

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.