Test2::...:Custom(3)

💖 NAME 💖

Okay bestie, this page is Test2::Compare::Custom — a custom field check for comparisons. The header vibes say Test2::...:Custom(3) and the manual is the User Contributed Perl Documentation. So yeah, it's giving "write your own check for a field inside a deep data structure" energy 💅.

✨ DESCRIPTION ✨

Sometimes you wanna do something complicated or unusual when validating a field that's nested inside a deep data structure. You could pull it out of the structure and test it separately, or you can use this to embed the check. This gives you a way to write custom checks for fields in deep comparisons. No cap, that's the whole point 🦋.

🌸 SYNOPSIS 🌸

my $cus = Test2::Compare::Custom->new(
    name => 'IsRef',
    operator => 'ref(...)',
    stringify_got => 1,
    code => sub {
        my %args = @_;
        return $args{got} ? 1 : 0;
    },
);

# Pass
is(
    { a => 1, ref => {},   b => 2 },
    { a => 1, ref => $cus, b => 2 },
    "This will pass"
);

# Fail
is(
    {a => 1, ref => 'notref', b => 2},
    {a => 1, ref => $cus,     b => 2},
    "This will fail"
);

🎀 ARGUMENTS 🎀

Your custom sub will be passed 4 arguments in a hash:

code => sub {
    my %args = @_;
    # provides got, exists, operator, name
    return ref($args{got}) ? 1 : 0;
},

$_ is also localized to got to make it easier for those who need to use regexes. Iconic.

• got, $_ — the value to be checked.
• exists — this will be a boolean. This will be true if got exists at all. If exists is false then it means got is not simply undef, but doesn't exist at all (think checking the value of a hash key that does not exist).
• operator — the operator specified at construction.
• name — the name provided at construction.

🔥 METHODS 🔥

• $code = $cus->code — returns the coderef provided at construction.
• $name = $cus->name — returns the name provided at construction.
• $op = $cus->operator — returns the operator provided at construction.
• $stringify = $cus->stringify_got — returns the stringify_got flag provided at construction.
• $bool = $cus->verify(got => $got, exists => $bool) — yup, that's the verify signature, exactly as written. 💅

🌈 SOURCE 🌈

The source code repository for Test2-Suite can be found at https://github.com/Test-More/test-more/. Go off, repository 👑.

💜 MAINTAINERS 💜

• Chad Granum <exodist@cpan.org>

🫶 AUTHORS 🫶

• Chad Granum <exodist@cpan.org>
• Daniel Böhmer <dboehmer@cpan.org>

⭐ COPYRIGHT ⭐

Copyright Chad Granum <exodist@cpan.org>.

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

See http://dev.perl.org/licenses/

---

And that's the whole page, bestie. Sign-off time: perl v5.42.0, dated 2025-07-28, on Test2::...:Custom(3). Mwah 💋✨