clippy fixes

Closes #15

Reviewed-on: #16
Co-authored-by: Rhys Lloyd <krakow20@gmail.com>
Co-committed-by: Rhys Lloyd <krakow20@gmail.com>

Cargo.lock

@@ -14,6 +14,12 @@ version = "0.7.6"
 source = "sparse+https://git.aleshym.co/api/packages/Quaternions/cargo/"
 checksum = "813440870d646c57c222c1d713dc4e3ddcb2919c3801564d767d85d7bf2afee4"
 
+[[package]]
+name = "autocfg"
+version = "1.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
+
 [[package]]
 name = "bitflags"
 version = "2.11.1"
@@ -22,7 +28,7 @@ checksum = "c4512299f36f043ab09a583e57bceb5a5aab7a73db1805848e8fef3c9e8c78b3"
 
 [[package]]
 name = "card_game"
-version = "0.4.0"
+version = "0.4.1"
 dependencies = [
  "arrayvec",
  "serde",
@@ -46,6 +52,17 @@ dependencies = [
  "rand_core",
 ]
 
+[[package]]
+name = "console"
+version = "0.16.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d64e8af5551369d19cf50138de61f1c42074ab970f74e99be916646777f8fc87"
+dependencies = [
+ "encode_unicode",
+ "libc",
+ "windows-sys",
+]
+
 [[package]]
 name = "cpufeatures"
 version = "0.3.0"
@@ -55,12 +72,34 @@ dependencies = [
  "libc",
 ]
 
+[[package]]
+name = "encode_unicode"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "34aa73646ffb006b8f5147f3dc182bd4bcb190227ce861fc4a4844bf8e3cb2c0"
+
 [[package]]
 name = "equivalent"
 version = "1.0.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f"
 
+[[package]]
+name = "errno"
+version = "0.3.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "39cab71617ae0d63f51a36d69f866391735b51691dbda63cf6f96d042b63efeb"
+dependencies = [
+ "libc",
+ "windows-sys",
+]
+
+[[package]]
+name = "fastrand"
+version = "2.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f1f227452a390804cdb637b74a86990f2a7d7ba4b7d5693aac9b4dd6defd8d6"
+
 [[package]]
 name = "foldhash"
 version = "0.1.5"
@@ -120,6 +159,18 @@ dependencies = [
  "serde_core",
 ]
 
+[[package]]
+name = "insta"
+version = "1.47.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7b4a6248eb93a4401ed2f37dfe8ea592d3cf05b7cf4f8efa867b6895af7e094e"
+dependencies = [
+ "console",
+ "once_cell",
+ "similar",
+ "tempfile",
+]
+
 [[package]]
 name = "itoa"
 version = "1.0.18"
@@ -128,12 +179,15 @@ checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
 
 [[package]]
 name = "klondike"
-version = "0.3.0"
+version = "0.4.0"
 dependencies = [
  "card_game",
+ "insta",
  "rand",
+ "rmp-serde",
  "serde",
  "serde_derive",
+ "serde_json",
 ]
 
 [[package]]
@@ -166,6 +220,12 @@ version = "0.2.186"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
 
+[[package]]
+name = "linux-raw-sys"
+version = "0.12.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "32a66949e030da00e8c7d4434b251670a91556f4144941d37452769c25d58a53"
+
 [[package]]
 name = "log"
 version = "0.4.29"
@@ -178,6 +238,21 @@ version = "2.8.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "f8ca58f447f06ed17d5fc4043ce1b10dd205e060fb3ce5b979b8ed8e59ff3f79"
 
+[[package]]
+name = "num-traits"
+version = "0.2.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
 [[package]]
 name = "prettyplease"
 version = "0.2.37"
@@ -229,6 +304,38 @@ version = "0.10.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "63b8176103e19a2643978565ca18b50549f6101881c443590420e4dc998a3c69"
 
+[[package]]
+name = "rmp"
+version = "0.8.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4ba8be72d372b2c9b35542551678538b562e7cf86c3315773cae48dfbfe7790c"
+dependencies = [
+ "num-traits",
+]
+
+[[package]]
+name = "rmp-serde"
+version = "1.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "72f81bee8c8ef9b577d1681a70ebbc962c232461e397b22c208c43c04b67a155"
+dependencies = [
+ "rmp",
+ "serde",
+]
+
+[[package]]
+name = "rustix"
+version = "1.1.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b6fe4565b9518b83ef4f91bb47ce29620ca828bd32cb7e408f0062e9930ba190"
+dependencies = [
+ "bitflags",
+ "errno",
+ "libc",
+ "linux-raw-sys",
+ "windows-sys",
+]
+
 [[package]]
 name = "semver"
 version = "1.0.28"
@@ -277,6 +384,12 @@ dependencies = [
  "zmij",
 ]
 
+[[package]]
+name = "similar"
+version = "2.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bbbb5d9659141646ae647b42fe094daf6c6192d1620870b449d9557f748b2daa"
+
 [[package]]
 name = "syn"
 version = "2.0.117"
@@ -288,6 +401,19 @@ dependencies = [
  "unicode-ident",
 ]
 
+[[package]]
+name = "tempfile"
+version = "3.27.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "32497e9a4c7b38532efcdebeef879707aa9f794296a4f0244f6f69e9bc8574bd"
+dependencies = [
+ "fastrand",
+ "getrandom",
+ "once_cell",
+ "rustix",
+ "windows-sys",
+]
+
 [[package]]
 name = "unicode-ident"
 version = "1.0.24"
@@ -352,6 +478,21 @@ dependencies = [
  "semver",
 ]
 
+[[package]]
+name = "windows-link"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
+
+[[package]]
+name = "windows-sys"
+version = "0.61.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc"
+dependencies = [
+ "windows-link",
+]
+
 [[package]]
 name = "wit-bindgen"
 version = "0.51.0"

Cargo.toml

@@ -8,8 +8,8 @@ members = [
 resolver = "3"
 
 [workspace.dependencies]
-card_game = { version = "0.4.0", path = "card_game", registry = "Quaternions" }
-klondike = { version = "0.3.0", path = "klondike", registry = "Quaternions" }
+card_game = { version = "0.4.1", path = "card_game", registry = "Quaternions" }
+klondike = { version = "0.4.0", path = "klondike", registry = "Quaternions" }
 
 [workspace.lints.rust]
 # unsafe_code = "forbid"

card_game/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "card_game"
-version = "0.4.0"
+version = "0.4.1"
 edition = "2024"
 repository = "https://git.aleshym.co/Quaternions/card_game"
 license = "MIT OR Apache-2.0"

card_game/src/lib.rs

@@ -234,6 +234,7 @@ impl<const CAP: usize> IntoIterator for Stack<CAP> {
 		self.0.into_iter()
 	}
 }
+
 #[cfg(feature = "serde")]
 impl<'de, const CAP: usize> serde::Deserialize<'de> for Stack<CAP> {
 	fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
@@ -250,10 +251,10 @@ impl<'de, const CAP: usize> serde::Deserialize<'de> for Stack<CAP> {
 			where
 				A: serde::de::SeqAccess<'de>,
 			{
+				use serde::de::Error;
 				let mut stack = Stack::new();
 				while let Some(card) = seq.next_element()? {
-					// TODO: Error
-					stack.try_push(card).unwrap();
+					stack.try_push(card).map_err(A::Error::custom)?;
 				}
 				Ok(stack)
 			}
@@ -653,20 +654,6 @@ where
 	}
 }
 
-#[cfg_attr(
-	feature = "serde",
-	derive(serde_derive::Deserialize),
-	serde(bound = "
-		G: serde::Deserialize<'de>,
-		SessionConfig<G::Config>: serde::Deserialize<'de>,
-		Vec<G::Instruction>: serde::Deserialize<'de>,
-	")
-)]
-struct SerializedSession<G: Game> {
-	config: SessionConfig<G::Config>,
-	state: G,
-	history: Vec<G::Instruction>,
-}
 #[cfg(feature = "serde")]
 impl<'de, G: Game<Score = i32>> serde::de::Deserialize<'de> for Session<G>
 where
