Add richer metrics to JSON formatter

Enhance the JSON coverage output with per-file coverage percentages, a
total section with aggregate statistics, full group stats, and method
coverage support.

Per-file output now includes covered_percent (always), and when enabled:
branches_covered_percent and methods array with methods_covered_percent.
The total and groups sections report full statistics (covered, missed,
total, percent, strength) for each enabled coverage type (line, branch,
method).

Breaking change: group stats change from { covered_percent: 80.0 } to
the full stats shape with the key renamed to percent.

Based on the ideas in codeclimate-community/simplecov_json_formatter#12.

Co-Authored-By: Tejas <tejas.shetty@mailbox.org>

Author: sferik

CHANGELOG.md

@@ -1,8 +1,28 @@
 Unreleased
 ==========
 
+## Breaking Changes
+* 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.
+* Removed `docile` gem dependency. The `SimpleCov.configure` DSL block is now evaluated via `instance_exec` with instance variable proxying.
+
+## Enhancements
+* JSON formatter: added `total` section with aggregate coverage statistics (covered, missed, total, percent, strength) for line, branch, and method coverage
+* JSON formatter: per-file output now includes `covered_percent`, and when enabled: `branches_covered_percent`, `methods` array, and `methods_covered_percent`
+* JSON formatter: group stats now include full statistics for all enabled coverage types, not just line coverage percent
+* JSON formatter: added `silent:` keyword to `JSONFormatter.new` to suppress console output
+* Merged `simplecov-html` formatter into the main gem. A backward-compatibility shim ensures `require "simplecov-html"` still works.
+* Merged `simplecov_json_formatter` into the main gem. A backward-compatibility shim ensures `require "simplecov_json_formatter"` still works.
+* Added `rake assets:compile` task for building the HTML formatter's frontend assets via esbuild
+* Added TypeScript type checking CI workflow
+* Separated rubocop into its own `lint.yml` CI workflow
+* `CommandGuesser` now appends the framework name to parallel test data (e.g. `"RSpec (1/2)"` instead of `"(1/2)"`)
+
 ## Bugfixes
 * Don't report misleading 100% branch/method coverage for files added via `track_files` that were never loaded. See #902
+* Fix HTML formatter tab bar layout: dark mode toggle no longer wraps onto two lines, and tabs connect seamlessly with the content panel
+* Fix branch coverage cucumber feature to match the HTML formatter's updated output format
 
 0.22.1 (2024-09-02)
 ==========

features/step_definitions/json_steps.rb

@@ -6,7 +6,12 @@
     coverage_hash = json_report.fetch "coverage"
     directory = Dir.pwd
 
-    expect(coverage_hash.fetch("#{directory}/lib/faked_project.rb")).to eq "lines" => [nil, nil, 1, 1, 1, nil, nil, nil, 5, 3, nil, nil, 1]
-    expect(coverage_hash.fetch("#{directory}/lib/faked_project/some_class.rb")).to eq "lines" => [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]
+    faked_project = coverage_hash.fetch("#{directory}/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["covered_percent"]).to be_a(Float)
+
+    some_class = coverage_hash.fetch("#{directory}/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["covered_percent"]).to be_a(Float)
   end
 end

lib/simplecov/formatter/json_formatter/result_hash_formatter.rb

@@ -11,6 +11,7 @@ def initialize(result)
         end
 
         def format
+          format_total
           format_files
           format_groups
 
@@ -19,6 +20,10 @@ def format
 
       private
 
+        def format_total
+          formatted_result[:total] = format_coverage_statistics(@result.coverage_statistics)
+        end
+
         def format_files
           @result.files.each do |source_file|
             formatted_result[:coverage][source_file.filename] =
@@ -28,11 +33,7 @@ def format_files
 
         def format_groups
           @result.groups.each do |name, file_list|
-            formatted_result[:groups][name] = {
-              lines: {
-                covered_percent: file_list.covered_percent
-              }
-            }
+            formatted_result[:groups][name] = format_coverage_statistics(file_list.coverage_statistics)
           end
         end
 
@@ -41,6 +42,7 @@ def formatted_result
             meta: {
               simplecov_version: SimpleCov::VERSION
             },
+            total: {},
             coverage: {},
             groups: {}
           }
@@ -50,6 +52,23 @@ def format_source_file(source_file)
           source_file_formatter = SourceFileFormatter.new(source_file)
           source_file_formatter.format
         end
+
+        def format_coverage_statistics(statistics)
+          result = {lines: format_single_statistic(statistics[:line])}
+          result[:branches] = format_single_statistic(statistics[:branch]) if SimpleCov.branch_coverage? && statistics[:branch]
+          result[:methods] = format_single_statistic(statistics[:method]) if SimpleCov.method_coverage? && statistics[:method]
+          result
+        end
+
+        def format_single_statistic(stat)
+          {
+            covered: stat.covered,
+            missed: stat.missed,
+            total: stat.total,
+            percent: stat.percent.round(2),
+            strength: stat.strength.round(2)
+          }
+        end
       end
     end
   end

lib/simplecov/formatter/json_formatter/source_file_formatter.rb

@@ -10,24 +10,32 @@ def initialize(source_file)
         end
 
         def format
-          if SimpleCov.branch_coverage?
-            line_coverage.merge(branch_coverage)
-          else
-            line_coverage
-          end
+          result = line_coverage
+          result.merge!(branch_coverage) if SimpleCov.branch_coverage?
+          result.merge!(method_coverage) if SimpleCov.method_coverage?
+          result
         end
 
       private
 
         def line_coverage
           @line_coverage ||= {
-            lines: lines
+            lines: lines,
+            covered_percent: @source_file.covered_percent.round(2)
           }
         end
 
         def branch_coverage
           {
-            branches: branches
+            branches: branches,
+            branches_covered_percent: @source_file.branches_coverage_percent.round(2)
+          }
+        end
+
+        def method_coverage
+          {
+            methods: format_methods,
+            methods_covered_percent: @source_file.methods_coverage_percent.round(2)
           }
         end
 
@@ -43,6 +51,12 @@ def branches
           end
         end
 
+        def format_methods
+          @source_file.methods.collect do |method|
+            parse_method(method)
+          end
+        end
+
         def parse_line(line)
           return line.coverage unless line.skipped?
 
@@ -57,6 +71,15 @@ def parse_branch(branch)
             coverage: parse_line(branch)
           }
         end
