#advent

adventurous

A companion crate for solving Advent of Code puzzles

6 releases (3 breaking)

0.3.0 Dec 3, 2023
0.2.0 Dec 2, 2023
0.1.0 Dec 2, 2023
0.0.3 Dec 2, 2018

#18 in #advent

MIT license

11KB
204 lines

Adventurous

Adventurous is a companion crate to assist you in solving Advent of Code puzzles.

crates.io docs.rs license

Installation

[dependencies]
adventurous = "0.3.0"

Examples

Solving a puzzle

use adventurous::Input;
use anyhow::Result;

#[adventurous::part_one]
fn part_one(input: &Input) -> Result<usize> {
    Ok(input
        .traverse(|line| {
            // Do something with the line...
            line.parse::<usize>()
        })?
        .sum())
}

#[adventurous::part_two]
fn part_two(_input: &Input) -> Result<usize> {
    todo!()
}

fn main() -> Result<()> {
    adventurous::run("input.txt", part_one, part_two)
}

Regression testing

Once a solution has been solved, you can provide the correct answer for each part using the #[part_one] and #[part_two] attributes.

Calling test_solutions!() inside of your tests module will generate regression tests that ensure the output from your solvers matches the correct answer.

use adventurous::Input;
use anyhow::Result;

#[adventurous::part_one(answer = "73")]
fn part_one(input: &Input) -> Result<usize> {
    Ok(input
        .traverse(|line| {
            // Do something with the line...
            line.parse::<usize>()
        })?
        .sum())
}

#[cfg(test)]
mod tests {
    use super::*;

    adventurous::test_solutions!();
}

Dependencies

~0.6–1MB
~21K SLoC