@@ -680,9 +667,20 @@ where
 	where
 		D: serde::Deserializer<'de>,
 	{
+		#[derive(serde_derive::Deserialize)]
+		#[serde(bound(deserialize = "
+			G: serde::Deserialize<'de>,
+			SessionConfig<G::Config>: serde::Deserialize<'de>,
+			Vec<G::Instruction>: serde::Deserialize<'de>,
+		"))]
+		struct SerializedSession<G: Game> {
+			config: SessionConfig<G::Config>,
+			initial_state: G,
+			instructions: Vec<G::Instruction>,
+		}
 		let serialized = SerializedSession::deserialize(deserializer)?;
-		let mut session = Session::new(serialized.state, serialized.config);
-		for instruction in serialized.history {
+		let mut session = Session::new(serialized.initial_state, serialized.config);
+		for instruction in serialized.instructions {
 			session.process_instruction(instruction);
 		}
 		Ok(session)
@@ -719,19 +717,31 @@ where
 			}
 		}
 
-		use serde::ser::SerializeMap;
-		let mut map = serializer.serialize_map(Some(2))?;
+		#[derive(serde_derive::Serialize)]
+		#[serde(bound(serialize = "
+			G: serde::Serialize,
+			SessionConfig<G::Config>: serde::Serialize,
+			G::Instruction: serde::Serialize,
+		"))]
+		struct SerializedSession<'a, G: Game> {
+			config: &'a SessionConfig<G::Config>,
+			initial_state: &'a G,
+			instructions: History<'a, G>,
+		}
+
 		// serialize the initial state of the game.
 		// if there is history, it is the first snapshot's state,
 		// otherwise it is the current game state since there are no moves.
