Skip to content

Unified differ interface and source tracing improvements - #176

Merged
pmbittner merged 7 commits into
developfrom
diff-interface
Nov 3, 2025
Merged

Unified differ interface and source tracing improvements#176
pmbittner merged 7 commits into
developfrom
diff-interface

Conversation

@ibbem

@ibbemibbem commented Oct 24, 2025

Copy link
Copy Markdown
Collaborator

This PR addresses #146.
Along the way I improved the source tracing because it was necessary to correctly set the source of the returned VariationDiffs :). During these changes I also did two other small, unrelated fixes.

open questions:

  1. Should we use Differs.lineDiffer(...).diff(...) where we currently use other convenience methods?
  2. If yes, should we remove the other convenience methods (e.g., VariationDiff.fromFile)?.

@ibbem
ibbem requested a review from pmbittnerOctober 24, 2025 15:15
pmbittner
pmbittner reviewed Oct 26, 2025
View reviewed changes
Comment threadsrc/main/java/org/variantsync/diffdetective/variation/diff/Differ.java Outdated
pmbittner
pmbittner requested changes Oct 29, 2025
View reviewed changes

@pmbittnerpmbittner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I appreciate these changes and I am very happy about the detailed documentation! Good job!

There are a few things regarding documentation and naming things I would like resolve though before I am willing to merge.

Comment threadsrc/main/java/org/variantsync/diffdetective/util/Source.java Outdated
Comment threadsrc/main/java/org/variantsync/diffdetective/util/Source.java Outdated
Comment threadsrc/main/java/org/variantsync/diffdetective/util/Source.java Outdated
Comment threadsrc/main/java/org/variantsync/diffdetective/util/Source.java Outdated
Comment threadsrc/main/java/org/variantsync/diffdetective/util/Source.java Outdated
Comment threadsrc/main/java/org/variantsync/diffdetective/variation/diff/Differs.java Outdated
Comment threadsrc/main/java/org/variantsync/diffdetective/variation/diff/Differs.java Outdated
Comment threadsrc/main/java/org/variantsync/diffdetective/variation/diff/Differs.java Outdated
Comment threadsrc/main/java/org/variantsync/diffdetective/variation/diff/Differs.java Outdated
Comment threadsrc/main/java/org/variantsync/diffdetective/variation/diff/LineDiffer.java Outdated
@ibbem
ibbemforce-pushed the diff-interface branch 2 times, most recently from 2cc8b83 to 9b4c700CompareOctober 30, 2025 10:33
@ibbem
ibbem requested a review from pmbittnerOctober 30, 2025 11:23
pmbittner
pmbittner reviewed Nov 3, 2025
View reviewed changes

@pmbittnerpmbittner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from one error affecting the README, I think this is ready to merge. Thank you very much. :)

Comment threaddocs/variability-aware-differencing.png Outdated
@pmbittnerpmbittner added documentation Improvements or additions to documentation enhancement New feature or request Refactoring bm_work ibbem is paid for working on this labels Nov 3, 2025
ibbemand others added 6 commits November 3, 2025 10:25
@ibbem@pmbittner
refactor: improve the source tracing mechanism
23698b8
The new mechanism is more flexible and provides more introspection
capabilities. Furthermore, it provides more documentation about the
intent of our source tracking.
@ibbem@pmbittner
feat: improve the source tracking to reduce Source.Unknown
952464f
@ibbem@pmbittner
feat: create an interface for and a collection of differs
d78f3e8
Note about the visual abstract image: The image is purposefully placed
in the `src` folder such that it is easy to reference from the Javadoc.
Furthermore, the symlink from `docs` allows easy references from
`README.md` makes it more discoverable. The direction of the symlink
(`docs` to `src` instead of `src` to `docs`) is important because the
Javadoc is moved during the build process. A symlink would thus be
incorrect in the default javadoc location (`target/reports/apidocs/`) or
the final destination (`docs/javadoc`) which is used by the Nix build
and thus for Github pages.
@ibbem@pmbittner
fix: close ZipFile in GitLoader
b3aad00
@ibbem@pmbittner
doc: fix a typo in VariationDiffLabelFormat
de79247
@pmbittner
fix(README): path to visual abstract
574bfcb
@pmbittner

pmbittner commented Nov 3, 2025

Copy link
Copy Markdown
Member

I rebased onto develop to merge now.

@pmbittnerpmbittner mentioned this pull request Nov 3, 2025
Merged
2 tasks
@pmbittner
pmbittner merged commit 1fb58fa into developNov 3, 2025
2 checks passed
@ibbemibbem mentioned this pull request Nov 4, 2025
Closed
@pmbittner
pmbittner deleted the diff-interface branch November 6, 2025 10:27
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pmbittnerpmbittnerpmbittner approved these changes

Assignees

No one assigned

Labels

bm_workibbem is paid for working on thisdocumentationImprovements or additions to documentationenhancementNew feature or requestRefactoring

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ibbem@pmbittner