plow_linter 0.2.8

use crate::{
    lint::{
        common_error_literals::NO_ROOT_PREFIX,
        helpers::{catch_single_annotations_which_must_exist, validate_namespace_and_name},
        lint_failure, lint_success, Lint, LintResult,
    },
    Linter, MultiReaderRdfGraph,
};

use field33_rdftk_iri_temporary_fork::IRI as RDFTK_IRI;
use plow_ontology::constants::REGISTRY_PACKAGE_NAME;
use plow_package_management::metadata::get_root_prefix;
use std::str::FromStr;
use std::{any::Any, collections::HashSet};

const RELATED_FIELD: &str = "`registry:packageName`";
/// Ensures that a value for `registry:packageName` is specified as annotation on the ontology.
#[derive(Debug, Default)]
pub struct HasRegistryPackageName;

impl Lint for HasRegistryPackageName {
    fn as_any(&self) -> &dyn Any {
        self
    }
    fn short_description(&self) -> &str {
        "Check that the field is annotated with a value for `registry:packageName`"
    }
    /// Lints for the existence of `registry:packageName` and its correct format
    /// (should be `@namespace/package_name` , with both the namespace and package name
    /// only being alphanumeric characters + underscore)
    fn run(
        &self,
        Linter {
            document,
            graph: MultiReaderRdfGraph { inner: rdf_graph },
            ..
        }: &Linter,
    ) -> LintResult {
        let rdf_factory = field33_rdftk_core_temporary_fork::simple::statement::statement_factory();
        if let Some(root_prefix) = get_root_prefix(document) {
            let graph_ref = rdf_graph;
            let graph = graph_ref.borrow();
            // We explicitly pass valid data, unwrap is safe here.
            #[allow(clippy::unwrap_used)]
            let annotations = graph
                .statements()
                .filter(|statement| {
                    statement.subject()
                        == &rdf_factory
                            .named_subject(RDFTK_IRI::from_str(root_prefix).unwrap().into())
                        && statement.predicate()
                            == &RDFTK_IRI::from_str(REGISTRY_PACKAGE_NAME).unwrap().into()
                })
                .collect::<HashSet<_>>();

            if let Some(failure) =
                catch_single_annotations_which_must_exist(&annotations, RELATED_FIELD)
            {
                return failure;
            }

            // We know that `annotations` has at least one member here.
            #[allow(clippy::unwrap_used)]
            let annotation = annotations.iter().next().unwrap();
            let lint_prefix = format!("The value of {RELATED_FIELD},");
            if let Some(literal) = annotation.object().as_literal() {
                if let Err(failure) = validate_namespace_and_name(literal.lexical_form()) {
                    return lint_failure!(format!("{lint_prefix} {failure}"));
                }

                lint_success!(format!("{lint_prefix} is valid."))
            } else {
                lint_failure!(format!("{lint_prefix} is not a literal."))
            }
        } else {
            lint_failure!(NO_ROOT_PREFIX)
        }
    }
}