pathfilter 0.4.1

library to filter paths
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

use crate::IgnorePath;
use std::{path::Path, str::FromStr};

/// A filter that matches files based on a regex
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct RegexFilter {
    #[cfg_attr(feature = "serde", serde(with = "serde_regex"))]
    regex: regex::Regex,
}

impl IgnorePath for RegexFilter {
    fn ignore<P: AsRef<Path>>(&self, path: P) -> bool {
        match path.as_ref().to_str() {
            Some(s) => self.regex.is_match(s),
            None => false,
        }
    }
}

impl FromStr for RegexFilter {
    type Err = regex::Error;

    /// Attempts to parse a string into a regular expression
    fn from_str(s: &str) -> Result<Self, regex::Error> {
        Ok(RegexFilter::new(regex::Regex::new(s)?))
    }
}

impl RegexFilter {
    /// Creates a new regex filter for a string containing a regex.
    /// The regex is compiled and used to match paths.
    /// # Examples
    /// ```
    /// use pathfilter::RegexFilter;
    /// use pathfilter::IgnorePath;
    /// use std::path::Path;
    ///
    /// let filter = RegexFilter::new_str("^src/lib.rs$").unwrap();
    /// assert!(filter.ignore(Path::new("src/lib.rs")));
    /// assert!(!filter.ignore(Path::new("src/main.rs")));
    ///
    /// ```
    /// # Errors
    /// If the regex is invalid, an error is returned.
    pub fn new_str(pattern: &str) -> Result<Self, regex::Error> {
        let regex = regex::Regex::new(pattern)?;
        Ok(RegexFilter { regex })
    }

    /// Creates a new regex filter for a regex.
    ///
    /// # Examples
    /// ```
    /// use pathfilter::RegexFilter;
    /// use pathfilter::IgnorePath;
    /// use std::path::Path;
    /// use regex::Regex;
    ///
    /// let filter = RegexFilter::new(Regex::new("^src/lib.rs$").unwrap());
    /// assert!(filter.ignore(Path::new("src/lib.rs")));
    /// assert!(!filter.ignore(Path::new("src/Program.cs")));
    ///
    /// ```
    pub fn new(regex: regex::Regex) -> Self {
        RegexFilter { regex }
    }
}

#[cfg(test)]
mod tests {
    use regex::Regex;
    use std::path::Path;

    #[test]
    fn regex_filter_str() {
        use crate::{regex::RegexFilter, IgnorePath};

        let filter = RegexFilter::new_str("^(.*)\\.rs$").unwrap();
        assert!(filter.ignore(Path::new("src/lib.rs")));
        assert!(filter.ignore(Path::new("src/main.rs")));
        assert!(!filter.ignore(Path::new("src/Program.cs")));
    }

    #[test]
    fn regex_filter() {
        use crate::{regex::RegexFilter, IgnorePath};

        let filter = RegexFilter::new(Regex::new("^src/lib.rs$").unwrap());
        assert!(filter.ignore(Path::new("src/lib.rs")));
        assert!(!filter.ignore(Path::new("src/Program.cs")));
    }
}