v0.3.0: no M2 at prgrm end + versioned settings

Plus some other misc. minor changes

Author: sameer

Cargo.lock

@@ -1,12 +1,15 @@
 [package]
 name = "svg2gcode"
-version = "0.2.3"
+version = "0.3.0"
 authors = ["Sameer Puri <crates@purisa.me>"]
 edition = "2021"
 description = "Convert paths in SVG files to GCode for a pen plotter, laser engraver, or other machine."
 repository = "https://github.com/sameer/svg2gcode"
 license = "MIT"
 
+[features]
+serde = ["dep:serde", "dep:serde_repr"]
+
 [dependencies]
 g-code = { version = "0.4.1", features = ["serde"] }
 lyon_geom = "1.0.5"
@@ -23,7 +26,14 @@ optional = true
 version = "1"
 features = ["derive"]
 
+[dependencies.serde_repr]
+optional = true
+version = "0.1"
+
 [dev-dependencies]
-cairo-rs = { version = "0.18", default-features = false, features = ["svg", "v1_16"] }
+cairo-rs = { version = "0.18", default-features = false, features = [
+    "svg",
+    "v1_16",
+] }
 serde_json = "1"
 pretty_assertions = "1.4.0"

lib/Cargo.toml

@@ -286,7 +286,7 @@ mod tests {
     #[test]
     #[ignore = "Creates an image file, will revise later"]
     fn flatten_returns_expected_arcs() {
-        const PATH: &'static str = "M  8.0549,11.9023
+        const PATH: &str = "M  8.0549,11.9023
         c
         0.13447,1.69916 8.85753,-5.917903 7.35159,-6.170957
         z";

lib/src/arc.rs

@@ -171,17 +171,15 @@ fn node_name(node: &Node) -> String {
     name
 }
 
-#[cfg(test)]
+#[cfg(all(test, feature = "serde"))]
 mod test {
     use super::*;
-    #[cfg(feature = "serde")]
     use svgtypes::LengthUnit;
 
     #[test]
-    #[cfg(feature = "serde")]
     fn serde_conversion_options_is_correct() {
         let default_struct = ConversionOptions::default();
-        let default_json = "{\"dimensions\":[null,null]}";
+        let default_json = r#"{"dimensions":[null,null]}"#;
 
         assert_eq!(
             serde_json::to_string(&default_struct).unwrap(),
@@ -194,14 +192,13 @@ mod test {
     }
 
     #[test]
-    #[cfg(feature = "serde")]
     fn serde_conversion_options_with_single_dimension_is_correct() {
         let mut r#struct = ConversionOptions::default();
         r#struct.dimensions[0] = Some(Length {
             number: 4.,
             unit: LengthUnit::Mm,
         });
-        let json = "{\"dimensions\":[{\"number\":4.0,\"unit\":\"Mm\"},null]}";
+        let json = r#"{"dimensions":[{"number":4.0,"unit":"Mm"},null]}"#;
 
         assert_eq!(serde_json::to_string(&r#struct).unwrap(), json);
         assert_eq!(
@@ -211,7 +208,6 @@ mod test {
     }
 
     #[test]
-    #[cfg(feature = "serde")]
     fn serde_conversion_options_with_both_dimensions_is_correct() {
         let mut r#struct = ConversionOptions::default();
         r#struct.dimensions = [
@@ -224,8 +220,7 @@ mod test {
                 unit: LengthUnit::In,
             }),
         ];
-        let json =
-            "{\"dimensions\":[{\"number\":4.0,\"unit\":\"Mm\"},{\"number\":10.5,\"unit\":\"In\"}]}";
+        let json = r#"{"dimensions":[{"number":4.0,"unit":"Mm"},{"number":10.5,"unit":"In"}]}"#;
 
         assert_eq!(serde_json::to_string(&r#struct).unwrap(), json);
         assert_eq!(

lib/src/converter/mod.rs

@@ -1,6 +1,3 @@
-#[cfg(feature = "serde")]
-use serde::{Deserialize, Serialize};
-
 /// Approximate [Bézier curves](https://en.wikipedia.org/wiki/B%C3%A9zier_curve) with [Circular arcs](https://en.wikipedia.org/wiki/Circular_arc)
 mod arc;
 /// Converts an SVG to an internal representation
@@ -19,12 +16,82 @@ pub use machine::{Machine, MachineConfig, SupportedFunctionality};
 pub use postprocess::PostprocessConfig;
 pub use turtle::Turtle;
 
-#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+/// A cross-platform type used to store all configuration types.
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(Debug, Default, Clone, PartialEq)]
 pub struct Settings {
     pub conversion: ConversionConfig,
     pub machine: MachineConfig,
     pub postprocess: PostprocessConfig,
+    #[cfg_attr(feature = "serde", serde(default = "Version::unknown"))]
+    pub version: Version,
+}
+
+impl Settings {
+    /// Try to automatically upgrade the supported version.
+    ///
+    /// This will return an error if:
+    ///
+    /// - Settings version is [`Version::Unknown`].
+    /// - There are breaking changes requiring manual intervention. In which case this does a partial update to that point.
+    pub fn try_upgrade(&mut self) -> Result<(), ()> {
+        loop {
+            match self.version {
+                // Compatibility for M2 by default
+                Version::V0 => {
+                    self.machine.end_sequence = Some(format!(
+                        "{} M2",
+                        self.machine.end_sequence.take().unwrap_or_default()
+                    ));
+                    self.version = Version::V5;
+                }
+                Version::V5 => break Ok(()),
+                Version::Unknown(_) => break Err(()),
+            }
+        }
+    }
+}
+
+/// Used to control breaking change behavior for [`Settings`].
+///
+/// There were already 3 non-breaking version bumps (V1 -> V4) so versioning starts off with [`Version::V5`].
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
+pub enum Version {
+    /// Implicitly versioned settings from before this type was introduced.
+    V0,
+    /// M2 is no longer appended to the program by default
+    V5,
+    #[cfg_attr(feature = "serde", serde(untagged))]
+    Unknown(String),
+}
+
+impl Version {
+    /// Returns the most recent [`Version`]. This is useful for asking users to upgrade externally-stored settings.
+    pub const fn latest() -> Self {
+        Self::V5
+    }
+
+    /// Default version for old settings.
+    pub const fn unknown() -> Self {
+        Self::V0
+    }
+}
+
+impl std::fmt::Display for Version {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            Version::V0 => f.write_str("V0"),
+            Version::V5 => f.write_str("V5"),
+            Version::Unknown(unknown) => f.write_str(unknown),
+        }
+    }
+}
+
+impl Default for Version {
+    fn default() -> Self {
+        Self::latest()
+    }
 }
 
 #[cfg(test)]
@@ -334,4 +401,34 @@ mod test {
         "#;
         serde_json::from_str::<Settings>(json).unwrap();
     }
+
+    #[test]
+    #[cfg(feature = "serde")]
+    fn deserialize_v5_config_succeeds() {
+        let json = r#"
+        {
+            "conversion": {
+              "tolerance": 0.002,
+              "feedrate": 300.0,
+              "dpi": 96.0
+            },
+            "machine": {
+              "supported_functionality": {
+                "circular_interpolation": true
+              },
+              "tool_on_sequence": null,
+              "tool_off_sequence": null,
+              "begin_sequence": null,
+              "end_sequence": null
+            },
+            "postprocess": {
+                "checksums": false,
+                "line_numbers": false,
+                "newline_before_comment": false
+            },
+            "version": "V5"
+          }
+        "#;
+        serde_json::from_str::<Settings>(json).unwrap();
+    }
 }