helpers refactor

Author: sourproton

README.md

@@ -17,7 +17,7 @@ My attempt to solve the [AoC2022](https://adventofcode.com/2022/) with the [Rust
 
 ### Usage
 
-- Download your puzzles inputs and put them into the `data/inputs` folder. Name them `input01.txt`, `input02.txt`, etc
+- Download your the inputs for each puzzle and put them into the `data/inputs` folder. Name them `input01.txt`, `input02.txt`, etc
 - To run all solutions, run `cargo run --release`
 - To run the solutions to days `X`, `Y` and `Z`, run `cargo run --release -- X Y Z`
 

src/helpers.rs

@@ -0,0 +1,40 @@
+//! Helpers for AoC. Includes macros, reading functions, etc
+
+use {
+    crate::solutions,
+    std::fs::File,
+    std::io::{self, BufRead},
+    std::path::Path,
+};
+
+/// solves and displays pt1 and pt2 of `day`
+pub fn solve_day(day: u8) {
+    let filename = format!("./data/inputs/input{day:02}.txt");
+    match day {
+        1 => {
+            let (answer1, time1) = solutions::day01::pt1(&filename);
+            let (answer2, time2) = solutions::day01::pt2(&filename);
+
+            println!("Day {day:02}");
+            println!("    part 1: {answer1}, elapsed time: {time1} ms");
+            println!("    part 2: {answer2}, elapsed time: {time2} ms");
+        }
+        2 => {
+            let (answer1, time1) = solutions::day02::pt1(&filename);
+            let (answer2, time2) = solutions::day02::pt2(&filename);
+
+            println!("Day {day:02}");
+            println!("    part 1: {answer1}, elapsed time: {time1} ms");
+            println!("    part 2: {answer2}, elapsed time: {time2} ms");
+        }
+        _ => println!("Day {day:02}\n    not implemented!"),
+    }
+}
+
+/// returns an iterator over each line in the input file
+pub fn read_lines<P>(filename: P) -> std::io::Lines<std::io::BufReader<std::fs::File>>
+where
+    P: AsRef<Path>,
+{
+    io::BufReader::new(File::open(filename).expect("not able to open file")).lines()
+}

src/main.rs

@@ -1,10 +1,6 @@
-use {
-    path::Path,
-    std::fs::File,
-    std::io::{self, BufRead},
-    std::{env, path},
-};
+use std::env;
 
+mod helpers;
 mod solutions;
 
 const SOLVED: [u8; 2] = [1, 2];
@@ -16,47 +12,15 @@ fn main() {
     if args.len() == 1 {
         // if no arguments given, run all available solutions
         SOLVED.into_iter().for_each(|day| {
-            solve_day(day);
+            helpers::solve_day(day);
         })
     } else {
         // if arguments are given, run the respective solutions
         args.into_iter().skip(1).for_each(|arg| {
             let day = arg
                 .parse()
-                .expect("not able to parse command line argument {arg}");
-            solve_day(day);
+                .unwrap_or_else(|_| panic!("not able to parse command line argument {arg}"));
+            helpers::solve_day(day);
         })
     }
 }
-
-/// call functions to solve pt1 and pt2 of `day`
-fn solve_day(day: u8) {
-    let filename = format!("./data/inputs/input{day:02}.txt");
-    match day {
-        1 => {
-            let (answer1, time1) = solutions::day01::pt1(&filename);
-            let (answer2, time2) = solutions::day01::pt2(&filename);
-
-            println!("Day {day:02}");
-            println!("    part 1: {answer1}, elapsed time: {time1} ms");
-            println!("    part 2: {answer2}, elapsed time: {time2} ms");
-        }
-        2 => {
-            let (answer1, time1) = solutions::day02::pt1(&filename);
-            let (answer2, time2) = solutions::day02::pt2(&filename);
-
-            println!("Day {day:02}");
-            println!("    part 1: {answer1}, elapsed time: {time1} ms");
-            println!("    part 2: {answer2}, elapsed time: {time2} ms");
-        }
-        _ => println!("Day {day:02}\n    not implemented!"),
-    }
-}
-
-/// returns an iterator over each line in the input file
-fn read_lines<P>(filename: P) -> std::io::Lines<std::io::BufReader<std::fs::File>>
-where
-    P: AsRef<Path>,
-{
-    io::BufReader::new(File::open(filename).expect("not able to open file")).lines()
-}

src/solutions.rs

@@ -1,2 +1,4 @@
+//! Module that contains `day01`, `day02`... submodules, each with their solving functions
+
 pub mod day01;
 pub mod day02;

src/solutions/day01.rs

@@ -4,11 +4,8 @@
 //!
 //! https://adventofcode.com/2022/day/1
 
-use std::time::SystemTime;
+use {crate::helpers::read_lines, std::time::SystemTime};
 
-use crate::read_lines;
-
-// finds the block with the largest sum in the file
 pub fn pt1(filename: &str) -> (u32, u32) {
     let time = SystemTime::now();
 

src/solutions/day02.rs

@@ -4,9 +4,7 @@
 //!
 //! https://adventofcode.com/2022/day/2
 
-use std::time::SystemTime;
-
-use crate::read_lines;
+use {crate::helpers::read_lines, std::time::SystemTime};
 
 pub fn pt1(filename: &str) -> (u32, u32) {
     let time = SystemTime::now();