Merge branch 'master' into day04, adding the Answer struct

Author: sourproton

src/helpers.rs

@@ -2,7 +2,8 @@
 
 use {
     std::fs::File,
-    std::io::{self, BufRead},
+    std::io::{BufRead, BufReader, Lines},
+    std::iter::Flatten,
     std::path::Path,
 };
 
@@ -13,12 +14,18 @@ pub fn solve_day(day: u8) {
     /// macro takes a `dayXX` module and displays its `dayXX::pt1` and `dayXX::pt2` solutions
     macro_rules! solve {
         ($dayXX:ident) => {{
-            let (answer1, time1) = crate::solutions::$dayXX::pt1(&filename);
-            let (answer2, time2) = crate::solutions::$dayXX::pt2(&filename);
+            let answer1 = crate::solutions::$dayXX::pt1(&filename);
+            let answer2 = crate::solutions::$dayXX::pt2(&filename);
 
             println!("Day {day:02}");
-            println!("    part 1: {answer1}, elapsed time: {time1} ms");
-            println!("    part 2: {answer2}, elapsed time: {time2} ms");
+            println!(
+                "    part 1: {}, elapsed time: {} ms",
+                answer1.answer, answer1.time
+            );
+            println!(
+                "    part 2: {}, elapsed time: {} ms",
+                answer2.answer, answer2.time
+            );
             println!("");
         }};
     }
@@ -54,10 +61,35 @@ pub fn solve_day(day: u8) {
     }
 }
 
-/// 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>>
+/// struct to store the answer of a challenge
+pub struct Answer {
+    answer: u32,
+    time: u32,
+}
+
+impl Answer {
+    pub fn new(answer: u32, time: u32) -> Self {
+        Answer { answer, time }
+    }
+}
+
+/// returns an iterator over each line in the input file, ignoring lines that failed to be read
+pub fn read_lines<P>(filename: P) -> Flatten<Lines<BufReader<File>>>
 where
     P: AsRef<Path>,
 {
-    io::BufReader::new(File::open(filename).expect("not able to open file")).lines()
+    BufReader::new(File::open(filename).expect("not able to open file"))
+        .lines()
+        .flatten()
+}
+
+#[cfg(test)]
+mod tests {
+    use super::Answer;
+
+    impl Answer {
+        pub fn answer(&self) -> u32 {
+            self.answer
+        }
+    }
 }

src/solutions/day01.rs

@@ -4,15 +4,19 @@
 //!
 //! https://adventofcode.com/2022/day/1
 
-use {crate::helpers::read_lines, std::time::SystemTime};
+use {
+    crate::helpers::{read_lines, Answer},
+    std::time::SystemTime,
+};
 
