Index workspaces whose path contains glob metacharacters

[andriytyurnikov]

Fixes #4024, which was auto-closed as stale by the bot rather than by a decision, and needs reopening.

Important

Stacked on #4022. Until that merges, the diff shown here also contains its commits. The only commit belonging to this PR is Index workspaces whose path contains glob metacharacters — two files, configuration.rb and configuration_test.rb.

It genuinely depends on #4022 rather than merely following it: without the escaping fix, a bracketed path raises URI::InvalidComponentError in URI::Generic.build before this code is reached.

The problem

#4022 makes a bracketed file work. A bracketed workspace root still indexes zero files, so every feature is dead for the entire project rather than for one file in it.

# workspace: /tmp/.../[id]/{slug}, containing app/nested.rb and top_level.rb
config.instance_variable_get(:@included_patterns) #=> ["{}/**/*.rb", "*.rb"]
config.indexable_uris                             #=> []

Two causes compound.

top_level_directories globs "#{Dir.pwd}/*", which returns nothing when the working directory holds metacharacters. @included_patterns is built from it as "{#{top_level_directories.join(",")}}/**/*.rb", so an empty result degenerates to {}/**/*.rb. Independently, indexable_uris interpolates the workspace path into its own pattern, so even the *.rb fallback matches nothing.

Changes

Pass paths as base: instead of interpolating them. Dir.glob's base: treats its argument as a literal directory, which is correct on every platform — unlike backslash escaping, which Ruby does not support on Windows. Applied to the workspace path in indexable_uris, to Dir.pwd in top_level_directories, and to gem require paths, which land under the workspace whenever BUNDLE_PATH points inside the project.

Guard the empty case rather than converting it. Dir.glob("{}/**/*.rb", base: dir) does not return nothing — it escapes the base and walks the file system from the root, raising Errno::EPERM on macOS protected directories. This is the Ruby bug that made #4022 defer the whole file. Never constructing the empty brace group sidesteps it entirely, and is what unblocks the rest.

Match exclusion patterns against the workspace-relative path. File.fnmatch? reads brackets as a character class too, so File.join(@workspace_path, pattern) silently disabled every user-configured exclusion under such a workspace:

File.fnmatch?("/ws/[id]/ignore/**/*.rb", "/ws/[id]/ignore/excluded.rb", flags) #=> false

Absolute patterns keep matching the absolute path; relative ones now match the relative path, so the workspace path never becomes part of a pattern. The prefix is normalised before being stripped, because it originates from a client-supplied URI that may carry a trailing slash — something the previous File.join absorbed for free.

Deliberately not converted

The Ruby installation paths (RbConfig::CONFIG["rubylibdir"] and the default gem directories below it) are left interpolated. Reaching that bug requires a bracketed Ruby install, not a bracketed project, and base: reads distinctly worse there — one of the two call sites went from three lines to seven. The line drawn here is: harden the paths a user's project layout controls.

Tests

Four tests, each verified to fail when its fix is reverted:

Test	Covers
..._with_glob_metacharacters_in_the_workspace_path	nested and top-level files under [id]/{slug} — the headline, was []
test_excluded_patterns_apply_when_..._glob_metacharacters	exclusions still apply under such a workspace
test_excluded_patterns_apply_when_..._a_trailing_slash	the normalised prefix
..._in_a_workspace_without_indexable_subdirectories	the empty {} case, which otherwise raises Errno::EPERM

The last one is worth calling out: it passes on main and fails only against the base: conversion, so it exists specifically to pin the Ruby bug that made this file risky to touch.

One note on how these were checked. The trailing-slash test initially passed for the wrong reason — the file was never indexed, so refute_includes was vacuously true. It only showed up by reverting the fix and seeing the test still pass. It now sets included_patterns so the exclusion is genuinely exercised.

Test plan

• bundle exec rake — 334 + 18,565 runs, 0 failures, 0 errors
• bundle exec srb tc — no errors
• bin/rubocop — no offenses
• Bracketed workspace verified end to end: @included_patterns goes from {}/**/*.rb to {app}/**/*.rb, and indexable_uris from [] to both files