shacl 0.2.20

A SHACL validator for RDF data, implemented in Rust.
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::ast::{ASTSchema, ASTShape};
use crate::rdf::State;
use crate::rdf::error::ShaclParserError;
use crate::rdf::parsers::{node_shape, property_shape};
use itertools::Itertools;
use rudof_rdf::rdf_core::parser::RDFParse;
use rudof_rdf::rdf_core::parser::rdf_node_parser::constructors::{ListParser, SuccessParser};
use rudof_rdf::rdf_core::parser::rdf_node_parser::{ParserExt, RDFNodeParse};
use rudof_rdf::rdf_core::term::Object;
use rudof_rdf::rdf_core::term::Triple;
use rudof_rdf::rdf_core::vocabs::{RdfVocab, ShaclVocab};
use rudof_rdf::rdf_core::{Any, FocusRDF, Matcher};
use std::collections::{HashMap, HashSet};

pub struct ShaclParser<RDF: FocusRDF> {
    rdf_parser: RDFParse<RDF>,
    shapes: HashMap<Object, ASTShape>,
}

impl<RDF: FocusRDF> ShaclParser<RDF> {
    pub fn new(rdf: RDF) -> Self {
        Self {
            rdf_parser: RDFParse::new(rdf),
            shapes: HashMap::new(),
        }
    }

    pub fn parse(&mut self) -> Result<ASTSchema, ShaclParserError> {
        let pm = self.rdf_parser.prefixmap().unwrap_or_default();

        let mut state: State = self.shapes_candidates()?.into();

        while let Some(node) = state.pop_pending() {
            if !self.shapes.contains_key(&node) {
                self.rdf_parser.rdf_mut().set_focus(&node.clone().into());
                let shape = shape().parse_focused(self.rdf_parser.rdf_mut())?;
                self.shapes.insert(node, shape);
            }
        }

        Ok(
            ASTSchema::new().with_prefixmap(pm).with_shapes(self.shapes.clone()), // TODO - Maybe avoid the shapes clone
        )
    }

    /// Shapes candidates are defined in Appendix A of SHACL spec (Syntax rules)
    /// The text is:
    /// A shape is an IRI or blank node s that fulfills at least one of the following conditions in the shapes graph:
    /// - s is a SHACL instance of sh:NodeShape or sh:PropertyShape.
    /// - s is subject of a triple that has sh:targetClass, sh:targetNode, sh:targetObjectsOf or sh:targetSubjectsOf as predicate.
    /// - s is subject of a triple that has a parameter as predicate.
    /// - s is a value of a shape-expecting, non-list-taking parameter such as sh:node,
    ///   or a member of a SHACL list that is a value of a shape-expecting and list-taking parameter such as sh:or.
    fn shapes_candidates(&mut self) -> Result<Vec<Object>, ShaclParserError> {
        // instances of `sh:NodeShape`
        let mut node_shapes_instances = self.get_triples::<_, RDF::IRI, RDF::Term>(
            &Any,
            &RdfVocab::rdf_type().into(),
            &ShaclVocab::sh_node_shape().into(),
        )?;
        // instances of `sh:PropertyShape`
        let property_shapes_instances = self.get_triples::<_, RDF::IRI, RDF::Term>(
            &Any,
            &RdfVocab::rdf_type().into(),
            &ShaclVocab::sh_property_shape().into(),
        )?;
        // instances of `sh:Shape`
        let shape_instances = self.get_triples::<_, RDF::IRI, RDF::Term>(
            &Any,
            &RdfVocab::rdf_type().into(),
            &ShaclVocab::sh_shape().into(),
        )?;
        // subjects of sh:targetClass
        let subjects_target_class =
            self.get_triples::<_, RDF::IRI, _>(&Any, &ShaclVocab::sh_target_class().into(), &Any)?;
        // subjects of sh:targetSubjectsOf
        let subjects_target_subjects_of =
            self.get_triples::<_, RDF::IRI, _>(&Any, &ShaclVocab::sh_target_subjects_of().into(), &Any)?;
        // subjects of sh:targetObjectsOf
        let subjects_target_objects_of =
            self.get_triples::<_, RDF::IRI, _>(&Any, &ShaclVocab::sh_target_objects_of().into(), &Any)?;
        // subjects of sh:targetNode
        let subjects_target_node =
            self.get_triples::<_, RDF::IRI, _>(&Any, &ShaclVocab::sh_target_node().into(), &Any)?;
        // Search shape expecting parameters: https://www.w3.org/TR/shacl12-core/#dfn-shape-expecting
        // elements of `sh:and` list
        let sh_and_values = self.get_triples_list(&ShaclVocab::sh_and().into(), "sh:and", |v, ctx| {
            ShaclParserError::ValueNotExpected {
                iri: ctx.to_string(),
                expected: "subject".to_string(),
                found: v.to_string(),
            }
        })?;
        // elements of `sh:or` list
        let sh_or_values = self.get_triples_list(&ShaclVocab::sh_or().into(), "sh:or", |v, ctx| {
            ShaclParserError::ValueNotExpected {
                iri: ctx.to_string(),
                expected: "object".to_string(),
                found: v.to_string(),
            }
        })?;
        // elements of `sh:not` list
        let sh_not_values = self.objects_with_predicate(&ShaclVocab::sh_not().into())?;
        // subjects with property `sh:property`
        let subjects_property = self.objects_with_predicate(&ShaclVocab::sh_property().into())?;
        // elements of `sh:node` list
        let sh_qualified_value_shape_nodes =
            self.objects_with_predicate(&ShaclVocab::sh_qualified_value_shape().into())?;
        // elements of `sh:node` list
        let sh_node_values = self.objects_with_predicate(&ShaclVocab::sh_node().into())?;
        // elements of `sh:xone` list
        let sh_xone_values = self.get_triples_list(&ShaclVocab::sh_xone().into(), "sh:xone", |v, ctx| {
            ShaclParserError::ValueNotExpected {
                iri: ctx.to_string(),
                expected: "subject".to_string(),
                found: v.to_string(),
            }
        })?;
        // elements of `sh:reifierShape` list
        let sh_reifier_shape_values = self.objects_with_predicate(&ShaclVocab::sh_reifier_shape().into())?;

        node_shapes_instances.extend(property_shapes_instances);
        node_shapes_instances.extend(shape_instances);
        node_shapes_instances.extend(subjects_target_class);
        node_shapes_instances.extend(subjects_target_subjects_of);
        node_shapes_instances.extend(subjects_target_objects_of);
        node_shapes_instances.extend(subjects_target_node);
        node_shapes_instances.extend(sh_and_values);
        node_shapes_instances.extend(sh_or_values);
        node_shapes_instances.extend(sh_not_values);
        node_shapes_instances.extend(subjects_property);
        node_shapes_instances.extend(sh_qualified_value_shape_nodes);
        node_shapes_instances.extend(sh_node_values);
        node_shapes_instances.extend(sh_xone_values);
        node_shapes_instances.extend(sh_reifier_shape_values);

        Ok(node_shapes_instances
            .into_iter()
            .map(|s| RDF::subject_as_node(&s))
            .try_collect()?)
    }

