owl-ms-language-server 0.13.2

An incremental analysis assistant for writing ontologies with the OWL Manchester Syntax
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
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

use crate::error::{Error, ResultExt};
use itertools::Itertools;
use log::info;
use quick_xml::de::from_str;
use serde::{Deserialize, Serialize};
use std::{
    fs::read_to_string,
    path::{Path, PathBuf},
};
use tower_lsp::lsp_types::Url;
use walkdir::WalkDir;

#[derive(Deserialize, Serialize, Debug, Clone)]
#[serde(rename_all = "kebab-case")]
pub struct Catalog {
    #[serde(default)]
    uri: Vec<CatalogUri>,
    #[serde(default)]
    group: Vec<CatalogGroup>,

    /// Warning! This is the path to the catalog file NOT its parent folder.
    #[serde(skip)]
    locaton: String,
}

impl Catalog {
    #[cfg(test)]
    pub fn new(location: &str) -> Catalog {
        Catalog {
            uri: vec![],
            group: vec![],
            locaton: location.into(),
        }
    }

    #[cfg(test)]
    pub fn with_uri(self, name: &str, uri: &str) -> Catalog {
        let mut c = self.clone();
        c.uri.push(CatalogUri {
            _id: "Constructed in a builder".into(),
            name: name.into(),
            uri: uri.into(),
        });
        c
    }
}

/// This is a kind of mapping between a ontology URL and a relative file path
#[derive(Deserialize, Serialize, Debug, Clone)]
#[serde(rename_all = "kebab-case")]
pub struct CatalogUri {
    /// Non unique name of item
    #[serde(rename = "@id")]
    _id: String,

    /// Full URL of the ontology. This will be used in OMN import statements
    #[serde(rename = "@name")]
    pub name: String,

    /// Relative file path of the backing ontology file
    #[serde(rename = "@uri")]
    pub uri: String,
}

#[derive(Deserialize, Serialize, Debug, Clone)]
#[serde(rename_all = "kebab-case")]
pub struct CatalogGroup {
    pub uri: Vec<CatalogUri>,
}

impl Catalog {
    pub fn load_catalogs_recursive(uri: &Url) -> Vec<Catalog> {
        uri.to_file_path()
            .map_err(|()| Error::InvalidUrl(uri.clone()))
            .map(|path| {
                WalkDir::new(path)
                    .into_iter()
                    .filter_map(std::result::Result::ok)
                    .filter(|entry| entry.file_type().is_file())
                    .filter(|entry| entry.file_name().to_str() == "catalog-v001.xml".into())
                    .filter_map(|entry| read_to_string(entry.path()).ok().map(|s| (s, entry)))
                    .filter_map(|(xml, entry)| {
                        from_str(xml.as_str()).ok().map(|c: Catalog| (c, entry))
                    })
                    .map(|(mut catalog, entry)| {
                        catalog.locaton = entry
                            .path()
                            .to_str()
                            .expect("path should be valid utf-8")
                            .to_string();
                        info!("Found catalog {catalog:?}");
                        catalog
                    })
                    .collect_vec()
            })
            .inspect_log()
            .unwrap_or_default()
    }

    pub fn all_catalog_uris(&self) -> impl Iterator<Item = &CatalogUri> {
        self.uri
            .iter()
            .chain(self.group.iter().flat_map(|g| &g.uri))
    }

    /// Takes a path to a document and determins if the item is inside this catalog
    pub fn contains(&self, path: &PathBuf) -> bool {
        for catalog_uri in self.all_catalog_uris() {
            let catalog_item_path = self.parent_folder().join(&catalog_uri.uri);
            if &catalog_item_path == path {
                return true;
            }
        }
        false
    }

