Add built local::lib
[catagits/Gitalist.git] / local-lib5 / man / man3 / Test::Moose.3pm
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  | will give a
29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "Test::Moose 3"
132 .TH Test::Moose 3 "2009-11-19" "perl v5.8.7" "User Contributed Perl Documentation"
133 .SH "NAME"
134 Test::Moose \- Test functions for Moose specific features
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 .Vb 2
138 \&  use Test::More plan => 1;
139 \&  use Test::Moose;
140 .Ve
141 .PP
142 .Vb 3
143 \&  meta_ok($class_or_obj, "... Foo has a \->meta");
144 \&  does_ok($class_or_obj, $role, "... Foo does the Baz role");
145 \&  has_attribute_ok($class_or_obj, $attr_name, "... Foo has the 'bar' attribute");
146 .Ve
147 .SH "DESCRIPTION"
148 .IX Header "DESCRIPTION"
149 This module provides some useful test functions for Moose based classes. It
150 is an experimental first release, so comments and suggestions are very welcome.
151 .SH "EXPORTED FUNCTIONS"
152 .IX Header "EXPORTED FUNCTIONS"
153 .IP "\fBmeta_ok ($class_or_object)\fR" 4
154 .IX Item "meta_ok ($class_or_object)"
155 Tests if a class or object has a metaclass.
156 .ie n .IP "\fBdoes_ok ($class_or_object, \fB$role\fB, ?$message)\fR" 4
157 .el .IP "\fBdoes_ok ($class_or_object, \f(CB$role\fB, ?$message)\fR" 4
158 .IX Item "does_ok ($class_or_object, $role, ?$message)"
159 Tests if a class or object does a certain role, similar to what \f(CW\*(C`isa_ok\*(C'\fR
160 does for the \f(CW\*(C`isa\*(C'\fR method.
161 .ie n .IP "\fBhas_attribute_ok($class_or_object, \fB$attr_name\fB, ?$message)\fR" 4
162 .el .IP "\fBhas_attribute_ok($class_or_object, \f(CB$attr_name\fB, ?$message)\fR" 4
163 .IX Item "has_attribute_ok($class_or_object, $attr_name, ?$message)"
164 Tests if a class or object has a certain attribute, similar to what \f(CW\*(C`can_ok\*(C'\fR
165 does for the methods.
166 .SH "TODO"
167 .IX Header "TODO"
168 .IP "Convert the Moose test suite to use this module." 4
169 .IX Item "Convert the Moose test suite to use this module."
170 .PD 0
171 .IP "Here is a list of possible functions to write" 4
172 .IX Item "Here is a list of possible functions to write"
173 .RS 4
174 .IP "immutability predicates" 4
175 .IX Item "immutability predicates"
176 .IP "anon-class predicates" 4
177 .IX Item "anon-class predicates"
178 .IP "discovering original method from modified method" 4
179 .IX Item "discovering original method from modified method"
180 .IP "attribute metaclass predicates (attribute_isa?)" 4
181 .IX Item "attribute metaclass predicates (attribute_isa?)"
182 .RE
183 .RS 4
184 .RE
185 .PD
186 .SH "SEE ALSO"
187 .IX Header "SEE ALSO"
188 .IP "Test::More" 4
189 .IX Item "Test::More"
190 .SH "BUGS"
191 .IX Header "BUGS"
192 All complex software has bugs lurking in it, and this module is no
193 exception. If you find a bug please either email me, or add the bug
194 to cpan\-RT.
195 .SH "AUTHOR"
196 .IX Header "AUTHOR"
197 Anders Nor Berle <debolaz@gmail.com>
198 .PP
199 Stevan Little <stevan@iinteractive.com>
200 .SH "COPYRIGHT AND LICENSE"
201 .IX Header "COPYRIGHT AND LICENSE"
202 Copyright 2007\-2009 by Infinity Interactive, Inc.
203 .PP
204 <http://www.iinteractive.com>
205 .PP
206 This library is free software; you can redistribute it and/or modify
207 it under the same terms as Perl itself.