affine_core 0.0.5

AFFiNE primitive core.
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

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum DocumentVariant {
  Workspace,
  Page,
  Space,
  Settings,
  Unknown,
}

impl DocumentVariant {
  pub const fn as_str(self) -> &'static str {
    match self {
      Self::Workspace => "workspace",
      Self::Page => "page",
      Self::Space => "space",
      Self::Settings => "settings",
      Self::Unknown => "unknown",
    }
  }

  fn parse(value: &str) -> Option<Self> {
    match value {
      "page" => Some(Self::Page),
      "space" => Some(Self::Space),
      "settings" => Some(Self::Settings),
      _ => None,
    }
  }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct CanonicalDocumentIdentity {
  workspace_id: String,
  doc_id: String,
  variant: DocumentVariant,
}

impl CanonicalDocumentIdentity {
  pub fn workspace_id(&self) -> &str {
    &self.workspace_id
  }

  pub fn doc_id(&self) -> &str {
    &self.doc_id
  }

  pub const fn variant(&self) -> DocumentVariant {
    self.variant
  }

  pub const fn is_workspace(&self) -> bool {
    matches!(self.variant, DocumentVariant::Workspace)
  }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum DocumentIdentityError {
  Empty,
  WorkspaceRequired,
  InvalidFormat,
  InvalidVariant,
  DocumentRequired,
}

pub fn canonicalize_document_identity(
  raw_id: &str,
  workspace_hint: Option<&str>,
) -> Result<CanonicalDocumentIdentity, DocumentIdentityError> {
  if raw_id.is_empty() {
    return Err(DocumentIdentityError::Empty);
  }
  if workspace_hint.is_some_and(str::is_empty) {
    return Err(DocumentIdentityError::WorkspaceRequired);
  }

  let parts = raw_id.split(':').collect::<Vec<_>>();
  let (workspace, variant, doc_id) = match parts.as_slice() {
    [value] => match workspace_hint {
      Some(hint) if *value != hint => (hint, DocumentVariant::Unknown, *value),
      _ => (*value, DocumentVariant::Workspace, *value),
    },
    [variant, doc_id] => {
      let workspace = workspace_hint.ok_or(DocumentIdentityError::WorkspaceRequired)?;
      let variant = DocumentVariant::parse(variant).ok_or(DocumentIdentityError::InvalidVariant)?;
      (workspace, variant, *doc_id)
    }
    [workspace, variant, doc_id] => {
      let variant = DocumentVariant::parse(variant).ok_or(DocumentIdentityError::InvalidVariant)?;
      (workspace_hint.unwrap_or(workspace), variant, *doc_id)
    }
    [workspace, "space", "page", doc_id] => (workspace_hint.unwrap_or(workspace), DocumentVariant::Space, *doc_id),
    _ => return Err(DocumentIdentityError::InvalidFormat),
  };

  if workspace.is_empty() {
    return Err(DocumentIdentityError::WorkspaceRequired);
  }
  if !matches!(variant, DocumentVariant::Workspace) && doc_id.is_empty() {
    return Err(DocumentIdentityError::DocumentRequired);
  }

  Ok(CanonicalDocumentIdentity {
    workspace_id: workspace.to_string(),
    doc_id: doc_id.to_string(),
    variant,
  })
}

#[cfg(test)]
#[path = "../tests/access_control/document_identity/tests.rs"]
mod tests;