watchexec/src/notification_filter.rs

146 lines
4.2 KiB
Rust

extern crate glob;
use std::io;
use std::path::Path;
use globset;
use globset::{Glob, GlobSet, GlobSetBuilder};
use gitignore;
pub struct NotificationFilter {
filters: GlobSet,
filter_count: usize,
ignores: GlobSet,
ignore_files: gitignore::Gitignore,
}
#[derive(Debug)]
pub enum Error {
Glob(globset::Error),
Io(io::Error),
}
impl NotificationFilter {
pub fn new(filters: Vec<String>,
ignores: Vec<String>,
ignore_files: gitignore::Gitignore)
-> Result<NotificationFilter, Error> {
let mut filter_set_builder = GlobSetBuilder::new();
for f in &filters {
filter_set_builder.add(try!(Glob::new(f)));
debug!("Adding filter: \"{}\"", f);
}
let mut ignore_set_builder = GlobSetBuilder::new();
for i in &ignores {
let mut ignore_path = Path::new(i).to_path_buf();
if ignore_path.is_relative() && !i.starts_with("*") {
ignore_path = Path::new("**").join(&ignore_path);
}
let pattern = ignore_path.to_str().unwrap();
ignore_set_builder.add(try!(Glob::new(pattern)));
debug!("Adding ignore: \"{}\"", pattern);
}
let filter_set = try!(filter_set_builder.build());
let ignore_set = try!(ignore_set_builder.build());
Ok(NotificationFilter {
filters: filter_set,
filter_count: filters.len(),
ignores: ignore_set,
ignore_files: ignore_files,
})
}
pub fn is_excluded(&self, path: &Path) -> bool {
if self.ignores.is_match(path) {
debug!("Ignoring {:?}: matched ignore filter", path);
return true;
}
if self.filters.is_match(path) {
return false;
}
if self.ignore_files.is_excluded(path) {
debug!("Ignoring {:?}: matched gitignore file", path);
return true;
}
if self.filter_count > 0 {
debug!("Ignoring {:?}: did not match any given filters", path);
}
self.filter_count > 0
}
}
impl From<io::Error> for Error {
fn from(err: io::Error) -> Error {
Error::Io(err)
}
}
impl From<globset::Error> for Error {
fn from(err: globset::Error) -> Error {
Error::Glob(err)
}
}
#[cfg(test)]
mod tests {
use gitignore;
use super::NotificationFilter;
use std::path::Path;
#[test]
fn test_allows_everything_by_default() {
let filter = NotificationFilter::new(vec![], vec![], gitignore::load(&vec![])).unwrap();
assert!(!filter.is_excluded(&Path::new("foo")));
}
#[test]
fn test_filename() {
let filter = NotificationFilter::new(vec![], vec![String::from("test.json")], gitignore::load(&vec![])).unwrap();
assert!(filter.is_excluded(&Path::new("/path/to/test.json")));
assert!(filter.is_excluded(&Path::new("test.json")));
}
#[test]
fn test_multiple_filters() {
let filters = vec![String::from("*.rs"), String::from("*.toml")];
let filter = NotificationFilter::new(filters, vec![], gitignore::load(&vec![])).unwrap();
assert!(!filter.is_excluded(&Path::new("hello.rs")));
assert!(!filter.is_excluded(&Path::new("Cargo.toml")));
assert!(filter.is_excluded(&Path::new("README.md")));
}
#[test]
fn test_multiple_ignores() {
let ignores = vec![String::from("*.rs"), String::from("*.toml")];
let filter = NotificationFilter::new(vec![], ignores, gitignore::load(&vec![])).unwrap();
assert!(filter.is_excluded(&Path::new("hello.rs")));
assert!(filter.is_excluded(&Path::new("Cargo.toml")));
assert!(!filter.is_excluded(&Path::new("README.md")));
}
#[test]
fn test_ignores_take_precedence() {
let ignores = vec![String::from("*.rs"), String::from("*.toml")];
let filter = NotificationFilter::new(ignores.clone(), ignores, gitignore::load(&vec![]))
.unwrap();
assert!(filter.is_excluded(&Path::new("hello.rs")));
assert!(filter.is_excluded(&Path::new("Cargo.toml")));
assert!(filter.is_excluded(&Path::new("README.md")));
}
}