rspec_junit_formatter 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 892c4451f42f7fdbfe335df86dd6f910d5fc4a54b91614b2da4283490a635646
-  data.tar.gz: 870ebdab7dd2e600b57493ce26437cee64b73cdc1cd05b48d6f67ad7160e98e8
+  metadata.gz: 6a808950ca0ea8273d57ec14b76e0f33326f2cf473708c8809ce7f80d5daef1f
+  data.tar.gz: 724eb19bbed6395719c2791f5661a80f5ece271bf85eb44a1d864a883f06edde
 SHA512:
-  metadata.gz: 4b55d404b3e056fd85dcef4712c386de35448f442abbc750b8fe9fc5d9953b79bb9552790bff53f88f67a91d7685765d9ddbb9cbefba0317d7cd2c558dabd036
-  data.tar.gz: aa4f7f1061266efeb3e4da1756d5a47969c8f1964174dbba23054b580a035a356d8b8880f2da47b940f423a5f2fb35371eed52990ab2540f133f49708bbe2bf5
+  metadata.gz: 9bf5b02431be19674c48a308132008bdd93d1619a1efadd197009cd67c150984cdefc918f73209535a936f53dd3847b677c9f1c4823a181cc4e18e5f33411c27
+  data.tar.gz: db0d242d4eaf205bc38c795f2313a29306d8bdc82218940058929d215a5c7650a22406406bcdd9a585b0793cfa862f62302716f21d498270116625e991b0e871

data/README.md

