better_coverage 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80a077769534b5cd4709f7844887805d72b9f760605363cff95c9fd939eca64e
-  data.tar.gz: 96fbc52eae5827f8dc8f2625c9834aee87160b3056079be85d8300d7f2456f7c
+  metadata.gz: a7f5a4ce847abf8e093c1e2ec3362653d8ec1f0126ac5d8915b08895e3cea9b8
+  data.tar.gz: c952539e5001d5acbf41f60e926095d33cd266dc4afff4de93743d3fd2ed4d1c
 SHA512:
-  metadata.gz: 9b671abdd530d496637d69dfd2c9e1b4b0ab797a31ef47b1e10373896f1a0225d910a0585d33f030a03c049a8988862b410e104132ddee8b333b5240859681c6
-  data.tar.gz: d43e52ef4a6df7c1210749dbb85ae17862a206883a77a73fa1c0dce9fd5ea80358b9e70647fffabd12669680b566264636452d1f1e0cd3e3ba18491808d43b27
+  metadata.gz: 6b95e4b3a47df45691dd33570d869cebb6e13eafcb137c3205780144e5e32e5aadd4c707f691735f0b19e7aefd58c174aa7b249adc0cc4a21880932060e6fe43
+  data.tar.gz: 8181b23f8e230550880ae6f18045dc580c7d289a4a268900be9fc091b5eb42cc2c010975ef502b03cc6c15ec6fc419894dc09fba39dddc92e989183cfc467fa9

data/README.md

@@ -44,6 +44,59 @@ MinitestPlus::BetterCoverage.new(
 )
 ```
 
+## BetterJUnit
+
+**BetterJUnit** is a Minitest reporter that aggregates **all** test suites into a single JUnit XML file.
+
+##### Why?
+
+The built-in `Minitest::Reporters::JUnitReporter` writes one XML file per test class (e.g. `TEST-CalculatorTest.xml`, `TEST-StringTest.xml`, ...). Most CI test-result consumers — GitHub Actions test annotators, Buildkite test analytics, CircleCI insights, etc. — expect a **single** combined artefact. `BetterJUnit` emits exactly that: one `<testsuites>` document containing every `<testsuite>`, with the same field set as the upstream reporter (so it stays interoperable with every standard JUnit consumer).
+
+In your `test/test_helper.rb`:
+
+```ruby
+require 'minitest/reporters'
+require 'better_junit'
+
+Minitest::Reporters.use! [
+  MinitestPlus::BetterJUnit.new
+]
+```
+
+The combined report is written to `test/reports/junit.xml` by default.
+
+#### Options
+
+```ruby
+MinitestPlus::BetterJUnit.new(
+  path: 'build/reports/junit.xml',  # Output file path (default: 'test/reports/junit.xml')
+  base_path: Dir.pwd,               # Base for relative file paths in XML (default: Dir.pwd)
+  include_timestamp: true           # Add ISO8601 timestamp per suite (default: false)
+)
+```
+
+The `path` option accepts any path — nested directories are created automatically:
+
+```ruby
+MinitestPlus::BetterJUnit.new(path: 'out/deeply/nested/results/my-custom-junit.xml')
+```
+
+#### Sample output
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites>
+  <testsuite name="CalculatorTest" filepath="test/calculator_test.rb" skipped="0" failures="0" errors="0" tests="2" assertions="2" time="0.000021">
+    <testcase name="test_addition" lineno="6" classname="CalculatorTest" assertions="1" time="0.000018" file="test/calculator_test.rb"/>
+    <testcase name="test_subtraction" lineno="10" classname="CalculatorTest" assertions="1" time="0.000003" file="test/calculator_test.rb"/>
+  </testsuite>
+  <testsuite name="StringTest" filepath="test/string_test.rb" skipped="0" failures="0" errors="0" tests="2" assertions="2" time="0.000010">
+    <testcase name="test_reverse" lineno="10" classname="StringTest" assertions="1" time="0.000007" file="test/string_test.rb"/>
+    <testcase name="test_upcase" lineno="6" classname="StringTest" assertions="1" time="0.000003" file="test/string_test.rb"/>
+  </testsuite>
+</testsuites>
+```
+
 ## Contributing
 
 Contributions are welcome! If you find a bug or have suggestions for improvement, please open an issue or submit a pull request.

data/lib/better_coverage.rb

@@ -26,6 +26,10 @@ module MinitestPlus
       result = SimpleCov.result
       return unless result
 
+      # Calling SimpleCov.result stops its at_exit hook from running; flip it back
+      # on so the configured formatters still write their reports.
+      SimpleCov.running = true if SimpleCov.respond_to?(:running=) && !SimpleCov.running
+
       print_coverage_table(result)
     end
 

