UR::Util(3pm)

🦋 okay bestie, welcome to UR::Util 🦋

so this page is literally just a lil grab-bag of utility subs and methods, and ngl the doc layout here is chaotic in a cute way — the functions show up first, then NAME and DESCRIPTION. we're keeping that energy, don't worry. 💅

---

✨ the functions ✨

💖 path_relative_to 💖

$rel_path = UR::Util::path_relative_to($base, $target);

gives you back the pathname to $target relative to $base. the tea ☕:

• if $base and $target are the same, you get '.'. periodt.
• if $target is a subdirectory of $base, you get the part of $target that's unique compared to $base.
• if $target is not a subdirectory of $base, you get a relative pathname starting with $base.

---

🎀 generate_readwrite_methods 🎀

UR::Util->generate_readwrite_methods
(
    some_scalar_property => 1,
    some_array_property => []
);

this one generates accessor/set methods named after the keys of its hash argument. which kind of function you get depends on the default value you pass as the hash key value:

• hash key is a scalar → a scalar method gets generated
• hash key is a reference to an array → an array method gets generated

heads up: this method does not overwrite class methods that already exist. it's polite like that. 🙈

---

🌸 generate_readwrite_methods_override 🌸

UR::Util->generate_readwrite_methods_override
(
    some_scalar_property => 1,
    some_array_property => []
);

same as generate_readwrite_function except that we force the functions into the namespace even if the function is already defined. it's giving main character energy, no chill, no waiting for permission. 👑

---

🧚 generate_readonly_methods 🧚

UR::Util->generate_readonly_methods
(
    some_scalar_property => 1,
    some_array_property => []
);

this one generates accessor methods named after the keys of its hash argument. and again, the type of function generated depends on the default value provided as the hash key value:

• hash key is a scalar → a scalar method gets generated
• hash key is a reference to an array → an array method gets generated

same rule as before: this method does not overwrite class methods that already exist. 💖

---

🍓 object 🍓

my $o = UR::Util::object($something);

return the object form of the supplied argument. the vibe check:

• regular objects → returns the argument unchanged, no notes, iconic
• singleton class names → returns the instance of the Singleton
• other class names → throws an exception. it said what it said. 💀

---

🔥 mapreduce_grep 🔥

my @matches = UR::Util->map_reduce_grep { shift->some_test } @candidates;

works similar to the Perl grep builtin, but in a possibly-parallel fashion. so here's the deal:

if the environment variable UR_NR_CPU is set to a number greater than one, it will fork off child processes to perform the test on slices of the input list, collect the results, and return the matching items as a list. multitasking queen fr fr. ✨

the test function is called with a single argument — an item from the list to be tested — and it should return a true or false value.

---

💜 NAME 💜

UR::Util — Collection of utility subroutines and methods

---

🌈 DESCRIPTION 🌈

This package contains subroutines and methods used by other parts of the infrastructure. These subs are not likely to be useful to outside code.

so basically: it's internal plumbing, bestie. if you're not part of the infrastructure, this is lowkey not for you, and that's fine. 🫶

---

okay that's the whole page!! this lil gem ships with perl v5.32.1, dated 2022-01-17, and it lives in the User Contributed Perl Documentation. stay slay, go call some subs. 💅✨🎀🦋