|
| 1 | +use crate::utils::Dependency; |
| 2 | +use derive_more::Deref; |
| 3 | +use semver::VersionReq; |
| 4 | +use serde::{Deserialize, Serialize}; |
| 5 | + |
| 6 | +const DEFAULT_KIND: &str = "normal"; |
| 7 | + |
| 8 | +/// A crate dependency in our internal representation for releases.dependencies json. |
| 9 | +#[derive(Debug, Clone, PartialEq, Deref)] |
| 10 | +pub(crate) struct ReleaseDependency(Dependency); |
| 11 | + |
| 12 | +impl<'de> Deserialize<'de> for ReleaseDependency { |
| 13 | + fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> |
| 14 | + where |
| 15 | + D: serde::Deserializer<'de>, |
| 16 | + { |
| 17 | + /// The three possible representations of a dependency in our internal JSON format |
| 18 | + /// in the `releases.dependencies` column. |
| 19 | + #[derive(Serialize, Deserialize)] |
| 20 | + #[serde(untagged)] |
| 21 | + enum Repr { |
| 22 | + /// just [name, version]`` |
| 23 | + Basic((String, VersionReq)), |
| 24 | + /// [name, version, kind] |
| 25 | + WithKind((String, VersionReq, String)), |
| 26 | + /// [name, version, kind, optional] |
| 27 | + Full((String, VersionReq, String, bool)), |
| 28 | + } |
| 29 | + |
| 30 | + let src = Repr::deserialize(deserializer)?; |
| 31 | + let (name, req, kind, optional) = match src { |
| 32 | + Repr::Basic((name, req)) => (name, req, DEFAULT_KIND.into(), false), |
| 33 | + Repr::WithKind((name, req, kind)) => (name, req, kind, false), |
| 34 | + Repr::Full((name, req, kind, optional)) => (name, req, kind, optional), |
| 35 | + }; |
| 36 | + |
| 37 | + Ok(ReleaseDependency(Dependency { |
| 38 | + name, |
| 39 | + req, |
| 40 | + kind: Some(kind), |
| 41 | + optional, |
| 42 | + rename: None, |
| 43 | + })) |
| 44 | + } |
| 45 | +} |
| 46 | + |
| 47 | +impl Serialize for ReleaseDependency { |
| 48 | + fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> |
| 49 | + where |
| 50 | + S: serde::Serializer, |
| 51 | + { |
| 52 | + let dep = &self.0; |
| 53 | + let kind = dep.kind.as_deref().unwrap_or(DEFAULT_KIND); |
| 54 | + (dep.name.as_str(), &dep.req, kind, dep.optional).serialize(serializer) |
| 55 | + } |
| 56 | +} |
| 57 | + |
| 58 | +impl From<Dependency> for ReleaseDependency { |
| 59 | + fn from(dep: Dependency) -> Self { |
| 60 | + ReleaseDependency(dep) |
| 61 | + } |
| 62 | +} |
| 63 | + |
| 64 | +impl From<ReleaseDependency> for Dependency { |
| 65 | + fn from(dep: ReleaseDependency) -> Self { |
| 66 | + dep.0 |
| 67 | + } |
| 68 | +} |
| 69 | + |
| 70 | +pub(crate) type ReleaseDependencyList = Vec<ReleaseDependency>; |
| 71 | + |
| 72 | +#[cfg(test)] |
| 73 | +mod tests { |
| 74 | + use super::*; |
| 75 | + use anyhow::Result; |
| 76 | + use test_case::test_case; |
| 77 | + |
| 78 | + #[test_case("[]", "[]"; "empty")] |
| 79 | + #[test_case( |
| 80 | + r#"[["vec_map", "^0.0.1"]]"#, |
| 81 | + r#"[["vec_map","^0.0.1","normal",false]]"#; |
| 82 | + "2-tuple" |
| 83 | + )] |
| 84 | + #[test_case( |
| 85 | + r#"[["vec_map", "^0.0.1", "normal" ]]"#, |
| 86 | + r#"[["vec_map","^0.0.1","normal",false]]"#; |
| 87 | + "3-tuple" |
| 88 | + )] |
| 89 | + #[test_case( |
| 90 | + r#"[["rand", "^0.9", "normal", false], ["sdl3", "^0.16", "normal", false]]"#, |
| 91 | + r#"[["rand","^0.9","normal",false],["sdl3","^0.16","normal",false]]"#; |
| 92 | + "4-tuple" |
| 93 | + )] |
| 94 | + #[test_case( |
| 95 | + r#"[["byteorder", "^0.5", "normal", false],["clippy", "^0", "normal", true]]"#, |
| 96 | + r#"[["byteorder","^0.5","normal",false],["clippy","^0","normal",true]]"#; |
| 97 | + "with optional" |
| 98 | + )] |
| 99 | + fn test_parse_release_dependency_json(input: &str, output: &str) -> Result<()> { |
| 100 | + let deps: ReleaseDependencyList = serde_json::from_str(input)?; |
| 101 | + |
| 102 | + assert_eq!(serde_json::to_string(&deps)?, output); |
| 103 | + Ok(()) |
| 104 | + } |
| 105 | + |
| 106 | + #[test_case(r#"[["vec_map", "^0.0.1"]]"#, "normal", false)] |
| 107 | + #[test_case(r#"[["vec_map", "^0.0.1", "dev" ]]"#, "dev", false)] |
| 108 | + #[test_case(r#"[["vec_map", "^0.0.1", "dev", true ]]"#, "dev", true)] |
| 109 | + fn test_parse_dependency( |
| 110 | + input: &str, |
| 111 | + expected_kind: &str, |
| 112 | + expected_optional: bool, |
| 113 | + ) -> Result<()> { |
| 114 | + let deps: ReleaseDependencyList = serde_json::from_str(input)?; |
| 115 | + let [dep] = deps.as_slice() else { |
| 116 | + panic!("expected exactly one dependency"); |
| 117 | + }; |
| 118 | + |
| 119 | + assert_eq!(dep.name, "vec_map"); |
| 120 | + assert_eq!(dep.req, VersionReq::parse("^0.0.1")?); |
| 121 | + assert_eq!(dep.kind.as_deref(), Some(expected_kind)); |
| 122 | + assert_eq!(dep.optional, expected_optional); |
| 123 | + |
| 124 | + Ok(()) |
| 125 | + } |
| 126 | +} |
0 commit comments