    fn get_triples<S, P, O>(&self, s: &S, p: &P, o: &O) -> Result<HashSet<RDF::Subject>, ShaclParserError>
    where
        S: Matcher<RDF::Subject>,
        P: Matcher<RDF::IRI>,
        O: Matcher<RDF::Term>,
    {
        Ok(self
            .rdf_parser
            .rdf()
            .triples_matching(s, p, o)
            .map_err(|e| ShaclParserError::TriplesLookupError(e.to_string()))?
            .map(Triple::into_subject)
            .collect())
    }

    fn get_triples_list(
        &mut self,
        pred: &RDF::IRI,
        context: &str,
        err_fn: impl Fn(RDF::Term, &str) -> ShaclParserError,
    ) -> Result<HashSet<RDF::Subject>, ShaclParserError> {
        let mut rs = HashSet::new();

        for subject in self.objects_with_predicate(pred)? {
            self.rdf_parser.set_focus(&subject.into());
            let vs = ListParser::new().parse_focused(self.rdf_parser.rdf_mut())?;
            for v in vs {
                if let Ok(subj) = term_to_subject::<RDF>(&v, context) {
                    rs.insert(subj);
                } else {
                    return Err(err_fn(v, context));
                }
            }
        }

        Ok(rs)
    }

    fn objects_with_predicate(&self, pred: &RDF::IRI) -> Result<HashSet<RDF::Subject>, ShaclParserError> {
        let msg = format!("objects with predicate {pred}");
        let subjects = self
            .rdf_parser
            .rdf()
            .triples_with_predicate(pred)
            .map_err(|e| ShaclParserError::TriplesLookupError(e.to_string()))?
            .map(Triple::into_object)
            .flat_map(|t| term_to_subject::<RDF>(&t, msg.as_str()))
            .collect();
        Ok(subjects)
    }
}

fn term_to_subject<RDF: FocusRDF>(term: &RDF::Term, context: &str) -> Result<RDF::Subject, ShaclParserError> {
    RDF::term_as_subject(term).map_err(|_| ShaclParserError::ExpectedSubject {
        term: term.to_string(),
        context: context.to_string(),
    })
}

fn shape<RDF: FocusRDF + 'static>() -> impl RDFNodeParse<RDF, Output = ASTShape> {
    node_shape()
        .then(move |ns| SuccessParser::new(ASTShape::NodeShape(Box::new(ns))))
        .or(property_shape().then(|ps| SuccessParser::new(ASTShape::PropertyShape(Box::new(ps)))))
}