-pub fn pt1(filename: &str) -> (u32, u32) {
+/// solves the part 1 of day 01 and return its result and elapsed time
+pub fn pt1(filename: &str) -> Answer {
     let time = SystemTime::now();
 
     let mut biggest = 0;
     let mut current = 0;
 
-    read_lines(filename).flatten().for_each(|line| {
+    read_lines(filename).for_each(|line| {
         match line.as_str() {
             // if empty line, compare current block with biggest found until then
             "" => {
@@ -26,21 +30,19 @@ pub fn pt1(filename: &str) -> (u32, u32) {
 
     biggest = biggest.max(current);
 
-    let answer = biggest;
-    let time = time.elapsed().unwrap().as_millis() as u32;
-
-    (answer, time)
+    Answer::new(biggest, time.elapsed().unwrap().as_millis() as u32)
 }
 
-pub fn pt2(filename: &str) -> (u32, u32) {
+/// solves the part 2 of day 01 and return its result and elapsed time
+pub fn pt2(filename: &str) -> Answer {
     let time = SystemTime::now();
 
     // we want to find the sum of the 3 biggest blocks
     let mut biggest = vec![0, 0, 0];
     let mut current = 0;
 
     // iterating through each line of the file
-    read_lines(filename).flatten().for_each(|line| {
+    read_lines(filename).for_each(|line| {
         match line.as_str() {
             // if empty line, compare current block with 3 biggest known
             "" => {
@@ -72,10 +74,10 @@ pub fn pt2(filename: &str) -> (u32, u32) {
         biggest[2] = current;
     }
 
-    let answer = biggest.iter().sum();
-    let time = time.elapsed().unwrap().as_millis() as u32;
-
-    (answer, time)
+    Answer::new(
+        biggest.iter().sum(),
+        time.elapsed().unwrap().as_millis() as u32,
+    )
 }
 
 #[cfg(test)]
@@ -86,13 +88,13 @@ mod tests {
 
     #[test]
     fn pt01() {
-        let (answer, _) = pt1(FILENAME);
-        assert_eq!(24000, answer);
+        let answer = pt1(FILENAME);
+        assert_eq!(24000, answer.answer());
     }
 
     #[test]
     fn pt02() {
-        let (answer, _) = pt2(FILENAME);
-        assert_eq!(45000, answer);
+        let answer = pt2(FILENAME);
+        assert_eq!(45000, answer.answer());
     }
 }

src/solutions/day02.rs

@@ -4,32 +4,31 @@
 //!
 //! https://adventofcode.com/2022/day/2
 
-use {crate::helpers::read_lines, std::time::SystemTime};
+use {
+    crate::helpers::{read_lines, Answer},
+    std::time::SystemTime,
+};
 
-pub fn pt1(filename: &str) -> (u32, u32) {
+/// solves the part 1 of day 02 and return its result and elapsed time
+pub fn pt1(filename: &str) -> Answer {
     let time = SystemTime::now();
 
     let answer = read_lines(filename)
-        .flatten()
         .map(|line| RoundMoves::from_line(line).total_points())
         .sum();
 
-    let time = time.elapsed().unwrap().as_millis() as u32;
-
-    (answer, time)
+    Answer::new(answer, time.elapsed().unwrap().as_millis() as u32)
 }
 
-pub fn pt2(filename: &str) -> (u32, u32) {
+/// solves the part 2 of day 02 and return its result and elapsed time
+pub fn pt2(filename: &str) -> Answer {
     let time = SystemTime::now();
 
     let answer = read_lines(filename)
-        .flatten()
         .map(|line| RoundOutcome::from_line(line).total_points())
         .sum();
 
-    let time = time.elapsed().unwrap().as_millis() as u32;
-
-    (answer, time)
+    Answer::new(answer, time.elapsed().unwrap().as_millis() as u32)
 }
 
 #[derive(Debug)]
@@ -206,13 +205,13 @@ mod tests {
 
     #[test]
     fn pt01() {
-        let (answer, _) = pt1(FILENAME);
-        assert_eq!(15, answer);
+        let answer = pt1(FILENAME);
+        assert_eq!(15, answer.answer());
     }
 
     #[test]
     fn pt02() {
-        let (answer, _) = pt2(FILENAME);
-        assert_eq!(12, answer);
+        let answer = pt2(FILENAME);
+        assert_eq!(12, answer.answer());
     }
 }

src/solutions/day03.rs

@@ -4,22 +4,24 @@
 //!
 //! https://adventofcode.com/2022/day/3
 
-use {crate::helpers::read_lines, std::time::SystemTime};
+use {
+    crate::helpers::{read_lines, Answer},
+    std::time::SystemTime,
+};
 
-pub fn pt1(filename: &str) -> (u32, u32) {
+/// solves the part 1 of day 03 and return its result and elapsed time
+pub fn pt1(filename: &str) -> Answer {
     let time = SystemTime::now();
 
     let answer = read_lines(filename)
-        .flatten()
         .map(|line| Rucksack::from_line(line).value_of_common())
         .sum();
 
-    let time = time.elapsed().unwrap().as_millis() as u32;
-
-    (answer, time)
+    Answer::new(answer, time.elapsed().unwrap().as_millis() as u32)
 }
 
-pub fn pt2(filename: &str) -> (u32, u32) {
+/// solves the part 2 of day 03 and return its result and elapsed time
+pub fn pt2(filename: &str) -> Answer {
     let time = SystemTime::now();
 
     let mut current_group = Group {
@@ -32,7 +34,7 @@ pub fn pt2(filename: &str) -> (u32, u32) {
 
     let mut answer = 0;
 
-    for line in read_lines(filename).flatten() {
+    for line in read_lines(filename) {
         match current_index {
             1 => {
                 current_group.first = line;
@@ -52,9 +54,7 @@ pub fn pt2(filename: &str) -> (u32, u32) {
         }
     }
 
-    let time = time.elapsed().unwrap().as_millis() as u32;
-
-    (answer, time)
+    Answer::new(answer, time.elapsed().unwrap().as_millis() as u32)
 }
 
 /// represents a Rucksack and the content on its 1st and 2nd compartments
@@ -136,14 +136,14 @@ mod tests {
 
     #[test]
     fn pt01() {
-        let (answer, _) = pt1(FILENAME);
-        assert_eq!(157, answer);
+        let answer = pt1(FILENAME);
+        assert_eq!(157, answer.answer());
     }
 
     #[test]
     fn pt02() {
-        let (answer, _) = pt2(FILENAME);
-        assert_eq!(70, answer);
+        let answer = pt2(FILENAME);
+        assert_eq!(70, answer.answer());
     }
 
     #[test]