MooseX...::List(3pm)

💖 MooseX::AttributeHelpers::MethodProvider::List — aka MooseX...::List(3pm) ✨

okay bestie, sit down, hydrate, because we're about to talk about the method generator for MooseX::AttributeHelpers::Collection::List and it's honestly a whole vibe. it's giving Perl, it's giving User Contributed Perl Documentation, it's giving slay. 🦋

---

✨ VERSION ✨

version 0.25 — yes queen, we're on 0.25, no cap.

---

🌸 SYNOPSIS 🌸

okay so here's the entire situation, and honestly? iconic. look at this:

package Stuff;
use Moose;
use MooseX::AttributeHelpers;

has 'options' => (
    metaclass  => 'Collection::List',
    is         => 'rw',
    isa        => 'ArrayRef[Str]',
    default    => sub { [] },
    auto_deref => 1,
    provides   => {
        elements => 'all_options',
        map      => 'map_options',
        grep     => 'filter_options',
        find     => 'find_option',
        first    => 'first_option',
        last     => 'last_option',
        get      => 'get_option',
        join     => 'join_options',
        count    => 'count_options',
        empty    => 'do_i_have_options',
        sort     => 'sorted_options',
    }
);

no Moose;
1;

not me reading provides and just... 🫶 the way that each key maps to a name you pick yourself? chef's kiss. you're literally naming your own methods. main character energy fr fr.

---

💅 DESCRIPTION 💅

so this is a role — and what it does is provide the method generators for MooseX::AttributeHelpers::Collection::List. that's it. that's the whole job. and it does it beautifully. ✨

---

👑 METHODS 👑

meta

yeah. that's the method. that's the whole list. meta. periodt. 💅

---

🎀 PROVIDED METHODS 🎀

these are the methods you get to hand out like friendship bracelets. let's go one by one, no skipping, i don't play that. 💖

• count — returns the number of elements in the list. that's it. just counting. little accountant behaviour, we love it.

$stuff = Stuff->new;
$stuff->options(["foo", "bar", "baz", "boo"]);

my $count = $stuff->count_options;
print "$count\n"; # prints 4

• empty — if the list is populated, returns true. otherwise, returns false. (yes the name is empty and it's true when it's not empty. i know. i KNOW. it's giving chaos but it's what the docs say so we're rolling with it. 🙈)

$stuff->do_i_have_options ? print "Good boy.\n" : die "No options!\n" ;

• find — this method accepts a subroutine reference as its argument. that sub will receive each element of the list in turn. if it returns true for an element, that element will be returned by the find method. first match wins, no take-backs. ✨

my $found = $stuff->find_option( sub { $_[0] =~ /^b/ } );
print "$found\n"; # prints "bar"

• grep — this method accepts a subroutine reference as its argument. this method returns every element for which that subroutine reference returns a true value. find gives you one, grep gives you the whole squad. 🔥

my @found = $stuff->filter_options( sub { $_[0] =~ /^b/ } );
print "@found\n"; # prints "bar baz boo"

• map — this method accepts a subroutine reference as its argument. the subroutine will be executed for each element of the list. it is expected to return a modified version of that element. the return value of the method is a list of the modified options. glow-up generator, honestly. 🦋

my @mod_options = $stuff->map_options( sub { $_[0] . "-tag" } );
print "@mod_options\n"; # prints "foo-tag bar-tag baz-tag boo-tag"

• sort — sorts and returns the elements of the list.

you can provide an optional subroutine reference to sort with (as you can with the core sort function). however, instead of using $a and $b, you will need to use $_[0] and $_[1] instead. that's the plot twist. no $a, no $b, just vibes and positional args. 😭

# ascending ASCIIbetical
my @sorted = $stuff->sort_options();

# Descending alphabetical order
my @sorted_options = $stuff->sort_options( sub { lc $_[1] cmp lc $_[0] } );
print "@sorted_options\n"; # prints "foo boo baz bar"

• elements — returns all of the elements of the list. all of them. the whole roster. ⭐

my @option = $stuff->all_options;
print "@options\n"; # prints "foo bar baz boo"

• join — joins every element of the list using the separator given as argument. you pick the lil glue string. 🍓

my $joined = $stuff->join_options( ':' );
print "$joined\n"; # prints "foo:bar:baz:boo"

• get — returns an element of the list by its index. zero-indexed, bestie, don't come at me. 💜

my $option = $stuff->get_option(1);
print "$option\n"; # prints "bar"

• first — returns the first element of the list. the OG. the main character. 👑

my $first = $stuff->first_option;
print "$first\n"; # prints "foo"

• last — returns the last element of the list. the finale. the closing number. 🌈

my $last = $stuff->last_option;
print "$last\n"; # prints "boo"

---

🫶 SUPPORT 🫶

got bugs? we listen. bugs may be submitted through the RT bug tracker at <https://rt.cpan.org/Public/Dist/Display.html?Name=MooseX-AttributeHelpers> (or you can email <bug-MooseX-AttributeHelpers@rt.cpan.org>). 📬

there is also a mailing list available for users of this distribution, at <http://lists.perl.org/list/moose.html>. join the club, we have snacks. 🎀

there is also an irc channel available for users of this distribution, at #moose on irc.perl.org <irc://irc.perl.org/#moose>. come say hi, it's a vibe. 💬

---

🌟 AUTHOR 🌟

Stevan Little <stevan@iinteractive.com> — the legend, the icon, the moment. 👑

---

📜 COPYRIGHT AND LICENSE 📜

this software is copyright (c) 2007 by Stevan Little and Infinity Interactive, Inc.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. free as in freedom, bestie, go wild. 💖

---

and that's the whole page!! this was generated by perl v5.34.0 and it's dated 2022-06-15 — a lil time capsule from the User Contributed Perl Documentation collection, and honestly it ate. mwah. 💅✨ no cap, ily, go write some list methods. 🦋