shellist 0.2.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

/// One parsed line from a shell history file.
///
/// Holds the raw input line, the extracted base command, and an optional
/// timestamp (Unix epoch seconds) when the shell records one (zsh extended,
/// fish, or bash with `HISTTIMEFORMAT`).
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct HistoryEntry {
    /// The full raw command line as it appeared in the history file.
    pub raw: String,
    /// The extracted base command (first token, no args).
    pub command: String,
    /// Unix epoch seconds, when the shell records one.
    pub timestamp: Option<u64>,
}

impl HistoryEntry {
    /// Create a new entry from a raw line and its extracted command (no timestamp).
    pub fn new(raw: impl Into<String>, command: impl Into<String>) -> Self {
        Self {
            raw: raw.into(),
            command: command.into(),
            timestamp: None,
        }
    }

    /// Attach a timestamp to this entry (builder style).
    pub fn with_timestamp(mut self, timestamp: u64) -> Self {
        self.timestamp = Some(timestamp);
        self
    }

    /// Create an entry with all fields, including an optional timestamp.
    pub fn from_parts(
        raw: impl Into<String>,
        command: impl Into<String>,
        timestamp: Option<u64>,
    ) -> Self {
        Self {
            raw: raw.into(),
            command: command.into(),
            timestamp,
        }
    }
}

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

    #[test]
    fn history_entry_creation() {
        let entry = HistoryEntry::new("git status", "git");
        assert_eq!(entry.raw, "git status");
        assert_eq!(entry.command, "git");
    }

    #[test]
    fn history_entry_clone_equality() {
        let entry = HistoryEntry::new("ls -la", "ls");
        let cloned = entry.clone();
        assert_eq!(entry, cloned);
    }

    #[test]
    fn new_has_no_timestamp() {
        let entry = HistoryEntry::new("git status", "git");
        assert_eq!(entry.timestamp, None);
    }

    #[test]
    fn with_timestamp_sets_it() {
        let entry = HistoryEntry::new("git status", "git").with_timestamp(123);
        assert_eq!(entry.timestamp, Some(123));
    }

    #[test]
    fn from_parts_builds_full_entry() {
        let entry = HistoryEntry::from_parts("ls", "ls", Some(7));
        assert_eq!(entry.command, "ls");
        assert_eq!(entry.timestamp, Some(7));
    }
}