plow_linter 0.2.9

A linter to lint Plow ttl documents (interpreted as ontologies).
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

use std::any::Any;

use crate::lint::common_error_literals::NO_ROOT_PREFIX;
use crate::lint::{lint_failure, lint_success, Lint, LintResult};
use crate::Linter;
use harriet::{Directive, Statement};
use plow_package_management::metadata::get_root_prefix;

use super::LintName;

#[derive(Debug)]
pub struct BaseMatchesRootPrefix {
    pub name: LintName,
}
impl Default for BaseMatchesRootPrefix {
    fn default() -> Self {
        Self {
            name: LintName::BaseMatchesRootPrefix,
        }
    }
}

impl Lint for BaseMatchesRootPrefix {
    fn as_any(&self) -> &dyn Any {
        self
    }

    fn short_description(&self) -> &str {
        "Check that the @base directive matches the value for the `:` prefix."
    }

    /// Check that the @base directive matches the value for the `:` prefix.
    fn run(&self, Linter { document, .. }: &Linter) -> LintResult {
        if let Some(root_prefix) = get_root_prefix(document) {
            let mut base_directive = None;
            for statement in &document.statements {
                if let Statement::Directive(Directive::Base(directive)) = statement {
                    if base_directive.is_some() {
                        return LintResult::Failure(vec!["Found more than one @base directive. While it is valid Turtle to redeclare the @base throughout the file, this can easily be misused and is not supported in Field 33 ontologies".to_owned()]);
                    }
                    base_directive = Some(directive);
                }
            }
            if let Some(base_directive) = base_directive {
                let base_directive_iri = &base_directive.iri.iri;
                if *base_directive_iri == *root_prefix {
                    return lint_success!("@base directive matches `:` prefix.");
                }
                return lint_failure!(format!("@base directive (`{base_directive_iri}`) doesn't match the `:` prefix (`{root_prefix}`). Maybe there is a typo, or no trailing slash?"));
            }
            return lint_failure!("Unable to find a @base directive.");
        }
        lint_failure!(NO_ROOT_PREFIX)
    }
}