Improve VX support (#68)

* Upgrade deps

* Abstract some extract fns into common fn

* Upgrade deps

Author: nathaniel-daniel

Cargo.lock

@@ -5,7 +5,7 @@ edition = "2021"
 license = "MIT OR Apache-2.0"
 
 [dependencies]
-flate2 = { version = "1.0.33" }
+flate2 = { version = "1.0.34" }
 ruby-marshal = { git = "https://github.com/nathaniel-daniel/ruby-marshal-rs" }
 ruby-marshal-derive = { git = "https://github.com/nathaniel-daniel/ruby-marshal-rs" }
-serde = { version = "1.0.209", features = [ "derive" ] }
+serde = { version = "1.0.214", features = [ "derive" ] }

rpgm-common-types/Cargo.toml

@@ -1,5 +1,6 @@
 use flate2::bufread::ZlibDecoder;
 use flate2::bufread::ZlibEncoder;
+use flate2::Compression;
 use ruby_marshal::ArrayValue;
 use ruby_marshal::FromValue;
 use ruby_marshal::FromValueContext;
@@ -12,6 +13,8 @@ use ruby_marshal::ValueArena;
 use ruby_marshal::ValueHandle;
 use std::io::Read;
 
+const ARRAY_LEN: usize = 3;
+
 /// A list of compressed scripts
 #[derive(Debug)]
 pub struct CompressedScriptList {
@@ -66,7 +69,7 @@ impl std::fmt::Display for ScriptFromValueError {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         match self {
             Self::InvalidArrayLen { len } => {
-                write!(f, "invalid script array len of {len}, expected 3")
+                write!(f, "invalid script array len of {len}, expected {ARRAY_LEN}")
             }
             Self::InvalidName { .. } => {
                 write!(f, "the script name is invalid")
@@ -113,7 +116,7 @@ impl<'a> FromValue<'a> for CompressedScript {
         let script = script.value();
 
         let array_len = script.len();
-        if array_len != 3 {
+        if array_len != ARRAY_LEN {
             return Err(ScriptFromValueError::InvalidArrayLen { len: array_len }.into());
         }
 
@@ -184,7 +187,8 @@ impl IntoValue for Script {
         let id = self.id.into_value(arena)?;
         let name = arena.create_string(self.name.into()).into_raw();
 
-        let mut encoder = ZlibEncoder::new(self.data.as_bytes(), Default::default());
+        let compression = Compression::default();
+        let mut encoder = ZlibEncoder::new(self.data.as_bytes(), compression);
         let mut data = Vec::new();
         encoder
             .read_to_end(&mut data)

rpgm-common-types/src/script.rs

@@ -5,7 +5,7 @@ edition = "2021"
 license = "MIT OR Apache-2.0"
 
 [dependencies]
-anyhow = "1.0.86"
+anyhow = "1.0.91"
 argh = "0.1.12"
 camino = "1.1.9"
 memchr = "2.7.4"
@@ -14,7 +14,7 @@ rgssad = { git = "https://github.com/nathaniel-daniel/rgssad-rs", version = "0.0
 rpgmxp-types = { version = "0.0.0", path = "../rpgmxp-types" }
 rpgmvx-types = { version = "0.0.0", path = "../rpgmvx-types" }
 ruby-marshal = { git = "https://github.com/nathaniel-daniel/ruby-marshal-rs", version = "0.0.0" }
-serde = "1.0.209"
-serde_json = "1.0.127"
+serde = "1.0.214"
+serde_json = "1.0.132"
 walkdir = "2.5.0"
 rpgm-common-types = { version = "0.0.0", path = "../rpgm-common-types" }

rpgm-tool/Cargo.toml

@@ -88,7 +88,7 @@ impl FileSink {
                 // Create a windows-style path.
                 let path = path_components.join("\\");
 
-                writer.write_entry(&path, size, reader)?;
+                writer.write_file(&path, size, reader)?;
             }
         }
 

rpgm-tool/src/commands/compile_assets/file_sink.rs

@@ -258,12 +258,12 @@ fn extract_xp(
             extract_map_infos(entry, output_path)?;
         }
         ["Data", "System.rxdata"] if !options.skip_extract_system => {
-            extract_xp_system(entry, output_path)?;
+            extract_ruby_data::<rpgmxp_types::System>(entry, output_path)?;
         }
         ["Data", file]
             if !options.skip_extract_maps && crate::util::is_map_file_name(file, "rxdata") =>
         {
-            extract_xp_map(entry, output_path)?;
+            extract_ruby_data::<rpgmxp_types::Map>(entry, output_path)?;
         }
         _ => {
             let temp_path = nd_util::with_push_extension(&output_path, "temp");
@@ -294,12 +294,12 @@ fn extract_vx(
             extract_map_infos(entry, output_path)?;
         }
         ["Data", "System.rvdata"] if !options.skip_extract_system => {
-            extract_vx_system(entry, output_path)?;
+            extract_ruby_data::<rpgmvx_types::System>(entry, output_path)?;
         }
         ["Data", file]
             if !options.skip_extract_maps && crate::util::is_map_file_name(file, "rvdata") =>
         {
-            extract_vx_map(entry, output_path)?;
+            extract_ruby_data::<rpgmvx_types::Map>(entry, output_path)?;
         }
         _ => {
             let temp_path = nd_util::with_push_extension(&output_path, "temp");
@@ -462,92 +462,25 @@ where
     Ok(())
 }
 
-fn extract_xp_system<P>(file: impl std::io::Read, path: P) -> anyhow::Result<()>
+fn extract_ruby_data<T>(file: impl std::io::Read, path: impl AsRef<Path>) -> anyhow::Result<()>
 where
-    P: AsRef<Path>,
-{
-    let path = path.as_ref();
-    let path = path.with_extension("json");
-
-    let arena = ruby_marshal::load(file)?;
-    let ctx = FromValueContext::new(&arena);
-    let system: rpgmxp_types::System = ctx.from_value(arena.root())?;
-
-    let temp_path = nd_util::with_push_extension(&path, "temp");
-    let mut file = File::create_new(&temp_path)?;
-    serde_json::to_writer_pretty(&mut file, &system)?;
-    file.flush()?;
-    file.sync_all()?;
-    std::fs::rename(temp_path, path)?;
-
-    Ok(())
-}
-
-fn extract_vx_system<P>(file: impl std::io::Read, path: P) -> anyhow::Result<()>
-where
-    P: AsRef<Path>,
+    T: serde::Serialize + for<'a> ruby_marshal::FromValue<'a>,
 {
     let path = path.as_ref();
     let path = path.with_extension("json");
 
     let arena = ruby_marshal::load(file)?;
     let ctx = FromValueContext::new(&arena);
-    let system: rpgmvx_types::System = ctx.from_value(arena.root())?;
+    let data: T = ctx.from_value(arena.root())?;
 
+    // TODO: Lock?
+    // TODO: Drop delete guard for file?
     let temp_path = nd_util::with_push_extension(&path, "temp");
     let mut file = File::create_new(&temp_path)?;
-    serde_json::to_writer_pretty(&mut file, &system)?;
+    serde_json::to_writer_pretty(&mut file, &data)?;
     file.flush()?;
     file.sync_all()?;
     std::fs::rename(temp_path, path)?;
 
     Ok(())
 }
-
-fn extract_xp_map<P>(file: impl std::io::Read, path: P) -> anyhow::Result<()>
-where
-    P: AsRef<Path>,
-{
-    use rpgmxp_types::Map;
-
-    let path = path.as_ref();
-    let path = path.with_extension("json");
-
-    let arena = ruby_marshal::load(file)?;
-    let ctx = FromValueContext::new(&arena);
-    let map: Map = ctx.from_value(arena.root())?;
-    let map = serde_json::to_string_pretty(&map)?;
-
-    // TODO: Lock?
-    // TODO: Drop delete guard for file?
-    let temp_path = nd_util::with_push_extension(&path, "temp");
-    std::fs::write(&temp_path, map)?;
-
-    std::fs::rename(temp_path, path)?;
-
-    Ok(())
-}
-
-fn extract_vx_map<P>(file: impl std::io::Read, path: P) -> anyhow::Result<()>
-where
-    P: AsRef<Path>,
-{
-    use rpgmvx_types::Map;
-
-    let path = path.as_ref();
-    let path = path.with_extension("json");
-
-    let arena = ruby_marshal::load(file)?;
-    let ctx = FromValueContext::new(&arena);
-    let map: Map = ctx.from_value(arena.root())?;
-    let map = serde_json::to_string_pretty(&map)?;
-
-    // TODO: Lock?
-    // TODO: Drop delete guard for file?
-    let temp_path = nd_util::with_push_extension(&path, "temp");
-    std::fs::write(&temp_path, map)?;
-
-    std::fs::rename(temp_path, path)?;
-
-    Ok(())
-}