Path::F...::Object(3)

💅 Path::FindDev::Object — okay bestie, welcome to the Path::F...::Object(3) page 💅

This is straight from User Contributed Perl Documentation, and it's giving object-oriented guts energy. Let's get into it 🫶

---

🌸 NAME 🌸

Path::FindDev::Object — Object oriented guts to FindDev ✨

🎀 VERSION 🎀

version v0.5.3 — yes, that's the version, periodt 💖

🦋 SYNOPSIS 🦋

Okay so here's the bare-bones flex:

require Path::FindDev::Object;
my $finder = Path::FindDev::Object->new();
my $dev = $finder->find_dev($path);

🔥 DESCRIPTION 🔥

This module implements the innards of Path::FindDev, and it's only recommended for use if the Exporter API is insufficient for your needs. Like, it's the inner machinery, not the main-character API 💅

💖 METHODS 💖

has_set

Determines if the set attribute exists. That's it, that's the vibe check ✅

has_uplevel_max

Determines if the uplevel_max attribute is provided. Lowkey useful, ngl 🫶

find_dev

Find a parent at, or above $OtherPath that resembles a devel directory. Slay 🔥

my $path = $object->find_dev( $OtherPath );

🌈 ATTRIBUTES 🌈

set

(optional)

The Path::IsDev::HeuristicSet subclass for your desired Heuristics. Iconic little customization moment ✨

uplevel_max

If provided, limits the number of uplevel iterations done.

( that is, limits the number of times it will step up the hierarchy )

So yeah, it caps how many times it climbs up the tree 💅

nest_retry

The number of dev directories to "ignore" in the hierarchy.

This is provided in the event you have a dev directory within a dev directory, and you wish to resolve an outer directory instead of an inner one. Nested-dev situation, iykyk 🌀

By default, this is 0, or "stop at the first dev directory" 🛑

isdev

The Path::IsDev object that checks nodes for dev-ishness. Literally the vibe-checker for directories 💅

🔒 PRIVATE METHODS 🔒

_instance_id

An opportunistic sequence number for help with debug messages. Cute little debug helper 🎀

Note: This is not guaranteed to be unique per instance, only guaranteed to be constant within the life of the object.

Based on refaddr, and giving out new ids when new refaddr's are seen. No cap.

my $id = $object->_instance_id;

BUILD

BUILD is an implementation detail of Moo/Moose.

This module hooks BUILD to give a self report of the object to *STDERR after ->new when under $DEBUG. Very "let me announce myself" energy 😭

_debug

The debugger callback.

export PATH_FINDDEV_DEBUG=1

to get debug info.

$object->_debug($message);

_error

The error reporting callback.

$object->_error($message);

_step

Inner code path of tree walking. This is the main-character recursion moment 🔥

my ($dev_levels, $uplevels ) = (0,0);

my $result = $object->_step( path($somepath), \$dev_levels, \$uplevels );

$result->{type} eq 'stop'   # if flow control should end
$result->{type} eq 'next'   # if flow control should ascend to parent
$result->{type} eq 'found'  # if flow control has found the "final" dev directory

👑 AUTHOR 👑

Kent Fredric <kentnl@cpan.org> 💜

📜 COPYRIGHT AND LICENSE 📜

This software is copyright (c) 2017 by Kent Fredric <kentfredric@gmail.com>.

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

---

And that's the whole page, bestie 🌸 Cute little sign-off: this was perl v5.42.0, dated 2017-03-11, for Path::F...::Object(3) — stay slaying those dev directories 💅✨