+
+        def parse_method(method)
+          {
+            name: method.to_s,
+            start_line: method.start_line,
+            end_line: method.end_line,
+            coverage: parse_line(method)
+          }
+        end
       end
     end
   end

spec/fixtures/json/sample.json

@@ -2,6 +2,15 @@
   "meta": {
     "simplecov_version": "0.22.0"
   },
+  "total": {
+    "lines": {
+      "covered": 9,
+      "missed": 1,
+      "total": 10,
+      "percent": 90.0,
+      "strength": 1.0
+    }
+  },
   "coverage": {
     "/STUB_WORKING_DIRECTORY/spec/fixtures/json/sample.rb": {
       "lines": [
@@ -30,7 +39,8 @@
         "ignored",
         "ignored",
         null
-      ]
+      ],
+      "covered_percent": 90.0
     }
   },
   "groups": {}

spec/fixtures/json/sample_groups.json

@@ -2,6 +2,15 @@
   "meta": {
     "simplecov_version": "0.22.0"
   },
+  "total": {
+    "lines": {
+      "covered": 9,
+      "missed": 1,
+      "total": 10,
+      "percent": 90.0,
+      "strength": 1.0
+    }
+  },
   "coverage": {
     "/STUB_WORKING_DIRECTORY/spec/fixtures/json/sample.rb": {
       "lines": [
@@ -30,13 +39,18 @@
         "ignored",
         "ignored",
         null
-      ]
+      ],
+      "covered_percent": 90.0
     }
   },
   "groups": {
     "My Group": {
       "lines": {
-        "covered_percent": 80.0
+        "covered": 8,
+        "missed": 2,
+        "total": 10,
+        "percent": 80.0,
+        "strength": 0.0
       }
     }
   }

spec/fixtures/json/sample_with_branch.json

@@ -2,6 +2,22 @@
   "meta": {
     "simplecov_version": "0.22.0"
   },
+  "total": {
+    "lines": {
+      "covered": 9,
+      "missed": 1,
+      "total": 10,
+      "percent": 90.0,
+      "strength": 1.0
+    },
+    "branches": {
+      "covered": 1,
+      "missed": 1,
+      "total": 2,
+      "percent": 50.0,
+      "strength": 0.0
+    }
+  },
   "coverage": {
     "/STUB_WORKING_DIRECTORY/spec/fixtures/json/sample.rb": {
       "lines": [
@@ -31,6 +47,7 @@
         "ignored",
         null
       ],
+      "covered_percent": 90.0,
       "branches": [
         {
           "type": "then",
@@ -44,7 +61,8 @@
           "end_line": 16,
           "coverage": 1
         }
-      ]
+      ],
+      "branches_covered_percent": 50.0
     }
   },
   "groups": {}

spec/fixtures/json/sample_with_method.json

@@ -0,0 +1,81 @@
+{
+  "meta": {
+    "simplecov_version": "0.22.0"
+  },
+  "total": {
+    "lines": {
+      "covered": 9,
+      "missed": 1,
+      "total": 10,
+      "percent": 90.0,
+      "strength": 1.0
+    },
+    "methods": {
+      "covered": 3,
+      "missed": 0,
+      "total": 3,
+      "percent": 100.0,
+      "strength": 0.0
+    }
+  },
+  "coverage": {
+    "/STUB_WORKING_DIRECTORY/spec/fixtures/json/sample.rb": {
+      "lines": [
+        null,
+        1,
+        1,
+        1,
+        1,
+        null,
+        null,
+        1,
+        1,
+        null,
+        null,
+        1,
+        1,
+        0,
+        null,
+        1,
+        null,
+        null,
+        null,
+        "ignored",
+        "ignored",
+        "ignored",
+        "ignored",
+        "ignored",
+        null
+      ],
+      "covered_percent": 90.0,
+      "methods": [
+        {
+          "name": "Foo#initialize",
+          "start_line": 3,
+          "end_line": 6,
+          "coverage": 1
+        },
+        {
+          "name": "Foo#bar",
+          "start_line": 8,
+          "end_line": 10,
+          "coverage": 1
+        },
+        {
+          "name": "Foo#foo",
+          "start_line": 12,
+          "end_line": 18,
+          "coverage": 1
+        },
+        {
+          "name": "Foo#skipped",
+          "start_line": 21,
+          "end_line": 23,
+          "coverage": "ignored"
+        }
+      ],
+      "methods_covered_percent": 100.0
+    }
+  },
+  "groups": {}
+}