dover 0.2.4

A CLI tool for summarizing git diffs of Rust code
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
use std::{collections::HashMap, fmt, ops::Range};

use syn::{
    ImplItem, ItemImpl, Path, Type,
    spanned::Spanned,
    token::{For, Not, Unsafe},
};

use crate::{
    ByteRange, Change, Code, Diff, ExistenceChange, SourceFile, View, ViewableDiff, ViewableDiffs,
    collect_src_maps,
    overview::functions::{Function, FunctionDiff, Functions},
};

use super::{
    functions::{FunctionsDiff, UnsafeDiff},
    generics::{Generics, GenericsDiff},
};

#[derive(Debug)]
pub struct Impls {
    impls: Vec<Impl>,
}
impl Impls {
    pub fn new(impls: Vec<ItemImpl>, source: SourceFile) -> Self {
        // This is somewhat incorrect because it doesn't consider impls in submodules of
        // the same file, but we merge impls for now to make diffing more straightforward.

        let mut merged_impls = HashMap::new();
        for mut impl_ in impls.into_iter() {
            let impl_key = (impl_.trait_.clone(), impl_.self_ty.clone());

            if impl_.trait_.is_none() {
                merged_impls
                    .entry(impl_key)
                    .and_modify(|existing_impl: &mut ItemImpl| {
                        existing_impl.items.append(&mut impl_.items);
                    })
                    .or_insert(impl_);
            } else {
                let overwrote_impl = merged_impls.insert(impl_key, impl_);
                if let Some(impl_) = overwrote_impl {
                    println!(
                        "SCARY: overwrote trait impl: '{:?}' for {:?}",
                        impl_.trait_.unwrap(),
                        impl_.self_ty
                    );
                }
            }
        }
        let impls = merged_impls
            .into_values()
            .map(|impl_| Impl::new(impl_, source.clone()))
            .collect();

        Impls { impls }
    }
}
impl Diff for Impls {
    type Diff = ImplsDiff;

    fn diff_with(&self, other: &Self) -> Self::Diff {
        // PERF: This will be slow for large-ish impls (they're unsorted, unlike the other collection structs)
        let mut impl_diffs = Vec::new();

        // file1
        for impl_ in &self.impls {
            // We don't (currently) delineate between multiple non-trait impls in the same file. In one
            // sense it's incorrect, but in another sense we're just getting a general overview anyways
            let impl_with_matching_type = other
                .impls
                .iter()
                .find(|i| i.self_ty == impl_.self_ty && i.trait_ == impl_.trait_);

            match impl_with_matching_type {
                Some(i) => {
                    if let Some(diff) = impl_.diff_with(i) {
                        impl_diffs.push(diff);
                    }
                }

                None => {
                    // impl was deleted
                    let unsafe_diff: Option<UnsafeDiff> = None;
                    let generics_diff: Option<GenericsDiff> = None;
                    let items_diff = {
                        // TODO: only supports functions
                        let self_fn_items: Vec<_> = impl_
                            .items
                            .iter()
                            .filter_map(|i| match i {
                                ImplItem::Fn(func) => Some(func.clone()),
                                _ => None,
                            })
                            .collect();

                        let other_items_fns = Functions::new_impl(vec![], impl_.source.clone());
                        // TODO: using impl_.source here because I don't have source here, fix this.
                        let self_items_fns =
                            Functions::new_impl(self_fn_items, impl_.source.clone());
                        let fns_diff = self_items_fns.diff_with(&other_items_fns);

                        if fns_diff.is_empty() {
                            None
                        } else {
                            Some(ImplItemsDiff { fns_diff })
                        }
                    };

                    if unsafe_diff.is_none() && generics_diff.is_none() && items_diff.is_none() {
                        continue;
                    } else {
                        // take all the diffs, if old/new exists, get byte range and store in vec
                        let (old_src_map, new_src_map) =
                            collect_src_maps!(unsafe_diff, generics_diff, items_diff,);
                        let diff = ImplDiff {
                            change: Change::Existence(ExistenceChange::Deleted),
                            old: Some(impl_.original.clone()),
                            old_src: Some(impl_.source.clone()),
                            new: None,
                            new_src: None,
                            unsafe_diff,
                            generics_diff,
                            items_diff,
                            old_src_map,
                            new_src_map,
                        };
                        impl_diffs.push(diff)
                    }
                }
            }
        }

        // file2
        // Everything here is either new or already accounted for
        for impl_ in &other.impls {
            if !self
                .impls
                .iter()
                .any(|i| i.self_ty == impl_.self_ty && i.trait_ == impl_.trait_)
            {
                // impl was added
                let unsafe_diff: Option<UnsafeDiff> = None;
                let generics_diff: Option<GenericsDiff> = None;
                let items_diff = {
                    // TODO: only supports functions
                    let self_fn_items: Vec<_> = impl_
                        .items
                        .iter()
                        .filter_map(|i| match i {
                            ImplItem::Fn(func) => Some(func.clone()),
                            _ => None,
                        })
                        .collect();

                    // TODO: using impl_.source here because I don't have source here, fix this.
                    let other_items_fns = Functions::new_impl(vec![], impl_.source.clone());
                    let self_items_fns = Functions::new_impl(self_fn_items, impl_.source.clone());
                    let fns_diff = other_items_fns.diff_with(&self_items_fns);

                    if fns_diff.is_empty() {
                        None
                    } else {
                        Some(ImplItemsDiff { fns_diff })
                    }
                };

                if unsafe_diff.is_none() && generics_diff.is_none() && items_diff.is_none() {
                    continue;
                } else {
                    // take all the diffs, if old/new exists, get byte range and store in vec
                    let (old_src_map, new_src_map) =
                        collect_src_maps!(unsafe_diff, generics_diff, items_diff,);
                    let diff = ImplDiff {
                        change: Change::Existence(ExistenceChange::Added),
                        new: Some(impl_.original.clone()),
                        old: None,
                        unsafe_diff,
                        generics_diff,
                        items_diff,
                        new_src: Some(impl_.source.clone()),
                        old_src: None,
                        old_src_map,
                        new_src_map,
                    };
                    impl_diffs.push(diff)
                }
            }
        }

        ImplsDiff { impl_diffs }
    }
}
impl Impls {
    pub(crate) fn is_empty(&self) -> bool {
        self.impls.is_empty()
    }
    pub(crate) fn impls(&self) -> &[Impl] {
        self.impls.as_slice()
    }
}

