Compare commits
4 commits
07e9160cb5
...
2772db19a9
| Author | SHA1 | Date | |
|---|---|---|---|
| 2772db19a9 | |||
| 53c5d03ab7 | |||
| 561f85fbb0 | |||
| 6eacb405d9 |
15 changed files with 301 additions and 1 deletions
|
|
@ -4,3 +4,8 @@ version = "0.1.0"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
anyhow = "1.0.95"
|
||||||
|
clap = { version = "4.5.26", features = ["derive"] }
|
||||||
|
serde = { version = "1.0.217", features = ["derive"] }
|
||||||
|
thiserror = "2.0.11"
|
||||||
|
toml = "0.8.19"
|
||||||
|
|
|
||||||
44
src/bin/ent/main.rs
Normal file
44
src/bin/ent/main.rs
Normal file
|
|
@ -0,0 +1,44 @@
|
||||||
|
use clap::Parser;
|
||||||
|
|
||||||
|
#[derive(Debug, clap::Parser)]
|
||||||
|
#[command(version, about, long_about = None)]
|
||||||
|
struct Args {
|
||||||
|
/// Directory containing issues.
|
||||||
|
#[arg(short, long)]
|
||||||
|
issues_dir: String,
|
||||||
|
|
||||||
|
/// Type of behavior/output.
|
||||||
|
#[command(subcommand)]
|
||||||
|
command: Commands,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(clap::Subcommand, Debug)]
|
||||||
|
enum Commands {
|
||||||
|
/// List issues.
|
||||||
|
List,
|
||||||
|
// Mdbook {
|
||||||
|
// /// The name of the recipe to create MD Book for.
|
||||||
|
// target: String,
|
||||||
|
// },
|
||||||
|
// Info {
|
||||||
|
// /// The name of the recipe to show info for.
|
||||||
|
// target: String,
|
||||||
|
// },
|
||||||
|
}
|
||||||
|
|
||||||
|
fn main() -> anyhow::Result<()> {
|
||||||
|
let args: Args = Args::parse();
|
||||||
|
// println!("{:?}", args);
|
||||||
|
|
||||||
|
match args.command {
|
||||||
|
Commands::List => {
|
||||||
|
let issues =
|
||||||
|
entomologist::issues::Issues::new_from_dir(std::path::Path::new(&args.issues_dir))?;
|
||||||
|
for (uuid, issue) in issues.issues.iter() {
|
||||||
|
println!("{} {} ({:?})", uuid, issue.title, issue.state);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
109
src/issue.rs
Normal file
109
src/issue.rs
Normal file
|
|
@ -0,0 +1,109 @@
|
||||||
|
use std::str::FromStr;
|
||||||
|
|
||||||
|
#[derive(Debug, PartialEq, serde::Deserialize)]
|
||||||
|
/// These are the states an issue can be in.
|
||||||
|
pub enum State {
|
||||||
|
New,
|
||||||
|
Backlog,
|
||||||
|
InProgress,
|
||||||
|
Done,
|
||||||
|
WontDo,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, PartialEq)]
|
||||||
|
pub struct Issue {
|
||||||
|
pub title: String,
|
||||||
|
pub description: Option<String>,
|
||||||
|
pub state: State,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, thiserror::Error)]
|
||||||
|
pub enum ReadIssueError {
|
||||||
|
#[error(transparent)]
|
||||||
|
StdIoError(#[from] std::io::Error),
|
||||||
|
#[error("Failed to parse issue")]
|
||||||
|
IssueParseError,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl FromStr for State {
|
||||||
|
type Err = ReadIssueError;
|
||||||
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||||
|
let s = s.to_lowercase();
|
||||||
|
if s == "new" {
|
||||||
|
Ok(State::New)
|
||||||
|
} else if s == "backlog" {
|
||||||
|
Ok(State::Backlog)
|
||||||
|
} else if s == "inprogress" {
|
||||||
|
Ok(State::InProgress)
|
||||||
|
} else if s == "done" {
|
||||||
|
Ok(State::Done)
|
||||||
|
} else if s == "wontdo" {
|
||||||
|
Ok(State::WontDo)
|
||||||
|
} else {
|
||||||
|
Err(ReadIssueError::IssueParseError)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Issue {
|
||||||
|
pub fn new_from_dir(dir: &std::path::Path) -> Result<Self, ReadIssueError> {
|
||||||
|
let mut title: Option<String> = None;
|
||||||
|
let mut description: Option<String> = None;
|
||||||
|
let mut state = State::New; // default state, if not specified in the issue
|
||||||
|
|
||||||
|
for direntry in dir.read_dir()? {
|
||||||
|
if let Ok(direntry) = direntry {
|
||||||
|
let file_name = direntry.file_name();
|
||||||
|
if file_name == "title" {
|
||||||
|
title = Some(std::fs::read_to_string(direntry.path())?.trim().into());
|
||||||
|
} else if file_name == "description" {
|
||||||
|
description = Some(std::fs::read_to_string(direntry.path())?);
|
||||||
|
} else if file_name == "state" {
|
||||||
|
let state_string = std::fs::read_to_string(direntry.path())?;
|
||||||
|
state = State::from_str(state_string.trim())?;
|
||||||
|
} else {
|
||||||
|
println!("ignoring unknown file in issue directory: {:?}", file_name);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if title == None {
|
||||||
|
return Err(ReadIssueError::IssueParseError);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(Self {
|
||||||
|
title: title.unwrap(),
|
||||||
|
description: description,
|
||||||
|
state: state,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn read_issue_0() {
|
||||||
|
let issue_dir = std::path::Path::new("test/0000/3943fc5c173fdf41c0a22251593cd476d96e6c9f/");
|
||||||
|
let issue = Issue::new_from_dir(issue_dir).unwrap();
|
||||||
|
let expected = Issue {
|
||||||
|
title: String::from("this is the title of my issue"),
|
||||||
|
description: Some(String::from("This is the description of my issue.\nIt is multiple lines.\n* Arbitrary contents\n* But let's use markdown by convention\n")),
|
||||||
|
state: State::New,
|
||||||
|
};
|
||||||
|
assert_eq!(issue, expected);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn read_issue_1() {
|
||||||
|
let issue_dir = std::path::Path::new("test/0000/7792b063eef6d33e7da5dc1856750c149ba678c6/");
|
||||||
|
let issue = Issue::new_from_dir(issue_dir).unwrap();
|
||||||
|
let expected = Issue {
|
||||||
|
title: String::from("minimal"),
|
||||||
|
description: None,
|
||||||
|
state: State::InProgress,
|
||||||
|
};
|
||||||
|
assert_eq!(issue, expected);
|
||||||
|
}
|
||||||
|
}
|
||||||
125
src/issues.rs
Normal file
125
src/issues.rs
Normal file
|
|
@ -0,0 +1,125 @@
|
||||||
|
// Just a placeholder for now, get rid of this if we don't need it.
|
||||||
|
#[derive(Debug, PartialEq, serde::Deserialize)]
|
||||||
|
pub struct Config {}
|
||||||
|
|
||||||
|
#[derive(Debug, PartialEq)]
|
||||||
|
pub struct Issues {
|
||||||
|
pub issues: std::collections::HashMap<String, crate::issue::Issue>,
|
||||||
|
pub config: Config,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, thiserror::Error)]
|
||||||
|
pub enum ReadIssuesError {
|
||||||
|
#[error(transparent)]
|
||||||
|
StdIoError(#[from] std::io::Error),
|
||||||
|
#[error("Failed to parse issue")]
|
||||||
|
IssueParseError(#[from] crate::issue::ReadIssueError),
|
||||||
|
#[error("cannot handle filename")]
|
||||||
|
FilenameError(std::ffi::OsString),
|
||||||
|
#[error(transparent)]
|
||||||
|
TomlDeserializeError(#[from] toml::de::Error),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Issues {
|
||||||
|
pub fn new() -> Self {
|
||||||
|
Self {
|
||||||
|
issues: std::collections::HashMap::new(),
|
||||||
|
config: Config {},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn add_issue(&mut self, uuid: String, issue: crate::issue::Issue) {
|
||||||
|
self.issues.insert(uuid, issue);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn parse_config(&mut self, config_path: &std::path::Path) -> Result<(), ReadIssuesError> {
|
||||||
|
let config_contents = std::fs::read_to_string(config_path)?;
|
||||||
|
let config: Config = toml::from_str(&config_contents)?;
|
||||||
|
self.config = config;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn new_from_dir(dir: &std::path::Path) -> Result<Self, ReadIssuesError> {
|
||||||
|
let mut issues = Self::new();
|
||||||
|
|
||||||
|
for direntry in dir.read_dir()? {
|
||||||
|
if let Ok(direntry) = direntry {
|
||||||
|
if direntry.metadata()?.is_dir() {
|
||||||
|
let uuid = match direntry.file_name().into_string() {
|
||||||
|
Ok(uuid) => uuid,
|
||||||
|
Err(orig_string) => {
|
||||||
|
return Err(ReadIssuesError::FilenameError(orig_string))
|
||||||
|
}
|
||||||
|
};
|
||||||
|
let issue = crate::issue::Issue::new_from_dir(direntry.path().as_path())?;
|
||||||
|
issues.add_issue(uuid, issue);
|
||||||
|
} else if direntry.file_name() == "config.toml" {
|
||||||
|
issues.parse_config(direntry.path().as_path())?;
|
||||||
|
} else {
|
||||||
|
println!(
|
||||||
|
"ignoring unknown file in issues directory: {:?}",
|
||||||
|
direntry.file_name()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return Ok(issues);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn read_issues_0000() {
|
||||||
|
let issues_dir = std::path::Path::new("test/0000/");
|
||||||
|
let issues = Issues::new_from_dir(issues_dir).unwrap();
|
||||||
|
|
||||||
|
let mut expected = Issues::new();
|
||||||
|
expected.add_issue(
|
||||||
|
String::from("7792b063eef6d33e7da5dc1856750c149ba678c6"),
|
||||||
|
crate::issue::Issue {
|
||||||
|
title: String::from("minimal"),
|
||||||
|
description: None,
|
||||||
|
state: crate::issue::State::InProgress,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expected.add_issue(
|
||||||
|
String::from("3943fc5c173fdf41c0a22251593cd476d96e6c9f"),
|
||||||
|
crate::issue::Issue {
|
||||||
|
title: String::from("this is the title of my issue"),
|
||||||
|
description: Some(String::from("This is the description of my issue.\nIt is multiple lines.\n* Arbitrary contents\n* But let's use markdown by convention\n")),
|
||||||
|
state: crate::issue::State::New,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
assert_eq!(issues, expected);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn read_issues_0001() {
|
||||||
|
let issues_dir = std::path::Path::new("test/0001/");
|
||||||
|
let issues = Issues::new_from_dir(issues_dir).unwrap();
|
||||||
|
|
||||||
|
let mut expected = Issues::new();
|
||||||
|
expected.add_issue(
|
||||||
|
String::from("3fa5bfd93317ad25772680071d5ac3259cd2384f"),
|
||||||
|
crate::issue::Issue {
|
||||||
|
title: String::from("oh yeah we got titles"),
|
||||||
|
description: None,
|
||||||
|
state: crate::issue::State::Done,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expected.add_issue(
|
||||||
|
String::from("dd79c8cfb8beeacd0460429944b4ecbe95a31561"),
|
||||||
|
crate::issue::Issue {
|
||||||
|
title: String::from("issues out the wazoo"),
|
||||||
|
description: Some(String::from(
|
||||||
|
"Lots of words\nthat don't say much\nbecause this is just\na test\n",
|
||||||
|
)),
|
||||||
|
state: crate::issue::State::WontDo,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
assert_eq!(issues, expected);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -1 +1,2 @@
|
||||||
|
pub mod issue;
|
||||||
|
pub mod issues;
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,4 @@
|
||||||
|
This is the description of my issue.
|
||||||
|
It is multiple lines.
|
||||||
|
* Arbitrary contents
|
||||||
|
* But let's use markdown by convention
|
||||||
1
test/0000/3943fc5c173fdf41c0a22251593cd476d96e6c9f/title
Normal file
1
test/0000/3943fc5c173fdf41c0a22251593cd476d96e6c9f/title
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
this is the title of my issue
|
||||||
1
test/0000/7792b063eef6d33e7da5dc1856750c149ba678c6/state
Normal file
1
test/0000/7792b063eef6d33e7da5dc1856750c149ba678c6/state
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
inprogress
|
||||||
1
test/0000/7792b063eef6d33e7da5dc1856750c149ba678c6/title
Normal file
1
test/0000/7792b063eef6d33e7da5dc1856750c149ba678c6/title
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
minimal
|
||||||
1
test/0001/3fa5bfd93317ad25772680071d5ac3259cd2384f/state
Normal file
1
test/0001/3fa5bfd93317ad25772680071d5ac3259cd2384f/state
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
done
|
||||||
1
test/0001/3fa5bfd93317ad25772680071d5ac3259cd2384f/title
Normal file
1
test/0001/3fa5bfd93317ad25772680071d5ac3259cd2384f/title
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
oh yeah we got titles
|
||||||
1
test/0001/config.toml
Normal file
1
test/0001/config.toml
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
states = [ "open", "closed" ]
|
||||||
|
|
@ -0,0 +1,4 @@
|
||||||
|
Lots of words
|
||||||
|
that don't say much
|
||||||
|
because this is just
|
||||||
|
a test
|
||||||
1
test/0001/dd79c8cfb8beeacd0460429944b4ecbe95a31561/state
Normal file
1
test/0001/dd79c8cfb8beeacd0460429944b4ecbe95a31561/state
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
wontdo
|
||||||
1
test/0001/dd79c8cfb8beeacd0460429944b4ecbe95a31561/title
Normal file
1
test/0001/dd79c8cfb8beeacd0460429944b4ecbe95a31561/title
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
issues out the wazoo
|
||||||
Loading…
Add table
Add a link
Reference in a new issue