Initial commit

.cargo/config

@@ -0,0 +1,6 @@
+[alias]
+scaffold = "run --bin scaffold --quiet --release --"
+download = "run --bin download --quiet --release --"
+download_all = "run --bin download_all --quiet --release --"
+
+solve = "run --bin"

.env.example

@@ -0,0 +1,2 @@
+TOKEN=secret
+YEAR=2022

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: Check
+
+on: push
+
+env:
+    CARGO_TERM_COLOR: always
+
+jobs:
+    check:
+        runs-on: ubuntu-latest
+        name: Check
+        steps:
+            - uses: actions/checkout@v3
+            - name: cargo check
+              run: cargo check
+    test:
+        runs-on: ubuntu-latest
+        name: Test
+        steps:
+            - uses: actions/checkout@v3
+            - name: cargo test
+              run: cargo test
+    clippy:
+        runs-on: ubuntu-latest
+        name: Lint (clippy)
+        steps:
+            - uses: actions/checkout@v3
+            - name: cargo clippy
+              run: cargo clippy -- -D warnings
+    fmt:
+        runs-on: ubuntu-latest
+        name: Format
+        steps:
+            - uses: actions/checkout@v3
+            - name: cargo fmt
+              run: cargo fmt --check

.gitignore

@@ -0,0 +1,16 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# aoc-template
+# env vars
+.env
+
+# downloaded inputs
+/src/inputs/*
+!/src/inputs/.keep
+

Cargo.toml

@@ -0,0 +1,22 @@
+[package]
+name = "aoc"
+description = "solutions for advent of code 2016"
+readme = "README.md"
+version = "24.0.0"
+edition = "2021"
+license = "MIT"
+authors = ["Matej Janežič <janezic.mj@gmail.com>"]
+repository = "https://github.com/janezicmatej/aoc-template.git"
+default-run = "aoc"
+
+[dependencies]
+dotenv = "0.15.0"
+elves = "0.2.0"
+hashbrown = "0.13.1"
+hex-literal = "0.3.4"
+itertools = "0.10.5"
+lazy_static = "1.4.0"
+pico-args = "0.5.0"
+regex = "1.7.0"
+reqwest = "0.11.13"
+tokio = { version = "1.23.0", features = ["full"] }

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Matej Janežič
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,33 @@
+![ci](https://github.com/janezicmatej/aoc2016/actions/workflows/ci.yml/badge.svg)
+# Advent-of-Code 2016
+*This is a dumbed down version of [fspoettel/advent-of-code-rust](https://github.com/fspoettel/advent-of-code-rust) with some extra features*
+
+## Project overview
+
+### Project structure
+- `src/` :
+    - `bin/`:
+        - `<day>.rs`: solution files 
+        - `*.rs`: convenience scripts
+    - `inputs/`: this directory is gitignored, input files go here
+    - `examples/`: example files go here; you can push this as test are run in ci
+    - `utils/`: utils files go here
+    - `lib.rs`: contains framework code
+    - `main.rs`: contains framework code
+- `.env.example`: example dotenv file
+
+### Cli
+- `cargo scaffold <day>`: prepare solution files for `day`
+- `cargo download <day>`: download input file for `day`
+- `cargo solve <day>`: run solution against input for `day`
+- `cargo all`: alias for run; runs solutions for all days
+
+
+### dotenv
+
+set `YEAR` to whichever year you are solving for and `TOKEN` to AoC session Cookie
+
+### FAQ
+
+#### How are your commits numbered in ascending order?
+[https://westling.dev/b/extremely-linear-git](https://westling.dev/b/extremely-linear-git)

src/bin/download.rs

@@ -0,0 +1,61 @@
+use dotenv::dotenv;
+use reqwest::{header, Client};
+use std::{env, fs::OpenOptions, io::Write, process};
+
+#[tokio::main]
+async fn main() {
+    let day: u8 = match aoc::parse_args() {
+        Ok(day) => day,
+        Err(_) => {
+            eprintln!("Need to specify a day (as integer). example: `cargo download 7`");
+            process::exit(1);
+        }
+    };
+    dotenv().ok();
+
+    let day_padded = format!("{day:02}");
+    let token = env::var("TOKEN").expect("$TOKEN is not set");
+    let year = env::var("YEAR")
+        .expect("$YEAR is not set")
+        .parse::<u32>()
+        .expect("$YEAR must be a number");
+
+    let mut headers = header::HeaderMap::new();
+    let mut session_header = header::HeaderValue::from_str(format!("session={token}").as_str())
+        .expect("Error building cookie header");
+    session_header.set_sensitive(true);
+    headers.insert(header::COOKIE, session_header);
+
+    let client = Client::builder().default_headers(headers).build().unwrap();
+    let res = client
+        .get(format!("https://adventofcode.com/{year}/day/{day}/input"))
+        .send()
+        .await
+        .unwrap()
+        .text()
+        .await
+        .unwrap();
+
+    let input_path = format!("src/inputs/{day_padded}.txt");
+    let mut file = match OpenOptions::new()
+        .write(true)
+        .create(true)
+        .open(&input_path)
+    {
+        Ok(file) => file,
+        Err(e) => {
+            eprintln!("Failed to create module file: {e}");
+            process::exit(1);
+        }
+    };
+
+    match file.write_all(res.as_bytes()) {
+        Ok(_) => {
+            println!("Downloaded input file \"{}\"", &input_path);
+        }
+        Err(e) => {
+            eprintln!("Failed to write module contents: {e}");
+            process::exit(1);
+        }
+    }
+}

src/bin/download_all.rs

@@ -0,0 +1,57 @@
+use dotenv::dotenv;
+use itertools::Itertools;
+use reqwest::{header, Client};
+use std::{env, fs::OpenOptions, io::Write, process};
+
+#[tokio::main]
+async fn main() {
+    dotenv().ok();
+    let token = env::var("TOKEN").expect("$TOKEN is not set");
+    let year = env::var("YEAR")
+        .expect("$YEAR is not set")
+        .parse::<u32>()
+        .expect("$YEAR must be a number");
+
+    let mut headers = header::HeaderMap::new();
+    let mut session_header = header::HeaderValue::from_str(format!("session={token}").as_str())
+        .expect("Error building cookie header");
+    session_header.set_sensitive(true);
+    headers.insert(header::COOKIE, session_header);
+
+    let client = Client::builder().default_headers(headers).build().unwrap();
+    let responses = (1..=25)
+        .map(|d| {
+            let endpoint = format!("https://adventofcode.com/{year}/day/{d}/input");
+            println!("{endpoint}");
+            client.get(endpoint).send()
+        })
+        .collect_vec()
+        .into_iter()
+        .map(|x| async { x.await.unwrap().text().await.unwrap() })
+        .collect_vec();
+
+    for (day, res) in (1..=25).zip(responses) {
+        let input_path = format!("src/inputs/{day:02}.txt");
+        let mut file = match OpenOptions::new()
+            .write(true)
+            .create(true)
+            .open(&input_path)
+        {
+            Ok(file) => file,
+            Err(e) => {
+                eprintln!("Failed to create module file: {e}");
+                process::exit(1);
+            }
+        };
+
+        match file.write_all(res.await.as_bytes()) {
+            Ok(_) => {
+                println!("Downloaded input file \"{}\"", &input_path);
+            }
+            Err(e) => {
+                eprintln!("Failed to write module contents: {e}");
+                process::exit(1);
+            }
+        }
+    }
+}

src/bin/scaffold.rs

@@ -0,0 +1,104 @@
+/*
+ * This file contains template code.
+ * There is no need to edit this file unless you want to change template functionality.
+ */
+use std::{
+    fs::{File, OpenOptions},
+    io::Write,
+    process,
+};
+
+const MODULE_TEMPLATE: &str = r###"pub fn part_one(input: &str) -> Option<u32> {
+    None
+}
+pub fn part_two(input: &str) -> Option<u32> {
+    None
+}
+fn main() {
+    let input = &aoc::read_file("inputs", DAY);
+    aoc::solve!(1, part_one, input);
+    aoc::solve!(2, part_two, input);
+}
+#[cfg(test)]
+mod tests {
+    use super::*;
+    #[test]
+    fn test_part_one() {
+        let input = aoc::read_file("examples", DAY).trim();
+        assert_eq!(part_one(&input), None);
+    }
+    #[test]
+    fn test_part_two() {
+        let input = aoc::read_file("examples", DAY).trim();
+        assert_eq!(part_two(&input), None);
+    }
+}
+"###;
+
+fn safe_create_file(path: &str) -> Result<File, std::io::Error> {
+    OpenOptions::new().write(true).create_new(true).open(path)
+}
+
+fn create_file(path: &str) -> Result<File, std::io::Error> {
+    OpenOptions::new().write(true).create(true).open(path)
+}
+
+fn main() {
+    let day = match aoc::parse_args() {
+        Ok(day) => day,
+        Err(_) => {
+            eprintln!("Need to specify a day (as integer). example: `cargo scaffold 7`");
+            process::exit(1);
+        }
+    };
+
+    let day_padded = format!("{day:02}");
+
+    let input_path = format!("src/inputs/{day_padded}.txt");
+    let example_path = format!("src/examples/{day_padded}.txt");
+    let module_path = format!("src/bin/{day_padded}.rs");
+
+    let mut file = match safe_create_file(&module_path) {
+        Ok(file) => file,
+        Err(e) => {
+            eprintln!("Failed to create module file: {e}");
+            process::exit(1);
+        }
+    };
+
+    match file.write_all(MODULE_TEMPLATE.replace("DAY", &day.to_string()).as_bytes()) {
+        Ok(_) => {
+            println!("Created module file \"{}\"", &module_path);
+        }
+        Err(e) => {
+            eprintln!("Failed to write module contents: {e}");
+            process::exit(1);
+        }
+    }
+
+    match create_file(&input_path) {
+        Ok(_) => {
+            println!("Created empty input file \"{}\"", &input_path);
+        }
+        Err(e) => {
+            eprintln!("Failed to create input file: {e}");
+            process::exit(1);
+        }
+    }
+
+    match create_file(&example_path) {
+        Ok(_) => {
+            println!("Created empty example file \"{}\"", &example_path);
+        }
+        Err(e) => {
+            eprintln!("Failed to create example file: {e}");
+            process::exit(1);
+        }
+    }
+
+    println!("---");
+    println!(
+        "🎄 Type `cargo solve {}` to run your solution.",
+        &day_padded
+    );
+}