data/lib/better_junit.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'minitest/reporters'
+require 'builder'
+require 'fileutils'
+require 'pathname'
+require 'time'
+
+module MinitestPlus
+  class BetterJUnit < Minitest::Reporters::BaseReporter # rubocop:disable Metrics/ClassLength,Style/Documentation
+    DEFAULT_PATH = 'test/reports/junit.xml'
+
+    def initialize(options = {})
+      super({})
+      @path = options[:path] || DEFAULT_PATH
+      @base_path = options[:base_path] || Dir.pwd
+      @include_timestamp = options[:include_timestamp] || false
+    end
+
+    def report
+      super
+      FileUtils.mkdir_p(File.dirname(@path))
+      File.write(@path, build_xml)
+    end
+
+    private
+
+    def build_xml
+      xml = Builder::XmlMarkup.new(indent: 2)
+      xml.instruct!
+      xml.testsuites do
+        tests.group_by { |test| test_class(test) }.each do |suite, suite_tests|
+          parse_xml_for(xml, suite, suite_tests) if suite
+        end
+      end
+      xml.target!
+    end
+
+    def get_source_location(result)
+      result.source_location
+    end
+
+    def get_relative_path(result)
+      file_path = Pathname.new(get_source_location(result).first)
+      base_path = Pathname.new(@base_path)
+
+      if file_path.absolute?
+        file_path.relative_path_from(base_path)
+      else
+        file_path
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def parse_xml_for(xml, suite, tests)
+      stats = analyze_suite(tests)
+      file_path = get_relative_path(tests.first)
+      attrs = testsuite_attributes(suite, file_path, stats)
+
+      xml.testsuite(attrs) do
+        tests.each do |test|
+          xml.testcase(testcase_attributes(test, suite, file_path)) do
+            message = xml_message_for(test)
+            xml << message if message
+            xml << xml_attachment_for(test) if test.respond_to?('metadata') && test.metadata[:failure_screenshot_path]
+          end
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def testsuite_attributes(suite, file_path, stats)
+      attrs = {
+        name: suite.name, filepath: file_path.to_s, skipped: stats[:skip_count],
+        failures: stats[:fail_count], errors: stats[:error_count],
+        tests: stats[:test_count], assertions: stats[:assertion_count],
+        time: stats[:time]
+      }
+      attrs[:timestamp] = stats[:timestamp] if @include_timestamp && stats[:timestamp]
+      attrs
+    end
+
+    def testcase_attributes(test, suite, file_path)
+      {
+        name: test.name, lineno: get_source_location(test).last, classname: suite.name,
+        assertions: test.assertions, time: test.time, file: file_path.to_s
+      }
+    end
+
+    def xml_attachment_for(test)
+      xml = Builder::XmlMarkup.new(indent: 2, margin: 2)
+      xml.tag!('system-out', "[[ATTACHMENT|#{test.metadata[:failure_screenshot_path]}]]")
+      xml.target!
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def xml_message_for(test)
+      failure = test.failure
+      return nil unless failure
+
+      xml = Builder::XmlMarkup.new(indent: 2, margin: 2)
+
+      if test.skipped?
+        xml.skipped(type: failure.error.class.name)
+      elsif test.error?
+        xml.error(type: failure.error.class.name, message: trunc(failure.message)) do
+          xml.text!(message_for(test, failure) || '')
+        end
+      else
+        xml.failure(type: failure.error.class.name, message: trunc(failure.message)) do
+          xml.text!(message_for(test, failure) || '')
+        end
+      end
+
+      xml.target!
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    def trunc(text)
+      text.sub(/\n.*/m, '...')
+    end
+
+    def message_for(test, failure)
+      suite = test.class
+      name = test.name
+
+      if test.skipped?
+        "Skipped:\n#{name}(#{suite}) [#{location(failure)}]:\n#{failure.message}\n"
+      elsif test.error?
+        "Error:\n#{name}(#{suite}):\n#{failure.message}"
+      else
+        "Failure:\n#{name}(#{suite}) [#{location(failure)}]:\n#{failure.message}\n"
+      end
+    end
+
+    def location(failure)
+      last_before_assertion = ''
+      failure.backtrace.reverse_each do |s|
+        break if s =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
+
+        last_before_assertion = s
+      end
+      last_before_assertion.sub(/:in .*$/, '')
+    end
+
+    def analyze_suite(tests)
+      stats = Hash.new(0)
+      stats[:time] = 0.0
+      tests.each do |test|
+        stats[:"#{result(test)}_count"] += 1
+        stats[:assertion_count] += test.assertions
+        stats[:test_count] += 1
+        stats[:time] += test.time
+      end
+      stats[:timestamp] = Time.now.iso8601 if @include_timestamp
+      stats
+    end
+  end
+end

data/lib/minitest_plus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MinitestPlus
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_coverage
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Mridang Agarwalla
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-28 00:00:00.000000000 Z
+date: 2026-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
@@ -48,6 +48,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/better_coverage.rb
+- lib/better_junit.rb
 - lib/minitest_plus/version.rb
 homepage: https://github.com/mridang/minitest-reporters
 licenses: