CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.7.0 (2022-12-14)

Changed

• Update clap to v4; MSRV 1.60 (#779)
• Use OsString for argument parsing (#791)

0.6.0 (2022-02-11)

Added

• fs_err dependency (#363)
• Tokio: upgrade to v1.0 (#426)
• Tokio: add actix support (#510)
• Support for RUST_LOG (#555)
• Migrated to clap v3 for command-line argument parsing (#562, #617, #634)

Changed

• Rename APPLICATION -> APP; export from prelude; redo helpers (#272)
• Bump secrecy from 0.6 to 0.7 (#314)
• Fine-grained application state locking with arc-swap (#425)
• Replace color-backtrace with color-eyre (#427)
• Use main as the default branch name (#553)
• Upgrade Rust edition to 2021; MSRV 1.56 (#574)

Removed

• Signal handling (#419)
• gimli-backtrace feature (#422)
• generational-arena dependency (#424)
• chrono dependency (#579)
• Derive: darling dependency (#619)

Migration guide

The Abscissa v0.6.0 release now uses clap v3 for command-line argument parsing.

This is because Clap automatically handles things like version, help subcommands, and flags thereby providing a friendly help screen.

To migrate to the v0.6.0 version from other versions, add the v0.6.0 version of abscissa_core in your cargo.toml file.

[dependencies]
abscissa_core = "0.6.0"

[dev-dependencies]
abscissa_core = "0.6.0"

Now, replace gumdrop with clap v3 in the dependencies section of your Cargo.toml file.

clap = "3"

clap v3 uses a Parser proc macro: replace gumdrop's Option with Clap in your commands folder and commands.rs file.

• Use rustdoc comments in commands and subcommands structs for help messages;

use clap::Parser;

/// Command help message
#[derive(Command, Debug, Default, Parser)]
pub struct Command {
  // This is a free command
    #[clap()]
    pub args: Vec<String>,
  // This accepts short and long flags
    #[clap(short, long)]
    pub overwrite: bool,
}

• Create an entry point for your application in the commands.rs file.

/// Entry point for the application. It needs to be a struct to allow using subcommands!
#[derive(Command, Debug, Clap)]
#[clap(author, about, version)]
pub struct EntryPoint {
    #[clap(subcommand)]
    // Replace this with you app name
    cmd: AppCmd,

    /// Enable verbose logging
    #[clap(short, long)]
    pub verbose: bool,

    /// Use the specified config file
    #[clap(short, long)]
    pub config: Option<String>,
}

impl Runnable for EntryPoint {
    fn run(&self) {
        self.cmd.run()
    }
}

• In your commands.rs file, replace the code below with Entrypoint.

// Where App is the name of your Application
impl Configurable<AppConfig> for AppCmd

The code above becomes:

impl Configurable<AppConfig> for EntryPoint

• Remove the version command from your application.

In application.rs, replace AppCmd with EntryPoint

// Remove this
use crate::{commands::AppCmd, config::GorcConfig};

// Replace with this
use crate::{commands::EntryPoint, config::GorcConfig};

// Remove this
type Cmd = AppCmd;

// Replace with this
type Cmd = EntryPoint;

// Remove this
fn tracing_config(&self, command: &AppCmd) -> trace::Config {

// Replace with this
fn tracing_config(&self, command: &EntryPoint) -> trace::Config {

• Finally, replace the version argument to a flag in your tests/acceptance.rs file

// Remove this
let mut cmd = runner.arg("version").capture_stdout().run();

// Replace with this
let mut cmd = runner.arg("--version").capture_stdout().run();

To install the v0.6.0 version of Abscissa in your local machine, run the command below.

cargo install abscissa --version 0.6.0

0.5.2 (2020-01-29)

Fixed

• Usage handling of toplevel Options structs (#202)

0.5.1 (2020-01-12)

Added

• Add thiserror to default application boilerplate (#188)

Fixed

• Workaround for #[option(command)] usage parsing (#187)

0.5.0 (2019-12-16)

Added

• color-backtrace support (#148)
• gimli-backtrace Cargo feature (#150)
• cli: automatically generate Cargo.lock (#176)
• cli: add gen cmd subcommand (#177)

Changed

• template: warn for missing docs; re-export status macros via prelude (#147)
• Upgrade secrecy crate to v0.6 (#169)
• template: Wire up .gitignore (#175)

Replaced lazy_static with once_cell (#167, #168)

Abscissa primarily used lazy_static in two places:

• To define the APPLICATION constant in application.rs
• To provide a shared RUNNER object for invoking CLI tests in tests/acceptance.rs

Both usages have now been replaced with once_cell, which is a better fit for Abscissa's internal usages, and seems to stand a reasonable chance of being incorporated into the Rust standard library:

rust-lang/rfcs#2788

Existing applications will need to replace the lazy_static! directive in application.rs:

lazy_static! {
    /// Application state
    pub static ref APPLICATION: application::Lock<MyApplication> = application::Lock::default();
}

with one based on the new AppCell type:

use abscissa_core::application::AppCell;

/// Application state
pub static APPLICATION: AppCell<MyApplication> = AppCell::new();

This change should otherwise be largely a drop-in replacement, and also means you can remove lazy_static from [dependencies] in Cargo.toml.

For replacing RUNNER in tests/acceptance.rs, we suggest you edit Cargo.toml, adding the following:

[dev-dependencies]
once_cell = "1.2"

And then changing the following in tests/acceptance.rs:

lazy_static! {
    pub static ref RUNNER: CmdRunner = CmdRunner::default();
}

to:

use once_cell::sync::Lazy;

pub static RUNNER: Lazy<CmdRunner> = Lazy::new(|| CmdRunner::default());

Replaced log with tracing (#154)

tracing is a newer, more powerful application-level tracing library which also subsumes the functionality of a logging framework, and replaces Abscissa's previous logging component.

Existing apps will need to update their application.rs. Change the following at the bottom of the trait impl:

impl Application {
    // ...

    /// Get logging configuration from command-line options
    fn logging_config(&self, command: &MyCommand) -> logging::Config {
        if command.verbose() {
            logging::Config::verbose()
        } else {
            logging::Config::default()
        }
    }
}

to:

use abscissa_core::trace;

impl Application {
    // ...

    /// Get tracing configuration from command-line options
    fn tracing_config(&self, command: &EntryPoint<MyCommand>) -> trace::Config {
        if command.verbose {
            trace::Config::verbose()
        } else {
            trace::Config::default()
        }
    }
}

Split core prelude from template (#172)

Existing users may want to update their prelude.rs to look like:

/// Abscissa core prelude
pub use abscissa_core::prelude::*;

/// Application state accessors
pub use crate::application::{app_config, app_reader, app_writer};

Removed

Replaced Config custom derive with blanket impl (#152)

The previous custom derive for Config was replaced with a blanket impl instead. This only requires that you remove the derive for Config in existing applications' config.rs. Change:

use abscissa_core::{Config, EntryPoint};

/// MyApp Configuration
#[derive(Clone, Config, Debug, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct MyConfig { 
    // ...
}

to:

/// MyApp Configuration
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct MyConfig { 
    // ...
}

(i.e. remove Config from the #[derive(...)] section)

Removed failure (#151)

Since the time failure was written, std::error::Error has gained many of the features it was originally useful for. Many libraries now rely on it for bounds, especially in conjunction with Box for type erasure.

There is no prescribed replacement for failure at a framework-level (yet, see #144 for some discussion).

The new abscissa_core::error::Context type subsumes the functionality of both the previous abscissa_core::error::Error type and its previous usages of failure::Context, e.g. capturing error sources and backtraces.

All existing usages of abscissa_core::error::Error will need to be updated, per the instructions below.

Existing apps are advised to do the following:

• Cargo.toml: remove failure
• error.rs: remove failure imports and Fail derive. thiserror or err-derive are the suggested custom derive replacements. The Error type definition should be changed from:

/// Error type
#[derive(Debug)]
pub struct Error(abscissa_core::Error<ErrorKind>);

to:

use abscissa_core::error::Context;

/// Error type
#[derive(Debug)]
pub struct Error(Box<Context<ErrorKind>>);

• error.rs: add impl ErrorKind with context method: this is used for capturing an error source when using your own application's ErrorKind type, ala similar functionality in failure. Add the following impl to ErrorKind, allowing you to capture an error context for any error type which meets the trait bounds specified by the BoxError type:

use abscissa_core::error::BoxError;

impl ErrorKind {
    /// Create an error context from this error
    pub fn context(self, source: impl Into<BoxError>) -> Context<ErrorKind> {
        Context::new(self, Some(source.into()))
    }
}

• error.rs: replace ErrorKind impl of From with one for Context. After using the above context method, it's useful be able to convert it into() your application's wrapper type, particularly when writing From coercions from foreign error types.

Change:

impl From<abscissa_core::Error<ErrorKind>> for Error {
    fn from(other: abscissa_core::Error<ErrorKind>) -> Self {
        Error(other)
    }
}

to:

use abscissa_core::error::Context;

impl From<Context<ErrorKind>> for Error {
    fn from(context: Context<ErrorKind>) -> Self {
        Error(Box::new(context))
    }
}

• error.rs: update Error impl of Deref:

impl Deref for Error {
    type Target = abscissa_core::Error<ErrorKind>;

    fn deref(&self) -> &abscissa_core::Error<ErrorKind> {
        &self.0
    }
}

to:

impl Deref for Error {
    type Target = Context<ErrorKind>;

    fn deref(&self) -> &Context<ErrorKind> {
        &self.0
    }
}

• error.rs: add a std::error::Error impl for the app Error type:

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        self.0.source()
    }
}

0.4.0 (2019-10-13)

• Update dependencies: gumdrop 0.7, secrecy 0.4 (#141)
• template: Lint for 2018 edition idioms; export error macros (#136)
• Improve lints and deny policy (#135)
• derive: Update to 1.0 versions of proc-macro2/quote/syn (#134)
• Support positional arguments in usage descriptions (#131)
• Fix issues with the signal handler thread (#130)
• template: Add Deref impl on Error newtype (#129)

0.3.0 (2019-08-05)

• usage: Use bold rather than explicit color (#126)
• Switch from heck to ident_case (#124)
• component: Ensure registration will succeed before mutating (#122)
• component: Add #[component(dep = "...")] attribute (#121)
• derive: Custom derive support for Component (#119)
• component: Index Registry by TypeId (#118)
• component: Add get_downcast_ref/get_downcast_mut to Registry (#117)
• component: Add get_mut methods to Registry (#115)
• component: Use generational-arena for component storage (#113)
• component: allow Registry::iter() without mutable reference(#110)

0.2.1 (2019-07-27)

• usage: Fix bugs when traversing subcommands (#107)
• usage: Fix panic when printing usage on error (#106)

0.2.0 (2019-07-16)

• Merge abscissa_generator into abscissa CLI crate (#95)
• Rename abscissa crate to abscissa_core (#94)
• generator: Remove hashbrown dependency (#93)
• testing: Add Regex newtype (#91)
• config: Mandate Default bound + testing support (#84, #90)
• generator: Add serde(deny_unknown_fields) (#88)
• generator: Add config filename boilerplate to template (#82)
• Configuration loading improvements (#81)
• Refactor and improve abscissa::testing (#78)

0.1.0 (2019-07-02)

• components: Add basic downcasting support (#72)
• components: impl PartialOrd for Box<dyn Component> (#71)
• generator: Run git init automatically (#69)
• abscissa new: add --force option (#68)
• testing: Support for capturing/asserting on streams (#65)
• testing: Add initial testing subsystem (#64)
• Upgrade to gumdrop v0.6 (#63)
• command: Show full usage on error with no args (#61)
• Command usage improvements (#59)
• entrypoint: Use config arg (#58)
• terminal: Persistent stdout/stderr streams (#57)
• Integrated logging support (#56)
• abscissa_generator: Use Error/ErrorKind names (#55)
• Add app_config()/app_reader()/app_writer() and prelude to template (#52)
• abscissa_derive: Test all proc macros (#51)
• Signal handling using the signal-hook crate (#50)
• thread: Wrappers for spawning threads (#49)
• Impl Runnable/RunnableMut for Box<dyn Fn/FnMut> (#48)
• Switch from term crate to termcolor crate (#47)
• Rename Callable to Runnable (#45)
• Bump minimum Rust version to 1.35.0 (#44)
• Use secrecy crate for secret-keeping (#43, #53)
• Refactor Application and Config (#42)
• abscissa_generator: Generate new apps with abscissa new (#38, #39, #40, #41)
• config: Refactor to eliminate macro_rules! (#34)
• Update to Rust 2018 edition (#30, #36)

0.0.6 (2018-10-12)

• Upgrade to zeroize v0.4 (#24)

0.0.5 (2018-10-11)

• Use zeroize crate for clearing secrets from memory (#22)
• config/load.rs: Improved error messages (#21)
• Add fatal! and fatal_error! macros (#20)
• Remove LOGO_ASCII_ART (#19)
• Make error module public (#18)

0.0.4 (2018-09-01)

• secrets.rs: Fix trait bounds for BorrowSecret<T> (#16)

0.0.3 (2018-09-01)

• Full application lifecycle implementation (#14)

0.0.2 (2018-08-28)

• Use the failure_derive crate (#11)
• Use the isatty crate (#10
• util.rs: Export the chrono crate under util::time (#8)

0.0.1 (2018-08-25)

• Initial release