@@ -3,7 +3,7 @@
 [![Build results](https://github.com/sj26/rspec_junit_formatter/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/sj26/rspec_junit_formatter/actions/workflows/ci.yml?branch=main) 
 [![Gem version](http://img.shields.io/gem/v/rspec_junit_formatter.svg)](https://rubygems.org/gems/rspec_junit_formatter)
 
-[RSpec][rspec] 2 & 3 results that your CI can read. [Jenkins][jenkins-junit], [Buildkite][buildkite-junit], [CircleCI][circleci-junit], [Gitlab][gitlab-junit], and probably more, too.
+[RSpec][rspec] 3 results that your CI can read. [Jenkins][jenkins-junit], [Buildkite][buildkite-junit], [CircleCI][circleci-junit], [Gitlab][gitlab-junit], and probably more, too.
 
   [rspec]: http://rspec.info/
   [jenkins-junit]: https://jenkins.io/doc/pipeline/steps/junit/
@@ -11,6 +11,22 @@
   [circleci-junit]: https://circleci.com/docs/2.0/collect-test-data/
   [gitlab-junit]: https://docs.gitlab.com/ee/ci/unit_test_reports.html#ruby-example
 
+## Supported versions and legacy upgrades
+
+**0.7.0 requires Ruby >= 3.3 and RSpec >= 3.13, < 4.** We support upstream-maintained stable Ruby branches, including security maintenance, and the maintained stable RSpec minor series. As of October 2026, [Ruby 3.3 is security-maintained and Ruby 3.4/4.0 are normally maintained](https://www.ruby-lang.org/en/downloads/branches/). [RSpec supports only the latest major/minor pair](https://rspec.info/blog/2024/11/introducing-the-monorepo/), currently 3.13; RSpec 4 prereleases are not supported. Future minor releases may raise these minimums when upstream maintenance ends.
+
+**[0.6.2](https://rubygems.org/gems/rspec_junit_formatter/versions/0.6.2) is the final legacy-compatible release.** It retains Ruby >= 2.3 and RSpec >= 2, < 4 (except 2.12.0), including the encoding and aggregate failure fixes. See its [compatibility table](https://github.com/sj26/rspec_junit_formatter/blob/v0.6.2/README.md#tested-versus-permitted-versions) for tested combinations and limitations. It does not make end-of-life Ruby or RSpec versions maintained again.
+
+If you must keep an older Ruby **or** an older RSpec, use:
+
+```ruby
+gem "rspec_junit_formatter", "0.6.2", require: false
+```
+
+Then run `bundle update rspec_junit_formatter`. Without Bundler, use `gem install rspec_junit_formatter -v 0.6.2`. Upgrading Ruby alone is not enough if your project must keep an older RSpec.
+
+To use 0.7.0, upgrade Ruby to a maintained version and RSpec to 3.13, remove the legacy formatter pin, and run `bundle update rspec rspec_junit_formatter`. Both Ruby and `rspec-core` requirements are recorded in the package so dependency resolution can retain 0.6.2 for older environments.
+
 ## Usage
 
 Install the gem:
@@ -95,18 +111,113 @@ Note that this example captures all output from every example all the time, pote
 ## Caveats
 
  * XML can only represent a [limited subset of characters][xml-charsets] which excludes null bytes and most control characters. This gem will use character entities where possible and fall back to replacing invalid characters with Ruby-like escape codes otherwise. For example, the null byte becomes `\0`.
+ * When converting report text to UTF-8 for XML output, invalid byte sequences and characters with no UTF-8 conversion are replaced with `�` (U+FFFD REPLACEMENT CHARACTER). The formatter uses each string's declared encoding; it does not guess the encoding of binary data.
 
   [xml-charsets]: https://www.w3.org/TR/xml/#charsets
 
 ## Development
 
-Run the specs with `bundle exec rake`, which uses [Appraisal][appraisal] to run the specs against all supported versions of rspec.
+Use Ruby 3.4 (see [`.ruby-version`](.ruby-version)) for maintenance. This selects the development Ruby; the installed gem's minimum is defined in the [gemspec](rspec_junit_formatter.gemspec).
+
+Install the Bundler version recorded in `Gemfile.lock`, then test the locked development bundle:
+
+```sh
+gem install bundler -v 4.0.23
+bundle install
+bundle exec rake spec
+```
+
+The [development workflow](.github/workflows/development.yml) tests this bundle separately from the [compatibility workflow](.github/workflows/ci.yml). Use `bundle update --all` to refresh the development lockfile.
+
+The supported RSpec series is also defined by [Appraisal][appraisal], with a separate Gemfile to test dependency resolution without the root lockfile:
+
+```sh
+BUNDLE_GEMFILE=gemfiles/rspec_3_13.gemfile bundle install
+BUNDLE_GEMFILE=gemfiles/rspec_3_13.gemfile bundle exec rake spec
+```
+
+Plain `bundle exec rake` also runs the Appraisals outside CI.
 
   [appraisal]: https://github.com/thoughtbot/appraisal
 
+### Tested versus permitted versions
+
+The [gemspec](rspec_junit_formatter.gemspec) permits Ruby >= 3.3 and `rspec-core` >= 3.13, < 4. These requirements allow installation; future versions are not automatically tested or supported.
+
+The CI workflows test these combinations:
+
+| Ruby | RSpec | Bundle |
+| --- | --- | --- |
+| 3.3, 3.4 and 4.0 | 3.13, latest patch | Appraisal |
+| 3.3, 3.4 and 4.0 | 3.13, pinned by `Gemfile.lock` | Development |
+
+CI selects the latest patch of each listed Ruby branch. The locked bundle currently uses RSpec 3.13.2 and rspec-core 3.13.6. Older Ruby and RSpec combinations remain available in [0.6.2](https://github.com/sj26/rspec_junit_formatter/tree/v0.6.2), not in the current test matrix.
+
 ## Releasing
 
-Bump the gem version in the gemspec, and commit. Then `bundle exec rake build` to build a gem package, `bundle exec rake install` to install and test it locally, then `bundle exec rake release` to tag and push the commits and gem.
+Releases use the [Release workflow](https://github.com/sj26/rspec_junit_formatter/actions/workflows/release.yml)
+and [RubyGems trusted publishing](https://guides.rubygems.org/trusted-publishing/).
+GitHub Actions builds **unsigned gems**: it needs no personal signing key, persistent
+RubyGems API key, or maintainer machine. Local `bundle exec rake build`, `install`,
+and `release` tasks remain available; local releases may retain the maintainer's
+traditional gem signatures. Do not publish the same version through both paths.
+
+1. Bump the gemspec version and update the changelog in a reviewed PR. Merge it
+   into `main`. Use a new stable `X.Y.Z` version; never reuse a published version.
+2. Tag that exact commit as `vX.Y.Z` and push the tag. Record its full commit SHA
+   with `git rev-parse 'vX.Y.Z^{commit}'`. Pushing a tag alone does not publish.
+3. Run the Release workflow **from `main`**, supplying the tag and full SHA. Leave
+   `publish` unchecked for validation only. It checks tag/version/commit agreement
+   and main ancestry, runs the compatibility and development suites at that SHA,
+   builds the gem, rejects embedded signatures, and tests a clean installation
+   outside the checkout. PRs also exercise the package build/install check, but
+   their artifacts can never be published by this workflow.
+4. Run again with the same tag and SHA and `publish` checked. After the checks pass,
+   review the commit and package SHA-256 in the build log, then approve the
+   `release` environment deployment. Sam can approve his own run. The publish job
+   downloads that run's exact immutable artifact, uses short-lived OIDC credentials,
+   and does not check out or build project code.
+5. The workflow verifies that RubyGems serves identical bytes before publishing a
+   GitHub release with the same gem. Check both the
+   [RubyGems version](https://rubygems.org/gems/rspec_junit_formatter/versions) and
+   [GitHub release](https://github.com/sj26/rspec_junit_formatter/releases).
+
+### One-time configuration
+
+The GitHub `release` environment must require approval by `sj26`, allow
+self-approval, disable admin bypass, and allow deployments only from the `main`
+branch. The **Immutable release tags** repository ruleset blocks updates and
+deletion of `v*` tags, with no bypass actors. Under the existing gem's
+**Trusted publishers** on RubyGems, configure:
+
+| Field | Value |
+| --- | --- |
+| Repository owner | `sj26` |
+| Repository name | `rspec_junit_formatter` |
+| Workflow filename | `release.yml` |
+| Environment | `release` |
+
+Leave reusable-workflow repository fields blank. This workflow grants
+`id-token: write` only to the environment-protected publish job. Do not add a
+RubyGems API key or personal signing key to repository secrets.
+
+### Recovery
+
+Release runs are serialized and never auto-cancel an active publication. If a
+push succeeds but a later step fails, **re-run failed jobs in the original run**
+while its `release-gem` artifact is retained (30 days). This reuses the validated
+bytes and requires environment approval again. An existing RubyGems version is
+accepted only if its SHA-256 matches, and its downloaded bytes must also match.
+An incomplete GitHub draft can resume; an existing asset must match byte-for-byte
+and is never overwritten. A published GitHub release missing its gem fails closed
+and needs manual inspection rather than silently changing a public release.
+
+If the tag moved, a digest differs, or the original artifact expired, stop and
+investigate. Do not delete/recreate tags, yank/re-push gems, or overwrite release
+assets to force a retry. A fresh run rebuilds and is safe only if it reproduces
+the same bytes; otherwise recover the original artifact or use a new version
+through the normal review process. Validation-only runs do not test OIDC exchange
+or publication; only a real, explicitly approved new release can prove those paths.
 
 ## License
 

data/lib/rspec_junit_formatter/rspec3.rb

@@ -46,12 +46,7 @@ private
   end
 
   def error_count
-    # Introduced in rspec 3.6
-    if @summary_notification.respond_to?(:errors_outside_of_examples_count)
-      @summary_notification.errors_outside_of_examples_count
-    else
-      0
-    end
+    @summary_notification.errors_outside_of_examples_count
   end
 
   def result_of(notification)
@@ -125,19 +120,8 @@ private
 
   # Completely gross hack for absolutely forcing off colorising for the
   # duration of a block.
-  if RSpec.configuration.respond_to?(:color_mode=)
-    def without_color(&block)
-      swap_rspec_configuration(:color_mode, :off, &block)
-    end
-  elsif RSpec.configuration.respond_to?(:color=)
-    def without_color(&block)
-      swap_rspec_configuration(:color, false, &block)
-    end
-  else
-    warn 'rspec_junit_formatter cannot prevent colorising due to an unexpected RSpec.configuration format'
-    def without_color
-      yield
-    end
+  def without_color(&block)
+    swap_rspec_configuration(:color_mode, :off, &block)
   end
 
   def stdout_for(example_notification)
@@ -149,23 +133,9 @@ private
   end
 
   def aggregate_failure?(exception)
-    # Introduced in rspec 3.3
+    # rspec-expectations is optional; the formatter only depends on rspec-core.
     return false unless defined?(RSpec::Expectations::MultipleExpectationsNotMetError)
 
     exception.is_a?(RSpec::Expectations::MultipleExpectationsNotMetError)
   end
 end
-
-# rspec-core 3.0.x forgot to mark this as a module function which causes:
-#
-#   NoMethodError: undefined method `wrap' for RSpec::Core::Notifications::NullColorizer:Class
-#     .../rspec-core-3.0.4/lib/rspec/core/notifications.rb:229:in `add_shared_group_line'
-#     .../rspec-core-3.0.4/lib/rspec/core/notifications.rb:157:in `message_lines'
-#
-if defined?(RSpec::Core::Notifications::NullColorizer) && RSpec::Core::Notifications::NullColorizer.is_a?(Class) && !RSpec::Core::Notifications::NullColorizer.respond_to?(:wrap)
-  RSpec::Core::Notifications::NullColorizer.class_eval do
-    def self.wrap(*args)
-      new.wrap(*args)
-    end
-  end
-end

data/lib/rspec_junit_formatter.rb

@@ -9,8 +9,6 @@ require "rspec/core/formatters/base_formatter"
 # Dumps rspec results as a JUnit XML file.
 # Based on XML schema: http://windyroad.org/dl/Open%20Source/JUnit.xsd
 class RSpecJUnitFormatter < RSpec::Core::Formatters::BaseFormatter
-  # rspec 2 and 3 implements are in separate files.
-
 private
 
   def xml_dump
@@ -166,7 +164,7 @@ private
 
   def escape(text)
     # Make sure it's utf-8, replace illegal characters with ruby-like escapes, and replace special and discouraged characters with entities
-    text.to_s.encode(Encoding::UTF_8).gsub(ILLEGAL_REGEXP, ILLEGAL_REPLACEMENT).gsub(DISCOURAGED_REGEXP, DISCOURAGED_REPLACEMENTS)
+    text.to_s.encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: "\uFFFD").gsub(ILLEGAL_REGEXP, ILLEGAL_REPLACEMENT).gsub(DISCOURAGED_REGEXP, DISCOURAGED_REPLACEMENTS)
   end
 
   STRIP_DIFF_COLORS_BLOCK_REGEXP = /^ ( [ ]* ) Diff: (?: \e\[ 0 m )? (?: \n \1 \e\[ \d+ (?: ; \d+ )* m .* )* /x
@@ -188,8 +186,4 @@ end
 
 RspecJunitFormatter = RSpecJUnitFormatter
 
-if Gem::Version.new(RSpec::Core::Version::STRING) >= Gem::Version.new("3")
-  require "rspec_junit_formatter/rspec3"
-else
-  require "rspec_junit_formatter/rspec2"
-end
+require "rspec_junit_formatter/rspec3"

metadata

@@ -1,33 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rspec_junit_formatter
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Samuel Cochran
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDKDCCAhCgAwIBAgIBBTANBgkqhkiG9w0BAQsFADA6MQ0wCwYDVQQDDARzajI2
-  MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0y
-  NjEwMjAyMzA3MDhaFw0yNzEwMjAyMzA3MDhaMDoxDTALBgNVBAMMBHNqMjYxFDAS
-  BgoJkiaJk/IsZAEZFgRzajI2MRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
-  hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr60Eo/ttCk8GMTMFiPr3GoYMIMFvLak
-  xSmTk9YGCB6UiEePB4THSSA5w6IPyeaCF/nWkDp3/BAam0eZMWG1IzYQB23TqIM0
-  1xzcNRvFsn0aQoQ00k+sj+G83j3T5OOV5OZIlu8xAChMkQmiPd1NXc6uFv+Iacz7
-  kj+CMsI9YUFdNoU09QY0b+u+Rb6wDYdpyvN60YC30h0h1MeYbvYZJx/iZK4XY5zu
-  4O/FL2ChjL2CPCpLZW55ShYyrzphWJwLOJe+FJ/ZBl6YXwrzQM9HKnt4titSNvyU
-  KzE3L63A3PZvExzLrN9u09kuWLLJfXB2sGOlw3n9t72rJiuBr3/OQQIDAQABozkw
-  NzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU99dfRjEKFyczTeIz
-  m3ZsDWrNC80wDQYJKoZIhvcNAQELBQADggEBAEHT9KAaQy80m6KKiJiuVVq96HNo
-  sub7+06IGfsNqxJHJPZoqsdRUkH+WUliVdQ1yAI35QmO2glCJt1UvQU7vkI6CQBB
-  rjFWNmbQhyK2fjiwuvSI1QmgH/NeT45lzW4TSg04hmIhtX8G+1HeyKck/qDaDyoO
-  GgETed1QI+mcbxl1+O8w1QSuvClVm7y+Nk5PeOxjPT/2DMuChLyTP3NYnyiHifdS
-  OKO8Px6knr64z1LWwB+m04k+z+D1oD6757fkD96O1C1AtMtNoQHwfNX7JSPhQSQM
-  z4nsMtYoPwFoGnDqvraRmVqMLL3asgAh8SYE6c4eoaX1b0r83v6aLnIh3ew=
-  -----END CERTIFICATE-----
-date: 1980-01-02 00:00:00.000000000 Z
+cert_chain: []
+date: 2026-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -35,26 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.13'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 2.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.13'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +114,6 @@ files:
 - LICENSE
 - README.md
 - lib/rspec_junit_formatter.rb
-- lib/rspec_junit_formatter/rspec2.rb
 - lib/rspec_junit_formatter/rspec3.rb
 homepage: https://github.com/sj26/rspec_junit_formatter
 licenses:
@@ -154,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

checksums.yaml.gz.sig

@@ -1,2 +0,0 @@
-;�c��M���L���i�`-%uE���^o�_��+�=^����(L�֏!m�?�h+��W<c
-)���@,��v�R��x䆎���Uc

data/lib/rspec_junit_formatter/rspec2.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-class RSpecJUnitFormatter < RSpec::Core::Formatters::BaseFormatter
-  attr_reader :started
-
-  def start(example_count)
-    @started = Time.now
-    super
-  end
-
-  def dump_summary(duration, example_count, failure_count, pending_count)
-    super
-    xml_dump
-  end
-
-private
-
-  def result_of(example)
-    example.execution_result[:status].to_sym
-  end
-
-  def example_group_file_path_for(example)
-    meta = example.metadata
-    while meta[:example_group]
-      meta = meta[:example_group]
-    end
-    meta[:file_path]
-  end
-
-  def classname_for(example)
-    fp = example_group_file_path_for(example)
-    fp.sub(%r{\.[^/.]+\Z}, "").gsub("/", ".").gsub(/\A\.+|\.+\Z/, "")
-  end
-
-  def duration_for(example)
-    example.execution_result[:run_time]
-  end
-
-  def description_for(example)
-    example.full_description
-  end
-
-  def exception_for(example)
-    example.execution_result[:exception]
-  end
-
-  def failure_type_for(example)
-    exception_for(example).class.name
-  end
-
-  def failure_message_for(example)
-    strip_diff_colors(exception_for(example).to_s)
-  end
-
-  def failure_for(example)
-    exception = exception_for(example)
-    message   = strip_diff_colors(exception.message)
-    backtrace = format_backtrace(exception.backtrace, example)
-
-    if shared_group = find_shared_group(example)
-      backtrace << "Shared Example Group: \"#{shared_group.metadata[:shared_group_name]}\" called from #{shared_group.metadata[:example_group][:location]}"
-    end
-
-    "#{message}\n#{backtrace.join("\n")}"
-  end
-
-  def error_count
-    0
-  end
-
-  def find_shared_group(example)
-    group_and_parent_groups(example).find { |group| group.metadata[:shared_group_name] }
-  end
-
-  def group_and_parent_groups(example)
-    example.example_group.parent_groups + [example.example_group]
-  end
-
-  def stdout_for(example)
-    example.metadata[:stdout]
-  end
-
-  def stderr_for(example)
-    example.metadata[:stderr]
-  end
-end