Use hierarchical manifest format (#90)

Author: casey

Cargo.lock

@@ -29,12 +29,15 @@ serde_json = "1.0.127"
 serde_with = "3.11.0"
 serde_yaml = "0.9.34"
 snafu = "0.8.4"
+strum = { version = "0.27.2", features = ["derive"] }
+usized = "0.0.2"
 walkdir = "2.5.0"
 
 [dev-dependencies]
 assert_cmd = { version = "2.0.16", features = ["color-auto"] }
 assert_fs = { version = "1.1.2", features = ["color-auto"] }
 predicates = "3.1.2"
+pretty_assertions = "1.4.1"
 regex = "1.10.6"
 
 [lints.clippy]
@@ -51,6 +54,9 @@ too-many-lines = "allow"
 unused-async = "allow"
 wildcard-imports = "allow"
 
+[lints.rust]
+mismatched-lifetime-syntaxes = "allow"
+
 [profile.release]
 codegen-units = 1
 lto = true

Cargo.toml

@@ -175,17 +175,14 @@ drive prefix, such as `C:`.
 Paths may not contain the path components `.` or `..` and may not end with a
 slash.
 
-Filepack has no way of tracking empty directories, the presence of which are an
-error when creating or verifying a manifest.
-
 Manifests contain an object with one mandatory key, `files`.
 
 ### `files`
 
-The value of the mandatory `files` key is an object mapping string paths to
-manifest entries. Manifest entries are objects with the key `hash`, whose value
-is a hex-encoded BLAKE3 hash of the file, and `size`, whose value is the length
-of the file in bytes.
+The value of the mandatory `files` key is an object mapping path components to
+directory entries. Directory entries may be subdirectories or files. Files are
+objects with keys `hash`, the hex-encoded BLAKE3 hash of the file, and `size`,
+the length of the file in bytes.
 
 An example manifest for a directory containing the files `README.md` and
 `src/main.c`:
@@ -197,9 +194,11 @@ An example manifest for a directory containing the files `README.md` and
       "hash": "5a9a6d96244ec398545fc0c98c2cb7ed52511b025c19e9ad1e3c1ef4ac8575ad",
       "size": 1573
     },
-    "src/main.c": {
-      "hash": "38abf296dc2a90f66f7870fe0ce584af3859668cf5140c7557a76786189dcf0f",
-      "size": 4491
+    "src": {
+      "main.c": {
+        "hash": "38abf296dc2a90f66f7870fe0ce584af3859668cf5140c7557a76786189dcf0f",
+        "size": 4491
+      }
     }
   }
 }

DESIGN.md

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-set -euxo pipefail
+set -euo pipefail
 
 which rg
 

README.md

@@ -1,7 +1,7 @@
 watch +args='ltest':
   cargo watch --clear --exec '{{ args }}'
 
-clippy: (watch 'lclippy --all-targets -- --deny warnings')
+clippy: (watch 'lclippy --tests --all --all-targets -- --deny warnings')
 
 ci: lint
   cargo test --workspace

bin/forbid

@@ -0,0 +1,91 @@
+use super::*;
+
+#[derive(Clone, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
+#[serde(deny_unknown_fields, rename_all = "kebab-case", transparent)]
+pub(crate) struct Component(String);
+
+impl Component {
+  pub(crate) fn as_bytes(&self) -> &[u8] {
+    self.0.as_bytes()
+  }
+
+  pub(crate) fn as_str(&self) -> &str {
+    &self.0
+  }
+}
+
+impl Borrow<str> for Component {
+  fn borrow(&self) -> &str {
+    self.0.as_str()
+  }
+}
+
+impl FromStr for Component {
+  type Err = PathError;
+
+  fn from_str(s: &str) -> Result<Self, Self::Err> {
+    for character in s.chars() {
+      if SEPARATORS.contains(&character) {
+        return Err(PathError::Separator { character });
+      }
+    }
+
+    if s == ".." || s == "." {
+      return Err(PathError::Component {
+        component: s.into(),
+      });
+    }
+
+    if s.is_empty() {
+      return Err(PathError::ComponentEmpty);
+    }
+
+    Ok(Self(s.into()))
+  }
+}
+
+#[cfg(test)]
+mod tests {
+  use super::*;
+
+  #[test]
+  fn parent() {
+    assert_eq!(
+      "..".parse::<Component>().unwrap_err(),
+      PathError::Component {
+        component: "..".into(),
+      },
+    );
+  }
+
+  #[test]
+  fn current() {
+    assert_eq!(
+      ".".parse::<Component>().unwrap_err(),
+      PathError::Component {
+        component: ".".into(),
+      },
+    );
+  }
+
+  #[test]
+  fn empty() {
+    assert_eq!(
+      "".parse::<Component>().unwrap_err(),
+      PathError::ComponentEmpty,
+    );
+  }
+
+  #[test]
+  fn separator() {
+    assert_eq!(
+      "/".parse::<Component>().unwrap_err(),
+      PathError::Separator { character: '/' },
+    );
+
+    assert_eq!(
+      "\\".parse::<Component>().unwrap_err(),
+      PathError::Separator { character: '\\' },
+    );
+  }
+}

justfile

@@ -0,0 +1,21 @@
+use super::*;
+
+#[derive(Clone, Copy, IntoStaticStr)]
+#[strum(serialize_all = "kebab-case")]
+pub(crate) enum Context {
+  Directory,
+  Entry,
+  File,
+}
+
+impl Context {
+  fn name(self) -> &'static str {
+    self.into()
+  }
+}
+
+impl Display for Context {
+  fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+    write!(f, "{}", self.name())
+  }
+}