38 Commits

Author SHA1 Message Date
754ae271d7 increment version number 2024-04-19 21:43:25 -04:00
2643957c91 pre-release cleanup 2024-04-19 21:43:06 -04:00
5cd03b713c specifiing dates 2024-04-19 20:26:33 -04:00
4e26695532 updated readme 2024-04-16 09:49:57 -04:00
7453bb8cae more documentation 2024-04-10 13:21:45 -04:00
c92bb3b31b documenting code 2024-04-10 12:38:40 -04:00
51574e1403 a bit of cleanup 2024-04-09 20:05:58 -04:00
d910f78afd test coverage 2024-04-02 14:21:25 -04:00
a8e6572a53 logging 2024-04-02 10:58:49 -04:00
fc7e45cd3f test coverage 2024-04-02 00:07:09 -04:00
9fe6ae5eb8 listing all files 2024-04-01 22:00:40 -04:00
ddd620a021 code cleanup
mostly dead code removal
some formating
2024-04-01 13:25:04 -04:00
48df1fd9e0 v0.1.2 2024-03-18 22:02:46 -04:00
cfe9065243 using new file selection logic 2024-03-18 22:02:24 -04:00
c92da26ee7 cleanup 2024-03-18 20:20:18 -04:00
d3218ad907 getting latest file with window 2024-03-18 20:17:38 -04:00
3b1485d2c0 getting closest file to date 2024-03-06 14:50:03 -05:00
e4be0fb471 cli arguments 2024-03-06 14:31:53 -05:00
bce8f1e4b8 refactor file operations 2024-03-04 14:59:49 -05:00
e0c81885c8 path handling and unwraps 2024-02-28 17:20:55 -05:00
1c51c53eef some error handeling 2024-02-28 15:12:19 -05:00
875ea1e53e implementing arguments for configs 2024-02-22 02:16:58 -05:00
05fb399530 added cli interface options and some error msgs 2024-02-22 01:49:57 -05:00
695e31c7e4 fixed merge conflict 2024-02-22 01:35:07 -05:00
62617473bd added error messege for creating directory 2023-10-06 12:20:36 -04:00
f6e9bac0e3 Merge remote-tracking branch 'tea/main' 2023-10-06 11:54:56 -04:00
6958375f6c fixed runtime errors on new pc 2023-10-06 11:46:21 -04:00
85d81c02cc refactor file io and task to_string 2023-06-26 09:40:56 -04:00
e90ec3e647 tab width printing for subtasks 2023-06-25 13:20:54 -04:00
ad557e822f cleanup and file error 2023-06-25 12:59:28 -04:00
ea7cd57c07 increased version number: 0.1.1 2023-06-25 12:26:36 -04:00
cd97c18fef subtasks 2023-06-25 12:25:59 -04:00
3bb095ca45 task errors 2023-06-25 08:42:20 -04:00
16a2646cb8 updated config path 2023-06-25 06:59:53 -04:00
86750a7428 todo module refactor 2023-06-25 06:58:08 -04:00
c78071d132 Merge remote-tracking branch 'all/main' 2023-06-24 23:59:31 -04:00
1382482faa config error enum 2023-06-24 23:57:43 -04:00
75d8b80dd7 refactored todo file into todo module 2023-06-24 23:57:20 -04:00
11 changed files with 1006 additions and 397 deletions

2
.gitignore vendored
View File

@@ -21,4 +21,4 @@ Cargo.lock
# config file
.rusty_task.json
Notes/

View File

@@ -1,14 +1,18 @@
[package]
name = "rusty-tasks"
version = "0.1.0"
version = "0.1.3"
edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
chrono = "0.4.26"
clap = { version = "4.5.1", features = ["derive"] }
comrak = "0.18.0"
figment = { version = "0.10.10", features = ["env", "serde_json", "json"] }
regex = "1.8.4"
serde = { version = "1.0.164", features = ["serde_derive"] }
serde_json = "1.0.97"
resolve-path = "0.1.0"
simple_logger = "4.3.3"
log = "0.4.21"

111
README.md
View File

