.\" -*- 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::Require 3"
.TH Test2::Require 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::Require \- Base class and documentation for skip\-unless type test
packages.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Test2::Require::* packages are packages you load to ensure your test file is
skipped unless a specific requirement is met. Modules in this namespace may
subclass Test2::Require if they wish, but it is not strictly necessary to do
so.
.SH "HOW DO I WRITE A 'REQUIRE' MODULE?"
.IX Header "HOW DO I WRITE A 'REQUIRE' MODULE?"
.SS "AS A SUBCLASS"
.IX Subsection "AS A SUBCLASS"
.Vb 3
\&    package Test2::Require::Widget;
\&    use strict;
\&    use warnings;
\&
\&    use base \*(AqTest2::Require\*(Aq;
\&
\&    sub HAVE_WIDGETS { ... };
\&
\&    sub skip {
\&        my $class = shift;
\&        my @import_args = @_;
\&
\&        if (HAVE_WIDGETS()) {
\&            # We have widgets, do not skip
\&            return undef;
\&        }
\&        else {
\&            # No widgets, skip the test
\&            return "Skipped because there are no widgets" unless HAVE_WIDGETS();
\&        }
\&    }
\&
\&    1;
.Ve
.PP
A subclass of Test2::Require simply needs to implement a \f(CWskip()\fR method.
This method will receive all import arguments. This method should return undef
if the test should run, and should return a reason for skipping if the test
should be skipped.
.SS STAND-ALONE
.IX Subsection "STAND-ALONE"
If you do not wish to subclass Test2::Require then you should write an
\&\f(CWimport()\fR method:
.PP
.Vb 3
\&    package Test2::Require::Widget;
\&    use strict;
\&    use warnings;
\&
\&    use Test2::API qw/context/;
\&
\&    sub HAVE_WIDGETS { ... };
\&
\&    sub import {
\&        my $class = shift;
\&
\&        # Have widgets, should run.
\&        return if HAVE_WIDGETS();
\&
\&        # Use the context object to create the event
\&        my $ctx = context();
\&        $ctx\->plan(0, SKIP => "Skipped because there are no widgets");
\&        $ctx\->release;
\&    }
\&
\&    1;
.Ve
.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>"
.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