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
mod encodings;
mod transforms;

use std::fmt;
use std::io::{self, Read, Write};

pub use self::encodings::{Encoding, EncodingChecker};
pub use self::transforms::{Transform, TransformMode};

const BUFFER_SIZE: usize = 4096;

/// Configuration for processing. Two things can be set: encoding of input and type of line ending.
///
/// ```
/// use std::io::Cursor;
///
/// use loe::{process, Config, Encoding, TransformMode};
///
/// let mut input = Cursor::new("hello\nworld!\n");
/// let expected = "hello\r\nworld!\r\n";
/// let mut output = Cursor::new(Vec::new());
///
/// process(&mut input, &mut output, Config::default().encoding(Encoding::Ascii).transform(TransformMode::Crlf));
/// let actual = String::from_utf8(output.into_inner()).unwrap();
/// assert_eq!(actual, expected);
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Config<E: Into<Box<dyn EncodingChecker>>, T: Into<Box<dyn Transform>>> {
    encoding_checker: E,
    transform_mode: T,
}

impl Config<Encoding, TransformMode> {
    /// Creates default instance of the config (no encoding, UTF-8).
    pub fn new() -> Self {
        Config {
            encoding_checker: Encoding::Ignore,
            transform_mode: TransformMode::Lf,
        }
    }
}

impl<E: Into<Box<dyn EncodingChecker>>, T: Into<Box<dyn Transform>>> Config<E, T> {
    /// Changes the encoding. Given value must be a type which implements
    /// Into<Box<dyn EncodingChecker>>. For more info, see documentation for
    /// [EncodingChecker](trait.EncodingChecker.html).
    pub fn encoding(self, encoding: E) -> Self {
        Config {
            encoding_checker: encoding,
            ..self
        }
    }

    /// Changes the transformation. Given value must be a type which implements
    /// Into<Box<dyn Transform>>. For more info, see documentation for
    /// [Transform](trait.Transform.html).
    pub fn transform(self, transform: T) -> Self {
        Config {
            transform_mode: transform,
            ..self
        }
    }
}

impl Default for Config<Encoding, TransformMode> {
    fn default() -> Self {
        Config::new()
    }
}

/// Error which can occur during processing.
#[derive(Debug)]
pub enum ParseError {
    /// The input is in invalid encoding. This enum variant also holds the name of expected
    /// encoding.
    InvalidEncoding(String),
    /// An I/O error occurred.
    IoError(io::Error),
}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            ParseError::InvalidEncoding(ref encoding) => {
                write!(f, "file is not in expected encoding '{}'", encoding)
            }
            ParseError::IoError(ref err) => write!(f, "{}", err),
        }
    }
}

impl std::error::Error for ParseError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            ParseError::InvalidEncoding(_) => None,
            ParseError::IoError(error) => Some(error),
        }
    }
}