    pub fn parent_folder(&self) -> &Path {
        Path::new(self.locaton.as_str())
            .parent()
            .expect("catalog file should have a parent folder, because it is a file")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn catalog_deserialize_should_work() {
        let xml = r#"
            <?xml version="1.0" encoding="UTF-8" standalone="no"?>
            <catalog prefer="public" xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/oeo-import-edits.owl" uri="oeo-import-edits.owl"/>
                <uri id="Imports Wizard Entry" name="http://purl.obolibrary.org/obo/bfo/2.0/bfo.owl" uri="https://raw.githubusercontent.com/BFO-ontology/BFO/v2.0/bfo.owl"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/oeo-model.omn" uri="oeo-model.omn"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/oeo-physical.omn" uri="oeo-physical.omn"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/oeo-sector.omn" uri="oeo-sector.omn"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/oeo-social.omn" uri="oeo-social.omn"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/oeo-shared.omn" uri="oeo-shared.omn"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/imports/iao-extracted.owl" uri="../imports/iao-extracted.owl"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/imports/ro-extracted.owl" uri="../imports/ro-extracted.owl"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/imports/uo-extracted.owl" uri="../imports/uo-extracted.owl"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/imports/stato-extracted.owl" uri="../imports/stato-extracted.owl"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/imports/cco-extracted.owl" uri="../imports/cco-extracted.owl"/>                                      
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/imports/meno-extracted.owl" uri="../imports/meno-extracted.owl"/>
                <group id="Folder Repository, directory=, recursive=true, Auto-Update=true, version=2" prefer="public" xml:base="">
                    <uri id="Automatically generated entry, Timestamp=1740265509439" name="http://openenergy-platform.org/ontology/oeo/oeo-import-edits.owl" uri="oeo-import-edits.owl"/>
                    <uri id="Automatically generated entry, Timestamp=1740265509439" name="http://openenergy-platform.org/ontology/oeo/oeo-physical-axioms/" uri="oeo-physical-axioms.owl"/>
                </group>
            </catalog>
        "#;

        let catalog: Catalog = from_str(xml).unwrap();

        assert_eq!(catalog.all_catalog_uris().count(), 15);
        assert_eq!(
            catalog.all_catalog_uris().next().unwrap().uri,
            "oeo-import-edits.owl".to_string()
        );
        assert_eq!(
            catalog.all_catalog_uris().last().unwrap().uri,
            "oeo-physical-axioms.owl".to_string()
        );
    }

    #[test]
    fn catalog_deserialize_without_group_should_work() {
        // Arrange
        let xml = r#"
            <?xml version="1.0" encoding="UTF-8" standalone="no"?>
            <catalog prefer="public" xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/oeo-import-edits.owl" uri="oeo-import-edits.owl"/>
                <uri id="Imports Wizard Entry" name="http://purl.obolibrary.org/obo/bfo/2.0/bfo.owl" uri="https://raw.githubusercontent.com/BFO-ontology/BFO/v2.0/bfo.owl"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/oeo-model.omn" uri="oeo-model.omn"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/oeo-physical.omn" uri="oeo-physical.omn"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/oeo-sector.omn" uri="oeo-sector.omn"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/oeo-social.omn" uri="oeo-social.omn"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/oeo-shared.omn" uri="oeo-shared.omn"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/imports/iao-extracted.owl" uri="../imports/iao-extracted.owl"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/imports/ro-extracted.owl" uri="../imports/ro-extracted.owl"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/imports/uo-extracted.owl" uri="../imports/uo-extracted.owl"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/imports/stato-extracted.owl" uri="../imports/stato-extracted.owl"/>
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/imports/cco-extracted.owl" uri="../imports/cco-extracted.owl"/>                                      
                <uri id="Imports Wizard Entry" name="http://openenergy-platform.org/ontology/oeo/dev/imports/meno-extracted.owl" uri="../imports/meno-extracted.owl"/>
            </catalog>
        "#;

        // Act
        let catalog: Catalog = from_str(xml).unwrap();

        // Assert
        assert_eq!(catalog.all_catalog_uris().count(), 13);
    }

    #[test]
    fn catalog_serialize_with_empty_catalog_should_work() {
        // Arrange
        let value = Catalog::new("testing");

        // Act
        let xml = quick_xml::se::to_string(&value).unwrap();

        //Assert
        assert_eq!(xml, "<Catalog/>");
    }
}