debtmap 0.16.4

Code complexity and technical debt analyzer
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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
//! Navigation action functions for the TUI.
//!
//! This module contains the navigation action functions that perform
//! state transitions. These are separated from `nav_state.rs` to keep
//! the state module focused on the NavigationState struct and pure guards.
//!
//! # Design
//!
//! Each navigation action:
//! 1. Validates the transition against the transition table
//! 2. Checks guards for preconditions
//! 3. Updates state on success
//! 4. Returns a NavigationResult indicating success/failure

use super::nav_state::{
    can_enter_detail, can_enter_filter_menu, can_enter_help, can_enter_search, can_enter_sort_menu,
    can_go_back, can_navigate_detail_pages, is_valid_transition, NavigationResult, NavigationState,
};
use super::{detail_page::DetailPage, view_mode::ViewMode};

/// Navigate to Detail view.
pub fn navigate_to_detail(
    state: &mut NavigationState,
    has_items: bool,
    has_selection: bool,
) -> NavigationResult {
    if !is_valid_transition(state.view_mode, ViewMode::Detail) {
        return NavigationResult::Invalid {
            from: state.view_mode,
            to: ViewMode::Detail,
        };
    }

    if !can_enter_detail(state.view_mode, has_items, has_selection) {
        return NavigationResult::Blocked {
            reason: "No item selected",
        };
    }

    state.history.push(state.view_mode);
    state.view_mode = ViewMode::Detail;
    state.detail_page = DetailPage::Overview;

    NavigationResult::Success
}

/// Navigate to Search view.
pub fn navigate_to_search(state: &mut NavigationState) -> NavigationResult {
    if !is_valid_transition(state.view_mode, ViewMode::Search) {
        return NavigationResult::Invalid {
            from: state.view_mode,
            to: ViewMode::Search,
        };
    }

    if !can_enter_search(state.view_mode) {
        return NavigationResult::Blocked {
            reason: "Search only available from List view",
        };
    }

    state.history.push(state.view_mode);
    state.view_mode = ViewMode::Search;

    NavigationResult::Success
}

/// Navigate to SortMenu view.
pub fn navigate_to_sort_menu(state: &mut NavigationState) -> NavigationResult {
    if !is_valid_transition(state.view_mode, ViewMode::SortMenu) {
        return NavigationResult::Invalid {
            from: state.view_mode,
            to: ViewMode::SortMenu,
        };
    }

    if !can_enter_sort_menu(state.view_mode) {
        return NavigationResult::Blocked {
            reason: "Sort menu only available from List view",
        };
    }

    state.history.push(state.view_mode);
    state.view_mode = ViewMode::SortMenu;

    NavigationResult::Success
}

/// Navigate to FilterMenu view.
pub fn navigate_to_filter_menu(state: &mut NavigationState) -> NavigationResult {
    if !is_valid_transition(state.view_mode, ViewMode::FilterMenu) {
        return NavigationResult::Invalid {
            from: state.view_mode,
            to: ViewMode::FilterMenu,
        };
    }

    if !can_enter_filter_menu(state.view_mode) {
        return NavigationResult::Blocked {
            reason: "Filter menu only available from List view",
        };
    }

    state.history.push(state.view_mode);
    state.view_mode = ViewMode::FilterMenu;

    NavigationResult::Success
}

/// Navigate to Help view.
pub fn navigate_to_help(state: &mut NavigationState) -> NavigationResult {
    if !can_enter_help(state.view_mode) {
        return NavigationResult::Blocked {
            reason: "Already in Help view",
        };
    }

    // Help can be accessed from most views, so we don't check transition table strictly
    state.history.push(state.view_mode);
    state.view_mode = ViewMode::Help;

    NavigationResult::Success
}

/// Navigate back (escape).
pub fn navigate_back(state: &mut NavigationState) -> NavigationResult {
    if let Some(previous) = state.history.pop() {
        state.view_mode = previous;
        NavigationResult::Success
    } else if state.view_mode != ViewMode::List {
        state.view_mode = ViewMode::List;
        NavigationResult::Success
    } else {
        NavigationResult::Blocked {
            reason: "Already at root view",
        }
    }
}

/// Navigate detail pages (left/right).
pub fn navigate_detail_page(state: &mut NavigationState, forward: bool) -> NavigationResult {
    if !can_navigate_detail_pages(state.view_mode) {
        return NavigationResult::Blocked {
            reason: "Not in Detail view",
        };
    }

    state.detail_page = if forward {
        state.detail_page.next()
    } else {
        state.detail_page.prev()
    };

    NavigationResult::Success
}