-		let state = if let Some(snapshot) = self.state.history.first() {
+		let initial_state = if let Some(snapshot) = self.state.history.first() {
 			snapshot.state()
 		} else {
 			&self.state.state
 		};
-		map.serialize_entry("config", &self.config)?;
-		map.serialize_entry("state", state)?;
-		map.serialize_entry("history", &History(&self.state.history))?;
-		map.end()
+		let session = SerializedSession {
+			config: &self.config,
+			initial_state,
+			instructions: History(&self.state.history),
+		};
+		session.serialize(serializer)
 	}
 }

klondike-cli/src/main.rs

@@ -4,9 +4,6 @@ use klondike::{
 	KlondikePile, KlondikePileStack, SkipCards, Tableau, TableauStack,
 };
 
-#[cfg(test)]
-mod test;
-
 use std::fmt::Display;
 struct Displayed<T>(T);
 

klondike-cli/src/test.rs

@@ -1,16 +0,0 @@
-use card_game::Session;
-use klondike::Klondike;
-#[test]
-fn test_is_winnable() {
-	// is winnable
-	let solution_result = Session::new_default(Klondike::with_seed(124)).solve();
-	if let Ok(Some(solution)) = solution_result {
-		let win_moves = solution.clean_solution();
-		// for (i, ins) in win_moves.into_iter().enumerate() {
-		// 	println!("{i} = {:?}", ins.instruction());
-		// }
-		println!("Game is winnable with {} moves", win_moves.len());
-	} else {
-		println!("Game is not winnable");
-	}
-}

klondike/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "klondike"
-version = "0.3.0"
+version = "0.4.0"
 edition = "2024"
 
 [dependencies]
