bole 0.2.5

Manage all package managers on your system
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
//! Filtering and grouping operations for package managers.

use std::collections::HashMap;

use bole::pm::{GroupedPmInfo, PmInfo, all_package_managers, is_broken_version};

/// Filters for package manager lists.
pub(crate) struct Filter;

impl Filter {
    /// Keep only package managers with no version (broken).
    pub(crate) fn broken(pms: Vec<PmInfo>) -> Vec<PmInfo> {
        pms.into_iter()
            .filter(|pm| is_broken_version(&pm.version))
            .collect()
    }

    /// Keep only package managers with valid versions.
    #[allow(dead_code)]
    pub(crate) fn healthy(pms: Vec<PmInfo>) -> Vec<PmInfo> {
        pms.into_iter()
            .filter(|pm| !is_broken_version(&pm.version))
            .collect()
    }

    /// Keep only package managers with available updates.
    pub(crate) fn outdated(pms: Vec<PmInfo>) -> Vec<PmInfo> {
        // Get detectors once for all checks
        let detectors = all_package_managers();

        pms.into_iter()
            .filter(|pm| Self::is_outdated(pm, &detectors))
            .collect()
    }

    /// Check if a package manager has an available update.
    fn is_outdated(pm: &PmInfo, detectors: &[Box<dyn bole::pm::Detector>]) -> bool {
        // Broken PMs can't be outdated
        if is_broken_version(&pm.version) {
            return false;
        }

        detectors
            .iter()
            .find(|d| d.name() == pm.name)
            .and_then(|d| d.check_bump(pm))
            .map(|bump| bump.latest != pm.version)
            .unwrap_or(false) // No detector or no bump info means not outdated
    }
}

/// Groups package managers by name.
pub(crate) struct Grouper;

impl Grouper {
    /// Group by name, preserving PATH order.
    pub(crate) fn by_name(pms: Vec<PmInfo>) -> Vec<GroupedPmInfo> {
        let mut grouped: HashMap<String, Vec<PmInfo>> = HashMap::new();

        // Collect all instances by name
        for pm in pms {
            grouped.entry(pm.name.clone()).or_default().push(pm);
        }

        let mut result: Vec<_> = grouped
            .into_iter()
            .map(|(name, instances)| GroupedPmInfo::from_instances(name, instances))
            .collect();

        // Sort groups alphabetically for consistent output
        result.sort_by(|a, b| a.name.cmp(&b.name));
        result
    }

    /// Extract only the primary instance from each group.
    pub(crate) fn primary_only(pms: Vec<PmInfo>) -> Vec<PmInfo> {
        let grouped = Self::by_name(pms);

        grouped
            .into_iter()
            .map(|g| PmInfo {
                name: g.name,
                version: g.version,
                path: g.active_path,
                install_method: g.install_method,
                latest_version: None, // Not preserved during grouping
            })
            .collect()
    }
}

/// Sorts package manager lists.
pub(crate) struct Sorter;

impl Sorter {
    /// Sort alphabetically by name.
    pub(crate) fn by_name(mut pms: Vec<PmInfo>) -> Vec<PmInfo> {
        pms.sort_by(|a, b| a.name.cmp(&b.name));
        pms
    }

    /// Sort by category, then by name within each category.
    #[allow(dead_code)]
    pub(crate) fn by_category(mut pms: Vec<PmInfo>) -> Vec<PmInfo> {
        // Build lookup table once for O(1) lookups during sort
        let detectors = all_package_managers();
        let name_to_category: HashMap<String, bole::pm::Category> = detectors
            .iter()
            .map(|d| (d.name().to_string(), d.category()))
            .collect();

        pms.sort_by(|a, b| {
            let cat_a = name_to_category.get(&a.name);
            let cat_b = name_to_category.get(&b.name);

            match (cat_a, cat_b) {
                (Some(ca), Some(cb)) if ca != cb => {
                    // Respect the order defined in Category::all()
                    let order_a = bole::pm::Category::all()
                        .iter()
                        .position(|&c| c == *ca)
                        .unwrap_or(usize::MAX); // Unknown categories go last
                    let order_b = bole::pm::Category::all()
                        .iter()
                        .position(|&c| c == *cb)
                        .unwrap_or(usize::MAX);
                    order_a.cmp(&order_b)
                },
                // Same category or missing info: sort by name
                _ => a.name.cmp(&b.name),
            }
        });

        pms
    }
}

