blockwatch 0.2.27

Language agnostic linter that keeps your code and documentation in sync and valid
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
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
use similar::DiffOp;
use std::collections::{HashMap, VecDeque};
use std::ops::Range;
use std::path::PathBuf;
use std::str::FromStr;
use unidiff::{Line, PatchSet, PatchedFile};

/// Represents a line change from a diff.
#[derive(Debug, Eq, PartialEq)]
pub struct LineChange {
    /// 1-based line number with a change.
    pub line: usize,
    /// Modified ranges in this line. Can only be `Some` for modified lines, not added or deleted.
    pub ranges: Option<Vec<Range<usize>>>, // TODO: consider making it 1-based to be consistent with `line`.
}

/// Extracts line changes from a unified diff patch string.
///
/// Parses a patch/diff string and extracts all line changes grouped by file path.
/// Deleted files are ignored and not included in the result.
pub fn line_changes_from_diff(
    patch_diff: &str,
) -> anyhow::Result<HashMap<PathBuf, Vec<LineChange>>> {
    let patch_set = PatchSet::from_str(patch_diff)?;
    let mut result = HashMap::new();
    for patched_file in patch_set {
        if patched_file.is_removed_file() {
            // Deleted files are ignored.
            continue;
        }
        result.insert(
            patched_file.target_file.trim_start_matches("b/").into(),
            line_changes(&patched_file),
        );
    }
    Ok(result)
}

fn line_changes(patched_file: &PatchedFile) -> Vec<LineChange> {
    let mut line_changes = Vec::new();
    let mut deleted_lines: VecDeque<&Line> = VecDeque::new();
    let mut prev_line = None;
    for hunk in patched_file.hunks() {
        for line in hunk.lines() {
            if line.is_added() {
                if let Some(deleted_line) = deleted_lines.pop_front() {
                    // This is a modified line. Find modified ranges in it.
                    let ranges = line_diff(&deleted_line.value, &line.value);
                    line_changes.push(LineChange {
                        line: line.target_line_no.unwrap(),
                        ranges: Some(ranges),
                    });
                } else {
                    // This is a new (added) line.
                    line_changes.push(LineChange {
                        line: line.target_line_no.unwrap(),
                        ranges: None,
                    });
                }
            } else if line.is_removed() {
                deleted_lines.push_back(line);
            } else if line.is_context() {
                clear_or_fold_deleted_lines(&prev_line, &mut deleted_lines, &mut line_changes);
            }
            prev_line = Some(line);
        }
        clear_or_fold_deleted_lines(&prev_line, &mut deleted_lines, &mut line_changes);
    }
    line_changes
}

/// Returns sorted character ranges in `new` that represent changes from `old`.
fn line_diff(old: &str, new: &str) -> Vec<Range<usize>> {
    let mut result = Vec::new();
    let diff = similar::TextDiff::from_chars(old, new);
    let mut prev_op = None;
    for op in diff.ops() {
        match op {
            DiffOp::Delete { new_index, .. } => {
                if prev_op.is_none_or(|c: &DiffOp| !matches!(c, DiffOp::Delete { .. })) {
                    let idx = new.len().saturating_sub(1).min(*new_index);
                    push_or_merge_range(&mut result, idx..idx + 1);
                }
            }
            DiffOp::Insert {
                new_index, new_len, ..
            } => {
                push_or_merge_range(&mut result, *new_index..(new_index + new_len));
            }
            DiffOp::Replace {
                new_index, new_len, ..
            } => {
                push_or_merge_range(&mut result, *new_index..(new_index + new_len));
            }
            DiffOp::Equal { .. } => {}
        }
        prev_op = Some(op);
    }
    result
}

fn push_or_merge_range(ranges: &mut Vec<Range<usize>>, mut new: Range<usize>) {
    if let Some(overlapping) =
        // Contiguous ranges are also merged (e.g. [6, 8) and [8, 10) -> [6, 10)).
        ranges.pop_if(|range| new.start <= range.end && new.end >= range.start)
    {
        let start = new.start.min(overlapping.start);
        let end = new.end.max(overlapping.end);
        new = start..end;
    }
    ranges.push(new);
    // Sink the new/merged range to its sorted position.
    let mut i = ranges.len() - 1;
    while i > 0 && ranges[i].start < ranges[i - 1].start {
        ranges.swap(i, i - 1);
        i -= 1;
    }
}

