katana-document-viewer 0.1.4

KatanA document viewer artifact, render evaluation, and export foundation.
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

use serde::{Deserialize, Serialize};

#[path = "evaluation_coverage.rs"]
mod evaluation_coverage;
#[path = "evaluation_fixtures.rs"]
mod evaluation_fixtures;

use evaluation_coverage::V01EvaluationCoverageFactory;
use evaluation_fixtures::V01EvaluationFixtureFactory;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum FixtureCategory {
    CommonMark,
    Gfm,
    Math,
    GitHubAlert,
    KatanaCompatibility,
    ExternalRendering,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum CoverageStatus {
    KmmDto,
    KrrDirect,
    KrrMermaidCompatibility,
    KdvExportContract,
    MissingImplementation,
    ExternalBackendRequired,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct EvaluationFixture {
    pub id: String,
    pub path: String,
    pub category: FixtureCategory,
    pub scenario: String,
    pub coverage: CoverageStatus,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct EvaluationFixtureMatrix {
    pub fixtures: Vec<EvaluationFixture>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct EvaluationFeatureCoverage {
    pub id: String,
    pub fixture_id: String,
    pub category: FixtureCategory,
    pub scenario: String,
    pub status: CoverageStatus,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct EvaluationCoverageMatrix {
    pub features: Vec<EvaluationFeatureCoverage>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum BackendCapability {
    KrrDirect,
    KrrMermaidCompatibility,
    KdvManifestExport,
    ExternalBackendRequired,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct BackendCapabilityMatrix {
    pub capabilities: Vec<BackendCapabilityEntry>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct BackendCapabilityEntry {
    pub feature: String,
    pub capability: BackendCapability,
    pub backend: String,
}

impl EvaluationFixtureMatrix {
    pub fn v0_1() -> Self {
        Self {
            fixtures: V01EvaluationFixtureFactory::create(),
        }
    }

    pub fn status_count(&self, status: CoverageStatus) -> usize {
        self.fixtures
            .iter()
            .filter(|fixture| fixture.coverage == status)
            .count()
    }

    pub fn contains_category(&self, category: FixtureCategory) -> bool {
        self.fixtures
            .iter()
            .any(|fixture| fixture.category == category)
    }
}

impl EvaluationCoverageMatrix {
    pub fn v0_1() -> Self {
        Self {
            features: V01EvaluationCoverageFactory::create(),
        }
    }

    pub fn status_count(&self, status: CoverageStatus) -> usize {
        self.features
            .iter()
            .filter(|feature| feature.status == status)
            .count()
    }

    pub fn is_complete(&self) -> bool {
        self.status_count(CoverageStatus::MissingImplementation) == 0
            && self.status_count(CoverageStatus::ExternalBackendRequired) == 0
    }

    pub fn is_kdv_owned_complete(&self) -> bool {
        self.status_count(CoverageStatus::MissingImplementation) == 0
    }

    pub fn contains_feature(&self, id: &str, status: CoverageStatus) -> bool {
        self.features
            .iter()
            .any(|feature| feature.id == id && feature.status == status)
    }
}

impl BackendCapabilityMatrix {
    pub fn v0_1() -> Self {
        Self {
            capabilities: vec![
                capability("mermaid", BackendCapability::KrrDirect, "krr"),
                capability("drawio", BackendCapability::KrrDirect, "krr"),
                capability("zenuml", BackendCapability::KrrMermaidCompatibility, "krr"),
                capability("plantuml", BackendCapability::KrrDirect, "krr"),
                capability("html-export", BackendCapability::KdvManifestExport, "kdv"),
                capability("pdf-export", BackendCapability::KdvManifestExport, "kdv"),
                capability("png-export", BackendCapability::KdvManifestExport, "kdv"),
                capability("jpeg-export", BackendCapability::KdvManifestExport, "kdv"),
                capability("math", BackendCapability::KdvManifestExport, "kdv"),
            ],
        }
    }
}

fn capability(
    feature: &'static str,
    capability: BackendCapability,
    backend: &'static str,
) -> BackendCapabilityEntry {
    BackendCapabilityEntry {
        feature: feature.to_string(),
        capability,
        backend: backend.to_string(),
    }
}

#[cfg(test)]
#[path = "evaluation_kmm_tests.rs"]
mod kmm_tests;

#[cfg(test)]
#[path = "evaluation_tests.rs"]
mod tests;