catcher 0.18.1

A minimal, local-first markdown notes TUI over plain files
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

//! The outline picker: every heading of the open note in one list, to jump
//! to or fold from. Pure functions over the buffer, so the list and its
//! filter can be tested without an app; the app supplies the lines and
//! their blocks and keeps the picker's state.

use crate::fold;
use crate::md::Block;
use crate::search;

/// One heading of the note: where it is, how deep, and what it says.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Heading {
    /// The buffer line, zero-based.
    pub line: usize,
    /// `#` is 1, `######` is 6.
    pub level: usize,
    /// The heading's text with the hashes gone, trimmed.
    pub text: String,
}

/// Every heading in `lines`, in order. The same test the folder applies, so
/// a `#` inside a fence or a table is not a heading here either.
pub fn headings(lines: &[String], blocks: &[Block]) -> Vec<Heading> {
    (0..lines.len())
        .filter_map(|line| {
            let level = fold::heading_at(lines, blocks, line)?;
            Some(Heading {
                line,
                level,
                text: crate::md::heading_text(&lines[line])
                    .unwrap_or_default()
                    .to_string(),
            })
        })
        .collect()
}

/// The headings that answer `query`, in document order: an outline that
/// reshuffled itself by score would lose the shape its indent is showing.
/// Every heading, for an empty query.
pub fn filter(headings: &[Heading], query: &str) -> Vec<Heading> {
    headings
        .iter()
        .filter(|h| search::fuzzy(query, &h.text).is_some())
        .cloned()
        .collect()
}

/// The index in `headings` of the heading whose section `line` is in: the
/// nearest heading at or above it. `None` above the first heading.
pub fn containing(headings: &[Heading], line: usize) -> Option<usize> {
    headings.iter().rposition(|h| h.line <= line)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::md;

    fn lines(text: &str) -> Vec<String> {
        text.lines().map(String::from).collect()
    }

    fn outline(text: &str) -> Vec<Heading> {
        let l = lines(text);
        let b = md::blocks(&l);
        headings(&l, &b)
    }

    #[test]
    fn every_heading_is_listed_with_its_line_level_and_text() {
        let hs = outline("# Title\nintro\n## One\na\n### Deep\n## Two\n");
        let got: Vec<(usize, usize, &str)> = hs
            .iter()
            .map(|h| (h.line, h.level, h.text.as_str()))
            .collect();
        assert_eq!(
            got,
            vec![
                (0, 1, "Title"),
                (2, 2, "One"),
                (4, 3, "Deep"),
                (5, 2, "Two")
            ]
        );
    }

    #[test]
    fn a_hash_inside_a_fence_or_a_table_is_not_a_heading() {
        let hs = outline(
            "# Title\n```\n# not a heading\n```\n| a | b |\n|---|---|\n| # | x |\n## Two\n",
        );
        let got: Vec<&str> = hs.iter().map(|h| h.text.as_str()).collect();
        assert_eq!(got, vec!["Title", "Two"]);
    }

    #[test]
    fn a_tag_and_a_bare_hash_are_not_headings() {
        let hs = outline("#tag\n#\n####### seven\n   ## indented\n");
        let got: Vec<(usize, &str)> = hs.iter().map(|h| (h.level, h.text.as_str())).collect();
        assert_eq!(got, vec![(2, "indented")]);
    }

    #[test]
    fn a_closing_hash_run_is_dropped_but_a_hash_in_a_word_is_kept() {
        let text = |l: &str| crate::md::heading_text(l).map(str::to_string);
        assert_eq!(text("# Title #").as_deref(), Some("Title"));
        assert_eq!(text("## Title ###").as_deref(), Some("Title"));
        assert_eq!(text("# C#").as_deref(), Some("C#"));
        assert_eq!(text("#   spaced   ").as_deref(), Some("spaced"));
        assert_eq!(text("## Setup ^abc ##").as_deref(), Some("Setup"));
    }

    #[test]
    fn the_filter_is_fuzzy_and_keeps_document_order() {
        let hs = outline("# Meeting notes\n## Agenda\n## Action items\n## Notes\n");
        let texts =
            |q: &str| -> Vec<String> { filter(&hs, q).into_iter().map(|h| h.text).collect() };
        assert_eq!(texts("not"), vec!["Meeting notes", "Notes"]);
        assert_eq!(texts("ai"), vec!["Action items"]);
        assert!(filter(&hs, "xyz").is_empty());
        assert_eq!(filter(&hs, "").len(), 4);
        assert_eq!(filter(&hs, "  ").len(), 4);
    }

    #[test]
    fn the_heading_containing_a_line_is_the_nearest_one_above_it() {
        let hs = outline("intro\n# Title\ntext\n## One\na\n## Two\n");
        assert_eq!(containing(&hs, 0), None);
        assert_eq!(containing(&hs, 1), Some(0));
        assert_eq!(containing(&hs, 2), Some(0));
        assert_eq!(containing(&hs, 3), Some(1));
        assert_eq!(containing(&hs, 4), Some(1));
        assert_eq!(containing(&hs, 99), Some(2));
        assert_eq!(containing(&[], 5), None);
    }
}