Badger...rkspace(3pm)

💖 Badger::Workspace 💖

okay bestie, welcome to the Badger::Workspace page from the User Contributed Perl Documentation, manual section 3pm — and ngl, this one is lowkey the blueprint for every project you've ever poked at. let's get into it ✨

---

🌸 NAME 🌸

Badger::Workspace — an object representing a project workspace. that's the whole vibe. 🫶

---

✨ DESCRIPTION ✨

so this module implements an object for representing a workspace — think of it like the directory that holds the source, the configuration, the resources and all the other little files for a web site or literally any other project. it's a subclass of Badger::Workplace, which is the one that implements the base functionality. so like, Workplace is the parent and Workspace is the main character child 💅

the root directory for a workspace is expected to contain a configuration directory, called config by default, and that's where the configuration files for the workspace live. this whole thing is managed by delegation to a Badger::Config::Filesystem object. no cap, that's the delegation situation.

---

👑 CLASS METHODS 👑

💫 new(\%config)

this is the constructor method, aka how you birth a brand new Badger::Workspace object into existence. iconic behaviour honestly.

use Badger::Workspace;

my $space = Badger::Workspace->new(
    directory => '/path/to/workspace',
);

🎀 CONFIGURATION OPTIONS 🎀

• root / dir / directory — this parameter is mandatory, bestie, you have to give it. it's the filesystem path to the project directory. you can spell it any of these three ways: root, dir or directory, as per Badger::Workplace. pick your fighter, they all slay the same 💅
• config_module — the name of the delegate module for managing the files in the configuration directory. it defaults to Badger::Config::Filesystem.
• config_dir / config_directory — optional! use this to specify the name of the configuration direction under the root project directory. the default configuration directory name is config. so if you do nothing, it's config, periodt.
• config_file — optional too! use this to specify the name of the main configuration file (without file extension) that should reside in the config_dir directory under the root project directory. the default configuration file name is workspace.

---

🦋 PUBLIC METHODS 🦋

🌈 config($item)

when you call it with no arguments at all, it hands you back a Badger::Config::Filesystem object that manages the configuration directory for the project. like, the whole config manager. here:

my $cfg = $workspace->config;

but when you call it with a named item, it returns the configuration data associated with that item. this will typically be defined in a master configuration file, or in a file of the same name as the item, with an appropriate file extension added. so:

my $name = $workspace->config('name');

cute right?? 💖

🌟 inherit_config($item)

this one attempts to fetch an inherited configuration from a parent namespace. but heads up — the workspace must have a parent defined and must have the inherit option set to any true value. both. no shortcuts. ⭐

🧚 parent_config($item)

attempts to fetch the configuration for a named item from a parent workspace. obviously this requires the workspace to be attached to a parent — you can't get parent config from a workspace with no parent, that's not giving anything. note that this method is not bound by the inherit flag and will delegate to any parent regardless. she does not care about your flags, she goes straight to the parent 💅

💜 dir($name)

💜 dirs(\%dirmap)

💜 resolve_dir($name)

💜 file($path)

💜 attach($parent)

attaches the workspace to a parent workspace. family bonding time 🫶

💜 detach()

detaches the workspace from any parent workspace. okay bye then 😭

💜 parent($n)

returns the parent workspace if there is one. but if a numerical argument gets passed, it indicates a number of parents to skip. e.g. if $n is 1 then it bypasses the parent and returns the grandparent instead. so passing an argument of 0 is the same as passing no argument at all — zero skips, same energy, no difference. 💀

💜 ancestors($list)

returns a list of the parent, grandparent, great-grandparent and so on, all the way up as far as it can go. the whole family tree, no cap. a target list reference can be passed as an argument if you want to collect them somewhere specific.

💜 heritage()

this returns the same items in the ancestors() list but in reverse order — from most senior parent to most junior. so like, the ancestry served in chronological order. it's giving genealogy ✨

---

🙈 PRIVATE METHODS 🙈

💀 init(\%config)

this method redefines the default initialisation method. it calls the init_workplace() method inherited from Badger::Workplace and then calls the init_workspace() method to perform any workspace-specific initialisation. teamwork makes the dream work fr fr.

💀 init_workspace(\%config)

this method performs workspace-specific initialisation. in this module it simply calls init_config(). subclasses may redefine it to do something different — go off, customise your heart out 🎀

💀 init_config(\%config)

this initialised the Badger::Config::Filesystem object which manages the config configuration directory. yes bestie, the original says "initialised", we're keeping it exactly as written 💅

💀 init_dirs(\%config)

💀 init_parent(\%config)

💀 write_config_file($uri, $data)

delegates to the method of the same name provided by the filesystem config object — see Badger::Config::Filesystem. it's a hand-off, she's not doing it herself.

---

🔥 TODO 🔥

• Inheritance of configuration data between parent and child workspaces.

(the original just says it like that, no extra notes, so we leave it exactly as it is — a whole todo, just vibing there 👑)

---

🌸 AUTHOR 🌸

Andy Wardley <abw@wardley.org>. king behaviour honestly 🫶

---

💖 COPYRIGHT 💖

Copyright (C) 2008-2014 Andy Wardley. All Rights Reserved.

---

okay that's the whole page bestie, every flag, every default, every method, all accounted for. nothing skipped, nothing invented. slay 💅✨

this was Badger::Workspace from perl v5.36.0, dated 2023-08-28, in the User Contributed Perl Documentation — mwah, go build something cute with it 🎀🦋💖