@@ -9,9 +9,15 @@ rand = { version = "0.10.1", default-features = false, features = ["std_rng"] }
 serde = { version = "1.0.228", default-features = false, optional = true }
 serde_derive = { version = "1.0.228", default-features = false, optional = true }
 
+[dev-dependencies]
+insta = "1.47.2"
+rmp-serde = "1.3.1"
+serde = { version = "1.0.228", default-features = false }
+serde_json = "1.0.149"
+
 [lints]
 workspace = true
 
 [features]
 default = ["serde"]
-serde = ["dep:serde", "dep:serde_derive"]
+serde = ["dep:serde", "dep:serde_derive", "card_game/serde"]

klondike/src/lib.rs

@@ -2,6 +2,9 @@ pub type Rng = rand::rngs::StdRng;
 
 use card_game::{Card, Game, Pile, Rank, Stack};
 
+#[cfg(test)]
+mod test;
+
 // test readme
 #[doc = include_str!("../README.md")]
 #[cfg(doctest)]
@@ -161,6 +164,38 @@ impl Tableau {
 		})
 	}
 }
+pub struct TableauIter {
+	tableau: Option<Tableau>,
+}
+impl TableauIter {
+	pub const fn new() -> Self {
+		Self {
+			tableau: Some(Tableau::ITER_BEGIN),
+		}
+	}
+}
+impl Default for TableauIter {
+	fn default() -> Self {
+		Self::new()
+	}
+}
+impl Iterator for TableauIter {
+	type Item = Tableau;
+	fn next(&mut self) -> Option<Self::Item> {
+		let tableau = self.tableau?;
+		self.tableau = tableau.next();
+		Some(tableau)
+	}
+}
+impl IntoIterator for Tableau {
+	type Item = Self;
+	type IntoIter = TableauIter;
+	fn into_iter(self) -> Self::IntoIter {
+		TableauIter {
+			tableau: Some(self),
+		}
+	}
+}
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
 pub enum Foundation {
@@ -181,6 +216,38 @@ impl Foundation {
 		})
 	}
 }
