Imperial

Access the operating system's standard directory structure

Imperial provides access to the standard directory structure in UNIX and Linux, as defined by the systemd and XDG Base Directory specifications.

Features

• Typesafe representation of standard UNIX directories
• Supports any directory representation through typeclasses
• Resolves environment variables to correctly use user-specified directory locations
• Supports alternative sources of environment variables

Availability

Getting Started

Standard directory layout

Imperial provides a structure of nested objects inside the Root and Home objects which mirror the standard directory layout on modern UNIX systems, as described in the (XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html). This allows standard directories to be referenced in code without the risk of typos.

Additionally, certain environment variables may be set which change the standard location, particularly within a user's home directory. Imperial will take these into account, according to the specification.

Accessing Directories

Objects have the same names as their corresponding UNIX directory, but by convention begin with a capital letter. Any . prefixes in a directory's name are removed since, of course, . is used in place of / to access a nested object. So /var/lib would be represented by the object, Root.Var.Lib and $HOME/.local/bin would be Home.Local.Bin.

Conversely, Home.Config would normally resolve to $HOME/.config, but if the user has the XDG_CONFIG_HOME environment variable set to something else, it would simply resolve to $XDG_CONFIG_HOME.

The type of each of these objects is BaseLayout, which provides a BaseLayout#apply() method for constructing an instance of a directory type (such as java.io.File or galilei.Directory) representing the directory. Imperial is designed to be compatible with different file and directory representations, but it works automatically with Galilei.

For example, it would be possible to access a myapp configuration directory with,

import galilei.*
val dir: Directory = Home.Config() / t"myapp"

Source of Environment Variables

By default, Imperial will take its environment variables directly from the JVM, since they are globally accessible. But this is not always the correct source, for example in a long-running server which may receive multiple command-line requests from different shells over its lifetime, each with a potentially different set of environment variables.

To cater for this scenario, it's possible to provide an alternative EnvVarProvider instance. This is a single-abstract-method trait which takes a Text value and returns an Option[Text] of the value (returning None if the environment variable is unset).

For example, if the envvars is a Map of values, a new EnvVarProvider may be specified in-scope with,

given EnvVarProvider = envvars.get(_)

Status

Imperial is classified as fledgling. For reference, Soundness projects are categorized into one of the following five stability levels:

• embryonic: for experimental or demonstrative purposes only, without any guarantees of longevity
• fledgling: of proven utility, seeking contributions, but liable to significant redesigns
• maturescent: major design decisions broady settled, seeking probatory adoption and refinement
• dependable: production-ready, subject to controlled ongoing maintenance and enhancement; tagged as version 1.0.0 or later
• adamantine: proven, reliable and production-ready, with no further breaking changes ever anticipated

Projects at any stability level, even embryonic projects, can still be used, as long as caution is taken to avoid a mismatch between the project's stability level and the required stability and maintainability of your own project.

Imperial is designed to be small. Its entire source code currently consists of 140 lines of code.

Building

Imperial will ultimately be built by Fury, when it is published. In the meantime, two possibilities are offered, however they are acknowledged to be fragile, inadequately tested, and unsuitable for anything more than experimentation. They are provided only for the necessity of providing some answer to the question, "how can I try Imperial?".

1. Copy the sources into your own project

   Read the fury file in the repository root to understand Imperial's build structure, dependencies and source location; the file format should be short and quite intuitive. Copy the sources into a source directory in your own project, then repeat (recursively) for each of the dependencies.

   The sources are compiled against the latest nightly release of Scala 3. There should be no problem to compile the project together with all of its dependencies in a single compilation.

2. Build with Wrath

   Wrath is a bootstrapping script for building Imperial and other projects in the absence of a fully-featured build tool. It is designed to read the fury file in the project directory, and produce a collection of JAR files which can be added to a classpath, by compiling the project and all of its dependencies, including the Scala compiler itself.

   Download the latest version of wrath, make it executable, and add it to your path, for example by copying it to /usr/local/bin/.

   Clone this repository inside an empty directory, so that the build can safely make clones of repositories it depends on as peers of imperial. Run wrath -F in the repository root. This will download and compile the latest version of Scala, as well as all of Imperial's dependencies.

   If the build was successful, the compiled JAR files can be found in the .wrath/dist directory.

Contributing

Contributors to Imperial are welcome and encouraged. New contributors may like to look for issues marked beginner.

We suggest that all contributors read the Contributing Guide to make the process of contributing to Imperial easier.

Please do not contact project maintainers privately with questions unless there is a good reason to keep them private. While it can be tempting to repsond to such questions, private answers cannot be shared with a wider audience, and it can result in duplication of effort.

Author

Imperial was designed and developed by Jon Pretty, and commercial support and training on all aspects of Scala 3 is available from Propensive OÜ.

Name

This project is particular to Linux operating systems, whos mascot is a penguin. While Imperial defines the layout of the operating system's own (little) empire, "Emperor" is also a species of penguin.

In general, Soundness project names are always chosen with some rationale, however it is usually frivolous. Each name is chosen for more for its uniqueness and intrigue than its concision or catchiness, and there is no bias towards names with positive or "nice" meanings—since many of the libraries perform some quite unpleasant tasks.

Names should be English words, though many are obscure or archaic, and it should be noted how willingly English adopts foreign words. Names are generally of Greek or Latin origin, and have often arrived in English via a romance language.

Logo

The logo shows the colors of an emperor (suggesting imperial) penguin.

License

Imperial is copyright © 2024 Jon Pretty & Propensive OÜ, and is made available under the Apache 2.0 License.