Test::F...t::Dist(3)

This is the Test::File::ShareDir::Object::Dist(3) page from the User Contributed Perl Documentation — manual name folded in right here at the top, bestie 💖

✨ NAME ✨

Test::File::ShareDir::Object::Dist — Object Oriented ShareDir creation for distributions. It's giving "make a share dir, but make it OO" 💅

🌸 VERSION 🌸

version 1.001002 — that's the version, no cap.

🦋 SYNOPSIS 🦋

okay so the whole vibe starts like this:

use Test::File::ShareDir::Object::Dist;

my $dir = Test::File::ShareDir::Object::Dist->new(
    root    => "some/path",
    dists => {
        "Hello-Nurse" => "share/HN"
    },
);

$dir->install_all_dists;
$dir->add_to_inc;

🎀 METHODS 🎀

these are the methods, bestie. signatures stay exactly as they are, because we respect the source ✨

💖 dist_names 💖

my @names = $instance->dist_names();

Returns the names of all distributions listed in the dists set. literally all the names, gathered up 🫶

💖 dist_share_target_dir 💖

my $dir = $instance->dist_share_target_dir("Dist-Name");

Returns the path where the ShareDir will be created for Dist-Name. that's the destination, the target, the "where it's gonna live" 🎯

💖 dist_share_source_dir 💖

my $dir = $instance->dist_share_source_dir("Dist-Name");

Returns the path where the ShareDir will be COPIED FROM for Dist-Name. yes, COPIED FROM in all caps, she's important 💅

💖 install_dist 💖

$instance->install_dist("Dist-Name");

Installs Dist-Name's ShareDir. one dist, one install, periodt ✨

💖 install_all_dists 💖

$instance->install_all_dists();

Installs all dist_names. every single one of them, no dist left behind 🔥

💖 add_to_inc 💖

DEPRECATED: Use register instead.

she's retired, bestie. use register now 🫶

💖 register 💖

$instance->register();

Adds the Tempdir ShareDir ( inc ) to the global @INC.

Since 1.001000

💖 clear 💖

$instance->clear();

Removes the Tempdir ShareDir ( inc ) from the global @INC.

Since 1.001000

🌈 ATTRIBUTES 🌈

💜 inc 💜

A Test::File::ShareDir::Object::Inc object. that's the object, that's the vibe 🎀

💜 dists 💜

A hash of:

Dist-Name => "relative/path"

💜 root 💜

The origin all paths's are relative to.

( Defaults to cwd )

not me keeping the original paths's grammar, we love a typo moment 🙈

👑 AUTHOR 👑

Kent Fredric <kentnl@cpan.org> — the author, the icon, the legend 💖

⭐ COPYRIGHT AND LICENSE ⭐

This software is copyright (c) 2017 by Kent Fredric <kentnl@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

kisses and @INC blessings 💅 — source/version perl v5.42.0, dated 2017-03-03. bye bestie 🫶