provenant-cli 0.0.30

Rust-based ScanCode-compatible scanner for licenses, package metadata, SBOMs, and provenance data.
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

// SPDX-FileCopyrightText: Provenant contributors
// SPDX-License-Identifier: Apache-2.0

use std::collections::HashMap;

use crate::models::FileInfo;

use super::package_file_index::PackageFileIndex;
use super::{FileIx, PackageIx};

#[derive(Default)]
pub(super) struct OutputIndexes {
    first_file_index_by_path: HashMap<String, FileIx>,
    key_file_indices_by_package_ix: HashMap<PackageIx, Vec<FileIx>>,
}

#[derive(Clone, Copy, PartialEq, Eq)]
pub(super) enum OutputIndexMode {
    KeyFilesOnly,
    Full,
}

impl OutputIndexMode {
    fn includes_path_index(self) -> bool {
        matches!(self, Self::Full)
    }
}

impl OutputIndexes {
    pub(super) fn build(
        files: &[FileInfo],
        package_file_index: Option<&PackageFileIndex>,
        use_fallback_key_classification: bool,
        mode: OutputIndexMode,
    ) -> Self {
        let mut indexes = Self::default();

        for (idx, file) in files.iter().enumerate() {
            let file_ix = FileIx(idx);

            if mode.includes_path_index() {
                indexes
                    .first_file_index_by_path
                    .entry(file.path.clone())
                    .or_insert(file_ix);
            }

            let is_key_file = package_file_index.is_some_and(|index| {
                index.is_key_file(files, file_ix, use_fallback_key_classification)
            });

            if is_key_file {
                for package_ix in package_file_index
                    .into_iter()
                    .flat_map(|index| index.package_ixs_for_file(file_ix))
                {
                    indexes
                        .key_file_indices_by_package_ix
                        .entry(*package_ix)
                        .or_default()
                        .push(file_ix);
                }
            }
        }

        indexes
    }

    pub(super) fn file_ix_by_path(&self, path: &str) -> Option<FileIx> {
        self.first_file_index_by_path.get(path).copied()
    }

    pub(super) fn key_file_indices_for_package(&self, package_ix: PackageIx) -> Option<&[FileIx]> {
        self.key_file_indices_by_package_ix
            .get(&package_ix)
            .map(Vec::as_slice)
    }
}