semdiff-differ-text 0.1.0

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
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

use crate::{TextDiff, TextDiffReporter, is_text_file};
use askama::Template;
use semdiff_core::fs::FileLeaf;
use semdiff_core::{DetailReporter, MayUnsupported};
use semdiff_output::html::{HtmlReport, HtmlReportError};
use similar::ChangeTag;
use thiserror::Error;

const COMPARES_NAME: &str = "text";

#[derive(Debug, Error)]
pub enum TextDiffReportError {
    #[error("html report error: {0}")]
    HtmlReport(#[from] HtmlReportError),
}

#[derive(Template)]
#[template(path = "text_preview.html")]
struct TextPreviewTemplate<'a> {
    body: TextPreviewBody<'a>,
}

enum TextPreviewBody<'a> {
    Unchanged {
        body: &'a str,
    },
    Modified {
        diff: &'a similar::TextDiff<'a, 'a, 'a, [u8]>,
    },
    Added {
        body: &'a str,
    },
    Deleted {
        body: &'a str,
    },
}

impl TextPreviewTemplate<'_> {
    fn is_equal(change: &similar::Change<&[u8]>) -> bool {
        matches!(change.tag(), ChangeTag::Equal)
    }
}

#[derive(Template)]
#[template(path = "text_detail.html")]
struct TextDetailTemplate<'a> {
    detail: TextDetailBody<'a>,
}

enum TextDetailBody<'a> {
    Diff {
        lines: &'a similar::TextDiff<'a, 'a, 'a, [u8]>,
    },
    Single {
        label: &'a str,
        body: &'a str,
    },
}

impl TextDetailBody<'_> {
    fn is_multicolumn(&self) -> bool {
        matches!(self, TextDetailBody::Diff { .. })
    }
}

impl DetailReporter<TextDiff, FileLeaf, HtmlReport> for TextDiffReporter {
    type Error = TextDiffReportError;

    fn report_unchanged(
        &self,
        name: &str,
        diff: TextDiff,
        reporter: &HtmlReport,
    ) -> Result<MayUnsupported<()>, Self::Error> {
        let body = String::from_utf8_lossy(&diff.expected);
        let body = body.as_ref();
        let preview_html = TextPreviewTemplate {
            body: TextPreviewBody::Unchanged { body },
        };
        let detail_html = TextDetailTemplate {
            detail: TextDetailBody::Single { label: "same", body },
        };
        reporter.record_unchanged(name, COMPARES_NAME, preview_html, detail_html)?;
        Ok(MayUnsupported::Ok(()))
    }

    fn report_modified(
        &self,
        name: &str,
        diff: TextDiff,
        reporter: &HtmlReport,
    ) -> Result<MayUnsupported<()>, Self::Error> {
        let diff_view = diff.diff();
        let preview_html = TextPreviewTemplate {
            body: TextPreviewBody::Modified { diff: &diff_view },
        };
        let detail_html = TextDetailTemplate {
            detail: TextDetailBody::Diff { lines: &diff_view },
        };
        reporter.record_modified(name, COMPARES_NAME, preview_html, detail_html)?;
        Ok(MayUnsupported::Ok(()))
    }

    fn report_added(
        &self,
        name: &str,
        data: FileLeaf,
        reporter: &HtmlReport,
    ) -> Result<MayUnsupported<()>, Self::Error> {
        if !is_text_file(&data.kind, &data.content) {
            return Ok(MayUnsupported::Unsupported);
        }
        let actual_text = str::from_utf8(&data.content).expect("Invalid content");
        let preview_html = TextPreviewTemplate {
            body: TextPreviewBody::Added { body: actual_text },
        };
        let detail_html = TextDetailTemplate {
            detail: TextDetailBody::Single {
                label: "added",
                body: actual_text,
            },
        };
        reporter.record_added(name, COMPARES_NAME, preview_html, detail_html)?;
        Ok(MayUnsupported::Ok(()))
    }

    fn report_deleted(
        &self,
        name: &str,
        data: FileLeaf,
        reporter: &HtmlReport,
    ) -> Result<MayUnsupported<()>, Self::Error> {
        if !is_text_file(&data.kind, &data.content) {
            return Ok(MayUnsupported::Unsupported);
        }
        let expected_text = str::from_utf8(&data.content).expect("Invalid content");
        let preview_html = TextPreviewTemplate {
            body: TextPreviewBody::Deleted { body: expected_text },
        };
        let detail_html = TextDetailTemplate {
            detail: TextDetailBody::Single {
                label: "deleted",
                body: expected_text,
            },
        };
        reporter.record_deleted(name, COMPARES_NAME, preview_html, detail_html)?;
        Ok(MayUnsupported::Ok(()))
    }
}