Select XFL package roots in craft-xfl

This commit is contained in:
Dylan M. Taylor committed 2026-11-14 21:23:28 +00:00
1 parent 2942da9a35
commit 4801a54e3c
2 files changed
+58

No files matched your search

+32
View File
@@ -89,6 +89,19 @@ pub struct Archive<'a> {
budget: Cell<u64>,
}
/// 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)
+26
View File
@@ -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"<DOMDocument/>", true), ("Walk/DOMDocument.xml", b"<DOMDocument/>", true)]);
let archive = Archive::open(&root).unwrap();
assert_eq!(archive.xfl_package_root(), XflPackageRoot::Document);
let folder = zip(&[("Walk/DOMDocument.xml", b"<DOMDocument/>", true), ("Walk/LIBRARY/Clip.xml", b"<DOMSymbolItem/>", 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"<DOMDocument/>", true),
("Apple/DOMDocument.xml", b"<DOMDocument/>", 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"<DOMDocument/>", 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);