Drop leading / from project_filename

The paths returned by `SourceFile#project_filename` are described as
"relative to the projects directory," but they began with a `/` because
stripping `SimpleCov.root` left the separator behind. Consumers of
`coverage.json` (and the `minimum_coverage_by_file` error line) can
reasonably interpret a `/`-prefixed path as absolute and resolve it
incorrectly.

Strip the leading `/` or `\` in `project_filename`, adjust the built-in
regex profiles (`hidden_filter`, `test_frameworks`, `rails`) and
`StringFilter#segment_pattern` to match segment boundaries without
requiring a leading slash, refresh the JSON fixtures and specs, and
remove the now-unnecessary `shortenFilename` helper from the HTML
frontend (which also sidesteps any Windows backslash concern).

Anchored user-supplied RegexFilters that relied on a leading `/`, like
`%r{^/lib/}` need to be rewritten as `%r{\Alib/}`. Noted in CHANGELOG.

Author: sferik

CHANGELOG.md

@@ -5,6 +5,7 @@ Unreleased
 * JSON formatter: group stats changed from `{ "covered_percent": 80.0 }` to full stats shape `{ "covered": 8, "missed": 2, "total": 10, "percent": 80.0, "strength": 0.0 }`. The key `covered_percent` is renamed to `percent`.
 * JSON formatter: `simplecov_json_formatter` gem is now built in. `require "simplecov_json_formatter"` continues to work via a shim.
 * `StringFilter` now matches at path-segment boundaries. `"lib"` matches `/lib/` but no longer matches `/library/`. Use a `Regexp` filter for substring matching.
+* `SourceFile#project_filename` now returns a truly relative path with no leading separator (e.g. `lib/foo.rb` instead of `/lib/foo.rb`). This also removes the leading `/` from file path keys in `coverage.json` and from the filename in `minimum_coverage_by_file` error messages. Anchored `RegexFilter`s that relied on a leading `/` (e.g. `%r{^/lib/}`) should be rewritten (e.g. `%r{\Alib/}`).
 * Removed `docile` gem dependency. The `SimpleCov.configure` DSL block is now evaluated via `instance_exec` with instance variable proxying.
 
 ## Enhancements

features/minimum_coverage_by_file.feature

@@ -18,7 +18,7 @@ Feature:
 
     When I run `bundle exec rake test`
     Then the exit status should not be 0
-    And the output should contain "Line coverage by file (75.00%) is below the expected minimum coverage (75.01%) in /lib/faked_project/framework_specific.rb."
+    And the output should contain "Line coverage by file (75.00%) is below the expected minimum coverage (75.01%) in lib/faked_project/framework_specific.rb."
     And the output should contain "SimpleCov failed with exit 2"
 
   Scenario: Just passing it
@@ -48,8 +48,8 @@ Feature:
 
     When I run `bundle exec rake test`
     Then the exit status should not be 0
-    And the output should contain "Line coverage by file (80.00%) is below the expected minimum coverage (90.00%) in /lib/faked_project/some_class.rb."
-    And the output should contain "Branch coverage by file (50.00%) is below the expected minimum coverage (70.00%) in /lib/faked_project/some_class.rb."
+    And the output should contain "Line coverage by file (80.00%) is below the expected minimum coverage (90.00%) in lib/faked_project/some_class.rb."
+    And the output should contain "Branch coverage by file (50.00%) is below the expected minimum coverage (70.00%) in lib/faked_project/some_class.rb."
     And the output should contain "SimpleCov failed with exit 2"
 
   @branch_coverage
@@ -67,6 +67,6 @@ Feature:
 
     When I run `bundle exec rake test`
     Then the exit status should not be 0
-    And the output should contain "Branch coverage by file (50.00%) is below the expected minimum coverage (70.00%) in /lib/faked_project/some_class.rb."
+    And the output should contain "Branch coverage by file (50.00%) is below the expected minimum coverage (70.00%) in lib/faked_project/some_class.rb."
     And the output should not contain "Line coverage ("
     And the output should contain "SimpleCov failed with exit 2"

features/step_definitions/json_steps.rb

@@ -5,11 +5,11 @@
     json_report = JSON.parse(File.read("coverage/coverage.json"))
     coverage_hash = json_report.fetch "coverage"
 
-    faked_project = coverage_hash.fetch("/lib/faked_project.rb")
+    faked_project = coverage_hash.fetch("lib/faked_project.rb")
     expect(faked_project["lines"]).to eq [nil, nil, 1, 1, 1, nil, nil, nil, 5, 3, nil, nil, 1]
     expect(faked_project["lines_covered_percent"]).to be_a(Float)
 
-    some_class = coverage_hash.fetch("/lib/faked_project/some_class.rb")
+    some_class = coverage_hash.fetch("lib/faked_project/some_class.rb")
     expect(some_class["lines"]).to eq [nil, nil, 1, 1, 1, nil, 1, 2, nil, nil, 1, 1, nil, nil, 1, 1, 1, nil, 0, nil, nil, 0, nil, nil, 1, nil, 1, 0, nil, nil]
     expect(some_class["lines_covered_percent"]).to be_a(Float)
   end

