1Test::Base::Filter(3) User Contributed Perl DocumentationTest::Base::Filter(3)
2
6 Test::Base::Filter - Default Filter Class for Test::Base
7
9 package MyTestSuite;
10 use Test::Base -Base;
11 ... reusable testing code ...
13 package MyTestSuite::Filter;
15 use Test::Base::Filter -Base;
16 sub my_filter1 {
18 ...
19 }
20
22 Filters are the key to writing effective data driven tests with
23 Test::Base. Test::Base::Filter is a class containing a large default
24 set of generic filters. You can easily subclass it to add/override
25 functionality.
26
28 This is a list of the default stock filters (in alphabetic order):
29 append
31 list => list
33 Append a string to each element of a list.
35 --- numbers lines chomp append=-#\n join
37 one
38 two
39 three
40 array
42 list => scalar
44 Turn a list of values into an anonymous array reference.
46 base64_decode
48 scalar => scalar
50 Decode base64 data. Useful for binary tests.
52 base64_encode
54 scalar => scalar
56 Encode base64 data. Useful for binary tests.
58 chomp
60 list => list
62 Remove the final newline from each string value in a list.
64 chop
66 list => list
68 Remove the final char from each string value in a list.
70 dumper
72 scalar => list
74 Take a data structure (presumably from another filter like eval) and
76 use Data::Dumper to dump it in a canonical fashion.
77 escape
79 scalar => scalar
81 Unescape all backslash escaped chars.
83 eval
85 scalar => list
87 Run Perl's "eval" command against the data and use the returned value
89 as the data.
90 eval_all
92 scalar => list
94 Run Perl's "eval" command against the data and return a list of 4 val‐
96 ues:
97 1) The return value
99 2) The error in $@
100 3) Captured STDOUT
101 4) Captured STDERR
102 eval_stderr
104 scalar => scalar
106 Run Perl's "eval" command against the data and return the captured
108 STDERR.
109 eval_stdout
111 scalar => scalar
113 Run Perl's "eval" command against the data and return the captured STD‐
115 OUT.
116 exec_perl_stdout
118 list => scalar
120 Input Perl code is written to a temp file and run. STDOUT is captured
122 and returned.
123 flatten
125 scalar => list
127 Takes a hash or array ref and flattens it to a list.
129 get_url
131 scalar => scalar
133 The text is chomped and considered to be a url. Then LWP::Simple::get
135 is used to fetch the contents of the url.
136 hash
138 list => scalar
140 Turn a list of key/value pairs into an anonymous hash reference.
142 head[=number]
144 list => list
146 Takes a list and returns a number of the elements from the front of it.
148 The default number is one.
149 join
151 list => scalar
153 Join a list of strings into a scalar.
155 Join
157 Join the list of strings inside a list of array refs and return the
159 strings in place of the array refs.
160 lines
162 scalar => list
164 Break the data into an anonymous array of lines. Each line (except pos‐
166 sibly the last one if the "chomp" filter came first) will have a new‐
167 line at the end.
168 norm
170 scalar => scalar
172 Normalize the data. Change non-Unix line endings to Unix line endings.
174 prepend=string
176 list => list
178 Prepend a string onto each of a list of strings.
180 read_file
182 scalar => scalar
184 Read the file named by the current content and return the file's con‐
186 tent.
187 regexp[=xism]
189 scalar => scalar
191 The "regexp" filter will turn your data section into a regular expres‐
193 sion object. You can pass in extra flags after an equals sign.
194 If the text contains more than one line and no flags are specified,
196 then the 'xism' flags are assumed.
197 reverse
199 list => list
201 Reverse the elements of a list.
203 Reverse
205 list => list
207 Reverse the list of strings inside a list of array refs.
209 slice=x[,y]
211 list => list
213 Returns the element number x through element number y of a list.
215 sort
217 list => list
219 Sorts the elements of a list in character sort order.
221 Sort
223 list => list
225 Sort the list of strings inside a list of array refs.
227 split[=string⎪pattern]
229 scalar => list
231 Split a string in into a list. Takes a optional string or regexp as a
233 parameter. Defaults to /\s+/. Same as Perl "split".
234 Split[=string⎪pattern]
236 list => list
238 Split each of a list of strings and turn them into array refs.
240 strict
242 scalar => scalar
244 Prepend the string:
246 use strict;
248 use warnings;
249 to the block's text.
251 tail[=number]
253 list => list
255 Return a number of elements from the end of a list. The default number
257 is one.
258 trim
260 list => list
262 Remove extra blank lines from the beginning and end of the data. This
264 allows you to visually separate your test data with blank lines.
265 unchomp
267 list => list
269 Add a newline to each string value in a list.
271 write_file[=filename]
273 scalar => scalar
275 Write the content of the section to the named file. Return the file‐
277 name.
278 yaml
280 scalar => list
282 Apply the YAML::Load function to the data block and use the resultant
284 structure. Requires YAML.pm.
285
287 Ingy döt Net <ingy@cpan.org>
288
290 Copyright (c) 2006. Ingy döt Net. All rights reserved. Copyright (c)
291 2005. Brian Ingerson. All rights reserved.
292 This program is free software; you can redistribute it and/or modify it
294 under the same terms as Perl itself.
295 See http://www.perl.com/perl/misc/Artistic.html
297perl v5.8.8 2006-08-26 Test::Base::Filter(3)