#[derive(Debug, Eq, PartialEq)]
pub struct Impl {
    original: ItemImpl,
    unsafety: Option<Unsafe>,
    generics: Generics,
    trait_: Option<(Option<Not>, Path, For)>,
    self_ty: Box<Type>,
    items: Vec<ImplItem>,
    source: SourceFile,
}
impl Impl {
    pub fn new(i: ItemImpl, source: SourceFile) -> Self {
        let unsafety = i.unsafety;
        let generics = Generics::from(i.generics.clone());
        let trait_ = i.trait_.clone();
        let self_ty = i.self_ty.clone();
        let items = i.items.clone();
        Impl {
            original: i,
            unsafety,
            generics,
            trait_,
            self_ty,
            items,
            source,
        }
    }
}
impl Diff for Impl {
    type Diff = Option<ImplDiff>;

    fn diff_with(&self, other: &Self) -> Self::Diff {
        if self.self_ty != other.self_ty {
            // impls for two different types
            return None;
        }

        if self.trait_ != other.trait_ {
            // impls for two different traits on the same type
            return None;
        }

        let unsafe_diff = self.unsafety.diff_with(&other.unsafety);
        let generics_diff = self.generics.diff_with(&other.generics);
        let items_diff = {
            // TODO: only supports functions
            if self.items == other.items {
                None
            } else {
                let self_fn_items: Vec<_> = self
                    .items
                    .iter()
                    .filter_map(|i| match i {
                        ImplItem::Fn(func) => Some(func.clone()),
                        _ => None,
                    })
                    .collect();
                let other_fn_items: Vec<_> = other
                    .items
                    .iter()
                    .filter_map(|i| match i {
                        ImplItem::Fn(func) => Some(func.clone()),
                        _ => None,
                    })
                    .collect();

                let self_items_fns = Functions::new_impl(self_fn_items, self.source.clone());
                let other_items_fns = Functions::new_impl(other_fn_items, other.source.clone());

                let fns_diff = self_items_fns.diff_with(&other_items_fns);
                if fns_diff.is_empty() {
                    None
                } else {
                    Some(ImplItemsDiff { fns_diff })
                }
            }
        };

        if unsafe_diff.is_none() && generics_diff.is_none() && items_diff.is_none() {
            None
        } else {
            // take all the diffs, if old/new exists, get byte range and store in vec
            let (old_src_map, new_src_map) =
                collect_src_maps!(unsafe_diff, generics_diff, items_diff,);
            Some(ImplDiff {
                change: Change::Modified,
                old: Some(self.original.clone()),
                new: Some(other.original.clone()),
                unsafe_diff,
                generics_diff,
                items_diff,
                old_src: Some(self.source.clone()),
                new_src: Some(other.source.clone()),
                old_src_map,
                new_src_map,
            })
        }
    }
}
impl fmt::Display for Impl {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "(impl)")
    }
}

