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

use super::builtin::builtin_catalog_hash;
use crate::DATA_VERSION;
use crate::game::eu4::active_cwt_schema_id;
use crate::game::eu4::analysis::param_contracts::registered_param_contracts_hash;
use std::sync::OnceLock;

static ANALYSIS_RULES_ID: OnceLock<String> = OnceLock::new();

/// Identity of every rule set semantic analysis reads. Scope classification
/// comes from the active CWT schema, so the schema identity is part of it; a
/// change to the analysis itself raises `DATA_VERSION`.
pub fn analysis_rules_version() -> &'static str {
	ANALYSIS_RULES_ID.get_or_init(|| {
		format!(
			"rules-v{}-catalog-{}-contracts-{}-cwt-{}",
			DATA_VERSION,
			builtin_catalog_hash(),
			registered_param_contracts_hash(),
			&active_cwt_schema_id()[..16]
		)
	})
}

#[cfg(test)]
mod tests {
	use super::analysis_rules_version;
	use crate::DATA_VERSION;
	use crate::game::eu4::active_cwt_schema_id;
	use crate::game::eu4::analysis::param_contracts::registered_param_contracts_hash;

	#[test]
	fn analysis_rules_version_tracks_the_data_version() {
		assert!(
			analysis_rules_version().starts_with(&format!("rules-v{DATA_VERSION}-")),
			"analysis rules version should invalidate caches when the data version changes"
		);
	}

	#[test]
	fn analysis_rules_version_tracks_param_contract_registry() {
		assert!(
			analysis_rules_version().contains(registered_param_contracts_hash()),
			"analysis rules version should invalidate caches when param contracts change"
		);
	}

	#[test]
	fn analysis_rules_version_tracks_the_active_cwt_schema() {
		assert!(
			analysis_rules_version().ends_with(&format!("-cwt-{}", &active_cwt_schema_id()[..16])),
			"analysis rules version should invalidate caches when the CWT schema changes"
		);
	}
}