pboling / kettle-paths / 37858699482

92%

push

github

✨ Implement Kettle::Paths and template the gem

Replaces the scaffolded kettle-paths gem with a working shared path utility
for the Kettle toolchain, plus the full kettle-jem project template applied to
the gem.

The utility resolves paths by filesystem identity rather than by string or
lexical comparison, so it treats every spelling of one directory as equal:
symlinked ancestors (/var/home vs /home) and Windows 8.3 short vs long names
(C:/Users/RUNNER~1 vs C:/Users/runneradmin). Both defeat naive prefix checks
and Pathname#relative_path_from, which produces nonsense such as
"../../../../var/home/..." when the cwd and a discovered file name the same
directory with two different spellings. This is the same class of bug already
fixed in turbo_tests2 (TurboTests::Utils::Paths) and in the kettle-jem
maintenance tools (Kettle::Jem::RelativePaths); kettle-paths consolidates it
into one reusable home.

Public API:
  canonical(path, base:)         expand without resolving symlinks, so caller
                                 spelling is preserved
  same?(left, right, base:)      identity comparison of two paths
  identical?(left, right)        File.identical? wrapper, returning false for
                                 missing paths (measured Ruby 4.0.7 behavior)
  within?(path, root, base:)     containment by identity walk-up
  relative(path, root)           caller-spelling-preserving relative path
  relative_from(path, root)      identity-aware relative path
  glob(*parts)                   path-join glob
  local_path_remote?(remote)     detect a local path remote in a lockfile
  path_parts(path)               split into components

RBS signatures in sig/kettle/paths.rbs validate with RBS::Parser. Suite runs
47 examples, 0 failures via kettle-test (parallel), and the family lint gate
passes for all members including this one.

Requires Ruby >= 2.4.0, MIT licensed, version 0.1.0.

Signed-off-by: Peter H. Boling <peter.boling@gmail.com>

31 of 36 branches covered (86.11%)

Branch coverage included in aggregate %.

85 of 89 new or added lines in 2 files covered. (95.51%)

91 of 95 relevant lines covered (95.79%)

15.45 hits per line