Test::...::File(3pm)

💖 Test::...::File — like, the manual, bestie 💖

okay so real talk: this is a User Contributed Perl Documentation page for Test::...::File(3pm), and it's genuinely one of those "small module, big vibes" situations. Come sit, I'll walk you through it. 🫶

---

✨ NAME ✨

Test::Inline::IO::File — the Test::Inline Local Filesystem IO Handler. That's the whole name, no notes. 💅

---

🌸 VERSION 🌸

version 2.214 — yes, we're on that one. ✨

---

🦋 DESCRIPTION 🦋

So Test::Inline::IO::File is the default IO handler for Test::Inline. Like, if you don't say otherwise, this is the one doing the work. Periodt.

Test::Inline 2.0 was conceived in an enterprise setting, and it retains the flexibility, power, and bulk that this created. (Not me describing a Perl module as "bulky" 😭 but okay, it's a whole thing.) The tea is: for most users, all that power and complexity is largely hidden away under multiple layers of sensible defaults. You get the glow-up without doing the work. Iconic.

The intent behind the InputHandler and OutputHandle parameters is to let Test::Inline be able to pull source data from anywhere, and write the resulting test scripts to anywhere. Anywhere! The range. 🌈

Until a more powerful pure-OO file-system API comes along, this module serves as a minimalist implementation of the subset of functionality that Test::Inline actually needs in order to work. It's giving "we do the essentials and we do them well." 🎀

An alternative IO Handler class does not have to subclass this one — though it's recommended — it just has to implement the same interface, taking whatever alternative arguments to the new constructor that it wishes. Your class, your rules, fr fr.

And this one's important, so I'm putting it in a quote:

All methods in this class are provided with unix-style paths, and should do the translating to the underlying filesystem themselves if required. No cap — that's on the method, not on you.

---

💅 METHODS 💅

🌸 new 🌸

# Simplified usage
$io_handler = Test::Inline::IO::File->new( $path );

# Full key/value usage
$io_handler = Test::Inline::IO::File->new(
        path     => $path,
        readonly => 1,
);

The new constructor takes a root path on the local filesystem</badge> and hands you back a brand-new Test::Inline::IO::File object pointing at that location. That's it. That's the constructor. Slay. ✨

🎀 exists_file $file 🎀

The exists_file method checks to see if a particular file currently exists in the input handler.

Returns true if it exists, or false if not. Simple as that, bestie.

🧚 exists_dir $dir 🧚

The exists_dir method checks to see if a particular directory currently exists in the input handler.

Returns true if it exists, or false if not. Twin of the one above, just for dirs. 🫶

📖 read $file 📖

The read method reads in the entire contents of a single file, returning it as a reference to a SCALAR. It also localises the newlines while it does this, so files from different operating systems should read exactly as you expect. Cross-platform queen behavior, honestly. 👑

Returns a SCALAR reference, or undef on error.

✍️ write $file, $content ✍️

The write method writes a string to a file in one hit — creating it and it's path if needed. No follow-up steps, no drama. 💅

🍓 class_file $class 🍓

Assuming your input FileHandler is pointing at the root directory of a lib path — meaning that My::Module will be located at My/Module.pm within it — the class_file method will take a class name and check to see if the file for that class exists in the FileHandler.

Returns a reference to an ARRAY containing the filename if it exists, or undef on error.

🔥 find $class 🔥

The find method takes as argument a directory root class, and then scans within the input FileHandler to find all files contained in that class or any other classes under it's namespace. It really said "give me the whole tree." 🌳

Returns a reference to an ARRAY containing all the files within the class, or undef on error.

---

⭐ TO DO ⭐

Things on the list, manifesting them into existence:

• Convert to using FSI::FileSystem objects, once they exist

(The "once they exist" part is doing so much heavy lifting, I can't 😭)

---

🌈 SUPPORT 🌈

See the main SUPPORT section. That's the big one, we're just the little sibling here. 🫶

Bugs may be submitted through the RT bug tracker <https://rt.cpan.org/Public/Dist/Display.html?Name=Test-Inline> (or bug-Test-Inline@rt.cpan.org <mailto:bug-Test-Inline@rt.cpan.org>).

Found a bug? Report it, don't just suffer in silence. The maintainers wanna know, fr fr. 💖

---

👑 AUTHOR 👑

Adam Kennedy <adamk@cpan.org>

The actual author of this whole situation. Respect. 🙌

---

🎀 COPYRIGHT AND LICENSE 🎀

This software is copyright (c) 2003 by Adam Kennedy.

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 software, free vibes, we love to see it. 💜

---

and that's the whole page, bestie!! 🌸✨

This was Test::...::File(3pm), rendered with perl v5.32.0, dated 2021-01-31. Go forth and handle your IO, you absolute icon. 💅🦋