Fennec...llector(3pm)

💖 Fennec::Collector — the manual page, but make it make sense 💖

okay so bestie, welcome to Fennec::Collector — it's a Perl module, it's part of the User Contributed Perl Documentation, and it's literally the group chat moderator between your parent process and all its child processes. 🫶

---

✨ NAME ✨

Fennec::Collector — funnel results from child to parent. that's it, that's the whole job description, and she does it flawlessly. 💅

---

🌸 DESCRIPTION 🌸

The collector has two jobs and she is NOT multitasking badly, she is multitasking iconically:

1. In the parent process, she's responsible for gathering all the test results from the child processes.
2. In the child processes, she's responsible for sending results to the parent process.

so basically she's the one carrying messages across the family dinner table. no cap. ✨

---

🔥 METHODS SUBCLASSES MUST OVERRIDE 🔥

like, if you're subclassing and you don't do these, it's giving broken. you MUST override them:

• $bool = ok( $bool, $description ) — Fennec sometimes needs to report the result of an internal check. these checks will pass a boolean true/false value and a description. so yeah, $bool in, $bool out, $description along for the ride. ✅
• diag( $msg ) — Fennec uses this to report internal diagnostics messages. just take the $msg and do your thing with it. 🩺
• end_pid — called just before a child process exits. it's the goodbye hug. 👋
• collect — used by the parent process at an interval to get results from children and display them. parent's like "any updates bestie?" on a timer. 🕐

---

🎀 METHODS SUBCLASSES MAY OVERRIDE 🎀

these ones are optional, you may override them, no pressure, only vibes:

• new — builds the object from params, then calls init. constructor behavior, very main character. 👑
• init — called by new. that's the whole note. she just gets called. ✨
• finish — called at the very end of "done_testing()", and no tests should be reported after this. that's the boundary, babes. nothing after finish. periodt. 🚫

---

🦋 METHODS SUBCLASSES MUST BE AWARE OF 🦋

you don't override these, you just need to know about them. awareness check, you passed: 💜

• test_count — holds the test count so far. 📈
• test_failed — holds the number of tests failed so far. 💀
• inc_test_count — used to add 1 to the number of tests. one. just one. increment. 🔢
• inc_test_failed — used to add 1 to the number of failed tests. also one. sadly. 😭

---

🌈 AUTHORS 🌈

Chad Granum exodist7@gmail.com — yeah, that's the author, credit where it's due, iconic of him honestly. 👑

---

⭐ COPYRIGHT ⭐

Copyright (C) 2013 Chad Granum

Fennec is free software; Standard perl license (GPL and Artistic).

Fennec is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the license for more details.

bestie read that part again. no warranty. none. zero. she's free software and she's doing her best. 🙈

---

and that's the whole page, you ate it, you're welcome. 🍓 this was perl v5.36.0, dated 2022-12-02, and it's the Fennec...llector(3pm) page — yeah the title's got the ellipsis in it, that's just how she is, we don't question it. mwah. 💅✨💖