semdiff-differ-text 0.4.2

Text diff calculator and reporters for semdiff.
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

use memmap2::Mmap;
use mime::Mime;
use semdiff_core::fs::FileLeaf;
use semdiff_core::{Diff, DiffCalculator, MayUnsupported};
use similar::TextDiffConfig;
use std::convert;
use std::sync::Arc;

pub mod report_html;
pub mod report_json;
pub mod report_summary;

#[cfg(test)]
mod tests;

pub struct TextDiffReporter;

#[derive(Debug)]
pub struct TextDiff {
    equal: bool,
    expected: Arc<Mmap>,
    actual: Arc<Mmap>,
}

impl Diff for TextDiff {
    fn equal(&self) -> bool {
        self.equal
    }
}

impl TextDiff {
    fn diff(&self) -> similar::TextDiff<'_, '_, [u8]> {
        text_diff_lines(&self.expected[..], &self.actual[..])
    }
}

fn text_diff_lines<'a>(expected: &'a [u8], actual: &'a [u8]) -> similar::TextDiff<'a, 'a, [u8]> {
    TextDiffConfig::default()
        .algorithm(similar::Algorithm::Patience)
        .diff_lines(expected, actual)
}

fn is_printable_text(text: &str) -> bool {
    text.chars()
        .all(|ch| !ch.is_control() || ch.is_ascii_whitespace() || (!ch.is_ascii() && ch.is_whitespace()))
}

fn is_text_file(kind: &Mime, body: &[u8]) -> bool {
    let Ok(text) = str::from_utf8(body) else {
        return false;
    };

    if is_text_mime(kind) {
        return true;
    }

    is_printable_text(text)
}

fn is_text_mime(kind: &Mime) -> bool {
    kind.type_() == mime::TEXT
        || matches!(
            kind.essence_str(),
            "application/json"
                | "application/xml"
                | "application/javascript"
                | "application/x-javascript"
                | "application/x-www-form-urlencoded"
                | "application/yaml"
                | "application/x-yaml"
                | "application/toml"
        )
}

#[derive(Default)]
pub struct TextDiffCalculator;

impl DiffCalculator<FileLeaf> for TextDiffCalculator {
    type Error = convert::Infallible;
    type Diff = TextDiff;

    fn diff(
        &self,
        _name: &str,
        expected: FileLeaf,
        actual: FileLeaf,
    ) -> Result<MayUnsupported<Self::Diff>, Self::Error> {
        'available: {
            let Ok(expected_str) = str::from_utf8(&expected.content) else {
                return Ok(MayUnsupported::Unsupported);
            };
            let Ok(actual_str) = str::from_utf8(&actual.content) else {
                return Ok(MayUnsupported::Unsupported);
            };

            if is_text_mime(&expected.kind) && is_text_mime(&actual.kind) {
                break 'available;
            }

            if !is_printable_text(expected_str) || !is_printable_text(actual_str) {
                return Ok(MayUnsupported::Unsupported);
            }
        }
        Ok(MayUnsupported::Ok(TextDiff {
            equal: <[u8] as PartialEq<[u8]>>::eq(&expected.content, &actual.content),
            expected: expected.content,
            actual: actual.content,
        }))
    }
}