src/lib.rs

@@ -0,0 +1,127 @@
+/*
+ * This file contains template code.
+ * There is no need to edit this file unless you want to change template functionality.
+ * Prefer `./helpers.rs` if you want to extract code from your solutions.
+ */
+use std::env;
+use std::fs;
+
+pub const ANSI_ITALIC: &str = "\x1b[3m";
+pub const ANSI_BOLD: &str = "\x1b[1m";
+pub const ANSI_RESET: &str = "\x1b[0m";
+
+#[macro_export]
+macro_rules! solve {
+    ($part:expr, $solver:ident, $input:expr) => {{
+        use aoc::{ANSI_BOLD, ANSI_ITALIC, ANSI_RESET};
+        use std::fmt::Display;
+        use std::time::Instant;
+
+        fn print_result<T: Display>(func: impl FnOnce(&str) -> Option<T>, input: &str) {
+            let timer = Instant::now();
+            let result = func(input);
+            let elapsed = timer.elapsed();
+            match result {
+                Some(result) => {
+                    println!(
+                        "{} {}(elapsed: {:.2?}){}",
+                        result, ANSI_ITALIC, elapsed, ANSI_RESET
+                    );
+                }
+                None => {
+                    println!("not solved.")
+                }
+            }
+        }
+
+        println!("🎄 {}Part {}{} 🎄", ANSI_BOLD, $part, ANSI_RESET);
+        print_result($solver, $input);
+    }};
+}
+
+pub fn read_file(folder: &str, day: u8) -> String {
+    let cwd = env::current_dir().unwrap();
+
+    let filepath = cwd.join("src").join(folder).join(format!("{day:02}.txt"));
+
+    let f = fs::read_to_string(filepath);
+    f.expect("could not open input file")
+}
+
+fn parse_time(val: &str, postfix: &str) -> f64 {
+    val.split(postfix).next().unwrap().parse().unwrap()
+}
+
+pub fn parse_args() -> Result<u8, pico_args::Error> {
+    let mut args = pico_args::Arguments::from_env();
+    args.free_from_str()
+}
+
+pub fn parse_exec_time(output: &str) -> f64 {
+    output.lines().fold(0_f64, |acc, l| {
+        if !l.contains("elapsed:") {
+            acc
+        } else {
+            let timing = l.split("(elapsed: ").last().unwrap();
+            // use `contains` istd. of `ends_with`: string may contain ANSI escape sequences.
+            // for possible time formats, see: https://github.com/rust-lang/rust/blob/1.64.0/library/core/src/time.rs#L1176-L1200
+            if timing.contains("ns)") {
+                acc // range below rounding precision.
+            } else if timing.contains("µs)") {
+                acc + parse_time(timing, "µs") / 1000_f64
+            } else if timing.contains("ms)") {
+                acc + parse_time(timing, "ms")
+            } else if timing.contains("s)") {
+                acc + parse_time(timing, "s") * 1000_f64
+            } else {
+                acc
+            }
+        }
+    })
+}
+
+/// copied from: https://github.com/rust-lang/rust/blob/1.64.0/library/std/src/macros.rs#L328-L333
+#[cfg(test)]
+macro_rules! assert_approx_eq {
+    ($a:expr, $b:expr) => {{
+        let (a, b) = (&$a, &$b);
+        assert!(
+            (*a - *b).abs() < 1.0e-6,
+            "{} is not approximately equal to {}",
+            *a,
+            *b
+        );
+    }};
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_parse_exec_time() {
+        assert_approx_eq!(
+            parse_exec_time(&format!(
+                "🎄 Part 1 🎄\n0 (elapsed: 74.13ns){ANSI_RESET}\n🎄 Part 2 🎄\n0 (elapsed: 50.00ns){ANSI_RESET}"
+            )),
+            0_f64
+        );
+
+        assert_approx_eq!(
+            parse_exec_time("🎄 Part 1 🎄\n0 (elapsed: 755µs)\n🎄 Part 2 🎄\n0 (elapsed: 700µs)"),
+            1.455_f64
+        );
+
+        assert_approx_eq!(
+            parse_exec_time("🎄 Part 1 🎄\n0 (elapsed: 70µs)\n🎄 Part 2 🎄\n0 (elapsed: 1.45ms)"),
+            1.52_f64
+        );
+
+        assert_approx_eq!(
+            parse_exec_time(
+                "🎄 Part 1 🎄\n0 (elapsed: 10.3s)\n🎄 Part 2 🎄\n0 (elapsed: 100.50ms)"
+            ),
+            10400.50_f64
+        );
+    }
+}

src/main.rs

@@ -0,0 +1,43 @@
+/*
+ * This file contains template code.
+ * There is no need to edit this file unless you want to change template functionality.
+ */
+use aoc::{ANSI_BOLD, ANSI_ITALIC, ANSI_RESET};
+use std::process::Command;
+
+fn main() {
+    let total: f64 = (1..=25)
+        .map(|day| {
+            let day = format!("{day:02}");
+
+            let cmd = Command::new("cargo")
+                .args(["run", "--release", "--bin", &day])
+                .output()
+                .unwrap();
+
+            println!("----------");
+            println!("{ANSI_BOLD}| Day {day} |{ANSI_RESET}");
+            println!("----------");
+
+            let output = String::from_utf8(cmd.stdout).unwrap();
+            let is_empty = output.is_empty();
+
+            println!(
+                "{}",
+                if is_empty {
+                    "Not solved."
+                } else {
+                    output.trim()
+                }
+            );
+
+            if is_empty {
+                0_f64
+            } else {
+                aoc::parse_exec_time(&output)
+            }
+        })
+        .sum();
+
+    println!("{ANSI_BOLD}Total:{ANSI_RESET} {ANSI_ITALIC}{total:.2}ms{ANSI_RESET}");
+}