classifier-implementation 0.1.0

Compatibility classifier contract implementation
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

//! Governed classifier use-case boundary over the ordinary classifier engine.
#![deny(missing_docs)]
#![forbid(unsafe_code)]

use boxology_classifier::{Class, ClassificationReport, classify};
use boxology_schema::SchemaDocument;

mod contract;
pub use contract::*;

/// Pure implementation of the generated classifier capability.
pub struct ClassifierService;

#[boxology::implementation]
impl ClassifierService {
    /// Classifies strict canonical schema bytes without consulting ambient state.
    pub async fn classify(
        &self,
        _context: boxology::CallContext,
        request: ClassifyRequest,
    ) -> Result<ClassifyOutcome, ClassifierError> {
        let base = match request.base.as_deref() {
            Some(bytes) => match SchemaDocument::parse(bytes) {
                Ok(document) => Some(document),
                Err(diagnostics) => {
                    return Ok(failure(ClassifyFailureStage::Base, diagnostics));
                }
            },
            None => None,
        };
        let submitted = match SchemaDocument::parse(&request.submitted) {
            Ok(document) => document,
            Err(diagnostics) => {
                return Ok(failure(ClassifyFailureStage::Submitted, diagnostics));
            }
        };
        let report = match classify(base.as_ref(), Some(&submitted)) {
            Ok(report) => report,
            Err(diagnostics) => {
                return Ok(failure(ClassifyFailureStage::Pairing, diagnostics));
            }
        };
        Ok(ClassifyOutcome {
            report: Some(boundary_report(&report)),
            failure: None,
        })
    }
}

fn failure(
    stage: ClassifyFailureStage,
    diagnostics: boxology_schema::Diagnostics,
) -> ClassifyOutcome {
    ClassifyOutcome {
        report: None,
        failure: Some(ClassifyFailure {
            stage,
            diagnostics: diagnostics.to_string(),
        }),
    }
}

fn boundary_report(report: &ClassificationReport) -> ClassifyReport {
    ClassifyReport {
        verdict: boundary_class(report.verdict()),
        findings: report
            .findings()
            .iter()
            .map(|finding| ClassifyFinding {
                code: finding.code().to_owned(),
                path: finding.path().to_owned(),
                kind: finding.kind().to_owned(),
                class: boundary_class(finding.class()),
                base_excerpt: finding.base_excerpt().map(str::to_owned),
                submitted_excerpt: finding.submitted_excerpt().map(str::to_owned),
                condition: finding.condition().map(str::to_owned),
            })
            .collect(),
        rendered_text: boxology_classifier::render_text(report),
    }
}

fn boundary_class(class: Class) -> CompatibilityClass {
    match class {
        Class::Unchanged => CompatibilityClass::Unchanged,
        Class::Documentation => CompatibilityClass::Documentation,
        Class::Deprecation => CompatibilityClass::Deprecation,
        Class::Additive => CompatibilityClass::Additive,
        Class::CompatibleWithConditions => CompatibilityClass::CompatibleWithConditions,
        Class::Incompatible => CompatibilityClass::Incompatible,
    }
}

/// Generated implementation adapter for composition assembly.
#[doc(hidden)]
pub mod generated {
    include!("generated_adapter.rs");
}