Test::Base::Filter(3)

💖 NAME 💖

Test::Base::Filter — Default Filter Class for Test::Base, aka the stock filter bestie for your data-driven tests. This is the Test::Base::Filter(3) page from the User Contributed Perl Documentation, and we’re gonna get you comfy with it 💅✨

✨ SYNOPSIS ✨

okay so here’s the setup vibe, bestie:

package MyTestSuite;
use Test::Base -Base;

... reusable testing code ...

package MyTestSuite::Filter;
use Test::Base::Filter -Base;

sub my_filter1 {
    ...
}

🦋 DESCRIPTION 🦋

Filters are literally the key to writing effective data driven tests with Test::Base. Test::Base::Filter is a class containing a large default set of generic filters. You can easily subclass it to add/override functionality — main character energy, no cap 🫶

🌸 FILTERS 🌸

This is a list of the default stock filters (in alphabetic order), and yes we’re going through all of them 🎀

🌟 append

type: list => list — Append a string to each element of a list.

--- numbers lines chomp append=-#\n join
one
two
three

🍓 array

type: list => scalar — Turn a list of values into an anonymous array reference.

🧚 base64_decode

type: scalar => scalar — Decode base64 data. Useful for binary tests.

🧚 base64_encode

type: scalar => scalar — Encode base64 data. Useful for binary tests.

🌈 chomp

type: list => list — Remove the final newline from each string value in a list.

🌈 chop

type: list => list — Remove the final char from each string value in a list.

💜 dumper

type: scalar => list — Take a data structure (presumably from another filter like eval) and use Data::Dumper to dump it in a canonical fashion.

✨ escape

type: scalar => scalar — Unescape all backslash escaped chars.

🔥 eval

type: scalar => list — Run Perl’s eval command against the data and use the returned value as the data.

🔥 eval_all

type: scalar => list — Run Perl’s eval command against the data and return a list of 4 values:

1) The return value
2) The error in $@
3) Captured STDOUT
4) Captured STDERR

💀 eval_stderr

type: scalar => scalar — Run Perl’s eval command against the data and return the captured STDERR.

💀 eval_stdout

type: scalar => scalar — Run Perl’s eval command against the data and return the captured STDOUT.

🎀 exec_perl_stdout

type: list => scalar — Input Perl code is written to a temp file and run. STDOUT is captured and returned.

🦋 flatten

type: scalar => list — Takes a hash or array ref and flattens it to a list.

🌐 get_url

type: scalar => scalar — The text is chomped and considered to be a url. Then LWP::Simple::get is used to fetch the contents of the url.

🫶 hash

type: list => scalar — Turn a list of key/value pairs into an anonymous hash reference.

👑 head[=number]

type: list => list — Takes a list and returns a number of the elements from the front of it. The default number is one.

🎶 join

type: list => scalar — Join a list of strings into a scalar.

💫 Join

Join the list of strings inside a list of array refs and return the strings in place of the array refs.

🧵 lines

type: scalar => list — Break the data into an anonymous array of lines. Each line (except possibly the last one if the chomp filter came first) will have a newline at the end.

🌸 norm

type: scalar => scalar — Normalize the data. Change non-Unix line endings to Unix line endings.

🎀 prepend=string

type: list => list — Prepend a string onto each of a list of strings.

📖 read_file

type: scalar => scalar — Read the file named by the current content and return the file’s content.

🪄 regexp[=xism]

type: scalar => scalar — The regexp filter will turn your data section into a regular expression object. You can pass in extra flags after an equals sign.

If the text contains more than one line and no flags are specified, then the xism flags are assumed.

🔁 reverse

type: list => list — Reverse the elements of a list.

🔁 Reverse

type: list => list — Reverse the list of strings inside a list of array refs.

🍰 slice=x[,y]

type: list => list — Returns the element number x through element number y of a list.

⭐ sort

type: list => list — Sorts the elements of a list in character sort order.

⭐ Sort

type: list => list — Sort the list of strings inside a list of array refs.

✂️ split[=string|pattern]

type: scalar => list — Split a string into a list. Takes an optional string or regexp as a parameter. Defaults to s+. Same as Perl split.

✂️ Split[=string|pattern]

type: list => list — Split each of a list of strings and turn them into array refs.

🛡️ strict

type: scalar => scalar — Prepend the string:

use strict;
use warnings;

to the block’s text.

🐾 tail[=number]

type: list => list — Return a number of elements from the end of a list. The default number is one.

🧼 trim

type: list => list — Remove extra blank lines from the beginning and end of the data. This allows you to visually separate your test data with blank lines.

🌙 unchomp

type: list => list — Add a newline to each string value in a list.

📝 write_file[=filename]

type: scalar => scalar — Write the content of the section to the named file. Return the filename.

🧚 yaml

type: scalar => list — Apply the YAML::Load function to the data block and use the resultant structure. Requires YAML.pm.

👑 AUTHOR 👑

Ingy döt Net <ingy@cpan.org> — iconic author behavior, periodt 💜

🌈 COPYRIGHT 🌈

Copyright 2005-2018. Ingy döt Net. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See <http://www.perl.com/perl/misc/Artistic.html>.

---

okay bestie, that’s the whole Test::Base::Filter(3) manual page — perl v5.42.0, dated 2018-04-20. The footer says Test::Base::Filter(3) one more time, and we are obsessed 💋✨