Test2::...Grabber(3)

📦 version 1.302214, in opensuse-leap 16.0

💖 NAME 💖

Bestie, this is the Test2::...Grabber(3) page — aka Test2::Util::Grabber — from the User Contributed Perl Documentation. It’s literally an object used to temporarily intercept all events. Yes, all of them. Iconic behavior. 💅

🌸 DESCRIPTION 🌸

Once created, this object will intercept and stash all events sent to the shared Test2::Hub object. Once the object is destroyed, events will once again be sent to the shared hub. It’s giving temporary main-character portal energy. ✨

🦋 SYNOPSIS 🦋

use Test2 qw/Core Grab/;

my $grab = grab();

# Generate some events, they are intercepted.
ok(1, "pass");
ok(0, "fail");

my $events_a = $grab->flush;

# Generate some more events, they are intercepted.
ok(1, "pass");
ok(0, "fail");

# Same as flush, except it destroys the grab object.
my $events_b = $grab->finish;

After calling finish() the grab object is destroyed and $grab is set to undef. $events_a is an arrayref with the first two events. $events_b is an arrayref with the second two events. Slay, the math is mathing. 🎀

🫶 EXPORTS 🫶

💜 `$grab = grab()`

This lets you intercept all events for a section of code without adding anything to your call stack. This is useful for things that are sensitive to changes in the stack depth. No cap, stack-depth girlies need this. 🧚

my $grab = grab();
    ok(1, 'foo');
    ok(0, 'bar');

# $grab is magically undef after this.
my $events = $grab->finish;

is(@$events, 2, "grabbed two events.");

When you call finish() the $grab object will automagically undef itself, but only for the reference used in the method call. If you have other references to the $grab object they will not be set to undef. Important distinction, bestie. 🔥

If the $grab object is destroyed without calling finish(), it will automatically clean up after itself and restore the parent hub. Very responsible of it, ngl. 🌈

{
    my $grab = grab();
    # Things are grabbed
}
# Things are back to normal

By default the hub used has "no_ending" set to true. This will prevent the hub from enforcing that you issued a plan and ran at least one test. You can turn enforcement back one like this:

$grab->hub->set_no_ending(0);

With "no_ending" turned off, finish will run the post-test checks to enforce the plan and that tests were run. In many cases this will result in additional events in your events array. Surprise events, but make it official. 😭

🎀 METHODS 🎀

$grab = $class->new() — Create a new grab object, and it immediately starts intercepting events. It does not wait. It does not chill. It grabs. 💅
$ar = $grab->flush() — Get an arrayref of all the events so far, clearing the grab object’s internal list. It’s a little reset moment. ✨
$ar = $grab->events() — Get an arrayref of all events so far. Does not clear the internal list. Look, don’t touch. 👀
$ar = $grab->finish() — Get an arrayref of all the events, then destroy the grab object. It ate and then left. 🔥
$hub = $grab->hub() — Get the hub that is used by the grab event.

🌟 ENDING BEHAVIOR 🌟

Okay so this is the same tea as above, but it’s important so here it is again:

By default the hub used has "no_ending" set to true. This will prevent the hub from enforcing that you issued a plan and ran at least one test. You can turn enforcement back one like this:

$grab->hub->set_no_ending(0);

👀 SEE ALSO 👀

Test2::Tools::Intercept — Accomplish the same thing, but using blocks instead. Block-based bestie energy. 🫶

📦 SOURCE 📦

The source code repository for Test2 can be found at https://github.com/Test-More/test-more/. Go look, bestie. 🔍

👑 MAINTAINERS 👑

Chad Granum <exodist@cpan.org>

💐 AUTHORS 💐