Skip to main content

snip/
sort.rs

1use std::cmp::Ordering;
2
3use clap::ValueEnum;
4use serde::{Deserialize, Serialize};
5
6use crate::domain::Snippet;
7
8/// Snippet ordering shared by `snip list --sort`, the `[tui] sort` config key, and
9/// the TUI sort cycle, so every surface names and applies the same orders.
10#[derive(Clone, Copy, Debug, Default, Eq, PartialEq, Serialize, Deserialize, ValueEnum)]
11#[serde(rename_all = "lowercase")]
12#[value(rename_all = "lowercase")]
13pub enum SortMode {
14    /// Most recently modified first. Legacy `manual` config values migrate here.
15    #[default]
16    #[serde(alias = "manual")]
17    Modified,
18    /// Case-insensitive title, ascending.
19    Title,
20    /// Most recently created first.
21    Created,
22}
23
24impl SortMode {
25    pub fn next(self) -> Self {
26        match self {
27            Self::Modified => Self::Created,
28            Self::Created => Self::Title,
29            Self::Title => Self::Modified,
30        }
31    }
32
33    pub fn as_str(self) -> &'static str {
34        match self {
35            Self::Modified => "modified",
36            Self::Title => "title",
37            Self::Created => "created",
38        }
39    }
40
41    /// Pinned snippets always sort first; the mode only breaks ties after that.
42    pub fn compare(self, left: &Snippet, right: &Snippet) -> Ordering {
43        (!left.pinned)
44            .cmp(&(!right.pinned))
45            .then_with(|| match self {
46                Self::Modified => compare_optional_desc(&left.modified_at, &right.modified_at),
47                Self::Title => left.title.to_lowercase().cmp(&right.title.to_lowercase()),
48                // `created_at` is emitted in RFC3339 UTC form by snip, so lexical ordering is
49                // chronological. Imported snippets with mixed offsets may differ slightly.
50                Self::Created => right.created_at.cmp(&left.created_at),
51            })
52    }
53}
54
55/// Newest first, with missing timestamps last.
56fn compare_optional_desc(left: &Option<String>, right: &Option<String>) -> Ordering {
57    match (left, right) {
58        (Some(left), Some(right)) => right.cmp(left),
59        (Some(_), None) => Ordering::Less,
60        (None, Some(_)) => Ordering::Greater,
61        (None, None) => Ordering::Equal,
62    }
63}
64
65#[cfg(test)]
66mod tests {
67    use super::SortMode;
68
69    #[test]
70    fn default_and_cycle_prefer_recently_modified_snippets() {
71        assert_eq!(SortMode::default(), SortMode::Modified);
72        assert_eq!(SortMode::Modified.next(), SortMode::Created);
73        assert_eq!(SortMode::Created.next(), SortMode::Title);
74        assert_eq!(SortMode::Title.next(), SortMode::Modified);
75    }
76}