termdiff 4.1.1

Write a diff with color codes to a string
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
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

use super::*;
use crate::{diff_with_algorithm, ArrowsTheme, DrawDiff, SignsTheme};
#[cfg(test)]
use std::io::Cursor;

/// Test that the Myers algorithm produces the same output as the Similar algorithm
/// for a simple case
#[test]
#[cfg(all(feature = "myers", feature = "similar"))]
fn test_myers_vs_similar_simple() {
    let old = "The quick brown fox";
    let new = "The quick red fox";
    let theme = ArrowsTheme::default();

    // Get output from Similar algorithm
    let similar_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Similar)
    );

    // Get output from Myers algorithm
    let myers_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Myers)
    );

    // They should be the same
    assert_eq!(similar_output, myers_output);
}

/// Test that the Myers algorithm produces the same output as the Similar algorithm
/// for a multiline case
#[test]
#[cfg(all(feature = "myers", feature = "similar"))]
fn test_myers_vs_similar_multiline() {
    let old = "Line 1\nLine 2\nLine 3\nLine 4";
    let new = "Line 1\nModified Line 2\nLine 3\nModified Line 4";
    let theme = SignsTheme::default();

    // Get output from Similar algorithm
    let similar_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Similar)
    );

    // Get output from Myers algorithm
    let myers_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Myers)
    );

    // They should be the same
    assert_eq!(similar_output, myers_output);
}

/// Test that the Myers algorithm produces the same output as the Similar algorithm
/// for a case with added lines
#[test]
#[cfg(all(feature = "myers", feature = "similar"))]
fn test_myers_vs_similar_added_lines() {
    let old = "Line 1\nLine 3";
    let new = "Line 1\nLine 2\nLine 3";
    let theme = ArrowsTheme::default();

    // Get output from Similar algorithm
    let similar_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Similar)
    );

    // Get output from Myers algorithm
    let myers_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Myers)
    );

    // They should be the same
    assert_eq!(similar_output, myers_output);
}

/// Test that the Myers algorithm produces the same output as the Similar algorithm
/// for a case with removed lines
#[test]
#[cfg(all(feature = "myers", feature = "similar"))]
fn test_myers_vs_similar_removed_lines() {
    let old = "Line 1\nLine 2\nLine 3";
    let new = "Line 1\nLine 3";
    let theme = ArrowsTheme::default();

    // Get output from Similar algorithm
    let similar_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Similar)
    );

    // Get output from Myers algorithm
    let myers_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Myers)
    );

    // They should be the same
    assert_eq!(similar_output, myers_output);
}

/// Test that the Myers algorithm produces the same output as the Similar algorithm
/// for a case with trailing newline differences
#[test]
#[cfg(all(feature = "myers", feature = "similar"))]
fn test_myers_vs_similar_trailing_newline() {
    let old = "Line 1\nLine 2\n";
    let new = "Line 1\nLine 2";
    let theme = ArrowsTheme::default();

    // Get output from Similar algorithm
    let similar_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Similar)
    );

    // Get output from Myers algorithm
    let myers_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Myers)
    );

    // They should be the same
    assert_eq!(similar_output, myers_output);
}

/// Test that the Myers algorithm produces the same output as the Similar algorithm
/// for a case with empty inputs
#[test]
#[cfg(all(feature = "myers", feature = "similar"))]
fn test_myers_vs_similar_empty() {
    let old = "";
    let new = "";
    let theme = ArrowsTheme::default();

    // Get output from Similar algorithm
    let similar_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Similar)
    );

    // Get output from Myers algorithm
    let myers_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Myers)
    );

    // They should be the same
    assert_eq!(similar_output, myers_output);
}

/// Test that the Myers algorithm produces the same output as the Similar algorithm
/// for a case with completely different inputs
#[test]
#[cfg(all(feature = "myers", feature = "similar"))]
fn test_myers_vs_similar_completely_different() {
    let old = "This is completely different";
    let new = "From this text";
    let theme = ArrowsTheme::default();

    // Get output from Similar algorithm
    let similar_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Similar)
    );

    // Get output from Myers algorithm
    let myers_output = format!(
        "{}",
        DrawDiff::with_algorithm(old, new, &theme, Algorithm::Myers)
    );

    // They should be the same
    assert_eq!(similar_output, myers_output);
}

/// Test that the `diff_with_algorithm` function works with the Myers algorithm
#[test]
#[cfg(feature = "myers")]
fn test_diff_with_algorithm_myers() {
    let old = "The quick brown fox";
    let new = "The quick red fox";
    let mut buffer = Cursor::new(Vec::new());
    let theme = ArrowsTheme::default();

    diff_with_algorithm(&mut buffer, old, new, &theme, Algorithm::Myers).unwrap();

    let output = String::from_utf8(buffer.into_inner()).expect("Not valid UTF-8");
    // Verify the theme's arrow prefixes are present
    assert!(output.contains("<The quick brown fox"));
    assert!(output.contains(">The quick red fox"));
}

/// Test that the `diff_with_algorithm` function works with the Similar algorithm
#[test]
#[cfg(feature = "similar")]
fn test_diff_with_algorithm_similar() {
    let old = "The quick brown fox";
    let new = "The quick red fox";
    let mut buffer = Cursor::new(Vec::new());
    let theme = ArrowsTheme::default();

    diff_with_algorithm(&mut buffer, old, new, &theme, Algorithm::Similar).unwrap();

    let output = String::from_utf8(buffer.into_inner()).expect("Not valid UTF-8");
    // Verify the theme's arrow prefixes are present
    assert!(output.contains("<The quick brown fox"));
    assert!(output.contains(">The quick red fox"));
}