mago-guard 1.21.0

A PHP dependencies guard that helps keep your architecture clean.
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

use bumpalo::Bump;

use mago_collector::Collector;
use mago_database::file::File;
use mago_reporting::IssueCollection;
use mago_syntax::ast::Program;

use crate::report::breach::BoundaryBreach;
use crate::report::flaw::StructuralFlaw;

pub mod breach;
pub mod flaw;

const COLLECTOR_CATEGORIES: &[&str] = &["guard"];

#[derive(Debug, Default)]
pub struct FortressReport {
    pub boundary_breaches: Vec<BoundaryBreach>,
    pub structural_flaws: Vec<StructuralFlaw>,
    /// Whether perimeter guard was skipped due to missing configuration.
    pub missing_perimeter_configuration: bool,
    /// Whether structural guard was skipped due to missing configuration.
    pub missing_structural_configuration: bool,
}

impl FortressReport {
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.boundary_breaches.is_empty() && self.structural_flaws.is_empty()
    }

    pub fn report_into_issues(self, arena: &Bump, source_file: &File, program: &Program) -> IssueCollection {
        let mut collector = Collector::new(arena, source_file, program, COLLECTOR_CATEGORIES);
        for boundary_breach in self.boundary_breaches {
            collector.report_with_code(boundary_breach.vector.error_code(), boundary_breach.into());
        }

        for structural_flaw in self.structural_flaws {
            collector.report_with_code(structural_flaw.kind.error_code(), structural_flaw.into());
        }

        collector.finish()
    }
}