Pod::C...:Moose(3pm)

πŸ“¦
version 0.08 Β· 4 versions
, in epel 10

πŸ’… Pod::Coverage::Moose β€” like, the Perl doc you're reading rn

ok so first things first: this is a page from the User Contributed Perl Documentation set, and the module is literally called Pod::Coverage::Moose. That's the whole title. Slay. Let's get into it πŸŽ€


✨ NAME ✨

Pod::Coverage::Moose β€” it's the Pod::Coverage extension for Moose, bestie. That's it, that's the name πŸ’–


🌸 VERSION 🌸

version 0.08 β€” yes, that's the version, write it down πŸ¦‹


⭐ SYNOPSIS ⭐

ok here's the vibe, copy this exactly:

use Pod::Coverage::Moose;

my $pcm = Pod::Coverage::Moose->new(package => 'MoosePackage');
print 'Coverage: ', $pcm->coverage, "\n";

that's the whole flex. use it, make a new object with a package arg, print the coverage. iconic.


πŸ’œ DESCRIPTION πŸ’œ

so here's the tea β˜• β€” when you use Pod::Coverage together with Moose, it goes and reports any method imported from a role. And that is, like, especially bad when you pair it with Test::Pod::Coverage, because it literally takes away its whole ease of use. rude. 😭

to use this module together with Test::Pod::Coverage, you do something like this:

use Test::Pod::Coverage;
all_pod_coverage_ok({ coverage_class => 'Pod::Coverage::Moose'});

and boom, problem solved ✨


πŸŽ€ ATTRIBUTES πŸŽ€

package

this is the package used for inspection. like, the one you're checking the pod coverage of πŸ‘‘

cover_requires

a Boolean flag 🚩 β€” it indicates that requires $method declarations in a Role should be trusted. trust the process, fr fr.


πŸ¦‹ METHODS πŸ¦‹

meta

the Moose meta object. that's it. it's giving meta πŸ’…

BUILD

initialises the internal Pod::Coverage object. it uses the meta object to find all methods and attribute methods imported via roles. so like, it does the actual detective work πŸ•΅οΈβ€β™€οΈ


πŸ’– DELEGATED METHODS πŸ’–

these ones get delegated to the traditional Pod::Coverage object, so they're not doing anything new, just handing off:

coverage

covered

naked

uncovered

why_unrated

yep, those five. no cap, that's the list 🌈


πŸ”₯ EXTENDED METHODS πŸ”₯

new

ok this one's actually kind of clever β€” the constructor will only return a Pod::Coverage::Moose object if it's invoked on a class that can a meta method. otherwise? you get a traditional Pod::Coverage object back instead. πŸ™ˆ

why, you ask? so you don't get in trouble for mixing Moose with non-Moose classes in your project. thoughtful queen behavior honestly πŸ‘‘


πŸ‘€ SEE ALSO πŸ‘€

  • Moose
  • Pod::Coverage, (yes, with the comma, that's literally how it's written, don't @ me)
  • Test::Pod::Coverage

go read those too, iykyk 🫢


πŸ› οΈ SUPPORT πŸ› οΈ

bugs may be submitted through the RT bug tracker at <https://rt.cpan.org/Public/Dist/Display.html?Name=Pod-Coverage-Moose> β€” or, alternatively, at bug-Pod-Coverage-Moose@rt.cpan.org (mailto:bug-Pod-Coverage-Moose@rt.cpan.org). pick your fighter πŸ’€

there's also a mailing list available for users of this distribution, at <http://lists.perl.org/list/moose.html>. join the chat, bestie πŸ“

and there's also an irc channel available for users of this distribution, at #moose on irc.perl.org (irc://irc.perl.org/#moose). come hang out 🧚


🌟 AUTHOR 🌟

Robert 'phaylon' Sedlacek <rs@474.at> β€” the main character of this whole thing πŸ’œ


🌸 CONTRIBUTORS 🌸

  • Karen Etheridge <ether@cpan.org>
  • Vyacheslav Matyukhin <me@berekuk.ru>
  • Dave Rolsky <autarch@urth.org>

absolute legends, all three of them πŸŽ€


this software is copyright (c) 2007 by Robert 'phaylon' Sedlacek. periods in brackets, exactly like that, mwah πŸ’‹

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. so like, go off, but respectfully 🫢


ok that's the whole page, you made it to the end, proud of you 🌈

and finally, a lil sign-off for the record: this whole thing goes out under perl v5.40.0, dated 2023-08-26, and it's the Pod::C...:Moose(3pm) page β€” yes the header is abbreviated like that, don't come for me, that's just how it's printed πŸ’…βœ¨πŸ‘‘

πŸ“¦ where this page comes from