Mason:...lation(3pm)

💖 Mason::Compilation — the whole vibe 💖

okay so bestie, welcome to Mason::Compilation (manual page Mason:...lation(3pm), she's a User Contributed Perl Documentation girlie) — she does the compilation of a single component. one component. that's her whole job. iconic. 💅

---

✨ NAME ✨

Mason::Compilation — Performs compilation of a single component 🎀

---

🦋 DESCRIPTION 🦋

so here's the tea: a brand new Mason::Compilation object gets created by Mason::Interp to compile each component. every single one. she shows up, compiles, no drama. 🫶

and then — okay don't be sad — this class has no public API at this time. that's it. that's the whole thing. she's mysterious. she's lowkey booked and busy internally. 🙈

---

👑 MODIFIABLE METHODS 👑

these methods are not intended to be called externally, bestie, i'm gonna say that again for the people in the back — not meant to be called from the outside. but they may be useful to modify with method modifiers in plugins and subclasses. and their APIs will be kept as stable as possible. so like, you can touch them, just respectfully. 💅

• bad_attribute_names () — an arrayref-style list of attribute names that should not be used because they're reserved for built-in attributes or methods: "args", "m", "cmeta", "render", "main", etc. don't use them, fr fr, they're taken.
• bad_method_names () — a list of method names that should not be used because they're reserved for built-in attributes: "args", "m", "cmeta", etc. she's not as extensive as bad_attribute_names above, and here's why: methods like "render" and "main" can be overridden — but they make absolutely no sense as attributes. so it's giving "different list, different rules". 🎀
• compile () — the top-level method called to compile the component. returns the generated component class. she's the main character, honestly. 👑
• named_block_types () — an arrayref of valid named block types: "after", "filter", "method", etc. add to this list if you want to create your own named blocks (i.e. blocks that take a name argument). make your own, bestie, i believe in you. 🌸
• output_class_footer () — Perl code to be added at the bottom of the class. empty by default. nothing there. a blank canvas. ✨
• output_class_header () — Perl code to be added at the top of the class, just after initialization of Moose, $m and other required pieces. by default it consults the class_header parameter. 🦋

like, for example, if you wanted to add to the top of every component class:

# Add to the top of every component class:
#   use Modern::Perl;
#   use JSON::XS qw(encode_json decode_json);
#
override 'output_class_header' => sub {
    return join( "\n",
        super(),
        'use Modern::Perl;',
        'use JSON::XS qw(encode_json decode_json);' );
};

look at her go. so clean. so slay. 💜

• process_perl_code ($coderef) — this method is called on each distinct piece of Perl code in the component. $coderef is a reference to a string containing the code; the method can modify the code as desired. see Mason::Plugin::DollarDot for a sample usage. iykyk. 🔥
• unnamed_block_types () — an arrayref of valid unnamed block types: "args", "class", "init", etc. add to this list if you want to create your own unnamed blocks. ✨
• valid_flags () — an arrayref of valid flags: contains only "extends" at time of writing. add to this list if you want to create your own flags. 🎀

---

🌈 SEE ALSO 🌈

• Mason — the mothership, the blueprint, the whole ecosystem 💖

---

🫶 AUTHOR 🫶

Jonathan Swartz <swartz@pobox.com> — thank you king, we appreciate you 🌸

---

💜 COPYRIGHT AND LICENSE 💜

this software is copyright (c) 2012 by Jonathan Swartz.

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 go off, bestie, remix it. 🦋

---

and that's the whole page, no cap. perl v5.34.0, dated 2022-05-27, from the manual page Mason:...lation(3pm) — she said what she said, and she ate. periodt. 💅✨🎀