pub struct ImplsDiff {
    impl_diffs: Vec<ImplDiff>,
}
impl ImplsDiff {
    pub fn is_empty(&self) -> bool {
        self.impl_diffs.is_empty()
    }
}
impl View for ImplsDiff {
    fn as_viewable(&self) -> crate::ViewableDiffs {
        let ex_diffs = self
            .impl_diffs
            .iter()
            .filter(|diff| matches!(diff.change, Change::Existence(_)));

        let mut viewables = ViewableDiffs::empty();
        for ex_diff in ex_diffs {
            viewables.append(ex_diff.as_viewable());
        }

        // add/delete diffs should be side-by-side
        viewables.collapse();

        let mod_diffs = self
            .impl_diffs
            .iter()
            .filter(|diff| matches!(diff.change, Change::Modified));

        for mod_diff in mod_diffs {
            viewables.append(mod_diff.as_viewable());
        }

        viewables
    }
}

#[derive(Default, Debug)]
pub struct ImplDiff {
    change: Change,
    old: Option<ItemImpl>,
    new: Option<ItemImpl>,
    #[allow(unused)]
    unsafe_diff: Option<UnsafeDiff>,
    #[allow(unused)]
    generics_diff: Option<GenericsDiff>,
    #[allow(unused)]
    items_diff: Option<ImplItemsDiff>,
    old_src: Option<SourceFile>,
    new_src: Option<SourceFile>,
    old_src_map: Vec<Range<usize>>,
    new_src_map: Vec<Range<usize>>,
}
impl View for ImplDiff {
    fn as_viewable(&self) -> ViewableDiffs {
        let mut old_diff = Vec::new();
        if let Some(old) = self.old.as_ref() {
            old_diff = collect_impl_diff_changes(
                old,
                self.old_src.as_ref().unwrap().0.as_bytes(),
                &self.old_src_map,
                ExistenceChange::Deleted,
                match self.change {
                    Change::Existence(ex) => dbg!(Some(ex)),
                    Change::Modified => None,
                },
                &self.items_diff,
            );
        }

        let mut new_diff = Vec::new();
        if let Some(new) = self.new.as_ref() {
            new_diff = collect_impl_diff_changes(
                new,
                self.new_src.as_ref().unwrap().0.as_bytes(),
                &self.new_src_map,
                ExistenceChange::Added,
                match self.change {
                    Change::Existence(ex) => dbg!(Some(ex)),
                    Change::Modified => None,
                },
                &self.items_diff,
            );
        }

        ViewableDiffs::new(vec![ViewableDiff {
            old: if old_diff.is_empty() {
                None
            } else {
                Some(old_diff)
            },
            new: if new_diff.is_empty() {
                None
            } else {
                Some(new_diff)
            },
        }])
    }
}

