okh-tool 2.4.2

A CLI tool to deal with Open Know-How (OKH) data files. Its main functionalities are: validation of and conversion between the different formats. 
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257

// SPDX-FileCopyrightText: 2021 Robin Vobruba <hoijui.quaero@gmail.com>
//
// SPDX-License-Identifier: AGPL-3.0-or-later

use std::{fs, path::Path};

use regex::Regex;
use relative_path::RelativePathBuf;
use serde::{Deserialize, Serialize};
use url::Url;

use crate::{
    macros::rgx,
    oxrl::{Odrl, Otrl},
};

use super::{ParseError, SerError};

pub type DSString = String;

pub const OKHV: &str = "OKH-LOSHv1.0";
pub const MANIFEST_FILE_NAME: &str = "okh.toml";

#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "kebab-case")]
pub struct Software {
    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub label: Option<DSString>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub release: Option<Url>,
}

#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "kebab-case")]
pub struct SubMosh {
    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<DSString>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub image: Vec<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tsdc: Option<DSString>,

    // #[serde(default)]
    // #[serde(skip_serializing_if = "Option::is_none")]
    // pub manifest_file: Option<RelativePathBuf>,

    // #[serde(default)]
    // #[serde(skip_serializing_if = "Option::is_none")]
    // pub repo: Option<Url>,
    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub source: Vec<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub export: Vec<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub auxiliary: Vec<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub part: Vec<SubMosh>,
}

// #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, Default)]
// #[serde(rename_all = "kebab-case")]
// pub struct Meta {
//     pub source: DSString,

// // [__meta]
// // source = "github.com"
// // owner = "KarlK90"
// // repo = "yaemk-split-kb"
// // path = "okh.toml"
//     #[serde(default)]
//     #[serde(skip_serializing_if = "Option::is_none")]
//     pub owner: Option<DSString>,

//     #[serde(default)]
//     #[serde(skip_serializing_if = "Option::is_none")]
//     pub repo: Option<DSString>,

//     #[serde(default)]
//     #[serde(skip_serializing_if = "Option::is_none")]
//     pub path: Option<DSString>,
// }

#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct Okh {
    pub okhv: DSString,

    pub name: DSString,

    pub repo: Url,

    pub version: DSString,

    pub license: DSString,

    pub licensor: DSString,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub upload_method: Option<DSString>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub organisation: Option<DSString>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub readme: Option<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contribution_guide: Option<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub image: Vec<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub documentation_language: Option<DSString>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub attestation: Vec<Url>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub standard_compliance: Vec<DSString>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cpc_patent_class: Option<DSString>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tsdc: Option<DSString>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub bom: Option<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub release: Option<Url>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub timestamp: Option<DSString>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fork_of: Option<Url>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub function: Option<DSString>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub documentation_readiness_level: Option<Odrl>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub technology_readiness_level: Option<Otrl>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_manual: Option<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub manufacturing_instructions: Vec<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub software: Vec<Software>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub standard: Vec<DSString>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub source: Vec<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub export: Vec<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub auxiliary: Vec<RelativePathBuf>,

    #[serde(default)]
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub part: Vec<SubMosh>,
    // #[serde(default)]
    // #[serde(rename = "__meta")]
    // pub __meta: Meta,
}

impl Okh {
    pub fn from_toml(toml_str: &str) -> Result<Self, ParseError> {
        log::debug!("Parsing TOML to v2 ...");
        let parsed = toml::from_str::<Self>(toml_str)?;
        // TODO Add extra sanity checks here, if required
        Ok(parsed)
    }

    pub fn from_toml_file<OP>(toml_file: OP) -> Result<Self, ParseError>
    where
        OP: AsRef<Path>,
    {
        log::debug!("Reading TOML file to string ...");
        let toml_str = fs::read_to_string(toml_file)?;

        Self::from_toml(&toml_str)
    }

    pub fn to_toml(&self) -> Result<String, SerError> {
        log::debug!("Serializing to TOML ...");
        Ok(toml::to_string(self)?)
    }

    pub fn to_toml_file<OP>(&self, toml_file: OP) -> Result<(), SerError>
    where
        OP: AsRef<Path>,
    {
        let serialized = self.to_toml()?;
        log::debug!("Writing to TOML file ...");
        fs::write(toml_file, serialized)?;
        Ok(())
    }

    pub fn ext_matcher() -> &'static Regex {
        rgx!(r"(^|\.)[tT][oO][mM][lL]$")
    }

    pub fn file_matcher() -> &'static Regex {
        rgx!(r"okh\.[tT][oO][mM][lL]$")
    }
}