todo-ci 0.3.0

A simple CI/CD CLI tool for registering and checking todos in code with deadlines
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

use std::path::Path;

use chrono::{FixedOffset, NaiveDate};
use termcolor::{BufferWriter, ColorChoice};
use todo_ci::{
    cli::DisplayMode,
    core::{SearchResult, Todo, TodoState, TodoStatistics},
    display,
};


fn sample_todo_search_result() -> SearchResult {
    SearchResult {
        todos: vec![
            Todo {
                file: Path::new("./file.rs").into(),
                line_number: 3,
                date: Some(NaiveDate::from_ymd(2221, 7, 10)),
                description: String::from("Valid TODO on line 3"),
                state: TodoState::Valid,
            },
            Todo {
                file: Path::new("./file.rs").into(),
                line_number: 5,
                date: Some(NaiveDate::from_ymd(1990, 7, 10)),
                description: String::from("Expired TODO on line 5"),
                state: TodoState::Overdue,
            },
            Todo {
                file: Path::new("./file.rs").into(),
                line_number: 7,
                date: None,
                description: String::from("XX is not a valid date."),
                state: TodoState::Malformed,
            },
        ],
        statistics: TodoStatistics {
            files_searched: 1,
            valid_todo_count: 1,
            overdue_todo_count: 1,
            malformed_todo_count: 1,
        },
    }
}

#[test]
fn test_default_terminal_output() {
    // ColorChoice::Never removes the noisy ANSI escape codes making for easier assertions
    let bufwtr = BufferWriter::stdout(ColorChoice::Never);
    let mut buffer = bufwtr.buffer();

    display::print(
        &mut buffer,
        DisplayMode::Default,
        &sample_todo_search_result(),
        &FixedOffset::west(0),
    );

    let output = String::from_utf8_lossy(buffer.as_slice());

    // Assertions are intentionally not very specific -
    // otherwise they would just break often even on minor changes to the printer 
    assert!(output.contains("Valid TODO on line 3"));
    assert!(output.contains("Expired TODO on line 5"));
    assert!(output.contains("XX is not a valid date."));

    assert!(output.contains("Searched 1 file(s):"));
    assert!(output.contains("2 todo(s) found of which 1 is/are overdue"));
}

#[test]
fn test_overdue_only_terminal_output() {
    // ColorChoice::Never removes the noisy ANSI escape codes making for easier assertions
    let bufwtr = BufferWriter::stdout(ColorChoice::Never);
    let mut buffer = bufwtr.buffer();

    display::print(
        &mut buffer,
        DisplayMode::OverdueOnly,
        &sample_todo_search_result(),
        &FixedOffset::west(0),
    );

    let output = String::from_utf8_lossy(buffer.as_slice());

    // Assertions are intentionally not very specific -
    // otherwise they would just break often even on minor changes to the printer 
    assert!(!output.contains("Valid TODO on line 3"));
    assert!(output.contains("Expired TODO on line 5"));
    assert!(!output.contains("XX is not a valid date."));

    assert!(output.contains("Searched 1 file(s):"));
    assert!(output.contains("2 todo(s) found of which 1 is/are overdue"));
}

#[test]
fn test_concise_terminal_output() {
    // ColorChoice::Never removes the noisy ANSI escape codes making for easier assertions
    let bufwtr = BufferWriter::stdout(ColorChoice::Never);
    let mut buffer = bufwtr.buffer();

    display::print(
        &mut buffer,
        DisplayMode::Concise,
        &sample_todo_search_result(),
        &FixedOffset::west(0),
    );

    let output = String::from_utf8_lossy(buffer.as_slice());

    // Assertions are intentionally not very specific -
    // otherwise they would just break often even on minor changes to the printer 
    assert!(!output.contains("Valid TODO on line 3"));
    assert!(!output.contains("Expired TODO on line 5"));
    assert!(!output.contains("XX is not a valid date."));

    assert!(output.contains("Searched 1 file(s):"));
    assert!(output.contains("2 todo(s) found of which 1 is/are overdue"));
}