#[cfg(test)]
mod tests {
    use bole::pm::InstallMethod;

    use super::*;

    fn test_pm(name: &str, version: &str) -> PmInfo {
        PmInfo {
            name: name.to_string(),
            version: version.to_string(),
            path: format!("/usr/bin/{}", name),
            install_method: InstallMethod::Unknown,
            latest_version: None,
        }
    }

    fn test_pm_with_path(name: &str, version: &str, path: &str) -> PmInfo {
        PmInfo {
            name: name.to_string(),
            version: version.to_string(),
            path: path.to_string(),
            install_method: InstallMethod::Unknown,
            latest_version: None,
        }
    }

    #[test]
    fn test_filter_broken() {
        // Arrange
        let pms = vec![
            test_pm("cargo", "1.70.0"),
            test_pm("npm", "8.0.0"),
            test_pm("pip", "   "),
            test_pm("go", "\t\n"),
            test_pm("deno", "??"),
        ];

        // Act
        let broken = Filter::broken(pms);

        // Assert
        assert_eq!(broken.len(), 3);
        assert_eq!(broken[0].name, "pip");
        assert_eq!(broken[1].name, "go");
        assert_eq!(broken[2].name, "deno");
    }

    #[test]
    fn test_filter_healthy() {
        // Arrange
        let pms = vec![
            test_pm("npm", "8.0.0"),
            test_pm("pip", ""),
            test_pm("cargo", "1.70.0"),
        ];

        // Act
        let healthy = Filter::healthy(pms);

        // Assert
        assert_eq!(healthy.len(), 2);
        assert_eq!(healthy[0].name, "npm");
        assert_eq!(healthy[1].name, "cargo");
    }

    #[test]
    fn test_filter_outdated_empty_version() {
        // Arrange: broken or unknown PMs should not be considered outdated
        let pms = vec![
            test_pm("pip", ""),
            test_pm("npm", "   "),
            test_pm("unknown-pm", "1.0.0"),
        ];

        // Act
        let outdated = Filter::outdated(pms);

        // Assert
        assert_eq!(outdated.len(), 0);
    }

    #[test]
    fn test_grouper_by_name() {
        // Arrange
        let pms = vec![
            test_pm_with_path("npm", "8.0.0", "/usr/bin/npm"),
            test_pm_with_path("npm", "9.0.0", "/usr/local/bin/npm"),
            test_pm("pip", "22.0"),
        ];

        // Act
        let grouped = Grouper::by_name(pms);

        // Assert
        assert_eq!(grouped.len(), 2);
        assert_eq!(grouped[0].name, "npm");
        assert_eq!(grouped[1].name, "pip");
        assert_eq!(grouped[0].alternative_paths.len(), 1);
        assert_eq!(grouped[1].alternative_paths.len(), 0);
    }

    #[test]
    fn test_grouper_primary_only() {
        // Arrange
        let pms = vec![
            test_pm_with_path("npm", "8.0.0", "/usr/bin/npm"),
            test_pm_with_path("npm", "9.0.0", "/usr/local/bin/npm"),
            test_pm("pip", "22.0"),
            test_pm_with_path("cargo", "1.70", "/usr/bin/cargo"),
            test_pm_with_path("cargo", "1.71", "/home/.cargo/bin/cargo"),
        ];

        let primary = Grouper::primary_only(pms);
        assert_eq!(primary.len(), 3);

        // Should keep only first instance of each
        let npm = primary.iter().find(|pm| pm.name == "npm").unwrap();
        assert_eq!(npm.version, "8.0.0");
        assert_eq!(npm.path, "/usr/bin/npm");
    }

    #[test]
    fn test_grouper_single_instances() {
        // Arrange
        let pms = vec![
            test_pm("npm", "8.0.0"),
            test_pm("pip", "22.0"),
            test_pm("cargo", "1.70.0"),
        ];

        // Act
        let grouped = Grouper::by_name(pms.clone());

        // Assert
        assert_eq!(grouped.len(), 3);
        for group in &grouped {
            assert_eq!(group.alternatives, "-");
            assert_eq!(group.alternative_paths.len(), 0);
        }

        // Act
        let primary = Grouper::primary_only(pms);

        // Assert
        assert_eq!(primary.len(), 3);
    }

