cargo-detect-package 1.0.16

A Cargo tool to detect the package that a file belongs to, passing the package name to a subcommand
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

// Facade that dispatches to either the real filesystem or a mock in tests.
//
// The facade pattern allows the same code to work with both real and mock implementations,
// with the mock variant only available in test builds.

use std::path::{Path, PathBuf};
#[cfg(test)]
use std::sync::Arc;
use std::{fmt, io};

#[cfg(test)]
use crate::pal::MockFilesystem;
use crate::pal::{BuildTargetFilesystem, Filesystem};

/// Facade over filesystem operations, dispatching to real or mock implementation.
///
/// In production, this always uses `BuildTargetFilesystem`. In tests, it can also wrap a
/// `MockFilesystem` for controlled test scenarios.
#[derive(Clone)]
pub(crate) enum FilesystemFacade {
    /// Real filesystem implementation.
    Target(&'static BuildTargetFilesystem),

    /// Mock filesystem for testing.
    #[cfg(test)]
    Mock(Arc<MockFilesystem>),
}

// Debug implementations have no API contract to test.
#[cfg_attr(coverage_nightly, coverage(off))]
#[cfg_attr(test, mutants::skip)]
impl fmt::Debug for FilesystemFacade {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Target(_) => f.debug_struct("FilesystemFacade::Target").finish(),
            #[cfg(test)]
            Self::Mock(_) => f.debug_struct("FilesystemFacade::Mock").finish(),
        }
    }
}

/// Static instance of the real filesystem for production use.
static BUILD_TARGET_FILESYSTEM: BuildTargetFilesystem = BuildTargetFilesystem;

// Facade types are trivial pass-through layers - not worth testing.
#[cfg_attr(coverage_nightly, coverage(off))]
#[cfg_attr(test, mutants::skip)]
impl FilesystemFacade {
    /// Creates a facade using the real filesystem.
    pub(crate) const fn target() -> Self {
        Self::Target(&BUILD_TARGET_FILESYSTEM)
    }

    /// Creates a facade wrapping a mock filesystem (test builds only).
    #[cfg(test)]
    pub(crate) fn from_mock(mock: MockFilesystem) -> Self {
        Self::Mock(Arc::new(mock))
    }
}

// Facade types are trivial pass-through layers - not worth testing.
#[cfg_attr(coverage_nightly, coverage(off))]
#[cfg_attr(test, mutants::skip)]
impl Filesystem for FilesystemFacade {
    fn cargo_toml_exists(&self, dir: &Path) -> bool {
        match self {
            Self::Target(fs) => fs.cargo_toml_exists(dir),
            #[cfg(test)]
            Self::Mock(mock) => mock.cargo_toml_exists(dir),
        }
    }

    fn read_cargo_toml(&self, dir: &Path) -> io::Result<String> {
        match self {
            Self::Target(fs) => fs.read_cargo_toml(dir),
            #[cfg(test)]
            Self::Mock(mock) => mock.read_cargo_toml(dir),
        }
    }

    fn is_file(&self, path: &Path) -> bool {
        match self {
            Self::Target(fs) => fs.is_file(path),
            #[cfg(test)]
            Self::Mock(mock) => mock.is_file(path),
        }
    }

    fn canonicalize(&self, path: &Path) -> io::Result<PathBuf> {
        match self {
            Self::Target(fs) => fs.canonicalize(path),
            #[cfg(test)]
            Self::Mock(mock) => mock.canonicalize(path),
        }
    }

    fn current_dir(&self) -> io::Result<PathBuf> {
        match self {
            Self::Target(fs) => fs.current_dir(),
            #[cfg(test)]
            Self::Mock(mock) => mock.current_dir(),
        }
    }

    fn exists(&self, path: &Path) -> bool {
        match self {
            Self::Target(fs) => fs.exists(path),
            #[cfg(test)]
            Self::Mock(mock) => mock.exists(path),
        }
    }
}

// Facade types are trivial pass-through layers - not worth testing.
#[cfg_attr(coverage_nightly, coverage(off))]
#[cfg_attr(test, mutants::skip)]
impl Default for FilesystemFacade {
    fn default() -> Self {
        Self::target()
    }
}