.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 turned on, 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 "Test::Unit::Assertion::CodeRef 3pm"
.TH Test::Unit::Assertion::CodeRef 3pm "2015-12-30" "perl v5.22.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::Unit::Assertion::CodeRef \- A delayed evaluation assertion using a Coderef
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    require Test::Unit::Assertion::CodeRef;
\&
\&    my $assert_eq =
\&      Test::Unit::Assertion::CodeRef\->new(sub {
\&        $_[0] eq $_[1]
\&          or Test::Unit::Failure\->throw(\-text =>
\&                                          "Expected \*(Aq$_[0]\*(Aq, got \*(Aq$_[1]\*(Aq\en");
\&      });
\&
\&    $assert_eq\->do_assertion(\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq);
.Ve
.PP
Although this is how you'd use Test::Unit::Assertion::CodeRef
directly, it is more usually used indirectly via
Test::Unit::Test::assert, which instantiates a
Test::Unit::Assertion::CodeRef when passed a Coderef as its first
argument.
.SH "IMPLEMENTS"
.IX Header "IMPLEMENTS"
Test::Unit::Assertion::CodeRef implements the Test::Unit::Assertion
interface, which means it can be plugged into the Test::Unit::TestCase
and friends' \f(CW\*(C`assert\*(C'\fR method with no ill effects.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is used by the framework to allow us to do assertions in a
\&'functional' manner. It is typically used generated automagically in
code like:
.PP
.Vb 4
\&    $self\->assert(sub {
\&                    $_[0] == $_[1]
\&                      or $self\->fail("Expected $_[0], got $_[1]");
\&                  }, 1, 2);
.Ve
.PP
(Note that if Damian Conway's Perl6 \s-1RFC\s0 for currying ever comes to
pass then we'll be able to do this as:
.PP
.Vb 1
\&    $self\->assert(^1 == ^2 || $self\->fail("Expected ^1, got ^2"), 1, 2)
.Ve
.PP
which will be nice...)
.PP
If you have a working B::Deparse installed with your perl installation
then, if an assertion fails, you'll see a listing of the decompiled
coderef (which will be sadly devoid of comments, but should still be
useful)
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (c) 2001 Piers Cawley <pdcawley@iterative\-software.com>.
.PP
All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Test::Unit::TestCase
.IP "\(bu" 4
Test::Unit::Assertion