libmotiva 0.1.1

Sanctioned entities matching utilities
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

use std::{
  collections::{HashMap, HashSet},
  sync::LazyLock,
};

use ahash::RandomState;
use rust_embed::Embed;
use serde::Deserialize;

#[derive(Embed)]
#[folder = "./assets/followthemoney/followthemoney/schema"]
struct Schemas;

pub static SCHEMAS: LazyLock<HashMap<String, FtmSchema, RandomState>> = LazyLock::new(|| {
  tracing::debug!("building schemas");

  let mut schemas = Schemas::iter()
    .map(|filename| {
      let file = Schemas::get(filename.as_ref()).expect("invalid schema");
      let content = std::str::from_utf8(&file.data).expect("invalid schema");
      let schema = serde_yaml::from_str::<HashMap<String, FtmSchema>>(content).expect("invalid schema");

      schema.into_iter().next().expect("schema does not contain schema")
    })
    .collect::<HashMap<String, FtmSchema, RandomState>>();

  let schemas_clone = schemas.clone();
  let mut children_map: HashMap<&str, Vec<&str>> = HashMap::default();

  for (name, schema) in &schemas_clone {
    schemas.get_mut(name).unwrap().matchable_chain = resolve_schemas(&schemas, name, true).unwrap_or_default();
    schemas.get_mut(name).unwrap().parents = resolve_schemas(&schemas, name, false).unwrap_or_default();

    for parent in &schema.extends {
      children_map.entry(parent).or_default().push(name);
    }
  }

  for name in schemas_clone.keys() {
    let mut descendants: HashSet<&str> = HashSet::default();
    let mut stack: Vec<&str> = Vec::default();

    if let Some(children) = children_map.get(name.as_str()) {
      stack.extend(children);
    }

    while let Some(node) = stack.pop() {
      if descendants.insert(node)
        && let Some(children) = children_map.get(&node)
      {
        stack.extend(children.clone());
      }
    }

    schemas.get_mut(name).unwrap().descendants = descendants.into_iter().map(String::from).collect();
  }

  schemas
});

fn resolve_schemas(schemas: &HashMap<String, FtmSchema, RandomState>, schema: &str, if_matchable: bool) -> Option<Vec<String>> {
  let mut out = Vec::with_capacity(8);

  if let Some(def) = schemas.get(schema) {
    if if_matchable && schema != "Thing" && !def.matchable {
      return None;
    }

    if !if_matchable || def.matchable || schema == "Thing" {
      out.push(schema.to_string());
    }

    for parent in &def.extends {
      out.extend(resolve_schemas(schemas, parent, false)?);
    }
  }

  Some(out)
}

#[derive(Clone, Debug, Deserialize)]
pub struct FtmSchema {
  #[serde(default)]
  pub extends: Vec<String>,
  pub matchable: bool,
  #[serde(default)]
  pub caption: Vec<String>,
  #[serde(default)]
  pub properties: HashMap<String, FtmProperty, RandomState>,

  #[serde(skip)]
  pub matchable_chain: Vec<String>,
  #[serde(skip)]
  pub parents: Vec<String>,
  #[serde(skip)]
  pub descendants: Vec<String>,
}

#[derive(Clone, Debug, Deserialize)]
pub struct FtmProperty {
  #[serde(default, rename = "type")]
  pub _type: String,
  #[serde(default = "c_true")]
  pub matchable: bool,
  #[serde(default)]
  pub reverse: Option<FtmReverseField>,
}

#[derive(Clone, Debug, Deserialize)]
pub struct FtmReverseField {
  pub name: String,
}

const fn c_true() -> bool {
  true
}

#[cfg(test)]
mod tests {
  #[test]
  fn resolve_schemas() {
    assert_eq!(super::resolve_schemas(&super::SCHEMAS, "Thing", true).as_ref(), Some(&vec!["Thing".into()]));

    assert_eq!(
      super::resolve_schemas(&super::SCHEMAS, "Person", true).as_ref(),
      Some(&vec!["Person".into(), "LegalEntity".into(), "Thing".into()])
    );

    assert_eq!(super::resolve_schemas(&super::SCHEMAS, "Event", true).as_ref(), None);

    assert_eq!(
      super::resolve_schemas(&super::SCHEMAS, "Event", false).as_ref(),
      Some(&vec!["Event".into(), "Interval".into(), "Analyzable".into(), "Thing".into()])
    );
  }
}