@@ -1,26 +1,111 @@
# Rusty-tasks
A rewrite of an older CLI todo system without python and regex
## Goals
A personal task management system built on plain text and works in your favorite editor
- [ ] BLAZING FAST!
- [ ] replace python with rust
- [ ] replace regex with a markdown parsing library
- [ ] learn some rust along the way
## Ideas
## The General Idea
If you've used the bullet journal technique before, think if this as the
If you've used the bullet journal technique before, think of this as the
digital, automated version of that.
- Accessible from anywhere in the terminal (TMUX, bare shell, etc)
- Accessible from anywhere in the terminal (TMUX, bare shell, etc.)
* works really well with a drop-down terminal
- Takes advantage of default editor (vim, emacs, etc)
- Take advantage of Markdown for formatting
- Take advantage of your favorite editor (vim, Emacs, etc.)
- Take advantage of plain text formats (Markdown)
- Organize tasks at different levels of urgency
* Daily - Must get done now
* Weekly - Must get done in the near future
* Monthly - I'm going to forget if I don't write it down but It's a ways away
* Monthly - I'm going to forget if I don't write it down, but It's a ways away
- Every day start a new file
* files should be dated
- Carry over uncompleted tasks from previous day
- Carry over uncompleted tasks from the previous day
## Installing
```bash
git clone https://github.com/andrei-stoica/rusty-tasks.git
cd rusty-task cargo install --path .
```
Alternatively, there is a binary download for AMD64 Linux machines available
on the [releases page](https://github.com/andrei-stoica/rusty-tasks/releases).
Just drop that anywhere on your PATH. I recommend adding `~/bin` to your PATH
and dropping the executable there.
If you are not on an AMD64 Linux machine, you will need to build from source.
I have not tested this on other platforms, so I hesitate to provide binaries
for them.
## Usage
***WARNING:*** *This documentation can be ahead of the releases on the GH release page*
```help
Usage: rusty-tasks [OPTIONS]
Options:
-c, --config <FILE> set config file to use
-C, --current-config show current config file
-d, --date <DATE> view a specific date's file (format: YYYY-MM-DD)
-p, --previous <PREVIOUS> view previous day's notes [default: 0]
-l, --list list closest files to date
-n, --number <NUMBER> number of files to list [default: 5]
-L, --list-all list closest files to date
-v, --verbose... increase logging level
-h, --help Print help
-V, --version Print version
```
Just use `rust-task` to access today's notes file.
Use `rust-task -p <n>` to access a previous day's file where `<n>` is the number
of days back you want to go. If a file does not exist for that day, it will
default to the closest to that date. A value of 0 represents today's file.
Alternatively, use `--date` or `-d` to specify a date specifically. Preferably
in the format year-month-day, padding with zero is optional. However, if the
year, or, year and month are omitted they will be filled in with the current
date's year and month. For example, If the current date is `2024-2-30`, the
string `4` will resolve to `2024-2-4`, and `1-4` will resolve to `2024-1-4`.
Specify a custom config location with `-c`, otherwise, it will scan for a config
in the locations specified in the [config section](#config). If no config
exists it will create one. To see what config is being loaded you can use `-C`.
To list your existing notes you can use `-L`. For a subset of these use
`-l` combined with `-n` to specify the number of files to list. This will be
the closest `n` files to the specified date, which is today by default. Specify
the target date using the `-p` as mentioned earlier
## Config
The config should be located in the following locations:
- `~/.config/rusty_task.json`
- `~/.rusty_task.json`
- `$PWD/.rusty_task.json`
If there is no config it will be created at `~/.config/rusty_task.json`.
Example config:
```
{
"editor": "nano",
"sections": [
"Daily",
"Weekly",
"Monthly"
],
"notes_dir": "~/notes"
}
```
- `editor` is the executable that will be launched to modify the notes file
- `sections` is a list of Sections that will be carried over from the previous
day's notes
* only uncompleted tasks are carried over
* You can use other sections for scratch space and other journaling tasks
- `notes_dir` is the directory that stores your daily notes
* this could be set to your obsidian vault if you want it to work with
all of your other notes (I recommend checking out [obsidian.nvim](https://github.com/epwalsh/obsidian.nvim)
if you want to interact with an obsidian vault in neovim)

104
src/cli/mod.rs Normal file
View File

@@ -0,0 +1,104 @@
use chrono::{Datelike, NaiveDate};
use clap::Parser;
#[derive(Parser, Debug)]
#[command(version, about)]
pub struct Args {
/// set config file to use
#[arg(short, long, value_name = "FILE")]
pub config: Option<String>,
/// show current config file
#[arg(short = 'C', long)]
pub current_config: bool,
/// view a specific date's file (YYYY-MM-DD)
#[arg(short, long)]
pub date: Option<String>,
/// view previous day's notes
#[arg(short = 'p', long, default_value_t = 0)]
pub previous: u16,
/// list closest files to date
#[arg(short, long)]
pub list: bool,
/// number of files to list
#[arg(short, long, default_value_t = 5)]
pub number: usize,
/// list closest files to date
#[arg(short = 'L', long)]
pub list_all: bool,
/// increase logging level
#[arg(short, long, action = clap::ArgAction::Count)]
pub verbose: u8,
}
pub fn smart_parse_date(date_str: &str, cur_date: &NaiveDate) -> Option<NaiveDate> {
let full_date_fmt = "%Y-%m-%d";
if let Ok(date) = NaiveDate::parse_from_str(date_str, &full_date_fmt) {
return Some(date);
}
let parts: Vec<&str> = date_str.split('-').collect();
match parts.len() {
1 => cur_date.with_day(parts[0].parse().unwrap_or(cur_date.day())),
2 => cur_date
.with_day(parts[1].parse().unwrap_or(cur_date.day()))?
.with_month(parts[0].parse().unwrap_or(cur_date.month())),
3 => NaiveDate::from_ymd_opt(
parts[0].parse().ok()?,
parts[1].parse().ok()?,
parts[2].parse().ok()?,
),
_ => None,
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_smart_parse_date() {
let good_date = NaiveDate::from_ymd_opt(2024, 01, 03).expect("Invalid date specified");
let good_date_str = good_date.format("%Y-%m-%d").to_string();
assert_eq!(
Some(good_date),
smart_parse_date(&good_date_str, &good_date)
);
let no_padding_date_str = "2024-1-3";
assert_eq!(
Some(good_date),
smart_parse_date(no_padding_date_str, &good_date)
);
let bad_day_str = "2024-01-99";
assert_eq!(None, smart_parse_date(bad_day_str, &good_date));
let no_day_str = "2024-01";
assert_eq!(None, smart_parse_date(no_day_str, &good_date));
let bad_month_str = "2024-25-01";
assert_eq!(None, smart_parse_date(bad_month_str, &good_date));
let no_month_str = "2024-14";
assert_eq!(None, smart_parse_date(no_month_str, &good_date));
let no_year_str = "01-03";
assert_eq!(Some(good_date), smart_parse_date(no_year_str, &good_date));
let bad_month_no_year_str = "25-01";
assert_eq!(None, smart_parse_date(bad_month_no_year_str, &good_date));
let bad_day_no_year_str = "01-35";
assert_eq!(None, smart_parse_date(bad_day_no_year_str, &good_date));
let no_year_month_str = "03";
assert_eq!(
Some(good_date),
smart_parse_date(no_year_month_str, &good_date)
);
let bad_day_no_year_month_str = "35";
assert_eq!(
None,
smart_parse_date(bad_day_no_year_month_str, &good_date)
);
}
}

View File

@@ -11,45 +11,63 @@ use std::path::PathBuf;
#[derive(Deserialize, Serialize, Debug)]
pub struct Config {
pub editor: Option<String>,
pub sections: Option<Vec<String>>,
pub notes_dir: Option<String>,
pub editor: String,
pub sections: Vec<String>,
pub notes_dir: String,
}
impl Default for Config {
fn default() -> Self {
Config {
editor: Some("nano".into()),
sections: Some(vec!["Daily".into(), "Weekly".into(), "Monthly".into()]),
notes_dir: Some("Notes".into()),
editor: "nano".into(),
sections: vec!["Daily".into(), "Weekly".into(), "Monthly".into()],
notes_dir: "~/Notes".into(),
}
}
}
#[derive(Debug)]
pub enum ConfigError {
IOError(&'static str),
ParseError(&'static str),
EnvError(&'static str),
}
impl Config {
pub fn load(cfg_file: &str) -> Result<Self, &'static str> {
pub fn load(cfg_file: &str) -> Result<Self, ConfigError> {
Figment::from(Serialized::defaults(Config::default()))
.merge(Env::raw().only(&["EDITOR"]))
.merge(Json::file(cfg_file))
.extract()
.or(Err("Could not load config"))
.or(Err(ConfigError::IOError("Could not load config")))
}
pub fn write_default(cfg_file: &str) -> Result<(), &'static str> {
let buf = serde_json::to_string_pretty(&Self::default())
.or_else(|_| return Err("could not serialize default config"))?;
pub fn write_default(cfg_file: &str) -> Result<(), ConfigError> {
let buf = serde_json::to_string_pretty(&Self::default()).or_else(|_| {
Err(ConfigError::ParseError(
"could not serialize default config",
))
})?;
let mut f = File::create(cfg_file).or_else(|_| Err("Could not open config file"))?;
f.write_all(&buf.as_bytes())
.or_else(|_| return Err("could not write default config to file"))?;
let mut f = File::create(cfg_file)
.or_else(|_| Err(ConfigError::IOError("Could not open config file")))?;
f.write_all(&buf.as_bytes()).or_else(|_| {
Err(ConfigError::IOError(
"could not write default config to file",
))
})?;
Ok(())
}
pub fn expected_locations() -> Result<Vec<PathBuf>, &'static str> {
pub fn expected_locations() -> Result<Vec<PathBuf>, ConfigError> {
let cfg_name = "rusty_task.json";
let home = var("HOME").or(Err("$HOME environment variable not set"))?;
let pwd = var("PWD").or(Err("$PWD environment variable not set"))?;
let home = var("HOME").or(Err(ConfigError::EnvError(
"$HOME environment variable not set",
)))?;
let pwd = var("PWD").or(Err(ConfigError::EnvError(
"$PWD environment variable not set",
)))?;
let mut home_config_cfg = PathBuf::from(home.clone());
home_config_cfg.push(".config");

281
src/file/mod.rs Normal file
View File

@@ -0,0 +1,281 @@
use crate::todo::{File as TodoFile, Status as TaskStatus};
use crate::NaiveDate;
use crate::TaskGroup;
use chrono::Datelike;
use comrak::nodes::{AstNode, NodeValue};
use comrak::parse_document;
use comrak::{Arena, ComrakExtensionOptions, ComrakOptions, ComrakParseOptions};
use std::collections::HashMap;
use std::fs::{read, File};
use std::io::Write;
use std::path::PathBuf;
use std::str;
#[derive(Debug)]
pub enum FileNameParseError {
TypeConversionError(&'static str),
ParseError(chrono::ParseError),
}
pub fn get_filepath(data_dir: &PathBuf, date: &NaiveDate) -> PathBuf {
let file_name = format!("{}-{:02}-{:02}.md", date.year(), date.month(), date.day());
let mut file_path = data_dir.clone();
file_path.push(file_name);
file_path
}
/// generate strings from TaskGroups and date
pub fn generate_file_content(data: &Vec<TaskGroup>, date: &NaiveDate) -> String {
// TODO: This should be a type and then I can implement it with From<>
let mut content = format!(
"# Today's tasks {}-{:02}-{:02}\n",
date.year(),
date.month(),
date.day()
);
data.iter()
.for_each(|task_group| content.push_str(format!("\n{}", task_group.to_string()).as_str()));
content
}
pub fn write_file(path: &PathBuf, content: &String) {
let mut new_file = File::create(&path).expect("Could not open today's file: {today_file_path}");
write!(new_file, "{}", content).expect("Could not write to file: {today_file_path}");
}
/// Load in text file as String
pub fn load_file(file: &TodoFile) -> String {
// TODO: This could be a TryFrom<>
let contents_utf8 = read(file.file.clone())
.expect(format!("Could not read file {}", file.file.to_string_lossy()).as_str());
str::from_utf8(&contents_utf8)
.expect(
format!(
"failed to convert contents of file to string: {}",
file.file.to_string_lossy()
)
.as_str(),
)
.to_string()
}
/// Parse contents of markdown file with Comrak ( relaxed tasklist matching is enabled)
pub fn parse_todo_file<'a>(contents: &String, arena: &'a Arena<AstNode<'a>>) -> &'a AstNode<'a> {
let options = &ComrakOptions {
extension: ComrakExtensionOptions {
tasklist: true,
..ComrakExtensionOptions::default()
},
parse: ComrakParseOptions {
relaxed_tasklist_matching: true,
..ComrakParseOptions::default()
},
..ComrakOptions::default()
};
parse_document(arena, contents, options)
}
pub fn extract_secitons<'a>(
root: &'a AstNode<'a>,
sections: &Vec<String>,
) -> HashMap<String, TaskGroup> {
let mut groups: HashMap<String, TaskGroup> = HashMap::new();
for node in root.reverse_children() {
let node_ref = &node.data.borrow();
if let NodeValue::Heading(heading) = node_ref.value {
if heading.level < 2 {
continue;
}
let first_child_ref = &node.first_child();
let first_child = if let Some(child) = first_child_ref {
child
} else {
continue;
};
let data_ref = &first_child.data.borrow();
let title = if let NodeValue::Text(value) = &data_ref.value {
value
} else {
continue;
};
if sections.iter().any(|section| section.eq(title)) {
if let Ok(mut group) = TaskGroup::try_from(node) {
group.tasks = group
.tasks
.into_iter()
.filter(|task| !matches!(task.status, TaskStatus::Done(_)))
.collect();
groups.insert(title.to_string(), group);
}
}
};
}
groups
}
#[cfg(test)]
mod test {
use super::*;
use crate::todo::{Status, Task};
#[test]
fn test_extract_sections() {
let test_md = "\
# Test
## Content
- [ ] something
- [x] done
- [!] other
## Unused
### Sub section
- [ ] task
## Unrealated Stuff
- [ ] something else
+ [ ] subtask";
let arena = Arena::new();
let root = parse_todo_file(&test_md.to_string(), &arena);
let result = extract_secitons(root, &vec![]);
assert_eq!(result.keys().count(), 0);
let result = extract_secitons(root, &vec!["Not There".to_string()]);
assert_eq!(result.keys().count(), 0);
let sections = vec!["Unused".to_string()];
let result = extract_secitons(root, &sections);
assert_eq!(result.keys().count(), 0);
let sections = vec!["Sub section".to_string()];
let result = extract_secitons(root, &sections);
assert_eq!(result.keys().count(), 1);
assert!(result.get(sections.first().unwrap()).is_some());
assert_eq!(result.get(sections.first().unwrap()).unwrap().level, 3);
let sections = vec!["Content".to_string()];
let result = extract_secitons(root, &sections);
assert_eq!(result.keys().count(), 1);
assert!(result.get(sections.first().unwrap()).is_some());
assert_eq!(
result
.get(sections.first().unwrap())
.expect("No Value for \"Content\""),
&TaskGroup {
name: sections.first().unwrap().clone(),
tasks: vec![
Task {
status: TaskStatus::Empty,
text: "something".to_string(),
subtasks: None
},
Task {
status: TaskStatus::Todo('!'),
text: "other".to_string(),
subtasks: None
},
],
level: 2
}
);
let sections = vec!["Unrealated Stuff".to_string()];
let result = extract_secitons(root, &sections);
assert_eq!(result.keys().count(), 1);
assert!(result.get(sections.first().unwrap()).is_some());
assert_eq!(
result
.get(sections.first().unwrap())
.expect("No Value for \"Content\""),
&TaskGroup {
name: sections.first().unwrap().clone(),
tasks: vec![Task {
status: TaskStatus::Empty,
text: "something else".to_string(),
subtasks: Some(vec![Task {
status: TaskStatus::Empty,
text: "subtask".to_string(),
subtasks: None
}]),
}],
level: 2
}
);
let result = extract_secitons(
root,
&vec!["Content".to_string(), "Sub section".to_string()],
);
assert_eq!(result.keys().count(), 2);
}
#[test]
fn test_generate_file_content() {
let date = NaiveDate::from_ymd_opt(2024, 1, 1).unwrap();
let mut content: Vec<TaskGroup> = vec![];
let result = generate_file_content(&content, &date);
let expected = "# Today's tasks 2024-01-01\n";
assert_eq!(result, expected);
content.push(TaskGroup {
name: "Empty".into(),
tasks: vec![],
level: 2,
});
let result = generate_file_content(&content, &date);
let expected = "# Today's tasks 2024-01-01\n\n## Empty\n";
assert_eq!(result, expected);
content.push(TaskGroup {
name: "Subgroup".into(),
tasks: vec![],
level: 3,
});
let result = generate_file_content(&content, &date);
let expected = "# Today's tasks 2024-01-01\n\n## Empty\n\n### Subgroup\n";
assert_eq!(result, expected);
content.push(TaskGroup {
name: "Tasks".into(),
tasks: vec![
Task {
status: Status::Empty,
text: "task 1".into(),
subtasks: None,
},
Task {
status: Status::Done('x'),
text: "task 2".into(),
subtasks: None,
},
Task {
status: Status::Todo('>'),
text: "task 3".into(),
subtasks: None,
},
],
level: 2,
});
let result = generate_file_content(&content, &date);
let expected = "\
# Today's tasks 2024-01-01
## Empty
### Subgroup
## Tasks
- [ ] task 1
- [x] task 2
- [>] task 3
";
assert_eq!(result, expected);
}
}

26
src/logging/mod.rs Normal file
View File

@@ -0,0 +1,26 @@
use log::Level;
pub fn get_logging_level(verbose_level: u8) -> Level {
match verbose_level {
..=0 => Level::Error,
1 => Level::Warn,
2 => Level::Info,
3 => Level::Debug,
4.. => Level::Trace,
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_get_logging_level() {
assert_eq!(get_logging_level(0), Level::Error);
assert_eq!(get_logging_level(1), Level::Warn);
assert_eq!(get_logging_level(2), Level::Info);
assert_eq!(get_logging_level(3), Level::Debug);
assert_eq!(get_logging_level(4), Level::Trace);
assert_eq!(get_logging_level(5), Level::Trace);
}
}

View File

@@ -1,75 +1,147 @@
mod cli;
mod config;
mod file;
mod logging;
mod todo;
use crate::config::Config;
use crate::todo::{Status as TaskStatus, TaskGroup};
use crate::todo::file::TodoFile;
use chrono::naive::NaiveDate;
use chrono::{Datelike, Local};
use comrak::nodes::{AstNode, NodeValue};
use comrak::{parse_document, Arena};
use comrak::{ComrakExtensionOptions, ComrakOptions, ComrakParseOptions};
use std::borrow::Borrow;
use std::collections::HashMap;
use std::env;
use std::fs::{read, read_dir, File};
use std::io::Write;
use std::path::{Path, PathBuf};
use chrono::{Local, TimeDelta};
use clap::Parser;
use cli::Args;
use comrak::Arena;
use config::Config;
use log;
use logging::get_logging_level;
use resolve_path::PathResolveExt;
use simple_logger::init_with_level;
use std::fs;
use std::path::Path;
use std::process::Command;
use std::str;
//TODO handle unwraps and errors more uniformly
//TODO refactor creating new file
//TODO clean up verbose printing
//TODO create custom errors for better error handling
use todo::{File as TodoFile, TaskGroup};
// TODO: add options to use specific date instead of args.previous
fn main() {
let expected_cfg_files = Config::expected_locations().unwrap();
println!("{:#?}", expected_cfg_files);
// setup
let args = Args::parse();
let _logger = init_with_level(get_logging_level(args.verbose)).unwrap();
log::debug!("{:?}", args);
// getting config location
let expected_cfg_files = match Config::expected_locations() {
Ok(cfg_files) => cfg_files,
Err(e) => panic!("{:?}", e),
};
// getting exising config files
let cfg_files: Vec<&Path> = expected_cfg_files
.iter()
.map(|file| Path::new(file))
.filter(|file| file.exists())
.collect();
println!("{:#?}", cfg_files);
if cfg_files.len() <= 0 {
let status = Config::write_default(expected_cfg_files[0].to_str().unwrap());
if let Err(e) = status {
println!("Could not write to default cfg location: {:#?}", e);
// writing default config if non exist
if cfg_files.len() <= 0 && args.config.is_none() {
if let Err(e) = Config::write_default(match expected_cfg_files[0].to_str() {
Some(s) => s,
None => panic!("Could not resolve expected cfg file paths"),
}) {
panic!("Could not write config: {:?}", e);
}
}
let cfg = Config::load(cfg_files.last().unwrap().to_str().unwrap()).unwrap();
println!("{:#?}", cfg);
let data_dir = get_data_dir(
&cfg.notes_dir
.clone()
.expect("Could not get notes dir from config"),
);
println!("dir = {}", data_dir.to_str().unwrap());
// set witch config file to load
let cfg_file = match args.config {
Some(file) => file,
None => match cfg_files.last() {
None => expected_cfg_files[0].to_string_lossy().to_string(),
Some(file) => file.to_string_lossy().to_string(),
},
};
let latest_file = get_latest_file(&data_dir);
println!("Latest file: {:?}", latest_file);
// show current config file or just log it based on args
if args.current_config {
print!("{}", &cfg_file);
return;
} else {
log::debug!("config file: {}", &cfg_file);
}
let now = Local::now();
let today = NaiveDate::from_ymd_opt(now.year(), now.month(), now.day()).unwrap();
// load config file
let cfg = match Config::load(&cfg_file) {
Ok(cfg) => cfg,
Err(_e) => panic!("could not load config: {}", cfg_file),
};
log::debug!("{:#?}", cfg);
// resolve data directory and create it if it does not exisit
let data_dir = cfg.notes_dir.resolve().to_path_buf();
if !fs::metadata(&data_dir).is_ok() {
match fs::create_dir_all(&data_dir) {
Err(_e) => panic!("Could not create default directory: {:?}", &data_dir),
_ => log::info!("created dir {}", &data_dir.to_string_lossy()),
};
}
// get file paths of notes
let files = fs::read_dir(&data_dir)
.expect(format!("Could not find notes folder: {:?}", &data_dir).as_str())
.filter_map(|f| f.ok())
.map(|file| file.path());
// list all notes
if args.list_all {
files
.into_iter()
.for_each(|f| println!("{}", f.canonicalize().unwrap().to_string_lossy()));
return ();
}
// get clossest files to specified date
let today = Local::now().date_naive();
let target = if let Some(date_str) = args.date {
cli::smart_parse_date(&date_str, &today).expect("Could not parse date")
} else {
today - TimeDelta::try_days(args.previous.into()).unwrap()
};
let closest_files = TodoFile::get_closest_files(files.collect(), target, args.number);
// list files
if args.list {
println!("Today - n\tFile");
closest_files.into_iter().for_each(|f| {
println!(
"{}\t\t{}",
(today - f.date).num_days(),
f.file.canonicalize().unwrap().to_string_lossy(),
)
});
return ();
}
// TODO: If the user did not pick a date that exist they should have the
// option to updated their choice
let latest_file = closest_files.first();
let current_file = match latest_file {
Ok(file) if file.date < today => {
println!("Today's file does not exist, creating");
// copy old file if the user specifies today's notes but it does not exist
Some(todo_file) if todo_file.date < today && args.previous == 0 => {
let sections = &cfg.sections;
log::info!("looking for sections: {:?}", sections);
let arena = Arena::new();
let root = parse_todo_file(&file, &arena);
//println!("{:#?}", root);
//println!("=======================================================");
let sections = &cfg.sections.unwrap();
let groups = extract_secitons(root, sections);
println!("{:#?}", groups);
// attempt to load file
let root = {
log::info!(
"loading and parsing file: {}",
todo_file.file.to_string_lossy()
);
let contents = file::load_file(&todo_file);
let root = file::parse_todo_file(&contents, &arena);
root
};
log::trace!("file loaded");
// extract sections specified in config
let groups = file::extract_secitons(root, sections);
log::trace!("sections extracted");
// create new sections and generate empty sections for any that are missing
let level = groups.values().map(|group| group.level).min().unwrap_or(2);
let data = sections
.iter()
.map(|section| match groups.get(section) {
@@ -78,147 +150,42 @@ fn main() {
})
.collect();
let new_file = write_file(&data_dir, &today, &data);
Some(new_file)
// generate string for new file and write to filesystem
let content = file::generate_file_content(&data, &today);
let file_path = file::get_filepath(&data_dir, &today);
log::info!("writing to file: {}", file_path.to_string_lossy());
file::write_file(&file_path, &content);
// return file name
file_path
}
Err(_) => {
println!("No files in dir: {:}", cfg.notes_dir.unwrap());
let sections = &cfg.sections.unwrap();
// returning the selected file
Some(todo_file) => todo_file.file.to_owned(),
// no note files exist creating based on template from config
None => {
// generate empty file
let sections = &cfg.sections;
log::info!("creating new empty file with sections: {:?}", sections);
let data = sections
.iter()
.map(|sec| TaskGroup::empty(sec.clone(), 2))
.collect();
let new_file = write_file(&data_dir, &today, &data);
Some(new_file)
}
Ok(file) => {
println!("Today's file was created");
Some(file.file.path())
}
};
if let Some(file) = current_file {
Command::new(cfg.editor.expect("Could not resolve editor from config"))
.args([file])
.status()
.expect(format!("failed to launch editor {}", "vim").as_str());
};
}
fn write_file(data_dir: &PathBuf, date: &NaiveDate, data: &Vec<TaskGroup>) -> PathBuf {
let mut content = format!(
"# Today's tasks {}-{:02}-{:02}\n",
date.year(),
date.month(),
date.day()
);
data.iter()
.for_each(|task_group| content.push_str(format!("\n{}", task_group.to_string()).as_str()));
let file_name = format!(
"{}-{:02}-{:02}.md",
date.year(),
date.month(),
date.day()
);
let mut file_path = data_dir.clone();
file_path.push(file_name);
let mut file = File::create(&file_path).expect("Could not open today's file: {today_file_path}");
write!(file, "{}", content).expect("Could not write to file: {today_file_path}");
let content = file::generate_file_content(&data, &today);
let file_path = file::get_filepath(&data_dir, &today);
file::write_file(&file_path, &content);
log::info!("writing to file: {}", file_path.to_string_lossy());
// return file name
file_path
}
fn parse_todo_file<'a>(file: &TodoFile, arena: &'a Arena<AstNode<'a>>) -> &'a AstNode<'a> {
let options = &ComrakOptions {
extension: ComrakExtensionOptions {
tasklist: true,
..ComrakExtensionOptions::default()
},
parse: ComrakParseOptions {
relaxed_tasklist_matching: true,
..ComrakParseOptions::default()
},
..ComrakOptions::default()
};
let contents_utf8 = read(file.file.path())
.expect(format!("Could not read file {}", file.file.path().to_string_lossy()).as_str());
let contents = str::from_utf8(&contents_utf8).expect(
format!(
"failed to convert contents of file to string: {}",
file.file.path().to_string_lossy()
)
.as_str(),
// opening file
log::info!(
"Opening {} in {}",
current_file.to_string_lossy(),
cfg.editor
);
parse_document(arena, contents, options)
}
fn extract_secitons<'a>(
root: &'a AstNode<'a>,
sections: &Vec<String>,
) -> HashMap<String, TaskGroup> {
let mut groups: HashMap<String, TaskGroup> = HashMap::new();
for node in root.reverse_children() {
let node_ref = &node.data.borrow();
if let NodeValue::Heading(heading) = node_ref.value {
if heading.level < 2 {
continue;
}
let first_child_ref = &node.first_child();
let first_child = if let Some(child) = first_child_ref.borrow() {
child
} else {
continue;
};
let data_ref = &first_child.data.borrow();
let title = if let NodeValue::Text(value) = &data_ref.value {
value
} else {
continue;
};
println!("Attempting to parse {}", title);
if sections.iter().any(|section| section.eq(title)) {
if let Ok(mut group) = TaskGroup::try_from(node) {
group.tasks = group
.tasks
.into_iter()
.filter(|task| !matches!(task.status, TaskStatus::Done(_)))
.collect();
groups.insert(title.to_string(), group);
}
}
};
}
groups
}
fn get_data_dir(dir_name: &str) -> PathBuf {
let mut dir = match env::var("HOME") {
Ok(home) => {
let mut x = PathBuf::new();
x.push(home);
x
}
_ => env::current_dir().expect("PWD environment variable not set"),
};
dir = dir.join(dir_name);
dir
}
fn get_latest_file(dir: &Path) -> Result<TodoFile, String> {
let dir = read_dir(dir).expect(format!("Could not find notes folder: {:?}", dir).as_str());
dir.filter_map(|f| f.ok())
.filter_map(|file| TodoFile::try_from(file).ok())
.reduce(|a, b| TodoFile::latest_file(a, b))
.ok_or("Could not reduce items".to_string())
Command::new(&cfg.editor)
.args([current_file])
.status()
.expect(format!("failed to launch editor {}", &cfg.editor).as_str());
}

View File

@@ -1,68 +1,116 @@
use chrono::naive::NaiveDate;
use regex::Regex;
use std::cmp::min;
use std::convert::TryFrom;
use std::fs::DirEntry;
use std::str::FromStr;
use std::path::PathBuf;
#[derive(Debug)]
pub struct TodoFile {
pub file: DirEntry,
use crate::file::FileNameParseError;
#[derive(Debug, Clone, PartialEq)]
pub struct File {
pub file: PathBuf,
pub date: NaiveDate,
}
impl TodoFile {
fn capture_as_number<T: FromStr>(capture: &regex::Captures, name: &str) -> Result<T, String> {
Ok(capture
.name(name)
.unwrap()
.as_str()
.parse::<T>()
.ok()
.ok_or("Something went wrong".to_owned())?)
fn try_get_date(file: &PathBuf) -> Result<NaiveDate, FileNameParseError> {
let file_name = file
.file_name()
.ok_or(FileNameParseError::TypeConversionError(
"Could not get filename from path: {:?}",
))?
.to_str()
.ok_or(FileNameParseError::TypeConversionError(
"Could not get filename from path: {:?}",
))?;
NaiveDate::parse_from_str(file_name, "%Y-%m-%d.md")
.or_else(|e| Err(FileNameParseError::ParseError(e)))
}
pub fn latest_file(a: TodoFile, b: TodoFile) -> TodoFile {
if a.date > b.date {
a
} else {
b
impl TryFrom<PathBuf> for File {
type Error = FileNameParseError;
fn try_from(path: PathBuf) -> Result<Self, Self::Error> {
Ok(Self {
date: try_get_date(&path)?,
file: path.into(),
})
}
}
impl File {
pub fn get_closest_files(files: Vec<PathBuf>, target: NaiveDate, n: usize) -> Vec<File> {
let mut dated_files = files
.into_iter()
.filter_map(|file| File::try_from(file).ok())
.collect::<Vec<_>>();
dated_files.sort_by_cached_key(|dated_file| (dated_file.date - target).num_days().abs());
let count = min(n, dated_files.len());
dated_files[..count].to_vec()
}
}
fn get_file_regex() -> Regex {
//TODO This would ideally be configurable
Regex::new(r"(?P<year>\d{4})-(?P<month>\d{2})-(?P<day>\d{2}).md")
.expect("could not create regex")
}
}
impl TryFrom<DirEntry> for TodoFile {
type Error = String;
fn try_from(direntry: DirEntry) -> Result<Self, Self::Error> {
let re = TodoFile::get_file_regex();
// println!("{:?}", re);
let file_name = direntry.file_name();
let file_name_str = match file_name.to_str() {
Some(name) => name,
_ => "",
};
// println!("{:?}", file_name_str);
if let Some(caps) = re.captures(file_name_str) {
let year: i32 = Self::capture_as_number(&caps, "year").unwrap();
let month: u32 = Self::capture_as_number(&caps, "month").unwrap();
let day: u32 = Self::capture_as_number(&caps, "day").unwrap();
return Ok(Self {
file: direntry,
date: NaiveDate::from_ymd_opt(year, month, day).unwrap(),
});
};
Err(format!(
"Could not parse file name => {{ name: {:?}, re: {:?} }}",
file_name, re
)
.to_string())
#[cfg(test)]
mod test {
use super::*;
use chrono::NaiveDate;
use std::path::PathBuf;
#[test]
fn test_get_closest_date() {
let files = vec![
PathBuf::from("./2024-01-01.md"),
PathBuf::from("./2024-01-02.md"),
PathBuf::from("./2024-01-03.md"),
PathBuf::from("./2024-02-01.md"),
PathBuf::from("./2024-03-01.md"),
PathBuf::from("./2024-04-01.md"),
PathBuf::from("./2024-04-02.md"),
PathBuf::from("./2024-04-03.md"),
PathBuf::from("./2024-04-04.md"),
];
let res = File::get_closest_files(
files.clone(),
NaiveDate::from_ymd_opt(2023, 12, 30).unwrap(),
3,
);
let expected_res = vec![
File::try_from(PathBuf::from("./2024-01-01.md")).unwrap(),
File::try_from(PathBuf::from("./2024-01-02.md")).unwrap(),
File::try_from(PathBuf::from("./2024-01-03.md")).unwrap(),
];
assert_eq!(res, expected_res);
let res = File::get_closest_files(
files.clone(),
NaiveDate::from_ymd_opt(2024, 2, 1).unwrap(),
3,
);
let expected_res = vec![
File::try_from(PathBuf::from("./2024-02-01.md")).unwrap(),
File::try_from(PathBuf::from("./2024-01-03.md")).unwrap(),
File::try_from(PathBuf::from("./2024-03-01.md")).unwrap(),
];
assert_eq!(res, expected_res);
let res = File::get_closest_files(
files.clone(),
NaiveDate::from_ymd_opt(2024, 5, 2).unwrap(),
3,
);
let expected_res = vec![
File::try_from(PathBuf::from("./2024-04-04.md")).unwrap(),
File::try_from(PathBuf::from("./2024-04-03.md")).unwrap(),
File::try_from(PathBuf::from("./2024-04-02.md")).unwrap(),
];
assert_eq!(res, expected_res);
let res = File::get_closest_files(
files[..1].to_vec(),
NaiveDate::from_ymd_opt(2023, 12, 30).unwrap(),
3,
);
let expected_res = vec![File::try_from(PathBuf::from("./2024-01-01.md")).unwrap()];
assert_eq!(res, expected_res);
}
}

View File

@@ -1,130 +1,5 @@
pub mod file;
mod file;
mod tasks;
use std::borrow::Borrow;
use comrak::nodes::AstNode;
use comrak::nodes::NodeValue;
#[derive(Debug, Clone)]
pub struct TaskGroup {
pub name: String,
pub tasks: Vec<Task>,
pub level: u8,
}
// This does not support subtasks, need to figure out best path forward
#[derive(Debug, Clone)]
pub struct Task {
pub status: Status,
pub text: String,
}
#[derive(Debug, PartialEq, Clone)]
pub enum Status {
Done(char),
Todo(char),
Empty,
}
impl Task {
fn find_text<'a>(node: &'a AstNode<'a>) -> String {
let mut text = String::new();
for child in node.descendants() {
let data_ref = child.data.borrow();
if let NodeValue::Text(contents) = &data_ref.value {
text.push_str(format!("{}\n ", &contents.clone()).as_str());
};
}
text
}
}
impl ToString for Task {
fn to_string(&self) -> String {
let ch = match self.status {
Status::Done(ch) => ch,
Status::Todo(ch) => ch,
Status::Empty => ' ',
};
format!(" - [{}] {}\n", ch, self.text.trim())
}
}
impl<'a> TryFrom<&'a AstNode<'a>> for Task {
type Error = String;
fn try_from(node: &'a AstNode<'a>) -> Result<Self, Self::Error> {
let data_ref = &node.data.borrow();
if let NodeValue::TaskItem(ch) = data_ref.value {
let text = Self::find_text(node);
let status = match ch {
Some(c) if c == 'x' || c == 'X' => Status::Done(c),
Some(c) => Status::Todo(c),
_ => Status::Empty,
};
Ok(Self { status, text })
} else {
Err("Node being parsed is not a TaskItem".into())
}
}
}
impl TaskGroup {
pub fn empty(name: String, level: u8) -> TaskGroup {
TaskGroup {
name,
tasks: Vec::new(),
level,
}
}
}
impl ToString for TaskGroup {
fn to_string(&self) -> String {
let mut output = String::new();
output.push_str(format!("{} {}\n", "#".repeat(self.level.into()), self.name).as_str());
self.tasks
.iter()
.for_each(|task| output.push_str(task.to_string().as_str()));
output
}
}
impl<'a> TryFrom<&'a AstNode<'a>> for TaskGroup {
type Error = String;
fn try_from(node: &'a AstNode<'a>) -> Result<Self, Self::Error> {
let node_ref = &node.data.borrow();
if let NodeValue::Heading(heading) = node_ref.value {
let level = heading.level;
let first_child_ref = &node.first_child();
let first_child = if let Some(child) = first_child_ref.borrow() {
child
} else {
return Err("".into());
};
let data_ref = &first_child.data.borrow();
let name = if let NodeValue::Text(value) = &data_ref.value {
value.to_string()
} else {
return Err("".into());
};
let next_sib = node.next_sibling().ok_or("Empty section at end of file")?;
if let NodeValue::List(_list_meta) = next_sib.data.borrow().value {
let tasks = next_sib
.children()
.into_iter()
.filter_map(|item_node| Task::try_from(item_node).ok())
.collect();
Ok(TaskGroup { name, tasks, level })
} else {
Err("Next sibling of node is not a list".into())
}
} else {
Err("Node is not a section heading".into())
}
}
}
pub use file::File;
pub use tasks::{Status, TaskGroup};

201
src/todo/tasks.rs Normal file
View File

@@ -0,0 +1,201 @@
use std::borrow::Borrow;
use comrak::nodes::AstNode;
use comrak::nodes::NodeValue;
#[derive(Debug, Clone, PartialEq)]
pub struct TaskGroup {
pub name: String,
pub tasks: Vec<Task>,
pub level: u8,
}
// This does not support subtasks, need to figure out best path forward
#[derive(Debug, Clone, PartialEq)]
pub struct Task {
pub status: Status,
pub text: String,
pub subtasks: Option<Vec<Task>>,
}
#[derive(Debug, PartialEq, Clone)]
pub enum Status {
Done(char),
Todo(char),
Empty,
}
pub enum TaskError {
ParsingError(&'static str),
}
impl Task {
fn extract_text<'a>(node: &'a AstNode<'a>) -> Result<String, TaskError> {
let data_ref = node.data.borrow();
if let NodeValue::Text(contents) = &data_ref.value {
Ok(contents.to_string())
} else {
Err(TaskError::ParsingError("Could not get text from element"))
}
}
fn extract_text_from_task<'a>(node: &'a AstNode<'a>) -> Result<String, TaskError> {
let mut text = String::new();
let data_ref = node.data.borrow();
if let NodeValue::Paragraph = data_ref.value {
for child in node.children() {
let child_data_ref = child.data.borrow();
let t = match &child_data_ref.borrow().value {
NodeValue::Text(contents) => contents.clone(),
NodeValue::Emph if child.first_child().is_some() => {
format!("*{}*", Self::extract_text(child.first_child().unwrap())?)
}
NodeValue::Strong if child.first_child().is_some() => {
format!("**{}**", Self::extract_text(child.first_child().unwrap())?)
}
NodeValue::SoftBreak => {
format!("\n{}", " ".repeat(data_ref.sourcepos.start.column))
}
_ => "".into(),
};
text.push_str(&t);
}
Ok(text)
} else {
Err(TaskError::ParsingError("First child is not Paragraph"))
}
}
}
impl ToString for Task {
fn to_string(&self) -> String {
let ch = match self.status {
Status::Done(ch) => ch,
Status::Todo(ch) => ch,
Status::Empty => ' ',
};
let subtasks = if let Some(subtasks) = &self.subtasks {
let text = subtasks
.iter()
.map(|task| task.to_string())
.collect::<Vec<_>>()
.join("\n");
format!("\n{}", text).trim_end().replace("\n", "\n ")
} else {
"".into()
};
format!("- [{}] {}{}\n", ch, self.text.trim(), subtasks)
}
}
impl<'a> TryFrom<&'a AstNode<'a>> for Task {
type Error = TaskError;
fn try_from(node: &'a AstNode<'a>) -> Result<Self, Self::Error> {
let data_ref = &node.data.borrow();
if let NodeValue::TaskItem(ch) = data_ref.value {
let text = Self::extract_text_from_task(
node.first_child()
.ok_or(TaskError::ParsingError("No childern of node found"))?,
)?;
let status = match ch {
Some(c) if c == 'x' || c == 'X' => Status::Done(c),
Some(c) => Status::Todo(c),
_ => Status::Empty,
};
let subtasks = node
.children()
.filter_map(|child| {
if let NodeValue::List(_) = child.data.borrow().value {
Some(child)
} else {
None
}
})
.map(|child| {
child
.children()
.into_iter()
.filter_map(|item_node| Task::try_from(item_node).ok())
.collect()
})
.reduce(|a: Vec<Task>, b: Vec<Task>| [a, b].concat());
Ok(Self {
status,
text,
subtasks,
})
} else {
Err(TaskError::ParsingError(
"Node being parsed is not a TaskItem",
))
}
}
}
impl TaskGroup {
pub fn empty(name: String, level: u8) -> TaskGroup {
TaskGroup {
name,
tasks: Vec::new(),
level,
}
}
}
impl ToString for TaskGroup {
fn to_string(&self) -> String {
let mut output = String::new();
output.push_str(format!("{} {}\n", "#".repeat(self.level.into()), self.name).as_str());
self.tasks
.iter()
.for_each(|task| output.push_str(task.to_string().as_str()));
output
}
}
impl<'a> TryFrom<&'a AstNode<'a>> for TaskGroup {
type Error = TaskError;
fn try_from(node: &'a AstNode<'a>) -> Result<Self, Self::Error> {
let node_ref = &node.data.borrow();
if let NodeValue::Heading(heading) = node_ref.value {
let level = heading.level;
let first_child = node
.first_child()
.ok_or(TaskError::ParsingError("Node has no children"))?;
let data_ref = first_child.data.borrow();
let name = if let NodeValue::Text(value) = &data_ref.value {
Ok(value.to_string())
} else {
Err(TaskError::ParsingError(
"Could not get title from heading node",
))
}?;
let next_sib = node
.next_sibling()
.ok_or(TaskError::ParsingError("Empty section at end of file"))?;
if let NodeValue::List(_list_meta) = next_sib.data.borrow().value {
let tasks = next_sib
.children()
.into_iter()
.filter_map(|item_node| Task::try_from(item_node).ok())
.collect();
Ok(TaskGroup { name, tasks, level })
} else {
Err(TaskError::ParsingError(
"Next sibling of node is not a list",
))
}
} else {
Err(TaskError::ParsingError("Node is not a section heading"))
}
}
}