shacl 0.3.1

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

mod focus_nodes_ops;
mod native;
#[cfg(feature = "sparql")]
mod sparql;
mod validate;
mod value_nodes_ops;

use crate::ir::{IRComponent, IRPropertyShape, IRSchema, IRShape, ShapeLabelIdx};
use crate::types::Target;
use rudof_iri::IriS;
use rudof_rdf::rdf_core::term::Object;
use rudof_rdf::rdf_core::{NeighsRDF, SHACLPath};
use std::collections::HashSet;

use crate::error::ValidationError;
use crate::validator::nodes::{FocusNodes, ValueNodes};
use crate::validator::report::ValidationResult;
pub use native::NativeEngine;
use rudof_rdf::rdf_core::query::QueryRDF;
#[cfg(feature = "sparql")]
pub use sparql::SparqlEngine;
pub use validate::Validate;

pub trait Engine<S: NeighsRDF>: Send {
    /// Pre-builds internal indexes from the data graph for faster target resolution
    ///
    /// This should be called **once** before the validation loop starts
    fn build_indexes(&mut self, _store: &S) -> Result<(), ValidationError> {
        Ok(())
    }

    /// Creates a new engine instance that shares pre-built indexes and cache.
    ///
    /// This is used by the parallel validator to cheaply spin up per-shape
    /// engines without rebuilding expensive indexes for every thread.
    fn fork(&self) -> Box<dyn Engine<S>>;

    fn evaluate(
        &mut self,
        store: &S,
        shape: &IRShape,
        component: &IRComponent,
        value_nodes: &ValueNodes<S>,
        source_shape: Option<&IRShape>,
        maybe_path: Option<&SHACLPath>,
        shapes_graph: &IRSchema,
    ) -> Result<Vec<ValidationResult>, ValidationError>;

    fn focus_nodes(&self, store: &S, targets: &[Target]) -> Result<FocusNodes<S>, ValidationError> {
        let targets_iter: Vec<_> = targets
            .iter()
            .flat_map(|target| match target {
                Target::Node(n) => self.target_node(store, n),
                Target::Class(c) => self.target_class(store, c),
                Target::SubjectsOf(p) => self.target_subject_of(store, p),
                Target::ObjectsOf(p) => self.target_object_of(store, p),
                Target::ImplicitClass(n) => self.implicit_target_class(store, n),
                Target::WrongNode(_) => todo!(),
                Target::WrongClass(_) => todo!(),
                Target::WrongSubjectsOf(_) => todo!(),
                Target::WrongObjectsOf(_) => todo!(),
                Target::WrongImplicitClass(_) => todo!(),
            })
            .flatten()
            .collect();

        Ok(FocusNodes::from_iter(targets_iter))
    }

    /// If s is a shape in a shapes graph SG and s has value t for sh:targetNode
    /// in SG then { t } is a target from any data graph for s in SG.
    fn target_node(&self, store: &S, node: &Object) -> Result<FocusNodes<S>, ValidationError>;

    fn target_class(&self, store: &S, class: &Object) -> Result<FocusNodes<S>, ValidationError>;

    fn target_subject_of(&self, store: &S, predicate: &IriS) -> Result<FocusNodes<S>, ValidationError>;

    fn target_object_of(&self, store: &S, predicate: &IriS) -> Result<FocusNodes<S>, ValidationError>;

    fn implicit_target_class(&self, store: &S, shape: &Object) -> Result<FocusNodes<S>, ValidationError>;

    fn path(&self, store: &S, shape: &IRPropertyShape, focus_node: &S::Term) -> Result<FocusNodes<S>, ValidationError> {
        let nodes = store.objects_for_shacl_path(focus_node, shape.path())?;

        Ok(FocusNodes::new(nodes))
    }

    fn record_validation(&mut self, node: Object, shape_idx: ShapeLabelIdx, results: Vec<ValidationResult>);

    fn has_validated(&self, node: &Object, shape_idx: ShapeLabelIdx) -> bool;

    /// Returns the cached validation results for a given `(node, shape_idx)` pair, if any.
    ///
    /// Returns an owned [`Vec`] so that implementations backed by concurrent data
    /// structures can return data without tying the lifetime to
    /// an internal lock guard.
    fn get_cached_results(&self, node: &Object, shape_idx: ShapeLabelIdx) -> Option<Vec<ValidationResult>>;
}

#[cfg(feature = "sparql")]
fn select<S: QueryRDF>(store: &S, query: &str, index: &str) -> Result<HashSet<S::Term>, ValidationError> {
    let mut out = HashSet::new();

    let query = store
        .query_select(query)
        .map_err(ValidationError::select_query_error::<S>)?;

    for sol in query.iter() {
        if let Some(sol) = sol.find_solution(index) {
            out.insert(sol.to_owned());
        }
    }

    Ok(out)
}