/// Get available actions for current state (for status bar display).
pub fn available_actions(
    state: &NavigationState,
    has_items: bool,
    has_selection: bool,
) -> Vec<(&'static str, &'static str)> {
    let mut actions = vec![];

    if can_enter_detail(state.view_mode, has_items, has_selection) {
        actions.push(("Enter", "View details"));
    }

    if can_enter_search(state.view_mode) {
        actions.push(("/", "Search"));
    }

    if can_enter_sort_menu(state.view_mode) {
        actions.push(("s", "Sort"));
    }

    if can_enter_filter_menu(state.view_mode) {
        actions.push(("f", "Filter"));
    }

    if can_enter_help(state.view_mode) {
        actions.push(("?", "Help"));
    }

    if can_go_back(state.view_mode, state.history.len()) {
        actions.push(("Esc", "Back"));
    }

    actions.push(("q", "Quit"));

    actions
}

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

    // ============================================================================
    // Navigation Action Tests
    // ============================================================================

    #[test]
    fn test_navigate_to_detail_success() {
        let mut state = NavigationState::new();

        let result = navigate_to_detail(&mut state, true, true);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::Detail);
        assert_eq!(state.history.len(), 1);
        assert_eq!(state.history[0], ViewMode::List);
    }

    #[test]
    fn test_navigate_to_detail_blocked_no_selection() {
        let mut state = NavigationState::new();

        let result = navigate_to_detail(&mut state, true, false);
        assert!(matches!(result, NavigationResult::Blocked { .. }));
        assert_eq!(state.view_mode, ViewMode::List);
        assert!(state.history.is_empty());
    }

    #[test]
    fn test_navigate_to_detail_invalid_from_detail() {
        let mut state = NavigationState::new();
        state.view_mode = ViewMode::Detail;

        let result = navigate_to_detail(&mut state, true, true);
        assert!(matches!(result, NavigationResult::Invalid { .. }));
    }

    #[test]
    fn test_navigate_to_search_success() {
        let mut state = NavigationState::new();

        let result = navigate_to_search(&mut state);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::Search);
    }

    #[test]
    fn test_navigate_to_search_invalid_from_detail() {
        let mut state = NavigationState::new();
        state.view_mode = ViewMode::Detail;

        let result = navigate_to_search(&mut state);
        assert!(matches!(result, NavigationResult::Invalid { .. }));
    }

    #[test]
    fn test_navigate_back_uses_history() {
        let mut state = NavigationState::new();

        // Navigate List -> Detail
        navigate_to_detail(&mut state, true, true);
        assert_eq!(state.view_mode, ViewMode::Detail);

        // Navigate Detail -> Help
        navigate_to_help(&mut state);
        assert_eq!(state.view_mode, ViewMode::Help);

        // Back goes to Detail (not List)
        navigate_back(&mut state);
        assert_eq!(state.view_mode, ViewMode::Detail);

        // Back goes to List
        navigate_back(&mut state);
        assert_eq!(state.view_mode, ViewMode::List);
    }

    #[test]
    fn test_navigate_back_blocked_at_root() {
        let mut state = NavigationState::new();

        let result = navigate_back(&mut state);
        assert!(matches!(result, NavigationResult::Blocked { .. }));
    }

    #[test]
    fn test_navigate_back_without_history() {
        let mut state = NavigationState::new();
        state.view_mode = ViewMode::Detail;

        // No history but not at root - should go to List
        let result = navigate_back(&mut state);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::List);
    }

    #[test]
    fn test_navigate_detail_page() {
        let mut state = NavigationState::new();
        state.view_mode = ViewMode::Detail;
        state.detail_page = DetailPage::Overview;

        // Forward: Overview -> ScoreBreakdown
        let result = navigate_detail_page(&mut state, true);
        assert!(result.is_success());
        assert_eq!(state.detail_page, DetailPage::ScoreBreakdown);

        // Backward: ScoreBreakdown -> Overview
        let result = navigate_detail_page(&mut state, false);
        assert!(result.is_success());
        assert_eq!(state.detail_page, DetailPage::Overview);
    }

    #[test]
    fn test_navigate_detail_page_blocked_outside_detail() {
        let mut state = NavigationState::new();

        let result = navigate_detail_page(&mut state, true);
        assert!(matches!(result, NavigationResult::Blocked { .. }));
    }

    // ============================================================================
    // Integration Tests
    // ============================================================================

    #[test]
    fn test_typical_user_flow() {
        let mut state = NavigationState::new();

        // User views list
        assert_eq!(state.view_mode, ViewMode::List);

        // User selects item and views detail
        let result = navigate_to_detail(&mut state, true, true);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::Detail);

        // User navigates detail pages (Overview -> ScoreBreakdown)
        let result = navigate_detail_page(&mut state, true);
        assert!(result.is_success());
        assert_eq!(state.detail_page, DetailPage::ScoreBreakdown);

        // User opens help
        let result = navigate_to_help(&mut state);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::Help);

        // User closes help (returns to detail)
        let result = navigate_back(&mut state);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::Detail);

        // User goes back to list
        let result = navigate_back(&mut state);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::List);
    }

    #[test]
    fn test_search_to_detail_flow() {
        let mut state = NavigationState::new();

        // Start search
        let result = navigate_to_search(&mut state);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::Search);

        // Select search result (goes to detail)
        let result = navigate_to_detail(&mut state, true, true);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::Detail);

        // Go back (should return to Search due to history)
        let result = navigate_back(&mut state);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::Search);
    }

    #[test]
    fn test_available_actions() {
        let state = NavigationState::new();

        let actions = available_actions(&state, true, true);

        // From List with items and selection, should have most actions
        let action_keys: Vec<_> = actions.iter().map(|(k, _)| *k).collect();
        assert!(action_keys.contains(&"Enter"));
        assert!(action_keys.contains(&"/"));
        assert!(action_keys.contains(&"s"));
        assert!(action_keys.contains(&"f"));
        assert!(action_keys.contains(&"?"));
        assert!(action_keys.contains(&"q"));
    }

    #[test]
    fn test_available_actions_detail_view() {
        let mut state = NavigationState::new();
        state.view_mode = ViewMode::Detail;
        state.history.push(ViewMode::List);

        let actions = available_actions(&state, true, true);

        // From Detail, should have fewer actions
        let action_keys: Vec<_> = actions.iter().map(|(k, _)| *k).collect();
        assert!(!action_keys.contains(&"/")); // No search from detail
        assert!(!action_keys.contains(&"s")); // No sort from detail
        assert!(action_keys.contains(&"Esc")); // Can go back
        assert!(action_keys.contains(&"?")); // Help available
    }

    #[test]
    fn test_navigate_to_sort_menu_success() {
        let mut state = NavigationState::new();

        let result = navigate_to_sort_menu(&mut state);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::SortMenu);
        assert_eq!(state.history.len(), 1);
    }

    #[test]
    fn test_navigate_to_filter_menu_success() {
        let mut state = NavigationState::new();

        let result = navigate_to_filter_menu(&mut state);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::FilterMenu);
        assert_eq!(state.history.len(), 1);
    }

    #[test]
    fn test_navigate_to_help_success() {
        let mut state = NavigationState::new();

        let result = navigate_to_help(&mut state);
        assert!(result.is_success());
        assert_eq!(state.view_mode, ViewMode::Help);
    }

    #[test]
    fn test_navigate_to_help_blocked_from_help() {
        let mut state = NavigationState::new();
        state.view_mode = ViewMode::Help;

        let result = navigate_to_help(&mut state);
        assert!(matches!(result, NavigationResult::Blocked { .. }));
    }
}

