Over-zealous extension splitting #146
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I'm not sure sure it is *actually* a bug, but the PATH algorithm's way of splitting extensions was over-zealous and in practice will split off more extensions that is probably desired. To fix this, we will need to add a heuristic, but this commit adds tests to demonstrate the problem.
The prior algorithm went as follows: Obtain ALL suffixes from the base component of the filename. Then, starting from the back, keep the suffixes split until a suffix is encountered that begins with the regular expression /.\d/. It was assumed that this was intended to be a floating point number, and not an extension, and thus the splitting would stop at that point. Some input has been seen where the filenames are composed nearly entirely of Word.then.dot.and.then.dot. One entry amongst them contained Word.then.dot.5.then.dot. This caused this one entry to be treated differently from the rest of the entries due to the ".5", and the sorting order was not as expected. The new algorithm is as follows: Obtain a maxium of two suffixes. Keep these suffixes until one of them has a length greater than 4 or starts with the regular expression /.\d/. This heuristic of course is not bullet-proof, but it will do a better job on most real-world filenames than the previous algorithm.
Codecov Report
@@ Coverage Diff @@
## master #146 +/- ##
=======================================
Coverage 96.62% 96.62%
=======================================
Files 10 10
Lines 622 622
=======================================
Hits 601 601
Misses 21 21
Continue to review full report at Codecov.
|
SethMMorton
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #145.
The old algorithm for suffix splitting when applying
PATHsorting was over-zealous, and it appears to give bad results if filename collections a) have the form "word.then.dot.then.word.then.dot" and b) one or more (but not all) of the filenames looks like "word.then.dot.5.then.dot".The new algorithm will not attempt to split ALL suffixes, but only the first two it encounters, and then only if the length of the suffix (plus the leading ".") is not more than 5 characters. The rule that the suffix cannot start with the regex
/.\d/still applies.It's hard to say that this was a "bug" because the algorithm was chosen as it was deliberately, but it certainly was not the desired behavior.