GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-06-26 10:54:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

produce Tag instances in the parser (#260)

Browse source 
and..
* fix usage-docs plugin
* upgrade mdbook
This commit is contained in:
Dustin J. Mitchell 2021-06-04 09:26:12 -04:00 • committed by GitHub
parent 5a454a5dfd
commit 5f28eb3a74
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 62 additions and 80 deletions
Download patch file Download diff file Expand all files Collapse all files

2
cli/Cargo.toml
View file

@ -27,7 +27,7 @@ lazy_static = "1"
iso8601-duration = "0.1"
# only needed for usage-docs
mdbook = { version = "0.4", optional = true }
mdbook = { version = "0.4.9", optional = true }
serde_json = { version = "*", optional = true }
[dependencies.taskchampion]

2
cli/src/argparse/args/arg_matching.rs
View file

@ -44,7 +44,7 @@ mod test {
fn test_arg_matching() {
assert_eq!(
arg_matching(plus_tag)(argv!["+foo", "bar"]).unwrap(),
(argv!["bar"], "foo")
(argv!["bar"], tag!("foo"))
);
assert!(arg_matching(plus_tag)(argv!["foo", "bar"]).is_err());
}

2
cli/src/argparse/args/misc.rs
View file

@ -25,7 +25,7 @@ mod test {
fn test_arg_matching() {
assert_eq!(
arg_matching(plus_tag)(argv!["+foo", "bar"]).unwrap(),
(argv!["bar"], "foo")
(argv!["bar"], tag!("foo"))
);
assert!(arg_matching(plus_tag)(argv!["foo", "bar"]).is_err());
}

38
cli/src/argparse/args/tags.rs
View file

@ -3,31 +3,13 @@ use std::convert::TryFrom;
use taskchampion::Tag;
/// Recognizes a tag prefixed with `+` and returns the tag value
pub(crate) fn plus_tag(input: &str) -> IResult<&str, &str> {
fn to_tag(input: (char, &str)) -> Result<&str, ()> {
Ok(input.1)
}
map_res(
all_consuming(tuple((
char('+'),
recognize(verify(rest, |s: &str| Tag::try_from(s).is_ok())),
))),
to_tag,
)(input)
pub(crate) fn plus_tag(input: &str) -> IResult<&str, Tag> {
preceded(char('+'), map_res(rest, Tag::try_from))(input)
}
/// Recognizes a tag prefixed with `-` and returns the tag value
pub(crate) fn minus_tag(input: &str) -> IResult<&str, &str> {
fn to_tag(input: (char, &str)) -> Result<&str, ()> {
Ok(input.1)
}
map_res(
all_consuming(tuple((
char('-'),
recognize(verify(rest, |s: &str| Tag::try_from(s).is_ok())),
))),
to_tag,
)(input)
pub(crate) fn minus_tag(input: &str) -> IResult<&str, Tag> {
preceded(char('-'), map_res(rest, Tag::try_from))(input)
}
#[cfg(test)]
@ -36,21 +18,17 @@ mod test {
#[test]
fn test_plus_tag() {
assert_eq!(plus_tag("+abc").unwrap().1, "abc");
assert_eq!(plus_tag("+abc123").unwrap().1, "abc123");
assert_eq!(plus_tag("+abc").unwrap().1, tag!("abc"));
assert_eq!(plus_tag("+abc123").unwrap().1, tag!("abc123"));
assert!(plus_tag("-abc123").is_err());
assert!(plus_tag("+abc123 ").is_err());
assert!(plus_tag(" +abc123").is_err());
assert!(plus_tag("+1abc").is_err());
}
#[test]
fn test_minus_tag() {
assert_eq!(minus_tag("-abc").unwrap().1, "abc");
assert_eq!(minus_tag("-abc123").unwrap().1, "abc123");
assert_eq!(minus_tag("-abc").unwrap().1, tag!("abc"));
assert_eq!(minus_tag("-abc123").unwrap().1, tag!("abc123"));
assert!(minus_tag("+abc123").is_err());
assert!(minus_tag("-abc123 ").is_err());
assert!(minus_tag(" -abc123").is_err());
assert!(minus_tag("-1abc").is_err());
}
}

30
cli/src/argparse/filter.rs
View file

@ -8,7 +8,7 @@ use nom::{
multi::{fold_many0, fold_many1},
IResult,
};
use taskchampion::Status;
use taskchampion::{Status, Tag};
/// A filter represents a selection of a particular set of tasks.
///
@ -26,10 +26,10 @@ pub(crate) struct Filter {
#[derive(Debug, PartialEq, Clone)]
pub(crate) enum Condition {
/// Task has the given tag
HasTag(String),
HasTag(Tag),
/// Task does not have the given tag
NoTag(String),
NoTag(Tag),
/// Task has the given status
Status(Status),
@ -68,15 +68,15 @@ impl Condition {
}
fn parse_plus_tag(input: ArgList) -> IResult<ArgList, Condition> {
fn to_condition(input: &str) -> Result<Condition, ()> {
Ok(Condition::HasTag(input.to_owned()))
fn to_condition(input: Tag) -> Result<Condition, ()> {
Ok(Condition::HasTag(input))
}
map_res(arg_matching(plus_tag), to_condition)(input)
}
fn parse_minus_tag(input: ArgList) -> IResult<ArgList, Condition> {
fn to_condition(input: &str) -> Result<Condition, ()> {
Ok(Condition::NoTag(input.to_owned()))
fn to_condition(input: Tag) -> Result<Condition, ()> {
Ok(Condition::NoTag(input))
}
map_res(arg_matching(minus_tag), to_condition)(input)
}
@ -320,8 +320,8 @@ mod test {
Filter {
conditions: vec![
Condition::IdList(vec![TaskId::WorkingSetId(1),]),
Condition::HasTag("yes".into()),
Condition::NoTag("no".into()),
Condition::HasTag(tag!("yes")),
Condition::NoTag(tag!("no")),
],
}
);
@ -353,10 +353,10 @@ mod test {
conditions: vec![
// from first filter
Condition::IdList(vec![TaskId::WorkingSetId(1), TaskId::WorkingSetId(2),]),
Condition::HasTag("yes".into()),
Condition::HasTag(tag!("yes")),
// from second filter
Condition::IdList(vec![TaskId::WorkingSetId(2), TaskId::WorkingSetId(3)]),
Condition::HasTag("no".into()),
Condition::HasTag(tag!("no")),
],
}
);
@ -373,9 +373,9 @@ mod test {
conditions: vec![
// from first filter
Condition::IdList(vec![TaskId::WorkingSetId(1), TaskId::WorkingSetId(2),]),
Condition::HasTag("yes".into()),
Condition::HasTag(tag!("yes")),
// from second filter
Condition::HasTag("no".into()),
Condition::HasTag(tag!("no")),
],
}
);
@ -390,8 +390,8 @@ mod test {
both,
Filter {
conditions: vec![
Condition::HasTag("yes".into()),
Condition::HasTag("no".into()),
Condition::HasTag(tag!("yes")),
Condition::HasTag(tag!("no")),
],
}
);

24
cli/src/argparse/modification.rs
View file

@ -4,7 +4,7 @@ use crate::usage;
use chrono::prelude::*;
use nom::{branch::alt, combinator::*, multi::fold_many0, IResult};
use std::collections::HashSet;
use taskchampion::Status;
use taskchampion::{Status, Tag};
#[derive(Debug, PartialEq, Clone)]
pub enum DescriptionMod {
@ -44,17 +44,17 @@ pub struct Modification {
pub active: Option<bool>,
/// Add tags
pub add_tags: HashSet<String>,
pub add_tags: HashSet<Tag>,
/// Remove tags
pub remove_tags: HashSet<String>,
pub remove_tags: HashSet<Tag>,
}
/// A single argument that is part of a modification, used internally to this module
enum ModArg<'a> {
Description(&'a str),
PlusTag(&'a str),
MinusTag(&'a str),
PlusTag(Tag),
MinusTag(Tag),
Wait(Option<DateTime<Utc>>),
}
@ -71,10 +71,10 @@ impl Modification {
}
}
ModArg::PlusTag(tag) => {
acc.add_tags.insert(tag.to_owned());
acc.add_tags.insert(tag);
}
ModArg::MinusTag(tag) => {
acc.remove_tags.insert(tag.to_owned());
acc.remove_tags.insert(tag);
}
ModArg::Wait(wait) => {
acc.wait = Some(wait);
@ -105,14 +105,14 @@ impl Modification {
}
fn plus_tag(input: ArgList) -> IResult<ArgList, ModArg> {
fn to_modarg(input: &str) -> Result<ModArg, ()> {
fn to_modarg(input: Tag) -> Result<ModArg<'static>, ()> {
Ok(ModArg::PlusTag(input))
}
map_res(arg_matching(plus_tag), to_modarg)(input)
}
fn minus_tag(input: ArgList) -> IResult<ArgList, ModArg> {
fn to_modarg(input: &str) -> Result<ModArg, ()> {
fn to_modarg(input: Tag) -> Result<ModArg<'static>, ()> {
Ok(ModArg::MinusTag(input))
}
map_res(arg_matching(minus_tag), to_modarg)(input)
@ -198,7 +198,7 @@ mod test {
assert_eq!(
modification,
Modification {
add_tags: set![s!("abc"), s!("def")],
add_tags: set![tag!("abc"), tag!("def")],
..Default::default()
}
);
@ -252,8 +252,8 @@ mod test {
modification,
Modification {
description: DescriptionMod::Set(s!("new desc fun")),
add_tags: set![s!("next")],
remove_tags: set![s!("daytime")],
add_tags: set![tag!("next")],
remove_tags: set![tag!("daytime")],
..Default::default()
}
);

5
cli/src/bin/usage-docs.rs
View file

@ -40,7 +40,10 @@ fn process(_ctx: &PreprocessorContext, mut book: Book) -> Result<Book, Error> {
if new_content != chapter.content {
eprintln!(
"Substituting usage in {:?}",
chapter.source_path.as_ref().unwrap()
chapter
.source_path
.as_ref()
.unwrap_or(chapter.path.as_ref().unwrap())
);
}
chapter.content = new_content;

24
cli/src/invocation/filter.rs
View file

@ -1,22 +1,17 @@
use crate::argparse::{Condition, Filter, TaskId};
use std::collections::HashSet;
use std::convert::TryInto;
use taskchampion::{Replica, Status, Tag, Task, Uuid, WorkingSet};
use taskchampion::{Replica, Status, Task, Uuid, WorkingSet};
fn match_task(filter: &Filter, task: &Task, uuid: Uuid, working_set: &WorkingSet) -> bool {
for cond in &filter.conditions {
match cond {
Condition::HasTag(ref tag) => {
// see #111 for the unwrap
let tag: Tag = tag.try_into().unwrap();
if !task.has_tag(&tag) {
if !task.has_tag(tag) {
return false;
}
}
Condition::NoTag(ref tag) => {
// see #111 for the unwrap
let tag: Tag = tag.try_into().unwrap();
if task.has_tag(&tag) {
if task.has_tag(tag) {
return false;
}
}
@ -254,8 +249,8 @@ mod test {
#[test]
fn tag_filtering() -> anyhow::Result<()> {
let mut replica = test_replica();
let yes: Tag = "yes".try_into()?;
let no: Tag = "no".try_into()?;
let yes = tag!("yes");
let no = tag!("no");
let mut t1 = replica
.new_task(Status::Pending, s!("A"))?
@ -274,7 +269,7 @@ mod test {
// look for just "yes" (A and B)
let filter = Filter {
conditions: vec![Condition::HasTag(s!("yes"))],
conditions: vec![Condition::HasTag(tag!("yes"))],
};
let mut filtered: Vec<_> = filtered_tasks(&mut replica, &filter)?
.map(|t| t.get_description().to_owned())
@ -284,7 +279,7 @@ mod test {
// look for tags without "no" (A, D)
let filter = Filter {
conditions: vec![Condition::NoTag(s!("no"))],
conditions: vec![Condition::NoTag(tag!("no"))],
};
let mut filtered: Vec<_> = filtered_tasks(&mut replica, &filter)?
.map(|t| t.get_description().to_owned())
@ -294,7 +289,10 @@ mod test {
// look for tags with "yes" and "no" (B)
let filter = Filter {
conditions: vec![Condition::HasTag(s!("yes")), Condition::HasTag(s!("no"))],
conditions: vec![
Condition::HasTag(tag!("yes")),
Condition::HasTag(tag!("no")),
],
};
let filtered: Vec<_> = filtered_tasks(&mut replica, &filter)?
.map(|t| t.get_description().to_owned())

3
cli/src/invocation/modify.rs
View file

@ -1,5 +1,4 @@
use crate::argparse::{DescriptionMod, Modification};
use std::convert::TryInto;
use taskchampion::TaskMut;
/// Apply the given modification
@ -31,12 +30,10 @@ pub(super) fn apply_modification(
}
for tag in modification.add_tags.iter() {
let tag = tag.try_into()?; // see #111
task.add_tag(&tag)?;
}
for tag in modification.remove_tags.iter() {
let tag = tag.try_into()?; // see #111
task.remove_tag(&tag)?;
}

6
cli/src/macros.rs
View file

@ -30,3 +30,9 @@ macro_rules! set(
macro_rules! s(
{ $s:expr } => { $s.to_owned() };
);
/// Create a Tag from an &str; just a testing shorthand
#[cfg(test)]
macro_rules! tag(
{ $s:expr } => { { use std::convert::TryFrom; taskchampion::Tag::try_from($s).unwrap() } };
);

2
cli/src/usage.rs
View file

@ -93,7 +93,7 @@ impl Usage {
/// With the appropriate documentation.
pub fn substitute_docs(&self, content: &str) -> Result<String> {
// this is not efficient, but it doesn't need to be
let mut lines = content.lines();
let lines = content.lines();
let mut w = String::new();
const DOC_HEADER_PREFIX: &str = "<!-- INSERT GENERATED DOCUMENTATION - ";