Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Tools::Class.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::Tools::Class 3pm"
61 .TH Test2::Tools::Class 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::Tools::Class \- Test2 implementation of the tools for testing classes.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Test2 based tools for validating classes and objects. These are similar to
71 some tools from Test::More, but they have a more consistent interface.
72 .SH SYNOPSIS
73 .IX Header "SYNOPSIS"
74 .Vb 1
75 \& use Test2::Tools::Class;
76 \&
77 \& isa_ok($CLASS_OR_INSTANCE, $PARENT_CLASS1, $PARENT_CLASS2, ...);
78 \& isa_ok($CLASS_OR_INSTANCE, [$PARENT_CLASS1, $PARENT_CLASS2, ...], "Test Name");
79 \&
80 \& can_ok($CLASS_OR_INSTANCE, $METHOD1, $METHOD2, ...);
81 \& can_ok($CLASS_OR_INSTANCE, [$METHOD1, $METHOD2, ...], "Test Name");
82 \&
83 \& DOES_ok($CLASS_OR_INSTANCE, $ROLE1, $ROLE2, ...);
84 \& DOES_ok($CLASS_OR_INSTANCE, [$ROLE1, $ROLE2, ...], "Test Name");
85 .Ve
86 .SH EXPORTS
87 .IX Header "EXPORTS"
88 All subs are exported by default.
89 .ie n .IP "can_ok($thing, @methods)" 4
90 .el .IP "can_ok($thing, \f(CW@methods\fR)" 4
91 .IX Item "can_ok($thing, @methods)"
92 .PD 0
93 .ie n .IP "can_ok($thing, \e@methods, $test_name)" 4
94 .el .IP "can_ok($thing, \e@methods, \f(CW$test_name\fR)" 4
95 .IX Item "can_ok($thing, @methods, $test_name)"
96 .PD
97 This checks that \f(CW$thing\fR (either a class name, or a blessed instance) has the
98 specified methods.
99 .Sp
100 If the second argument is an arrayref then it will be used as the list of
101 methods leaving the third argument to be the test name.
102 .ie n .IP "isa_ok($thing, @classes)" 4
103 .el .IP "isa_ok($thing, \f(CW@classes\fR)" 4
104 .IX Item "isa_ok($thing, @classes)"
105 .PD 0
106 .ie n .IP "isa_ok($thing, \e@classes, $test_name)" 4
107 .el .IP "isa_ok($thing, \e@classes, \f(CW$test_name\fR)" 4
108 .IX Item "isa_ok($thing, @classes, $test_name)"
109 .PD
110 This checks that \f(CW$thing\fR (either a class name, or a blessed instance) is or
111 subclasses the specified classes.
112 .Sp
113 If the second argument is an arrayref then it will be used as the list of
114 classes leaving the third argument to be the test name.
115 .ie n .IP "DOES_ok($thing, @roles)" 4
116 .el .IP "DOES_ok($thing, \f(CW@roles\fR)" 4
117 .IX Item "DOES_ok($thing, @roles)"
118 .PD 0
119 .ie n .IP "DOES_ok($thing, \e@roles, $test_name)" 4
120 .el .IP "DOES_ok($thing, \e@roles, \f(CW$test_name\fR)" 4
121 .IX Item "DOES_ok($thing, @roles, $test_name)"
122 .PD
123 This checks that \f(CW$thing\fR (either a class name, or a blessed instance) does
124 the specified roles.
125 .Sp
126 If the second argument is an arrayref then it will be used as the list of
127 roles leaving the third argument to be the test name.
128 .Sp
129 \&\fBNote 1:\fR This uses the \f(CW\*(C`$class\->DOES(...)\*(C'\fR method, not the \f(CWdoes()\fR
130 method Moose provides.
131 .Sp
132 \&\fBNote 2:\fR Not all perls have the \f(CWDOES()\fR method, if you use this on those
133 perls the test will be skipped.
134 .SH SOURCE
135 .IX Header "SOURCE"
136 The source code repository for Test2\-Suite can be found at
137 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
138 .SH MAINTAINERS
139 .IX Header "MAINTAINERS"
140 .IP "Chad Granum <[email protected]>" 4
141 .IX Item "Chad Granum <[email protected]>"
142 .SH AUTHORS
143 .IX Header "AUTHORS"
144 .IP "Chad Granum <[email protected]>" 4
145 .IX Item "Chad Granum <[email protected]>"
146 .SH COPYRIGHT
147 .IX Header "COPYRIGHT"
148 Copyright Chad Granum <[email protected]>.
149 .PP
150 This program is free software; you can redistribute it and/or
151 modify it under the same terms as Perl itself.
152 .PP
153 See \fIhttp://dev.perl.org/licenses/\fR