/// Pushes the first deleted line to the `line_changes` and deletes all the rest.
fn fold_deleted_lines(deleted_lines: &mut VecDeque<&Line>, line_changes: &mut Vec<LineChange>) {
    if let Some(deleted_line) = deleted_lines.pop_front() {
        line_changes.push(LineChange {
            line: deleted_line.source_line_no.unwrap(),
            ranges: None,
        })
    }
    deleted_lines.clear()
}

/// Clears `deleted_lines` if `prev_line` is a new line, folds them otherwise.
fn clear_or_fold_deleted_lines(
    prev_line: &Option<&Line>,
    deleted_lines: &mut VecDeque<&Line>,
    line_changes: &mut Vec<LineChange>,
) {
    if prev_line.is_some_and(|prev: &Line| prev.is_added()) {
        // Consecutive deleted lines followed by a new line is a single modified line and
        // should already be handled by the new line handler.
        deleted_lines.clear();
    } else {
        fold_deleted_lines(deleted_lines, line_changes);
    }
}

#[cfg(test)]
mod modified_line_ranges_tests {
    use super::*;

    #[test]
    fn equal_lines_returns_empty_ranges() {
        let ranges = line_diff("box", "box");

        assert!(ranges.is_empty());
    }

    #[test]
    fn replaced_nonconsecutive_characters_returns_separate_ranges() {
        let ranges = line_diff("box", "for");

        assert_eq!(ranges, vec![0..1, 2..3]);
    }

    #[test]
    fn replaced_consecutive_characters_returns_merged_ranges() {
        let ranges = line_diff("boxes", "faxed");

        assert_eq!(ranges, vec![0..2, 4..5]);
    }

    #[test]
    fn inserted_nonconsecutive_characters_returns_separate_ranges() {
        let ranges = line_diff("box", "aboxa");

        assert_eq!(ranges, vec![0..1, 4..5]);
    }

    #[test]
    fn inserted_consecutive_characters_returns_merged_ranges() {
        let ranges = line_diff("box", "2 boxes");

        assert_eq!(ranges, vec![0..2, 5..7]);
    }

    #[test]
    fn deleted_consecutive_characters_in_the_beginning_are_treated_as_single() {
        let ranges = line_diff("abracadabra", "cadabra");

        assert_eq!(ranges, vec![0..1]);
    }

    #[test]
    fn deleted_consecutive_characters_in_the_end_are_treated_as_single() {
        let ranges = line_diff("abracadabra", "abra");

        assert_eq!(ranges, vec![3..4]);
    }

    #[test]
    fn deleted_consecutive_characters_are_treated_as_single() {
        let ranges = line_diff("abracadabra", "cdar");

        assert_eq!(ranges, vec![0..2, 3..4]);
    }

    #[test]
    fn mixed_ops_returns_correct_ranges() {
        let ranges = line_diff("there was three", "there is thora");

        assert_eq!(ranges, vec![6..7, 11..12, 13..14]);
    }
}

#[cfg(test)]
#[allow(clippy::single_range_in_vec_init)]
mod tests {
    use super::*;
    use std::collections::HashSet;

    /// Creates a whole line change (either added or deleted line).
    fn line_change(line: usize) -> LineChange {
        LineChange { line, ranges: None }
    }

    #[test]
    fn single_file_diff_extracts_ranges_for_single_file() -> anyhow::Result<()> {
        let ranges = line_changes_from_diff(
            r#"diff --git a/Cargo.toml b/Cargo.toml
index 8c34c48..23ddd69 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -9,6 +9,7 @@ tree-sitter = "0.25.3"
 tree-sitter-rust = "0.23"
 tree-sitter-java = "0.23.5"
 quick-xml = "0.37.2"
+diffy = "0.4.2"
 
 [build-dependencies]
 cc="1.2.16"
\ No newline at end of file"#,
        )?;
        assert_eq!(ranges.keys().collect::<Vec<_>>(), vec!["Cargo.toml"]);
        Ok(())
    }

    #[test]
    fn multiple_files_diff_extracts_ranges_for_multiple_files() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/Cargo.toml b/Cargo.toml
index 8c34c48..23ddd69 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -9,6 +9,7 @@ tree-sitter = "0.25.3"
 tree-sitter-rust = "0.23"
 tree-sitter-java = "0.23.5"
 quick-xml = "0.37.2"
+diffy = "0.4.2"
 
 [build-dependencies]
 cc="1.2.16"
\ No newline at end of file
diff --git a/src/main.rs b/src/main.rs
index 63c5842..34d1d3f 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,4 +1,5 @@
 mod parsers;
+mod differ;
 