html_frontend/src/app.ts

@@ -272,11 +272,6 @@ function fmtPct(pct: number): string {
   return (Math.floor(pct * 100) / 100).toFixed(2);
 }
 
-function shortenFilename(filename: string): string {
-  // Paths in the JSON output are already root-relative with a leading `/`.
-  return filename.replace(/^\//, '');
-}
-
 function fileId(filename: string): string {
   return md5Hex(filename);
 }
@@ -416,7 +411,6 @@ function buildMissedMethodLines(methods: MethodEntry[] | undefined): Set<number>
 
 function renderSourceFile(filename: string, data: FileCoverage, branchCoverage: boolean, methodCoverage: boolean): string {
   const id = fileId(filename);
-  const shortName = shortenFilename(filename);
   const coveredLines = data.covered_lines;
   const missedLines = data.missed_lines;
   const totalLines = coveredLines + missedLines;
@@ -433,7 +427,7 @@ function renderSourceFile(filename: string, data: FileCoverage, branchCoverage:
 
   let html = `<div class="source_table" id="${id}">`;
   html += '<div class="header">';
-  html += `<h2>${escapeHTML(shortName)}</h2>`;
+  html += `<h2>${escapeHTML(filename)}</h2>`;
   html += renderCoverageSummary(coveredLines, totalLines, coveredBranches, totalBranches, coveredMethods, totalMethods, branchCoverage, methodCoverage, showMethodToggle);
 
   if (showMethodToggle) {
@@ -534,7 +528,6 @@ function renderFileList(
   for (const fn of filenames) {
     const f = allCoverage[fn];
     if (!f) continue;
-    const shortName = shortenFilename(fn);
     const id = fileId(fn);
     const coveredLines = f.covered_lines;
     const relevantLines = coveredLines + f.missed_lines;
@@ -548,7 +541,7 @@ function renderFileList(
     }
 
     html += `<tr class="t-file" ${dataAttrs}>`;
-    html += `<td class="strong t-file__name"><a href="#${id}" class="src_link" title="${escapeHTML(shortName)}">${escapeHTML(shortName)}</a></td>`;
+    html += `<td class="strong t-file__name"><a href="#${id}" class="src_link" title="${escapeHTML(fn)}">${escapeHTML(fn)}</a></td>`;
     html += renderCoverageCells(f.lines_covered_percent, coveredLines, relevantLines, 'line', false);
     if (branchCoverage) {
       html += renderCoverageCells(f.branches_covered_percent || 100.0, f.covered_branches || 0, f.total_branches || 0, 'branch', false);

lib/simplecov/filter.rb

@@ -65,18 +65,20 @@ def matches?(source_file)
     def segment_pattern
       @segment_pattern ||= begin
         normalized = filter_argument.delete_prefix("/")
+        escaped = Regexp.escape(normalized)
+        boundary = '(?:\A|/)'
         if normalized.include?(".")
           # Contains a dot — looks like a filename pattern. Allow substring
           # match within the last path segment (e.g. "test.rb" matches
-          # "faked_test.rb") while still anchoring to a "/" boundary.
-          %r{/[^/]*#{Regexp.escape(normalized)}}
+          # "faked_test.rb") while still anchoring to a segment boundary.
+          /#{boundary}[^\/]*#{escaped}/
         elsif normalized.end_with?("/")
           # Trailing slash signals directory-only matching
-          %r{/#{Regexp.escape(normalized)}}
+          /#{boundary}#{escaped}/
         else
           # No dot — looks like a directory or path. Require segment-boundary
-          # match so "lib" matches "/lib/" but not "/library/".
-          %r{/#{Regexp.escape(normalized)}(?=[/.]|$)}
+          # match so "lib" matches "lib/" but not "library/".
+          /#{boundary}#{escaped}(?=[\/.]|\z)/
         end
       end
     end

lib/simplecov/formatter/html_formatter/public/application.js

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 SimpleCov.profiles.define "hidden_filter" do
-  add_filter %r{^/\..*}
+  add_filter %r{\A\..*}
 end

lib/simplecov/profiles/hidden_filter.rb

@@ -3,8 +3,8 @@
 SimpleCov.profiles.define "rails" do
   load_profile "test_frameworks"
 
-  add_filter %r{^/config/}
-  add_filter %r{^/db/}
+  add_filter %r{\Aconfig/}
+  add_filter %r{\Adb/}
 
   add_group "Controllers", "app/controllers"
   add_group "Channels", "app/channels"

lib/simplecov/profiles/rails.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 SimpleCov.profiles.define "test_frameworks" do
-  add_filter %r{^/(test|features|spec|autotest)/}
+  add_filter %r{\A(test|features|spec|autotest)/}
 end

lib/simplecov/profiles/test_frameworks.rb

@@ -24,7 +24,7 @@ def initialize(filename, coverage_data, loaded: true)
 
     # The path to this source file relative to the projects directory
     def project_filename
-      @filename.delete_prefix(SimpleCov.root)
+      @filename.delete_prefix(SimpleCov.root).sub(%r{\A[/\\]}, "")
     end
 
     # The source code for this file. Aliased as :source