.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test2::Compare::Custom 3"
.TH Test2::Compare::Custom 3 2024-05-12 "perl v5.38.2" "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
Test2::Compare::Custom \- Custom field check for comparisons.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Sometimes you want to do something complicated or unusual when validating a
field nested inside a deep data structure. You could pull it out of the
structure and test it separately, or you can use this to embed the check. This
provides a way for you to write custom checks for fields in deep comparisons.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 9
\&    my $cus = Test2::Compare::Custom\->new(
\&        name => \*(AqIsRef\*(Aq,
\&        operator => \*(Aqref(...)\*(Aq,
\&        stringify_got => 1,
\&        code => sub {
\&            my %args = @_;
\&            return $args{got} ? 1 : 0;
\&        },
\&    );
\&
\&    # Pass
\&    is(
\&        { a => 1, ref => {},   b => 2 },
\&        { a => 1, ref => $cus, b => 2 },
\&        "This will pass"
\&    );
\&
\&    # Fail
\&    is(
\&        {a => 1, ref => \*(Aqnotref\*(Aq, b => 2},
\&        {a => 1, ref => $cus,     b => 2},
\&        "This will fail"
\&    );
.Ve
.SH ARGUMENTS
.IX Header "ARGUMENTS"
Your custom sub will be passed 4 arguments in a hash:
.PP
.Vb 5
\&    code => sub {
\&        my %args = @_;
\&        # provides got, exists, operator, name
\&        return ref($args{got}) ? 1 : 0;
\&    },
.Ve
.PP
\&\f(CW$_\fR is also localized to \f(CW\*(C`got\*(C'\fR to make it easier for those who need to use
regexes.
.IP got 4
.IX Item "got"
.PD 0
.ie n .IP $_ 4
.el .IP \f(CW$_\fR 4
.IX Item "$_"
.PD
The value to be checked.
.IP exists 4
.IX Item "exists"
This will be a boolean. This will be true if \f(CW\*(C`got\*(C'\fR exists at all. If
\&\f(CW\*(C`exists\*(C'\fR is false then it means \f(CW\*(C`got\*(C'\fR is not simply undef, but doesn't
exist at all (think checking the value of a hash key that does not exist).
.IP operator 4
.IX Item "operator"
The operator specified at construction.
.IP name 4
.IX Item "name"
The name provided at construction.
.SH METHODS
.IX Header "METHODS"
.ie n .IP "$code = $cus\->code" 4
.el .IP "\f(CW$code\fR = \f(CW$cus\fR\->code" 4
.IX Item "$code = $cus->code"
Returns the coderef provided at construction.
.ie n .IP "$name = $cus\->name" 4
.el .IP "\f(CW$name\fR = \f(CW$cus\fR\->name" 4
.IX Item "$name = $cus->name"
Returns the name provided at construction.
.ie n .IP "$op = $cus\->operator" 4
.el .IP "\f(CW$op\fR = \f(CW$cus\fR\->operator" 4
.IX Item "$op = $cus->operator"
Returns the operator provided at construction.
.ie n .IP "$stringify = $cus\->stringify_got" 4
.el .IP "\f(CW$stringify\fR = \f(CW$cus\fR\->stringify_got" 4
.IX Item "$stringify = $cus->stringify_got"
Returns the stringify_got flag provided at construction.
.ie n .IP "$bool = $cus\->verify(got => $got, exists => $bool)" 4
.el .IP "\f(CW$bool\fR = \f(CW$cus\fR\->verify(got => \f(CW$got\fR, exists => \f(CW$bool\fR)" 4
.IX Item "$bool = $cus->verify(got => $got, exists => $bool)"
.SH SOURCE
.IX Header "SOURCE"
The source code repository for Test2\-Suite can be found at
\&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
.SH MAINTAINERS
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH AUTHORS
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.IP "Daniel Böhmer <dboehmer@cpan.org>" 4
.IX Item "Daniel Böhmer <dboehmer@cpan.org>"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2018 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR