path_resolver.relative_path: use standard library that just works #2107
Conversation
path_resolver.relative_path does not work if the path
of interest is not in the subtree of the reference directory.
Original function naively cut longest common path prefix.
NOTE: Can we afford requiring pathname library?
Does it work properly with OPAL?
If I remember correctly, that is actually by design. What I can't remember is whether that was a compliance issue with AsciiDoc Python or there was another reason for placing that restriction. I need to revisit my notes and document what's going on here.
Again, I don't think it's naive. I think it's intentional...either for reasons of security or reasons of best practice. I need to refresh my memory. I would prefer not to use the Pathname library. In my experience, it's very slow and not well written. There have been numerous blogs I've come across challenging it's quality. That should help explain its intentional absence here. |
|
In other words, PathResolver is meant to be a more robust replacement for Pathname. |
|
I did some research and I agree this is a bug. |
- return filename as relative path if filename doesn't share common root with base directory - add test for scenario
|
I fixed this by simply checking to ensure the filename shares a common root with the base directory before truncating. The main reason we don't use Pathname is because we don't need all that logic. Part of the contract of the method is that both paths are already expanded. So all we have to do is take away the base directory part if they share the same root. This is very much an internal method. |
|
See #2335 |
- return filename as relative path if filename doesn't share common root with base directory - add test for scenario
- return filename as relative path if filename doesn't share common root with base directory - add test for scenario
- return filename as relative path if filename doesn't share common root with base directory - add test for scenario
|
I've improved this logic even further in 1.5.7. |
path_resolver.relative_pathdoes not work if the path of interest is not in the subtree of the reference directory.Original function naively cut longest common path prefix.
NOTE: Can we afford requiring pathname library? Does it work properly with OPAL?
WARNING: unable to run tests due to dependency errors so cannot confirm the test is correct, please review/rerun.