md-todo 0.1.1

Work with todos in markdown files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

use crate::todo::Todo;
use anyhow::Result;
use md5::{Digest, Md5};
use std::fs;
use std::fs::DirEntry;
use std::path::Path;

pub fn get_todos_from_dir(dir: &Path) -> Result<Vec<Todo>> {
    let mut todos: Vec<Todo> = vec![];
    walk_folder_tree(dir, &mut todos)?;
    Ok(todos)
}

/// Recrusivly walk the directory tree and read all markdown files
fn walk_folder_tree(dir: &Path, todos: &mut Vec<Todo>) -> Result<()> {
    if dir.is_dir() {
        for entry in fs::read_dir(dir)? {
            let entry = entry?;
            let entry_path = entry.path();
            if entry_path.is_dir() {
                walk_folder_tree(&entry_path, todos)?;
            } else {
                match entry.file_name().to_str() {
                    Some(file_name) => {
                        if file_name.ends_with("md") {
                            read_file(&entry, todos)?;
                        }
                    }
                    None => panic!("Cant get filename of path {}", entry_path.to_str().unwrap()),
                }
            }
        }
    }
    Ok(())
}

/// Parses a file and builds Todo objects for each todo found
fn read_file(file: &DirEntry, todos: &mut Vec<Todo>) -> Result<()> {
    let file_content = fs::read_to_string(file.path())?;

    for (line_no, line) in file_content.lines().enumerate() {
        let line = line.trim_start();

        if !line.starts_with("- [x]") && !line.starts_with("- [ ]") {
            continue;
        }

        let todo = build_todo(file, &file_content, line, line_no)?;
        todos.push(todo);
    }

    Ok(())
}

/// Builds a todo out of the metadata of the file
fn build_todo(file: &DirEntry, file_text: &str, line: &str, line_no: usize) -> Result<Todo> {
    let name = line[6..line.len()].to_string();
    let done = line.starts_with("- [x]");
    let filename = file.file_name().to_str().unwrap().to_lowercase();
    let filepath = file.path();
    let headings = get_headings(file_text, (line_no + 1) as u32)?;
    let file_md5 = get_file_content_md5(file_text);

    let todo = Todo::new(
        &name,
        &filename,
        line_no + 1,
        done,
        filepath,
        headings,
        file_md5,
    );

    Ok(todo)
}

/// Gets all headings above the todo in reverse order.
/// First heading above the todo = first entry in vec.
fn get_headings(file_text_content: &str, todo_line_no: u32) -> Result<Vec<String>> {
    let mut headings = vec![];

    let mut line_no = 1;
    for line in file_text_content.lines() {
        if line_no == todo_line_no {
            break;
        }

        let line = line.trim_start();

        if line.starts_with('#') {
            headings.push(line.to_string());
        }

        line_no += 1;
    }
    headings.reverse();
    Ok(headings)
}

pub fn get_file_content_md5(file_text: &str) -> Vec<u8> {
    let mut hasher = Md5::new();
    hasher.update(file_text);
    let file_md5 = hasher.finalize();
    file_md5.to_vec()
}