plow_linter 0.2.9

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

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

const RELATED_FIELD: &str = "`registry:licenseSPDX`";
/// A sane character count for a `licenseSPDX` field.
const SPDX_LICENSE_MAX_ALLOWED_CHAR_COUNT: usize = 100;
/// Ensures that a value for `registry:licenseSPDX` is specified as annotation on the ontology.
#[derive(Debug, Default)]
pub struct HasRegistryLicenseSPDX;

impl Lint for HasRegistryLicenseSPDX {
    fn as_any(&self) -> &dyn Any {
        self
    }
    fn short_description(&self) -> &str {
        "Check that the field is annotated with a value for `registry:licenseSPDX`"
    }
    /// Lints for the existence of `registry:licenseSPDX` and its validity.
    /// Check <https://spdx.org/licenses> for a list of available licenses.
    /// Maximum 100 characters are allowed for a license.
    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_LICENSE_SPDX).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},");
            annotation.object().as_literal().map_or_else(
                    || lint_failure!(format!("{lint_prefix} is not a literal.")),
                    |literal| {
                        let license_spdx_raw = literal.lexical_form().trim();
                        if literal.has_language() {
                            return lint_failure!(format!(
                                "{lint_prefix} does not accept language tags."
                            ));
                        }
                        if license_spdx_raw.chars().count() > SPDX_LICENSE_MAX_ALLOWED_CHAR_COUNT {
                            return lint_failure!(format!("{lint_prefix} allows a maximum of {SPDX_LICENSE_MAX_ALLOWED_CHAR_COUNT} characters."));
                        }
                        match spdx::Expression::parse(license_spdx_raw) {
                            Ok(_license_expression) => {
                                // In the future if necessary we can do more checks on the expression.
                                // For example check if licenses are OSI approved?
                                // When the requirements are clarified we can revisit this.
                                lint_success!(format!("{lint_prefix} is valid."))
                            }
                            Err(err) => {
                                lint_failure!(format!(
                                    "{lint_prefix} is not a valid spdx license. Error: {err}"
                                ))
                            }
                        }
                    },
                )
        } else {
            lint_failure!(NO_ROOT_PREFIX)
        }
    }
}