    #[test]
    fn test_sort_by_name() {
        // Arrange
        let pms = vec![
            test_pm("pip", "22.0"),
            test_pm("cargo", "1.70.0"),
            test_pm("npm", "8.0.0"),
            test_pm("zig", "0.11.0"),
            test_pm("asdf", "0.10.0"),
        ];

        // Act
        let sorted = Sorter::by_name(pms);

        // Assert
        assert_eq!(sorted[0].name, "asdf");
        assert_eq!(sorted[1].name, "cargo");
        assert_eq!(sorted[2].name, "npm");
        assert_eq!(sorted[3].name, "pip");
        assert_eq!(sorted[4].name, "zig");
    }

    #[test]
    fn test_sort_by_name_empty() {
        let pms = vec![];
        let sorted = Sorter::by_name(pms);
        assert_eq!(sorted.len(), 0);
    }

    #[test]
    fn test_sort_by_category() {
        // Arrange
        let pms = vec![
            test_pm("npm", "8.0.0"),        // JavaScript
            test_pm("pip", "22.0"),         // Python
            test_pm("brew", "4.0.0"),       // System
            test_pm("cargo", "1.70.0"),     // Rust
            test_pm("unknown-pm", "1.0.0"), // Unknown
        ];

        let sorted = Sorter::by_category(pms);

        // System should come first (based on Category::all() order)
        assert_eq!(sorted[0].name, "brew");

        // Within same category, should be sorted by name
        let names: Vec<String> = sorted.iter().map(|pm| pm.name.clone()).collect();
        assert!(
            names.iter().position(|n| n == "brew").unwrap()
                < names.iter().position(|n| n == "npm").unwrap()
        );
    }

    #[test]
    fn test_sort_by_category_same_category() {
        // Arrange
        let pms = vec![
            test_pm("yarn", "1.0.0"),
            test_pm("npm", "8.0.0"),
            test_pm("pnpm", "7.0.0"),
            test_pm("bun", "1.0.0"),
        ];

        // Act
        let sorted = Sorter::by_category(pms);

        // Assert: all are JavaScript, so should be sorted by name
        assert_eq!(sorted[0].name, "bun");
        assert_eq!(sorted[1].name, "npm");
        assert_eq!(sorted[2].name, "pnpm");
        assert_eq!(sorted[3].name, "yarn");
    }

    #[test]
    fn test_grouper_by_name_with_install_methods() {
        // Arrange
        let pms = vec![
            PmInfo {
                name: "npm".to_string(),
                version: "8.0.0".to_string(),
                path: "/usr/bin/npm".to_string(),
                install_method: InstallMethod::Unknown,
                latest_version: None,
            },
            PmInfo {
                name: "npm".to_string(),
                version: "9.0.0".to_string(),
                path: "/usr/local/bin/npm".to_string(),
                install_method: InstallMethod::System,
                latest_version: None,
            },
        ];

        // Act
        let grouped = Grouper::by_name(pms);

        // Assert
        assert_eq!(grouped.len(), 1);
        assert_eq!(grouped[0].name, "npm");
        assert_eq!(grouped[0].version, "8.0.0");
        assert_eq!(grouped[0].active_path, "/usr/bin/npm");
    }

    #[test]
    fn test_is_outdated_edge_cases() {
        // Arrange
        let detectors = all_package_managers();

        // Empty version
        let pm_empty = test_pm("npm", "");
        assert!(!Filter::is_outdated(&pm_empty, &detectors));

        // Whitespace version
        let pm_whitespace = test_pm("npm", "   ");
        assert!(!Filter::is_outdated(&pm_whitespace, &detectors));

        // Unknown PM (not in detector list)
        let pm_unknown = test_pm("unknown-tool", "1.0.0");
        assert!(!Filter::is_outdated(&pm_unknown, &detectors));
    }

    #[test]
    fn test_grouper_empty_list() {
        let grouped = Grouper::by_name(vec![]);
        assert_eq!(grouped.len(), 0);

        let primary = Grouper::primary_only(vec![]);
        assert_eq!(primary.len(), 0);
    }
}