shellist 0.3.0

Shell history analysis. Parses bash, zsh, and fish history, counts commands, and ranks by frequency.
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

use std::collections::HashMap;

use crate::models::HistoryEntry;

/// Count how many times each command appears.
///
/// Normalizes to lowercase so `Git` and `git` merge into one count.
/// Skips empty commands.
///
/// ```rust
/// use shellist::{HistoryEntry, count_commands};
/// let entries = [
///     HistoryEntry::new("ls -la", "ls"),
///     HistoryEntry::new("ls", "ls"),
///     HistoryEntry::new("Git status", "Git"),
/// ];
/// let counts = count_commands(&entries);
/// assert_eq!(counts.get("ls"), Some(&2));
/// assert_eq!(counts.get("git"), Some(&1));
/// ```
pub fn count_commands(entries: &[HistoryEntry]) -> HashMap<String, usize> {
    count_commands_at_depth(entries, 1)
}

/// Count commands treating the first `depth` whitespace tokens as the key.
///
/// `depth = 1` is the default (first token only). `depth = 2` ranks
/// multi-word commands like `git commit` and `git push` separately.
///
/// ```rust
/// use shellist::{HistoryEntry, count_commands_at_depth};
/// let entries = [
///     HistoryEntry::new("git commit", "git"),
///     HistoryEntry::new("git push", "git"),
///     HistoryEntry::new("git commit", "git"),
/// ];
/// let counts = count_commands_at_depth(&entries, 2);
/// assert_eq!(counts.get("git commit"), Some(&2));
/// assert_eq!(counts.get("git push"), Some(&1));
/// ```
pub fn count_commands_at_depth(entries: &[HistoryEntry], depth: usize) -> HashMap<String, usize> {
    let mut counts = HashMap::new();
    if depth == 0 {
        return counts;
    }
    if depth == 1 {
        for entry in entries {
            let key = entry.command.trim().to_lowercase();
            if key.is_empty() {
                continue;
            }
            *counts.entry(key).or_insert(0) += 1;
        }
        return counts;
    }
    for entry in entries {
        let mut tokens = entry.raw.split_whitespace().take(depth);
        let key = tokens.next();
        let key = match key {
            Some(first) => {
                let mut s = String::from(first);
                for t in tokens {
                    s.push(' ');
                    s.push_str(t);
                }
                s.to_lowercase()
            }
            None => continue,
        };
        if key.is_empty() {
            continue;
        }
        *counts.entry(key).or_insert(0) += 1;
    }
    counts
}

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

    #[test]
    fn counts_basic_commands() {
        let entries = vec![
            HistoryEntry::new("ls", "ls"),
            HistoryEntry::new("ls -la", "ls"),
            HistoryEntry::new("git status", "git"),
        ];
        let counts = count_commands(&entries);
        assert_eq!(counts["ls"], 2);
        assert_eq!(counts["git"], 1);
    }

    #[test]
    fn normalizes_to_lowercase() {
        let entries = vec![
            HistoryEntry::new("Git status", "Git"),
            HistoryEntry::new("git commit", "git"),
            HistoryEntry::new("GIT push", "GIT"),
        ];
        let counts = count_commands(&entries);
        assert_eq!(counts["git"], 3);
    }

    #[test]
    fn trims_spaces_before_counting() {
        let entries = vec![
            HistoryEntry::new("  ls  ", "  ls  "),
            HistoryEntry::new("ls", "ls"),
        ];
        let counts = count_commands(&entries);
        assert_eq!(counts["ls"], 2);
    }

    #[test]
    fn skips_empty_commands() {
        let entries = vec![
            HistoryEntry::new("", ""),
            HistoryEntry::new("   ", "   "),
            HistoryEntry::new("ls", "ls"),
        ];
        let counts = count_commands(&entries);
        assert_eq!(counts.len(), 1);
        assert_eq!(counts["ls"], 1);
    }

    #[test]
    fn empty_entries_returns_empty_map() {
        let entries: Vec<HistoryEntry> = vec![];
        let counts = count_commands(&entries);
        assert!(counts.is_empty());
    }

    #[test]
    fn depth_one_matches_count_commands() {
        let entries = vec![
            HistoryEntry::new("ls -la", "ls"),
            HistoryEntry::new("git status", "git"),
            HistoryEntry::new("ls", "ls"),
        ];
        let d1 = count_commands_at_depth(&entries, 1);
        assert_eq!(d1["ls"], 2);
        assert_eq!(d1["git"], 1);
    }

    #[test]
    fn depth_two_separates_subcommands() {
        let entries = vec![
            HistoryEntry::new("git commit", "git"),
            HistoryEntry::new("git push", "git"),
            HistoryEntry::new("git commit -m x", "git"),
            HistoryEntry::new("ls", "ls"),
        ];
        let d2 = count_commands_at_depth(&entries, 2);
        assert_eq!(d2.get("git commit"), Some(&2));
        assert_eq!(d2.get("git push"), Some(&1));
        assert_eq!(d2.get("ls"), Some(&1));
    }

    #[test]
    fn depth_zero_returns_empty() {
        let entries = vec![HistoryEntry::new("ls", "ls")];
        assert!(count_commands_at_depth(&entries, 0).is_empty());
    }

    #[test]
    fn depth_exceeding_tokens_uses_whole_line() {
        let entries = vec![HistoryEntry::new("git push", "git")];
        let d5 = count_commands_at_depth(&entries, 5);
        assert_eq!(d5.get("git push"), Some(&1));
    }
}