foch 0.0.2

EU4 mod analysis and merge toolkit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! Built-in adapter manifests for the first-party upstream DLLs.
//!
//! These let Foch drive the existing EU4 Unicode and Menu patches through the
//! legacy adapter without the upstream packages shipping a `foch-plugin.toml`.
//! They carry the structural facts (entry, phase, status export, config keys)
//! verified from upstream source; a package's file digests are bound when the
//! release asset is imported, not here.

use super::manifest::Manifest;

const EU4_UNICODE_PATCH: &str = include_str!("builtin/eu4-unicode-patch.toml");
const EU4_MENU_PATCH: &str = include_str!("builtin/eu4-menu-patch.toml");

/// Every adapter manifest Foch ships with, parsed. Panics only on a build-time
/// authoring error in the embedded TOML, which the test below catches.
pub fn adapters() -> Vec<Manifest> {
	[EU4_UNICODE_PATCH, EU4_MENU_PATCH]
		.into_iter()
		.map(|text| Manifest::parse(text).expect("built-in adapter manifest is valid"))
		.collect()
}

/// The adapter manifest for a plugin id, if Foch ships one.
pub fn adapter(plugin_id: &str) -> Option<Manifest> {
	adapters()
		.into_iter()
		.find(|manifest| manifest.plugin.id == plugin_id)
}

#[cfg(test)]
mod tests {
	use super::*;
	use crate::plugin::manifest::{Kind, Phase, StatusMode};

	#[test]
	fn built_in_adapters_parse() {
		let adapters = adapters();
		assert_eq!(adapters.len(), 2);
	}

	#[test]
	fn unicode_adapter_matches_verified_facts() {
		let unicode = adapter("io.github.yozoratempest.eu4-unicode-patch").unwrap();
		assert_eq!(unicode.entry.kind, Kind::Legacy);
		assert_eq!(unicode.entry.phase, Phase::Entry);
		let status = unicode.status.unwrap();
		assert_eq!(status.mode, StatusMode::Sync);
		assert_eq!(status.export, "Eu4UnicodeProbeEnabled");
	}

	#[test]
	fn menu_adapter_loads_after_unicode_and_polls() {
		let menu = adapter("io.github.yozoratempest.eu4-menu-patch").unwrap();
		assert_eq!(menu.plugin.version.to_string(), "0.1.4-experimental");
		assert_eq!(menu.entry.phase, Phase::Deferred);
		assert_eq!(
			menu.load_after,
			["io.github.yozoratempest.eu4-unicode-patch"]
		);
		let status = menu.status.unwrap();
		assert_eq!(status.mode, StatusMode::Poll);
		assert_eq!(status.pending, [0]);
	}
}