basalt-tui 0.12.4

Basalt TUI application for Obsidian notes.
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
106
107
108
109
110
111
112
113
114

/// A wrapper type representing the number of characters in a string. **All** characters are
/// counted for.
///
/// Character count can be created from an `usize` directly or computed from a `&str`.
#[derive(Default, Clone, Debug, PartialEq)]
pub struct CharCount(usize);

impl From<usize> for CharCount {
    fn from(value: usize) -> Self {
        Self(value)
    }
}

impl From<&str> for CharCount {
    fn from(value: &str) -> Self {
        value.chars().count().into()
    }
}

impl From<CharCount> for usize {
    fn from(value: CharCount) -> Self {
        value.0
    }
}

/// A wrapper type representing the number of words in a string.
///
/// Can be created from a `usize` directly or computed from a `&str` by counting the number of
/// whitespace-separated words, after removing special markdown characters.
///
/// markdown characters: * _ ` < > ? ! [ ] ( ) = ~ # +
#[derive(Default, Clone, Debug, PartialEq)]
pub struct WordCount(usize);

impl From<WordCount> for usize {
    fn from(value: WordCount) -> Self {
        value.0
    }
}

impl From<usize> for WordCount {
    fn from(value: usize) -> Self {
        Self(value)
    }
}

impl From<&str> for WordCount {
    fn from(value: &str) -> Self {
        let special_symbols = [
            '*', '_', '`', '<', '>', '?', '!', '[', ']', '(', ')', '=', '~', '#', '+',
        ];

        value
            .replace(special_symbols, "")
            .split_whitespace()
            .count()
            .into()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use indoc::indoc;
    use similar_asserts::assert_eq;

    #[test]
    fn test_text_counts() {
        let tests = [
            (
                indoc! {r#"# Heading 1

                ## Heading 2

                ### Heading 3

                #### Heading 4

                ##### Heading 5

                ###### Heading 6"#},
                (WordCount(12), CharCount(91)),
            ),
            (
                indoc! { r#"## Tasks

                - [ ] Task

                - [x] Completed task

                - [?] Completed task"#},
                (WordCount(10), CharCount(64)),
            ),
            (
                indoc! {r#"## Quotes

                You _can_ quote text by adding a `>` symbols before the text.

                > Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society.
                >
                >- Doug Engelbart, 1961"#},
                (WordCount(47), CharCount(294)),
            ),
        ];

        tests.into_iter().for_each(|(input, expected)| {
            assert_eq!(
                (WordCount::from(input), CharCount::from(input)),
                expected,
                "With input {input}"
            )
        });
    }
}