fn collect_impl_diff_changes(
    impl_: &ItemImpl,
    source_code: &[u8],
    source_map: &[Range<usize>],
    change_for_diffs: ExistenceChange,
    maybe_change_for_diffs: Option<ExistenceChange>,
    items_diff: &Option<ImplItemsDiff>,
) -> Vec<(Option<ExistenceChange>, Code)> {
    let impl_range = impl_.span().byte_range();
    let decl_start = impl_range.start;
    let sig_end = impl_.brace_token.span.span().byte_range().start + 1; // we'll take the "{"
    let items_end = end_index_of_items(impl_, source_code);

    let mut diff_changes = crate::collect_diff_changes(
        source_code,
        source_map,
        decl_start,
        sig_end,
        change_for_diffs,
    );

    if let Some(ids) = items_diff {
        let (get_orig_item, get_sub_diff): (
            Box<dyn Fn(&FunctionDiff) -> &Option<Function>>,
            Box<dyn Fn(ViewableDiff) -> Option<Vec<(Option<ExistenceChange>, Code)>>>,
        );
        match change_for_diffs {
            ExistenceChange::Added => {
                get_orig_item = Box::new(|fd: &FunctionDiff| fd.new());
                get_sub_diff = Box::new(|vd: ViewableDiff| vd.new);
            }
            ExistenceChange::Deleted => {
                get_orig_item = Box::new(|fd: &FunctionDiff| fd.old());
                get_sub_diff = Box::new(|vd: ViewableDiff| vd.old);
            }
        };
        let item_diff_changes = collect_item_diffs(
            source_code,
            impl_,
            sig_end,
            ids,
            get_orig_item,
            get_sub_diff,
        );
        diff_changes.extend(item_diff_changes);
    }

    // collect remaining whitespace and closing ')' or '}'
    let code = String::from_utf8(source_code[items_end..impl_range.end].to_vec())
        .expect("Off a code boundary");

    diff_changes.push((maybe_change_for_diffs, Code(code)));
    diff_changes
}

fn collect_item_diffs(
    // The full source code for the file we're parsing
    source_code: &[u8],
    // The impl we're parsing
    impl_: &ItemImpl,
    // The index at which the signature ends
    sig_end: usize,
    // The item diffs for the file we're parsing
    ids: &ImplItemsDiff,
    // How to get the original function from a item diff (old or new method)
    get_original_item: Box<dyn Fn(&FunctionDiff) -> &Option<Function>>,
    // How to get sub diffs from a given viewable diff (old or new field)
    get_sub_diffs: Box<dyn Fn(ViewableDiff) -> Option<Vec<(Option<ExistenceChange>, Code)>>>,
) -> Vec<(Option<ExistenceChange>, Code)> {
    let mut i = sig_end;
    let mut diffs = Vec::new();
    let impl_range = impl_.span().byte_range();

    if impl_.items.len() > ids.len() {
        let elided_whitespace =
            crate::collect_elided_whitespace(sig_end, source_code, impl_range.end);
        diffs.push((None, Code(elided_whitespace)));
    }

    while i < impl_range.end {
        let maybe_item_diff = ids.fns_diff.diffs().iter().find(|d| {
            get_original_item(d)
                .as_ref()
                .map(|func| func.original().span().byte_range().contains(&i))
                .unwrap_or(false)
        });
        match maybe_item_diff {
            Some(id) => {
                // Going to walk backwards and get all preceding whitespace until a newline or a character
                let item_diff_range = get_original_item(id)
                    .as_ref()
                    .unwrap()
                    .original()
                    .span()
                    .byte_range();
                let item_diff_start = item_diff_range.start;
                let item_diff_end = item_diff_range.end;

                let whitespace = crate::collect_preceding_whitespace(source_code, item_diff_start);
                diffs.push((None, Code(whitespace)));

                // then get the actual diff
                let viewable = id.as_viewable();
                for diff in viewable.vds {
                    if let Some(sub_diff) = get_sub_diffs(diff) {
                        diffs.extend(sub_diff);
                    }
                }

                i = item_diff_end;
            }
            None => {
                i += 1;
            }
        }
    }

    diffs
}

fn end_index_of_items(impl_: &ItemImpl, source_code: &[u8]) -> usize {
    let mut index_before_close_brace = impl_.span().byte_range().end - 2;
    while index_before_close_brace > 0
        && source_code[index_before_close_brace].is_ascii_whitespace()
    {
        index_before_close_brace -= 1;
    }

    index_before_close_brace += 1; // we want 1 index beyond the last char we ended at
    index_before_close_brace
}

#[derive(Debug)]
pub struct ImplItemsDiff {
    fns_diff: FunctionsDiff,
}
impl ImplItemsDiff {
    #[allow(unused)]
    pub fn len(&self) -> usize {
        self.fns_diff.diffs().len()
    }
}
impl ByteRange for ImplItemsDiff {
    fn old_ranges(&self) -> Vec<Range<usize>> {
        self.fns_diff.old_ranges()
    }

    fn new_ranges(&self) -> Vec<Range<usize>> {
        self.fns_diff.new_ranges()
    }
}