okf 0.2.5

The Open Knowledge Format (OKF) v0.2 in pure Rust: the `okf` CLI (validate, lint, inspect, index, graph, format, diff) plus the full okf-core and okf-validator library APIs re-exported.
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

//! Regression tests for the machine-readable cross-link graph.

mod common;

use common::TempDir;
use std::process::Command;

fn graph_json(bundle: &TempDir) -> String {
    let output = Command::new(env!("CARGO_BIN_EXE_okf"))
        .args(["graph", bundle.path().to_str().unwrap(), "--format", "json"])
        .output()
        .unwrap();
    assert!(output.status.success(), "stderr: {:?}", output.stderr);
    String::from_utf8(output.stdout).unwrap()
}

#[test]
fn graph_json_is_valid_for_empty_and_linkless_bundles() {
    let empty = TempDir::new();
    let val: serde_json::Value = serde_json::from_str(&graph_json(&empty)).unwrap();
    assert_eq!(val["concepts"], serde_json::json!([]));

    let linkless = TempDir::new();
    linkless.write("plain.md", "---\ntype: Metric\n---\n\nNo links.\n");
    let val: serde_json::Value = serde_json::from_str(&graph_json(&linkless)).unwrap();
    assert_eq!(
        val,
        serde_json::json!({
            "okf_version": "0.2",
            "concepts": [
                {
                    "id": "plain",
                    "links": [],
                    "sources": []
                }
            ]
        })
    );
}

#[test]
fn graph_json_separates_and_escapes_every_link_field() {
    let bundle = TempDir::new();
    bundle.write(
        "source.md",
        "---\ntype: Metric\n---\n\nSee [say \"hi\"](target.md) and [missing](missing\"target.md).\n",
    );
    bundle.write("target.md", "---\ntype: Metric\n---\n\nTarget.\n");

    let val: serde_json::Value = serde_json::from_str(&graph_json(&bundle)).unwrap();
    assert_eq!(
        val,
        serde_json::json!({
            "okf_version": "0.2",
            "concepts": [
                {
                    "id": "source",
                    "links": [
                        {
                            "target": "target",
                            "exists": true,
                            "text": "say \"hi\"",
                            "raw": "target.md"
                        },
                        {
                            "target": "missing\"target",
                            "exists": false,
                            "text": "missing",
                            "raw": "missing\"target.md"
                        }
                    ],
                    "sources": []
                },
                {
                    "id": "target",
                    "links": [],
                    "sources": []
                }
            ]
        })
    );
}