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
use std::{
    fs::File,
    io::{BufRead, BufReader},
    vec,
};

use clap::parser::ValuesRef;

/// Viewer struct used to perform view operations on file buffers.
#[derive(Default)]
pub struct Viewer {
    keywords: Option<Vec<String>>,
    line_range: Option<Vec<usize>>,
    #[allow(dead_code)]
    date_range: Option<Vec<String>>,
    head: Option<usize>,
    #[allow(dead_code)]
    all: Option<bool>,
    any: Option<bool>,
}

impl Viewer {
    pub fn new(
        keywords: Option<ValuesRef<'_, String>>,
        line_range: Option<ValuesRef<'_, usize>>,
        date_range: Option<ValuesRef<'_, String>>,
        head: Option<&usize>,
        all: Option<&bool>,
        any: Option<&bool>,
    ) -> Viewer {
        let mut _keywords = None;
        let mut _line_range = None;
        let mut _date_range = None;
        let mut _head = None;
        let mut _all = None;
        let mut _any = None;

        if let Some(v) = keywords {
            _keywords = Some(v.into_iter().cloned().collect());
        }
        if let Some(v) = line_range {
            _line_range = Some(v.into_iter().cloned().collect());
        }
        if let Some(v) = date_range {
            _date_range = Some(v.into_iter().cloned().collect());
        }
        if let Some(v) = head {
            _head = Some(*v);
        }
        if let Some(v) = all {
            _all = Some(*v);
        }
        if let Some(v) = any {
            _any = Some(*v);
        }

        Viewer {
            keywords: _keywords,
            line_range: _line_range,
            date_range: _date_range,
            head: _head,
            all: _all,
            any: _any,
        }
    }

    /// Filter enumerated lines for line numbers selected by the line range.
    fn filter_with_line_range(
        &self,
        lines: &[(usize, String)],
        range: &Vec<usize>,
    ) -> Result<Vec<(usize, String)>, &str> {
        // The range given is invalid if it has more than two values.
        // TODO: Should this be a panic?
        if range.len() > 2 {
            return Err("The range provided has more than two elements.");
        }

        let res = lines
            .iter()
            .filter(|(i, _)| {
                // If line range is only one value skip ln if it's not the selected ln.
                if range.len() == 1 && *i != range[0] {
                    return false;
                }

                // If line range is two values then skip ln if it's outside the range selected.
                if range.len() == 2 && (*i < range[0] || *i > range[1]) {
                    return false;
                }

                true
            })
            .into_iter()
            .cloned()
            .collect();

        Ok(res)
    }

    /// Filter enumerated lines containing keywords depending on a desired evaulation strategy (eval).
    /// An eval can be "all" or "any".
    fn filter_with_keywords(
        &self,
        lines: &[(usize, String)],
        keywords: &[String],
        eval: &str, // TODO: Use clap-recognizable enum
    ) -> Result<Vec<(usize, String)>, &str> {
        // Filter lines for lines that contain any of the keywords indicated by caller.
        let res = lines
            .iter()
            .filter(|(_, l)| string_contains_vec_elements(l, keywords, eval))
            .into_iter()
            .cloned()
            .collect();

        Ok(res)
    }

    /// Display the entire file.
    fn display_lines(&self, lines: &[(usize, String)]) -> Result<(), &str> {
        // If no lines are collected correctly display nothing.
        // TODO: Maybe panic.
        if lines.is_empty() {
            return Ok(());
        }

        // Last line number (assumed sorted ascending) determines line number padding.
        let last_ln = lines[lines.len() - 1].0;

        // Display each line numbered with padding based on the number of lines collected.
        // TODO: Could use generic binary search fn to calculate digits without conversion.
        for (i, line) in lines {
            println!(
                "ln{:0width$} {}",
                i,
                line,
                width = last_ln.to_string().len()
            );
        }

        Ok(())
    }

    /// Display with viewer function to display the file via its `BufReader`.
    // TODO:
    //       - Validation and error handling.
    //       - Use Enum eval.
    pub fn display_with(&self, buffer: &mut BufReader<File>) -> Result<(), &str> {
        // Collect enumerated lines.
        let mut lines: Vec<(usize, String)> = buffer.lines().flatten().enumerate().collect();
        // TODO: Enum.
        let mut eval = "all";

        // Update eval if 'any' provided.
        if let Some(any) = self.any {
            if any {
                eval = "any"
            }
        }

        // Return head view if one is provided.
        if let Some(head) = &self.head {
            let range = vec![0, head - 1];
            lines = self.filter_with_line_range(&lines, &range)?;
        }

        // Filter using ranges if provided.
        if let Some(range) = &self.line_range {
            lines = self.filter_with_line_range(&lines, range)?;
        }

        if let Some(keywords) = &self.keywords {
            lines = self.filter_with_keywords(&lines, keywords, eval)?;
        }

        self.display_lines(&lines)
    }
}

/// Check string for "any" or "all" (eval) elements from vector. Return true of eval is met, otherwise return false.
// TODO: Use Result and eval Enum.
fn string_contains_vec_elements(string: &str, vec: &[String], eval: &str) -> bool {
    if eval == "all" {
        return vec.iter().all(|e| string.contains(e));
    }

    if eval == "any" {
        return vec.iter().any(|e| string.contains(e));
    }

    false
}

#[test]
fn test_viewer_none() {
    let viewer = Viewer::default();

    assert_eq!(viewer.line_range, None);
    assert_eq!(viewer.date_range, None);
    assert_eq!(viewer.keywords, None);
}

#[test]
fn test_viewer_keywords() {
    let viewer = Viewer::default();
    let lines = vec![
        (0, "first".to_string()),
        (1, "second".to_string()),
        (2, "foo".to_string()),
    ];
    let keywords = vec!["foo".to_string()];

    if let Ok(res) = viewer.filter_with_keywords(&lines, &keywords, "all") {
        assert_eq!(res, vec![(2, "foo".to_string())]);
        return;
    } else {
        // Fail if result didn't return Ok.
        assert!(false);
    }
}

#[test]
fn test_viewer_line_range() {
    let viewer = Viewer::default();
    let lines = vec![
        (0, "first".to_string()),
        (1, "second".to_string()),
        (2, "third".to_string()),
    ];
    let range1 = vec![0];
    let range2 = vec![1, 2];

    // Test with one value.
    if let Ok(res) = viewer.filter_with_line_range(&lines, &range1) {
        assert_eq!(res, vec![(0, "first".to_string())]);
    } else {
        // Fail if result didn't return Ok.
        assert!(false);
    }

    // Test with two values.
    if let Ok(res) = viewer.filter_with_line_range(&lines, &range2) {
        assert_eq!(
            res,
            vec![(1, "second".to_string()), (2, "third".to_string())]
        );
    } else {
        // Fail if result didn't return Ok.
        assert!(false);
    }
}