refactor: 'secondary_values' function return a 'SecondaryValues' struct

The 'secondary_values' function in the Actions struct has been refactored to return a 'SecondaryValues' struct instead of a tuple.

src/actions.rs

@@ -10,6 +10,18 @@ use nalgebra::Vector2;
 
 use crate::{action::Action, error::ParseActionError, run_length::rle_decode};
 
+/// Secondary statistics for a sequence of actions.
+pub struct SecondaryValues {
+    /// Straight line box pushes.
+    pub box_lines: i32,
+    /// Changing focus from one box to another.
+    pub box_changes: i32,
+    /// Changing from moving the line to pushing the boxes.
+    pub pushing_sessions: i32,
+    /// Straight line player moves.
+    pub player_lines: i32,
+}
+
 /// A sequence of actions.
 #[derive(Clone, Eq, PartialEq, Hash, Debug, Default)]
 pub struct Actions(pub Vec<Action>);
@@ -26,7 +38,7 @@ impl Actions {
     }
 
     /// Returns the secondary values.
-    pub fn secondary_values(&self) -> (i32, i32, i32, i32) {
+    pub fn secondary_values(&self) -> SecondaryValues {
         let mut player_lines = 0;
         let mut box_lines = 0;
         let mut box_changes = 0;
@@ -62,7 +74,12 @@ impl Actions {
         if prev_pushed_box_position.is_some() {
             box_changes += 1;
         }
-        (box_lines, box_changes, pushing_sessions, player_lines)
+        SecondaryValues {
+            box_lines,
+            box_changes,
+            pushing_sessions,
+            player_lines,
+        }
     }
 }
 

tests/actions.rs

@@ -1,6 +1,6 @@
 use std::str::FromStr;
 
-use soukoban::{Actions, ParseActionError};
+use soukoban::{Actions, ParseActionError, SecondaryValues};
 
 #[test]
 fn parse_actions_error() {
@@ -31,7 +31,12 @@ fn scoring_metrics() {
     let empty_actions = Actions::from_str("").unwrap();
     assert_eq!(empty_actions.moves(), 0);
     assert_eq!(empty_actions.pushes(), 0);
-    let (box_lines, box_changes, pushing_sessions, player_lines) = empty_actions.secondary_values();
+    let SecondaryValues {
+        box_lines,
+        box_changes,
+        pushing_sessions,
+        player_lines,
+    } = empty_actions.secondary_values();
     assert_eq!(box_lines, 0);
     assert_eq!(box_changes, 0);
     assert_eq!(pushing_sessions, 0);
@@ -49,7 +54,12 @@ fn scoring_metrics() {
     let actions = Actions::from_str("ruuLLLLrrrrddlUruLLLulDrddllluuRRDrdLuuurDD").unwrap();
     assert_eq!(actions.moves(), 43);
     assert_eq!(actions.pushes(), 15);
-    let (box_lines, box_changes, pushing_sessions, player_lines) = actions.secondary_values();
+    let SecondaryValues {
+        box_lines,
+        box_changes,
+        pushing_sessions,
+        player_lines,
+    } = actions.secondary_values();
     assert_eq!(box_lines, 8);
     assert_eq!(box_changes, 5);
     assert_eq!(pushing_sessions, 7);
@@ -65,7 +75,12 @@ fn scoring_metrics() {
     // box lines     : 6
     // pushing sessions: 6
     let actions = Actions::from_str("ullDullddrRuLurrrdLLrrddlUruL").unwrap();
-    let (box_lines, box_changes, pushing_sessions, player_lines) = actions.secondary_values();
+    let SecondaryValues {
+        box_lines,
+        box_changes,
+        pushing_sessions,
+        player_lines,
+    } = actions.secondary_values();
     assert_eq!(box_lines, 6);
     assert_eq!(box_changes, 4);
     assert_eq!(pushing_sessions, 6);