use-focus-order 0.0.1

Primitive focus-order sorting and validation helpers
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

#![forbid(unsafe_code)]
//! Primitive focus-order helpers.
//!
//! The crate stays generic and does not depend on a DOM or UI framework.
//!
//! # Examples
//!
//! ```rust
//! use use_focus_order::{
//!     FocusItem, enabled_focus_items, has_duplicate_focus_order, is_focus_order_valid,
//!     sorted_focus_order,
//! };
//!
//! let items = [
//!     FocusItem {
//!         id: String::from("submit"),
//!         order: 2,
//!         enabled: true,
//!     },
//!     FocusItem {
//!         id: String::from("email"),
//!         order: 1,
//!         enabled: true,
//!     },
//!     FocusItem {
//!         id: String::from("help"),
//!         order: 3,
//!         enabled: false,
//!     },
//! ];
//!
//! assert_eq!(sorted_focus_order(&items)[0].id, "email");
//! assert_eq!(enabled_focus_items(&items).len(), 2);
//! assert!(!has_duplicate_focus_order(&items));
//! assert!(is_focus_order_valid(&items));
//! ```

use std::collections::HashSet;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct FocusItem {
    pub id: String,
    pub order: usize,
    pub enabled: bool,
}

#[must_use]
pub fn sorted_focus_order(items: &[FocusItem]) -> Vec<FocusItem> {
    let mut sorted = items.to_vec();
    sorted.sort_by(|left, right| {
        left.order
            .cmp(&right.order)
            .then_with(|| left.id.cmp(&right.id))
    });
    sorted
}

#[must_use]
pub fn enabled_focus_items(items: &[FocusItem]) -> Vec<FocusItem> {
    items.iter().filter(|item| item.enabled).cloned().collect()
}

#[must_use]
pub fn has_duplicate_focus_order(items: &[FocusItem]) -> bool {
    let mut seen = HashSet::with_capacity(items.len());
    items.iter().any(|item| !seen.insert(item.order))
}

#[must_use]
pub fn has_empty_focus_id(items: &[FocusItem]) -> bool {
    items.iter().any(|item| item.id.trim().is_empty())
}

#[must_use]
pub fn is_focus_order_valid(items: &[FocusItem]) -> bool {
    let enabled = enabled_focus_items(items);
    !has_duplicate_focus_order(&enabled) && !has_empty_focus_id(&enabled)
}

#[cfg(test)]
mod tests {
    use super::{
        FocusItem, enabled_focus_items, has_duplicate_focus_order, has_empty_focus_id,
        is_focus_order_valid, sorted_focus_order,
    };

    #[test]
    fn sorts_focus_order_and_filters_enabled_items() {
        let items = [
            FocusItem {
                id: String::from("submit"),
                order: 2,
                enabled: true,
            },
            FocusItem {
                id: String::from("email"),
                order: 1,
                enabled: true,
            },
            FocusItem {
                id: String::from("help"),
                order: 3,
                enabled: false,
            },
        ];

        let sorted = sorted_focus_order(&items);
        assert_eq!(sorted[0].id, "email");
        assert_eq!(enabled_focus_items(&items).len(), 2);
        assert!(is_focus_order_valid(&items));
    }

    #[test]
    fn detects_duplicate_orders_and_empty_ids() {
        let duplicates = [
            FocusItem {
                id: String::from("email"),
                order: 1,
                enabled: true,
            },
            FocusItem {
                id: String::from("submit"),
                order: 1,
                enabled: true,
            },
        ];
        let empty = [FocusItem {
            id: String::from("  "),
            order: 1,
            enabled: true,
        }];

        assert!(has_duplicate_focus_order(&duplicates));
        assert!(!is_focus_order_valid(&duplicates));
        assert!(has_empty_focus_id(&empty));
        assert!(!is_focus_order_valid(&empty));
    }
}