#[cfg(test)]
mod property_tests {
    use super::*;
    use proptest::prelude::*;

    /// Strategy for generating ViewMode values.
    fn view_mode_strategy() -> impl Strategy<Value = ViewMode> {
        prop_oneof![
            Just(ViewMode::List),
            Just(ViewMode::Detail),
            Just(ViewMode::Search),
            Just(ViewMode::SortMenu),
            Just(ViewMode::FilterMenu),
            Just(ViewMode::Help),
        ]
    }

    proptest! {
        /// Property: navigate_back from non-root without history goes to List.
        #[test]
        fn back_without_history_goes_to_list(mode in view_mode_strategy()) {
            if mode == ViewMode::List {
                return Ok(());
            }

            let mut state = NavigationState::new();
            state.view_mode = mode;
            // Intentionally don't push to history

            let result = navigate_back(&mut state);
            prop_assert!(result.is_success());
            prop_assert_eq!(state.view_mode, ViewMode::List);
        }

        /// Property: detail page navigation is cyclic.
        ///
        /// Navigating forward through all pages and back should preserve state.
        #[test]
        fn detail_page_navigation_cyclic(
            forward_count in 0usize..20
        ) {
            let mut state = NavigationState::new();
            state.view_mode = ViewMode::Detail;
            let initial_page = state.detail_page;

            // Navigate forward multiple times
            for _ in 0..forward_count {
                let _ = navigate_detail_page(&mut state, true);
            }

            // Navigate backward the same number of times
            for _ in 0..forward_count {
                let _ = navigate_detail_page(&mut state, false);
            }

            prop_assert_eq!(state.detail_page, initial_page);
        }
    }
}