From 4801a54e3c6082af7063e9f451da50b2db22a6e2 Mon Sep 17 00:00:00 2001 From: "Dylan M. Taylor" Date: Sat, 14 Nov 2026 21:23:28 +0000 Subject: [PATCH] Select XFL package roots in craft-xfl --- crates/xfl/src/lib.rs | 32 ++++++++++++++++++++++++++++++++ crates/xfl/src/tests.rs | 26 ++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) diff --git a/crates/xfl/src/lib.rs b/crates/xfl/src/lib.rs index 9fce43eac..4a957111f 100644 --- a/crates/xfl/src/lib.rs +++ b/crates/xfl/src/lib.rs @@ -89,6 +89,19 @@ pub struct Archive<'a> { budget: Cell, } +/// The package root selected from an XFL archive's `DOMDocument.xml` paths. +#[derive(Clone, Debug, PartialEq, Eq)] +pub enum XflPackageRoot<'a> { + /// A document XML file is directly at the archive root. + Document, + /// The sole eligible top-level folder containing a document. + Folder(&'a str), + /// No document path was found. + Missing, + /// More than one eligible top-level folder contains a document, sorted by name. + Multiple(Vec<&'a str>), +} + const END: u32 = 0x0605_4b50; const END64: u32 = 0x0606_4b50; const LOCATOR64: u32 = 0x0706_4b50; @@ -529,6 +542,25 @@ impl<'a> Archive<'a> { self.entries.keys().map(String::as_str) } + /// Selects the package root from XFL document paths. A root-level document takes precedence; + /// otherwise only a single-level folder is eligible, with macOS metadata excluded. + pub fn xfl_package_root(&self) -> XflPackageRoot<'_> { + if self.entries.contains_key("DOMDocument.xml") { + return XflPackageRoot::Document; + } + let mut folders: Vec<&str> = self + .names() + .filter_map(|name| name.strip_suffix("/DOMDocument.xml")) + .filter(|folder| !folder.contains('/') && *folder != "__MACOSX") + .collect(); + folders.sort_unstable(); + match folders.as_slice() { + [] => XflPackageRoot::Missing, + [folder] => XflPackageRoot::Folder(folder), + _ => XflPackageRoot::Multiple(folders), + } + } + /// How many files and folder entries the archive lists. pub fn counts(&self) -> (usize, usize) { (self.entries.len(), self.folders) diff --git a/crates/xfl/src/tests.rs b/crates/xfl/src/tests.rs index ee4b2cf33..5ae0713ba 100644 --- a/crates/xfl/src/tests.rs +++ b/crates/xfl/src/tests.rs @@ -28,6 +28,32 @@ fn reads_stored_and_deflated_entries() { assert_eq!(a.read("missing").unwrap(), None); } +#[test] +fn xfl_package_root_prefers_root_then_selects_one_top_level_folder() { + let root = zip(&[("DOMDocument.xml", b"", true), ("Walk/DOMDocument.xml", b"", true)]); + let archive = Archive::open(&root).unwrap(); + assert_eq!(archive.xfl_package_root(), XflPackageRoot::Document); + + let folder = zip(&[("Walk/DOMDocument.xml", b"", true), ("Walk/LIBRARY/Clip.xml", b"", true)]); + let archive = Archive::open(&folder).unwrap(); + assert_eq!(archive.xfl_package_root(), XflPackageRoot::Folder("Walk")); +} + +#[test] +fn xfl_package_root_reports_sorted_candidates_and_ignores_metadata_and_nested_paths() { + let multiple = zip(&[ + ("Zebra/DOMDocument.xml", b"", true), + ("Apple/DOMDocument.xml", b"", true), + ("__MACOSX/DOMDocument.xml", b"not a project", true), + ]); + let archive = Archive::open(&multiple).unwrap(); + assert_eq!(archive.xfl_package_root(), XflPackageRoot::Multiple(vec!["Apple", "Zebra"])); + + let nested = zip(&[("One/Two/DOMDocument.xml", b"", true), ("__MACOSX/One/DOMDocument.xml", b"metadata", true)]); + let archive = Archive::open(&nested).unwrap(); + assert_eq!(archive.xfl_package_root(), XflPackageRoot::Missing); +} + #[test] fn the_checksum_matches_the_published_check_value() { assert_eq!(crc32(b"123456789"), 0xCBF4_3926);