/// The entry point of *loe*. It processes the given input and write the result into the given
/// output. Its behavior is dependent on given config.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// use std::io::Cursor;
///
/// use loe::{process, Config};
///
/// let mut input = Cursor::new("hello\r\nworld!\r\n");
/// let expected = "hello\nworld!\n";
/// let mut output = Cursor::new(Vec::new());
///
/// process(&mut input, &mut output, Config::default());
/// let actual = String::from_utf8(output.into_inner()).unwrap();
/// assert_eq!(actual, expected);
/// ```
///
/// Wrapping the function to convert string to string:
///
/// ```
/// use std::io::Cursor;
///
/// use loe::{process, Config};
///
/// fn convert(input: String) -> String {
///     let mut input = Cursor::new(input);
///     let mut output = Cursor::new(Vec::new());
///
///     process(&mut input, &mut output, Config::default());
///     String::from_utf8(output.into_inner()).unwrap()
/// }
///
/// assert_eq!(convert("hello\r\nworld!\r\n".to_string()), "hello\nworld!\n".to_string());
/// ```
pub fn process<I, O, E, T>(
    input: &mut I,
    output: &mut O,
    config: Config<E, T>,
) -> Result<(), ParseError>
where
    I: Read,
    O: Write,
    E: Into<Box<dyn EncodingChecker>> + fmt::Display,
    T: Into<Box<dyn Transform>>,
{
    let encoding_name = format!("{}", config.encoding_checker);
    let mut encoding: Box<dyn EncodingChecker> = config.encoding_checker.into();
    let mut transform: Box<dyn Transform> = config.transform_mode.into();

    let mut read_buffer = [0; BUFFER_SIZE];
    let mut write_buffer = [0; 2 * BUFFER_SIZE];

    while let Ok(n) = input.read(&mut read_buffer) {
        if n == 0 {
            break;
        }

        let mut out_ptr = 0;
        for in_ptr in 0..n {
            if !encoding.feed(read_buffer[in_ptr]) {
                return Err(ParseError::InvalidEncoding(encoding_name));
            }
            out_ptr = transform.transform_buffer(in_ptr, out_ptr, &read_buffer, &mut write_buffer);
        }

        output
            .write(&write_buffer[0..out_ptr])
            .map_err(ParseError::IoError)?;
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use proptest::{prop_assert, proptest, proptest_helper};
    use std::io::Cursor;

    const LF_BYTE: u8 = b'\n';
    const CR_BYTE: u8 = b'\r';

    #[test]
    fn basic() {
        let mut input = Cursor::new("hello\r\nworld!\r\n");
        let expected = "hello\nworld!\n";
        let mut output = Cursor::new(vec![0; expected.len()]);

        assert!(process(&mut input, &mut output, Config::default()).is_ok());
        let output = String::from_utf8(output.into_inner());
        assert!(output.is_ok());
        let output = output.unwrap();
        assert_eq!(output, expected);
    }

    fn filter(iterator: impl Iterator<Item = u8>) -> Vec<u8> {
        iterator
            .filter(|b| b != &LF_BYTE && b != &CR_BYTE)
            .collect()
    }

    proptest! {
        #[test]
        fn prop_lf(data in ".*") {
            let mut input = Cursor::new(data);
            let mut output = Cursor::new(Vec::<u8>::new());

            process(&mut input, &mut output, Config::default().transform(TransformMode::Lf)).unwrap();

            let output = output.into_inner();

            // no CR byte
            prop_assert!(!output.iter().any(|b| b == &CR_BYTE), "no CR byte");
        }

        #[test]
        fn prop_crlf(data in ".*") {
            let mut input = Cursor::new(data);
            let mut output = Cursor::new(Vec::<u8>::new());

            process(&mut input, &mut output, Config::default().transform(TransformMode::Crlf)).unwrap();

            let output = output.into_inner();

            // no LF byte
            prop_assert!(!output.iter().any(|b| b == &LF_BYTE), "no LF byte");
        }

        #[test]
        fn prop_inverse(data in "[^\\r]*") {
            let mut input = Cursor::new(data);
            let mut output = Cursor::new(Vec::<u8>::new());
            let mut output2 = Cursor::new(Vec::<u8>::new());

            process(&mut input, &mut output, Config::default().transform(TransformMode::Crlf)).unwrap();

            output.set_position(0);
            process(&mut output, &mut output2, Config::default().transform(TransformMode::Lf)).unwrap();

            let input = input.into_inner().bytes().collect::<Vec<_>>();
            let output = output2.into_inner();

            prop_assert!(input == output, "CRLF to LF and back");
        }


        #[test]
        fn prop_preserve_rest(data in ".*") {
            let input_filtered = filter(data.bytes());

            let mut input = Cursor::new(data);
            let mut output = Cursor::new(Vec::<u8>::new());
            let mut output2 = Cursor::new(Vec::<u8>::new());

            process(&mut input, &mut output, Config::default().transform(TransformMode::Lf)).unwrap();

            input.set_position(0);
            process(&mut input, &mut output2, Config::default().transform(TransformMode::Crlf)).unwrap();

            let output_filtered = filter(output.into_inner().into_iter());
            prop_assert!(input_filtered == output_filtered, "the rest is preserved (LF)");

            let output_filtered = filter(output2.into_inner().into_iter());
            prop_assert!(input_filtered == output_filtered, "the rest is preserved (CRLF)");
        }
    }
}