Summary

Formalize diff line-level metadata and prepare for new state.

Review Request #11902 — Created Jan. 4, 2022 and submitted May 26, 2022, 10:42 a.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-5.0.x

Bugs

Depends On

Blocks

11907

Reviewers

Groups

reviewboard

People

Description

It will also be important not to completely break anything consuming
this line information. So, the moved information field is being
repurposed for general metadata, preserving to and from as moved
to/from keys.

For the moment, this is mostly a documentation change within the chunk
generator. However, the diff_line template tag has also been updated
to prepare for some uses of this metadata field. This consists of
pulling out the field into a variable, and changing some processing to
avoid repeating logic (which will be important for the upcoming code
safety checks feature).

Testing Done

Unit tests passed.

Made use of this in the upcoming code safety checkers feature.

Commits

Summary	ID
Formalize diff line-level metadata and prepare for new state. Lines in a rendered diff have a dictionary field for storing move information, and we have a couple other fields for other interesting state. What we don't have is a field for general metadata, and this will be important soon. It will also be important not to completely break anything consuming this line information. So, the moved information field is being repurposed for general metadata, preserving `to` and `from` as moved to/from keys. For the moment, this is mostly a documentation change within the chunk generator. However, the `diff_line` template tag has also been updated to prepare for some uses of this metadata field. This consists of pulling out the field into a variable, and changing some processing to avoid repeating logic (which will be important for the upcoming code safety checks feature).	799199c194f9206b965e0766f929c2b1820b9905

Summary

Formalize diff line-level metadata and prepare for new state.

Lines in a rendered diff have a dictionary field for storing move information, and we have a couple other fields for other interesting state. What we don't have is a field for general metadata, and this will be important soon. It will also be important not to completely break anything consuming this line information. So, the moved information field is being repurposed for general metadata, preserving `to` and `from` as moved to/from keys. For the moment, this is mostly a documentation change within the chunk generator. However, the `diff_line` template tag has also been updated to prepare for some uses of this metadata field. This consists of pulling out the field into a variable, and changing some processing to avoid repeating logic (which will be important for the upcoming code safety checks feature).

799199c194f9206b965e0766f929c2b1820b9905

Issues

Description	From	Last Updated
typo: i a line -> if a line	david	May 23, 2022, 5:38 p.m.
I feel like this could all be coalesced together. There's no need to reassign to line_html_sides if we don't do …	david	May 23, 2022, 5:40 p.m.

flake8 passed.

JSHint passed.

reviewboard/diffviewer/templatetags/difftags.py (Diff revision 1)
The issue has been resolved. Show all issues
```
typo: i a line -> if a line
```

reviewboard/diffviewer/templatetags/difftags.py (Diff revision 1)

The issue has been resolved. Show all issues

I feel like this could all be coalesced together. There's no need to reassign to line_html_sides if we don't do any processing:

if line_html and len(line_html) < STYLED_MAX_LINE_LEN:
    line_html_sides[side_i] = showextrawhitespace(line_html)

Change Summary:


Fixed typos in documentation.
Condensed some logic for better readability.
Moved this to release-5.0.x.

Commits:

	Summary	ID
	Formalize diff line-level metadata and prepare for new state. Lines in a rendered diff have a dictionary field for storing move information, and we have a couple other fields for other interesting state. What we don't have is a field for general metadata, and this will be important soon. It will also be important not to completely break anything consuming this line information. So, the moved information field is being repurposed for general metadata, preserving `to` and `from` as moved to/from keys. For the moment, this is mostly a documentation change within the chunk generator. However, the `diff_line` template tag has also been updated to prepare for some uses of this metadata field. This consists of pulling out the field into a variable, and changing some processing to avoid repeating logic (which will be important for the upcoming code safety checks feature).	2ce72fdc49581f1e92a2cf242d501f879ac7aaaa
	Formalize diff line-level metadata and prepare for new state. Lines in a rendered diff have a dictionary field for storing move information, and we have a couple other fields for other interesting state. What we don't have is a field for general metadata, and this will be important soon. It will also be important not to completely break anything consuming this line information. So, the moved information field is being repurposed for general metadata, preserving `to` and `from` as moved to/from keys. For the moment, this is mostly a documentation change within the chunk generator. However, the `diff_line` template tag has also been updated to prepare for some uses of this metadata field. This consists of pulling out the field into a variable, and changing some processing to avoid repeating logic (which will be important for the upcoming code safety checks feature).	799199c194f9206b965e0766f929c2b1820b9905

Branch:

release-4.0.x

release-5.0.x

Diff:

Revision 2 (+102 -60)

Show changes

	reviewboard/diffviewer/chunk_generator.py
	reviewboard/diffviewer/templatetags/difftags.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.0.x (f738871)