 fn main() {
     println!("Hello, world!");
diff --git a/src/differ.rs b/src/differ.rs
index e69de29..215ed53 100644
--- a/src/differ.rs
+++ b/src/differ.rs
@@ -0,0 +1,1 @@
+use std::collections::HashMap;
"#,
        )?;
        assert_eq!(
            line_changes
                .keys()
                .map(|k| k.to_str().unwrap())
                .collect::<HashSet<_>>(),
            HashSet::from(["Cargo.toml", "src/main.rs", "src/differ.rs"])
        );
        Ok(())
    }

    #[test]
    fn single_new_line_diff_returns_single_line_change() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..b4b0c67 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,5 @@
 one
 two
 three
+three and a half
 four"#,
        )?;
        assert_eq!(line_changes[&PathBuf::from("a.txt")], vec![line_change(4)]);
        Ok(())
    }

    #[test]
    fn single_first_new_line_diff_returns_single_line_change() -> anyhow::Result<()> {
        let ranges = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..fa220f8 100644
--- a/a.txt
+++ b/a.txt
@@ -1,3 +1,4 @@
+zero
 one
 two
 three"#,
        )?;
        assert_eq!(ranges[&PathBuf::from("a.txt")], vec![line_change(1)]);
        Ok(())
    }

    #[test]
    fn multiple_contiguous_new_lines_diff_returns_multiple_line_changes() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..3a7bc2a 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,6 @@
 one
 two
 three
+three and a half
+almost four
 four"#,
        )?;
        assert_eq!(
            line_changes[&PathBuf::from("a.txt")],
            vec![line_change(4), line_change(5),]
        );
        Ok(())
    }

    #[test]
    fn multiple_first_contiguous_new_lines_diff_returns_multiple_line_changes() -> anyhow::Result<()>
    {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..3ccae75 100644
--- a/a.txt
+++ b/a.txt
@@ -1,3 +1,5 @@
+sub-zero
+zero
 one
 two
 three"#,
        )?;
        assert_eq!(
            line_changes[&PathBuf::from("a.txt")],
            vec![line_change(1), line_change(2),]
        );
        Ok(())
    }

    #[test]
    fn multiple_non_contiguous_new_lines_diff_returns_multiple_line_changes() -> anyhow::Result<()>
    {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..e797e7c 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,6 @@
 one
 two
+two and a half
 three
+three and a half
 four"#,
        )?;
        assert_eq!(
            line_changes[&PathBuf::from("a.txt")],
            vec![line_change(3), line_change(5)]
        );
        Ok(())
    }

    #[test]
    fn multiple_contiguous_new_line_groups_diff_returns_multiple_line_changes() -> anyhow::Result<()>
    {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..ab47fb2 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,8 @@
 one
 two
+two and a half
+almost three
 three
+three and a half
+almost four
 four"#,
        )?;
        assert_eq!(
            line_changes[&PathBuf::from("a.txt")],
            vec![
                line_change(3),
                line_change(4),
                line_change(6),
                line_change(7),
            ]
        );
        Ok(())
    }

    #[test]
    fn modified_line_returns_single_line_change_with_ranges() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..e4c2829 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,4 @@
 one
 two
-there was three
+there is thora
 four"#,
        )?;
        assert_eq!(
            line_changes[&PathBuf::from("a.txt")],
            vec![LineChange {
                line: 3,
                // "i" in "is" was modified, "o" and "a" in "thora" were modified.
                ranges: Some(vec![6..7, 11..12, 13..14])
            }]
        );
        Ok(())
    }

    #[test]
    fn multiple_non_consecutive_modified_line_returns_separate_line_changes_with_ranges()
    -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..46c7533 100644
--- a/a.txt
+++ b/a.txt
@@ -1,5 +1,5 @@
-one
+modified one
 two
-three white rabbits
+three rabbits
 four
-five brown foxes
+five own boxes
 "#,
        )?;
        assert_eq!(
            line_changes[&PathBuf::from("a.txt")],
            vec![
                LineChange {
                    line: 1,
                    // "modified " was inserted.
                    ranges: Some(vec![0..9])
                },
                LineChange {
                    line: 3,
                    // "white " was deleted. Consecutive deletions are treated as single.
                    ranges: Some(vec![6..7])
                },
                LineChange {
                    line: 5,
                    // "br" from "brown" was deleted. "b" in "boxes" was modified.
                    ranges: Some(vec![5..6, 9..10])
                }
            ]
        );
        Ok(())
    }

    #[test]
    fn multiple_consecutive_modified_lines_returns_single_line_changes_with_ranges()
    -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..676cbb7 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,4 @@
 one
