Add filter building API

Author: christian-schilling

josh-cli/src/bin/josh-filter.rs

@@ -226,7 +226,9 @@ fn run_filter(args: Vec<String>) -> josh_core::JoshResult<i32> {
     refs.push((input_ref.clone(), reference.target().unwrap()));
 
     if args.get_flag("single") {
-        filterobj = josh_core::filter::chain(josh_core::filter::squash(None), filterobj);
+        filterobj = josh_core::filter::Filter::new()
+            .squash(None)
+            .chain(filterobj);
     }
 
     if let Some(pattern) = args.get_one::<String>("squash-pattern") {
@@ -236,11 +238,13 @@ fn run_filter(args: Vec<String>) -> josh_core::JoshResult<i32> {
             let target = reference.peel_to_commit()?.id();
             ids.push((
                 target,
-                josh_core::filter::message(reference.name().unwrap()),
+                josh_core::filter::Filter::new().message(reference.name().unwrap()),
             ));
             refs.push((reference.name().unwrap().to_string(), target));
         }
-        filterobj = josh_core::filter::chain(josh_core::filter::squash(Some(&ids)), filterobj);
+        filterobj = josh_core::filter::Filter::new()
+            .squash(Some(&ids))
+            .chain(filterobj);
     };
 
     if let Some(filename) = args.get_one::<String>("squash-file") {
@@ -251,13 +255,15 @@ fn run_filter(args: Vec<String>) -> josh_core::JoshResult<i32> {
             if let [sha, name] = split.as_slice() {
                 let target = git2::Oid::from_str(sha)?;
                 let target = repo.find_object(target, None)?.peel_to_commit()?.id();
-                ids.push((target, josh_core::filter::message(name)));
+                ids.push((target, josh_core::filter::Filter::new().message(name)));
                 refs.push((name.to_string(), target));
             } else if !split.is_empty() {
                 eprintln!("Warning: malformed line: {:?}", line);
             }
         }
-        filterobj = josh_core::filter::chain(josh_core::filter::squash(Some(&ids)), filterobj);
+        filterobj = josh_core::filter::Filter::new()
+            .squash(Some(&ids))
+            .chain(filterobj);
     };
 
     if args.get_flag("print-filter") {
@@ -318,7 +324,7 @@ fn run_filter(args: Vec<String>) -> josh_core::JoshResult<i32> {
                 &transaction,
                 josh_core::filter::parse(&i)?,
                 &[(input_ref.to_string(), r.id())],
-                josh_core::filter::empty(),
+                josh_core::filter::Filter::new().empty(),
             );
             updated_refs[0].0 = "refs/JOSH_TMP".to_string();
             josh_core::update_refs(&transaction, &mut updated_refs, "");
@@ -332,7 +338,7 @@ fn run_filter(args: Vec<String>) -> josh_core::JoshResult<i32> {
     let reverse = args.get_flag("reverse");
 
     let check_permissions = args.get_flag("check-permission");
-    let mut permissions_filter = josh_core::filter::empty();
+    let mut permissions_filter = josh_core::filter::Filter::new().empty();
     if check_permissions {
         let whitelist;
         let blacklist;
@@ -352,11 +358,11 @@ fn run_filter(args: Vec<String>) -> josh_core::JoshResult<i32> {
         } else {
             whitelist = match args.get_one::<String>("whitelist") {
                 Some(s) => josh_core::filter::parse(s)?,
-                _ => josh_core::filter::nop(),
+                _ => josh_core::filter::Filter::new(),
             };
             blacklist = match args.get_one::<String>("blacklist") {
                 Some(s) => josh_core::filter::parse(s)?,
-                _ => josh_core::filter::empty(),
+                _ => josh_core::filter::Filter::new().empty(),
             };
         }
         permissions_filter =
@@ -366,7 +372,7 @@ fn run_filter(args: Vec<String>) -> josh_core::JoshResult<i32> {
     let missing_permissions = args.get_flag("missing-permission");
     if missing_permissions {
         filterobj = permissions_filter;
-        permissions_filter = josh_core::filter::empty();
+        permissions_filter = josh_core::filter::Filter::new().empty();
     }
 
     let old_oid = if let Ok(id) = transaction.repo().refname_to_id(target) {
@@ -401,8 +407,7 @@ fn run_filter(args: Vec<String>) -> josh_core::JoshResult<i32> {
     josh_core::update_refs(&transaction, &mut updated_refs, "");
 
     if let Some(searchstring) = args.get_one::<String>("search") {
-        let ifilterobj =
-            josh_core::filter::chain(filterobj, josh_core::filter::parse(":SQUASH:INDEX")?);
+        let ifilterobj = filterobj.chain(josh_core::filter::parse(":SQUASH:INDEX")?);
 
         let max_complexity: usize = args
             .get_one::<String>("max_comp")

josh-cli/src/bin/josh.rs

@@ -386,7 +386,7 @@ fn apply_josh_filtering(
         &transaction,
         filterobj,
         &input_refs,
-        josh_core::filter::empty(),
+        josh_core::filter::Filter::new().empty(),
     );
 
     // Check for errors
@@ -749,7 +749,7 @@ fn handle_push(args: &PushArgs, transaction: &josh_core::cache::Transaction) ->
                     &transaction,
                     filter,
                     &[(josh_remote_ref.clone(), josh_remote_oid)],
-                    josh_core::filter::empty(),
+                    josh_core::filter::Filter::new().empty(),
                 );
 
                 // Check for errors
@@ -989,7 +989,7 @@ fn handle_link_add(
         transaction,
         link_filter,
         new_commit,
-        josh_core::filter::empty(),
+        josh_core::filter::Filter::new().empty(),
     )
     .map_err(from_josh_err)
     .context("Failed to apply :link filter")?;
@@ -1156,7 +1156,7 @@ fn handle_link_fetch(
         transaction,
         link_filter,
         new_commit,
-        josh_core::filter::empty(),
+        josh_core::filter::Filter::new().empty(),
     )
     .map_err(from_josh_err)
     .context("Failed to apply :link filter")?;

josh-core/src/build.rs

@@ -1,58 +1,9 @@
-use crate::filter::op::{LazyRef, Op};
+use crate::filter::Filter;
+use crate::filter::op::Op;
 use crate::filter::opt;
 use crate::filter::persist::to_filter;
-use crate::filter::{Filter, MESSAGE_MATCH_ALL_REGEX};
-
-/// Create a no-op filter that passes everything through unchanged
-pub fn nop() -> Filter {
-    to_filter(Op::Nop)
-}
-
-/// Create an empty filter that matches nothing
-pub fn empty() -> Filter {
-    to_filter(Op::Empty)
-}
-
-/// Create a message filter that transforms commit messages
-pub fn message(m: &str) -> Filter {
-    to_filter(Op::Message(m.to_string(), MESSAGE_MATCH_ALL_REGEX.clone()))
-}
-
-/// Create a file filter that selects a single file
-pub fn file(path: impl Into<std::path::PathBuf>) -> Filter {
-    let p = path.into();
-    to_filter(Op::File(p.clone(), p))
-}
-
-/// Create a hook filter
-pub fn hook(h: &str) -> Filter {
-    to_filter(Op::Hook(h.to_string()))
-}
-
-/// Create a squash filter
-pub fn squash(ids: Option<&[(git2::Oid, Filter)]>) -> Filter {
-    if let Some(ids) = ids {
-        to_filter(Op::Squash(Some(
-            ids.iter()
-                .map(|(x, y)| (LazyRef::Resolved(*x), *y))
-                .collect(),
-        )))
-    } else {
-        to_filter(Op::Squash(None))
-    }
-}
-
-/// Create a filter that is the result of feeding the output of `first` into `second`
-pub fn chain(first: Filter, second: Filter) -> Filter {
-    opt::optimize(to_filter(Op::Chain(vec![first, second])))
-}
 
 /// Create a filter that is the result of overlaying the output of `first` onto `second`
 pub fn compose(first: Filter, second: Filter) -> Filter {
     opt::optimize(to_filter(Op::Compose(vec![first, second])))
 }
-
-/// Create a sequence_number filter used for tracking commit sequence numbers
-pub fn sequence_number() -> Filter {
-    Filter::from_oid(git2::Oid::zero())
-}

josh-core/src/cache/cache.rs

@@ -409,7 +409,7 @@ impl Transaction {
     }
 
     fn get2(&self, filter: crate::filter::Filter, from: git2::Oid) -> Option<git2::Oid> {
-        if filter == crate::filter::nop() {
+        if filter == crate::filter::Filter::new() {
             return Some(from);
         }
         let sequence_number = if filter != crate::filter::sequence_number() {