.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Test::Deep::UnorderedPairs 3pm"
.TH Test::Deep::UnorderedPairs 3pm "2016-12-25" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test::Deep::UnorderedPairs \- A Test::Deep plugin for comparing an unordered list of tuples
.SH "VERSION"
.IX Header "VERSION"
version 0.006
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use Test::More;
\&    use Test::Deep;
\&    use Test::Deep::UnorderedPairs;
\&
\&    cmp_deeply(
\&        {
\&            inventory => [
\&                pear => 6,
\&                peach => 5,
\&                apple => 1,
\&            ],
\&        },
\&        {
\&            inventory => unordered_pairs(
\&                apple => 1,
\&                peach => ignore,
\&                pear => 6,
\&            ),
\&        },
\&        \*(Aqgot the right inventory\*(Aq,
\&    );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides the sub \f(CW\*(C`unordered_pairs\*(C'\fR
(and \f(CW\*(C`tuples\*(C'\fR, \f(CW\*(C`samehash\*(C'\fR, as synonyms)
to indicate the data being tested is a list of pairs that should be tested
where the order of the pairs is insignificant.
.PP
This is useful when testing a function that returns a list of hash elements as
an arrayref, not a hashref.  One such application might be testing \s-1PSGI\s0
headers, which are passed around as an arrayref:
.PP
.Vb 8
\&    my $response = [
\&        \*(Aq200\*(Aq,
\&        [
\&            \*(AqContent\-Length\*(Aq => \*(Aq12\*(Aq,
\&            \*(AqContent\-Type\*(Aq => \*(Aqtext/plain\*(Aq,
\&        ],
\&        [ \*(Aqhello world!\*(Aq ],
\&    ];
\&
\&    # this test passes
\&    cmp_deeply(
\&        $response,
\&        [
\&            \*(Aq200\*(Aq,
\&            unordered_pairs(
\&                \*(AqContent\-Type\*(Aq => \*(Aqtext/plain\*(Aq,
\&                \*(AqContent\-Length\*(Aq => \*(Aq12\*(Aq,
\&            ],
\&            [ \*(Aqhello world!\*(Aq ],
\&        ],
\&        \*(Aqcheck headers as an arrayref of unordered pairs\*(Aq,
\&    );
.Ve
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .SS """unordered_pairs"""
.el .SS "\f(CWunordered_pairs\fP"
.IX Subsection "unordered_pairs"
Pass an (even-numbered) list of items to test
.ie n .SS """tuples"", ""samehash"""
.el .SS "\f(CWtuples\fP, \f(CWsamehash\fP"
.IX Subsection "tuples, samehash"
\&\f(CW\*(C`tuples\*(C'\fR and \f(CW\*(C`samehash\*(C'\fR are aliases for \f(CW\*(C`unordered_pairs\*(C'\fR.  I'm open to more names as well;
I'm not quite yet sure what the best nomenclature should be.
.PP
(Be aware that "\f(CW\*(C`samehash\*(C'\fR" is a bit of a misnomer, since if a key is
repeated, the comparison is \fBnot\fR equivalent to comparing as a hash.)
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
Ricardo Signes, for maintaining Test::Deep and for being the first consumer
of this module, in Router::Dumb.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Test::Deep
.SH "SUPPORT"
.IX Header "SUPPORT"
Bugs may be submitted through the \s-1RT\s0 bug tracker <https://rt.cpan.org/Public/Dist/Display.html?Name=Test-Deep-UnorderedPairs>
(or bug\-Test\-Deep\-UnorderedPairs@rt.cpan.org <mailto:bug-Test-Deep-UnorderedPairs@rt.cpan.org>).
.PP
There is also a mailing list available for users of this distribution, at
<http://lists.perl.org/list/perl\-qa.html>.
.PP
There is also an irc channel available for users of this distribution, at
\&\f(CW\*(C`#perl\*(C'\fR on \f(CW\*(C`irc.perl.org\*(C'\fR <irc://irc.perl.org/#perl-qa>.
.PP
I am also usually active on irc, as 'ether' at \f(CW\*(C`irc.perl.org\*(C'\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Karen Etheridge <ether@cpan.org>
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2013 by Karen Etheridge.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.