+pub struct FoundationIter {
+	foundation: Option<Foundation>,
+}
+impl FoundationIter {
+	pub const fn new() -> Self {
+		Self {
+			foundation: Some(Foundation::ITER_BEGIN),
+		}
+	}
+}
+impl Default for FoundationIter {
+	fn default() -> Self {
+		Self::new()
+	}
+}
+impl Iterator for FoundationIter {
+	type Item = Foundation;
+	fn next(&mut self) -> Option<Self::Item> {
+		let foundation = self.foundation?;
+		self.foundation = foundation.next();
+		Some(foundation)
+	}
+}
+impl IntoIterator for Foundation {
+	type Item = Self;
+	type IntoIter = FoundationIter;
+	fn into_iter(self) -> Self::IntoIter {
+		FoundationIter {
+			foundation: Some(self),
+		}
+	}
+}
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
 pub enum KlondikePile {
@@ -635,7 +702,8 @@ fn test_klondike_iter() {
 
 #[cfg_attr(
 	feature = "serde",
-	derive(serde_derive::Deserialize, serde_derive::Serialize)
+	derive(serde_derive::Deserialize, serde_derive::Serialize),
+	serde(transparent)
 )]
 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
 pub struct Klondike {

klondike/src/snapshots/klondike__test__json.snap

@@ -0,0 +1,5 @@
+---
+source: klondike/src/test.rs
+expression: serialized
+---
+{"config":{"inner":{"draw_stock":"DrawOne","move_from_foundation":"Allowed","scoring":{"move_to_foundation":10,"flip_up_bonus":5,"move_to_tableau":5,"move_from_foundation":-15,"recycle":0}},"undo_penalty":-15,"solve_moves_budget":100000,"solve_states_budget":100000},"initial_state":{"stock":{"face_down":[52,51,21,59,36,45,49,50,22,3,58,39,41,61,13,57,34,56,28,1,19,12,17,5],"face_up":[]},"foundations":[[],[],[],[]],"tableau1":{"face_down":[],"face_up":[40]},"tableau2":{"face_down":[9],"face_up":[4]},"tableau3":{"face_down":[35,8],"face_up":[60]},"tableau4":{"face_down":[11,27,44],"face_up":[25]},"tableau5":{"face_down":[6,7,23,18],"face_up":[29]},"tableau6":{"face_down":[2,55,10,42,24],"face_up":[54]},"tableau7":{"face_down":[26,43,38,53,37,33],"face_up":[20]}},"instructions":[336,100,720,619,606,6,720,19,16,388,497,580,388,720,139,720,19,720,17,31,720,720,720,7,720,720,523,458,720,720,720,720,720,720,720,720,43,43,720,720,720,139,720,19,720,43,720,43,720,720,720,720,720,720,720,720,720,623,619,720,720,720,720,720,720,720,720,720,720,693,281,333,253,209,113,87,720,720,720,720,720,720,720,720,75,223,619,533,74,2,720,116,331,279,279,305,305,29,25,24,12,37,25,222,24,42,126,471,720,720,720,362,292,331,253,720,19,720,183,151,12,67,336,61,93,235,720,7,2,0,7,38,26,14,27,15,26,36,0,7,3,6,18,43,36,24,12,0,1,19,38,26,39,27,15,38,26,36]}

klondike/src/snapshots/klondike__test__save_rmp.snap

@@ -0,0 +1,6 @@
+---
+source: klondike/src/test.rs
+expression: serialized
+extension: bin
+snapshot_kind: binary
+---

klondike/src/test.rs

@@ -0,0 +1,55 @@
+use crate::Klondike;
+use card_game::Session;
+
+#[test]
+fn test_is_winnable() {
+	// is winnable
+	let solution_result = Session::new_default(Klondike::with_seed(124)).solve();
+	if let Ok(Some(solution)) = solution_result {
+		let win_moves = solution.clean_solution();
+		// for (i, ins) in win_moves.into_iter().enumerate() {
+		// 	println!("{i} = {:?}", ins.instruction());
+		// }
+		println!("Game is winnable with {} moves", win_moves.len());
+	} else {
+		println!("Game is not winnable");
+	}
+}
+
+#[cfg(feature = "serde")]
+#[test]
+fn test_json() {
+	let mut session = Session::new_default(Klondike::with_seed(124));
+	let solution_result = session.solve();
+	if let Ok(Some(solution)) = solution_result {
+		for snapshot in solution.clean_solution() {
+			session.process_instruction(snapshot.instruction().clone());
+		}
+	}
+	let serialized = serde_json::to_string(&session).unwrap();
+	println!("serialized = {serialized}");
+	let round_trip_session: Session<Klondike> = serde_json::from_str(&serialized).unwrap();
+	let serialized2 = serde_json::to_string(&round_trip_session).unwrap();
+	assert_eq!(serialized, serialized2);
+
+	insta::assert_snapshot!(serialized);
+}
+
+#[cfg(feature = "serde")]
+#[test]
+fn test_rmp() {
+	let mut session = Session::new_default(Klondike::with_seed(124));
+	let solution_result = session.solve();
+	if let Ok(Some(solution)) = solution_result {
+		for snapshot in solution.clean_solution() {
+			session.process_instruction(snapshot.instruction().clone());
+		}
+	}
+	let serialized = rmp_serde::to_vec(&session).unwrap();
+	println!("serialized.len() = {}", serialized.len());
+	let round_trip_session: Session<Klondike> = rmp_serde::from_slice(&serialized).unwrap();
+	let serialized2 = rmp_serde::to_vec(&round_trip_session).unwrap();
+	assert_eq!(serialized, serialized2);
+
+	insta::assert_binary_snapshot!("save_rmp.bin", serialized);
+}