-two
-three
+modified two
+modified three
 four"#,
        )?;
        assert_eq!(
            line_changes[&PathBuf::from("a.txt")],
            vec![
                LineChange {
                    line: 2,
                    ranges: Some(vec![0..9])
                },
                LineChange {
                    line: 3,
                    ranges: Some(vec![0..9])
                }
            ]
        );
        Ok(())
    }

    #[test]
    fn all_lines_replaced_returns_single_line_changes_with_ranges() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..676cbb7 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,2 @@
-one
-two
-three
-four
+modified one
+modified two"#,
        )?;
        assert_eq!(
            line_changes[&PathBuf::from("a.txt")],
            vec![
                LineChange {
                    line: 1,
                    ranges: Some(vec![0..9])
                },
                LineChange {
                    line: 2,
                    ranges: Some(vec![0..9])
                }
            ]
        );
        Ok(())
    }

    #[test]
    fn single_deleted_line_returns_single_line_change() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..87a123c 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,3 @@
 one
 two
-three
 four"#,
        )?;
        assert_eq!(line_changes[&PathBuf::from("a.txt")], vec![line_change(3)]);
        Ok(())
    }

    #[test]
    fn single_first_deleted_line_returns_single_line_change() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..58ac960 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,3 @@
-one
 two
 three
 four"#,
        )?;
        assert_eq!(line_changes[&PathBuf::from("a.txt")], vec![line_change(1)]);
        Ok(())
    }

    #[test]
    fn single_last_deleted_line_returns_single_line_change() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..4cb29ea 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,3 @@
 one
 two
 three
-four"#,
        )?;
        assert_eq!(line_changes[&PathBuf::from("a.txt")], vec![line_change(4)]);
        Ok(())
    }

    #[test]
    fn multiple_non_consecutive_deleted_lines_returns_separate_line_changes() -> anyhow::Result<()>
    {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..8c05df4 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,2 @@
-one
 two
-three
 four"#,
        )?;
        assert_eq!(
            line_changes[&PathBuf::from("a.txt")],
            vec![line_change(1), line_change(3)]
        );
        Ok(())
    }

    #[test]
    fn multiple_consecutive_deleted_lines_returns_single_line_change() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..a9c7698 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,2 @@
 one
-two
-three
 four"#,
        )?;
        // Consecutive deleted lines are treated as a single one-line range because they no longer
        // exist in the target file.
        assert_eq!(line_changes[&PathBuf::from("a.txt")], vec![line_change(2)]);
        Ok(())
    }

    #[test]
    fn all_lines_deleted_treated_as_deleted_file() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..e69de29 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +0,0 @@
-one
-two
-three
-four"#,
        )?;
        assert!(line_changes.is_empty());
        Ok(())
    }

    #[test]
    fn mixed_changes_returns_correct_line_changes() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
index f384549..58a279e 100644
--- a/a.txt
+++ b/a.txt
@@ -1,4 +1,5 @@
-one
+modified one
 two
-three
-four
+modified three
+modified four
+added five"#,
        )?;
        assert_eq!(
            line_changes[&PathBuf::from("a.txt")],
            vec![
                LineChange {
                    line: 1,
                    ranges: Some(vec![0..9])
                },
                LineChange {
                    line: 3,
                    ranges: Some(vec![0..9])
                },
                LineChange {
                    line: 4,
                    ranges: Some(vec![0..9])
                },
                line_change(5)
            ]
        );
        Ok(())
    }

    #[test]
    fn new_file_diff_returns_line_changes_for_every_line() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/example.rs b/example.rs
new file mode 100644
index 0000000..710d1d9
--- /dev/null
+++ b/example.rs
@@ -0,0 +1,3 @@
+fn main() {
+    println!("New file");
+}
"#,
        )?;
        assert_eq!(
            line_changes[&PathBuf::from("example.rs")],
            vec![line_change(1), line_change(2), line_change(3)]
        );
        Ok(())
    }

    #[test]
    fn deleted_file_diff_is_ignored() -> anyhow::Result<()> {
        let line_changes = line_changes_from_diff(
            r#"diff --git a/a.txt b/a.txt
deleted file mode 100644
index f384549..0000000
--- a/a.txt
+++ /dev/null
@@ -1,4 +0,0 @@
-one
-two
-three
-four"#,
        )?;
        assert!(line_changes.is_empty());
        Ok(())
    }
}