Summary

Pass through FileDiff extra_data into filename normalization.

Review Request #11282 — Created Nov. 16, 2020 and submitted Nov. 20, 2020, 9:09 a.m.

Information

Owner

david

Repository

Review Board

Branch

release-3.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

While most version control systems are relatively sane and treat a
filename as a filename, there are a few that don't. We first encountered
this with CVS, which loves to add a ,v to the end of filenames
depending on the method of access. To address this, we added a
normalization method that SCMTools could override.

Impending work on improving support for ClearCase requires even fancier
normalization, and one that requires being able to use some data about
the repository. This change adds the FileDiff extra_data as an argument
to the normalization method.

This is a soft API break. Existing SCMTools which provide a normalize
method that does not take any additional arguments will continue to
function, but emit a deprecation warning.

Testing Done

Ran unit tests.

Commits

Summary	ID
Pass through FileDiff extra_data into filename normalization. While most version control systems are relatively sane and treat a filename as a filename, there are a few that don't. We first encountered this with CVS, which loves to add a `,v` to the end of filenames depending on the method of access. To address this, we added a normalization method that SCMTools could override. Impending work on improving support for ClearCase requires even fancier normalization, and one that requires being able to use some data about the repository. This change adds the FileDiff extra_data as an argument to the normalization method. This is a soft API break. Existing SCMTools which provide a normalize method that does not take any additional arguments will continue to function, but emit a deprecation warning. Testing Done: Ran unit tests.	8fb3f514ca34bc15d76edeb0d45a0a0149a4f580

Summary

Pass through FileDiff extra_data into filename normalization.

While most version control systems are relatively sane and treat a filename as a filename, there are a few that don't. We first encountered this with CVS, which loves to add a `,v` to the end of filenames depending on the method of access. To address this, we added a normalization method that SCMTools could override. Impending work on improving support for ClearCase requires even fancier normalization, and one that requires being able to use some data about the repository. This change adds the FileDiff extra_data as an argument to the normalization method. This is a soft API break. Existing SCMTools which provide a normalize method that does not take any additional arguments will continue to function, but emit a deprecation warning. Testing Done: Ran unit tests.

8fb3f514ca34bc15d76edeb0d45a0a0149a4f580

Issues

Description	From	Last Updated
F841 local variable 'diff_files' is assigned to but never used	reviewbot	Nov. 16, 2020, 10:39 a.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/diffviewer/tests/test_diffutils.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F841 local variable 'diff_files' is assigned to but never used
```

Commits:

	Summary	ID
	Pass through FileDiff extra_data into filename normalization. While most version control systems are relatively sane and treat a filename as a filename, there are a few that don't. We first encountered this with CVS, which loves to add a `,v` to the end of filenames depending on the method of access. To address this, we added a normalization method that SCMTools could override. Impending work on improving support for ClearCase requires even fancier normalization, and one that requires being able to use some data about the repository. This change adds the FileDiff extra_data as an argument to the normalization method. This is a soft API break. Existing SCMTools which provide a normalize method that does not take any additional arguments will continue to function, but emit a deprecation warning. Testing Done: Ran unit tests.	1f1db17e96e2a660d578735366f030b0da899cc5
	Pass through FileDiff extra_data into filename normalization. While most version control systems are relatively sane and treat a filename as a filename, there are a few that don't. We first encountered this with CVS, which loves to add a `,v` to the end of filenames depending on the method of access. To address this, we added a normalization method that SCMTools could override. Impending work on improving support for ClearCase requires even fancier normalization, and one that requires being able to use some data about the repository. This change adds the FileDiff extra_data as an argument to the normalization method. This is a soft API break. Existing SCMTools which provide a normalize method that does not take any additional arguments will continue to function, but emit a deprecation warning. Testing Done: Ran unit tests.	8fb3f514ca34bc15d76edeb0d45a0a0149a4f580

Diff:

Revision 2 (+356 -30)

Show changes

	reviewboard/diffviewer/chunk_generator.py
	reviewboard/diffviewer/diffutils.py
	reviewboard/diffviewer/models.py
	reviewboard/diffviewer/tests/test_diffutils.py
	reviewboard/scmtools/clearcase.py
	reviewboard/scmtools/core.py
	reviewboard/scmtools/cvs.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.0.x (d53fc2d)