rspec_junit_formatter 0.6.2 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5284f5c3c374244eebe552b1284e12e846f0db274a6758ab2b3bf988828a5ecb
-  data.tar.gz: bba94018c3622f87b5a25d31d1dfcf6f3f52ab306234c67f32cfdb5526168835
+  metadata.gz: f8938b63b79c5d0cfd77464773645cca9a0c72b11c5d3f1fe7fc92d0279c4021
+  data.tar.gz: 9fc9a172d1292bb89a368e889f2f90165e47b087dd5c39fe7a154d9480ca3f61
 SHA512:
-  metadata.gz: 130f2aa5ff8c848fd971dd432a946452561eb8509bd9503525f4716d71acc7b7ac031ce81d0468eba463c0a808cb58e3c8121d9b139613af113397a1ef422126
-  data.tar.gz: db4e33312c94d947595627d342be7d3b483b4ca1c98fb53672851c58637728e11352d4a3102101a4f6cf81b0cf240a272dadd92c77c1861f0a3140727f52cd41
+  metadata.gz: e4c83896373201abf5ec66c1cc8dc858e44eb3def5546646e2ca72d36ea2dd70cb44d42b9db2d51d094daa46b3248fd4a189edced96f1db1a2319d4f38bdfff6
+  data.tar.gz: f3619e7aaef1751d2dc433c41e2c6608e77d31483e550fa8ce47ad95352f21c7052b10fa8b447b1f00d2a21b5d883be017939f120162fb5f635238088230aeca

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,20 +11,10 @@
   [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
 
-## Legacy release
-
-**0.6.2 is the final release for older Ruby and RSpec versions.** It retains Ruby >= 2.3 and RSpec >= 2, < 4 (except 2.12.0), with the latest encoding and aggregate failure fixes. See [tested versus permitted versions](#tested-versus-permitted-versions) for coverage and limitations.
-
-The next release will require Ruby >= 3.3 and RSpec >= 3.13. 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.
-
 ## Usage
 
+Requires Ruby >= 3.3 and RSpec >= 3.13, < 4. For older versions, see [legacy support](#supported-versions-and-legacy-upgrades).
+
 Install the gem:
 
 ```sh
@@ -111,110 +101,21 @@ Note that this example captures all output from every example all the time, pote
 
   [xml-charsets]: https://www.w3.org/TR/xml/#charsets
 
-## Development
+## Supported versions and legacy upgrades
 
-Use Ruby 3.4 (see [`.ruby-version`](.ruby-version)) for maintenance. Ruby 3.4 is in [normal maintenance](https://www.ruby-lang.org/en/downloads/branches/). This selects the development Ruby without changing the installed gem's requirements. Keep Ruby requirements out of the root Gemfile: Appraisal copies them into legacy Gemfiles.
+We support [maintained Ruby versions](https://www.ruby-lang.org/en/downloads/branches/), including security maintenance, and [the current stable RSpec series](https://rspec.info/blog/2024/11/introducing-the-monorepo/). Minor releases may raise the minimum versions when upstream support ends.
 
-Install the Bundler version recorded in `Gemfile.lock`, then test the locked development bundle:
+For Ruby < 3.3 or RSpec < 3.13, use [0.6.2](https://rubygems.org/gems/rspec_junit_formatter/versions/0.6.2), the final legacy release:
 
-```sh
-gem install bundler -v 4.0.23
-bundle install
-bundle exec rake spec
+```ruby
+gem "rspec_junit_formatter", "0.6.2", require: false
 ```
 
-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.
+Run `bundle update rspec_junit_formatter`, or install without Bundler using `gem install rspec_junit_formatter -v 0.6.2`. This release permits Ruby >= 2.3 and RSpec >= 2, < 4, except 2.12.0; see its [tested combinations](https://github.com/sj26/rspec_junit_formatter/blob/v0.6.2/README.md#tested-versus-permitted-versions).
 
-Legacy bundles are defined by [Appraisal][appraisal] and have separate Gemfiles. Select a compatible Ruby and Bundler, then run an individual bundle without the root lockfile, for example on Ruby 2.6:
-
-```sh
-BUNDLE_GEMFILE=gemfiles/rspec_2_x.gemfile bundle install
-BUNDLE_GEMFILE=gemfiles/rspec_2_x.gemfile bundle exec rake spec
-```
+## Contributing
 
-Plain `bundle exec rake` also runs all Appraisals outside CI. Not all historical RSpec versions run on modern Ruby, so use the combinations in the compatibility workflow rather than running all Appraisals on the maintainer Ruby.
-
-  [appraisal]: https://github.com/thoughtbot/appraisal
-
-### Tested versus permitted versions
-
-The [gemspec](rspec_junit_formatter.gemspec) permits Ruby >= 2.3 and `rspec-core` >= 2, < 4, excluding 2.12.0. These requirements allow installation; they do not mean every Ruby/RSpec combination is tested or works together.
-
-The CI workflows test these combinations:
-
-| Ruby | RSpec | Bundle |
-| --- | --- | --- |
-| 2.6–3.4 | 3.4–3.13, each minor series | Legacy Appraisals |
-| 2.6–3.1 | 2.14 (`< 2.99`) and 3.0–3.3, each minor series | Legacy Appraisals |
-| 3.4 and 4.0 | Current 3.13, pinned by `Gemfile.lock` | Development |
-
-Ruby 4.0 coverage initially uses only the current RSpec development bundle, not the historical Appraisals. Ruby 2.3–2.5 remain permitted but are not covered by CI. RSpec versions allowed by the gemspec but outside the Appraisal ranges are also untested. Historical RSpec versions below 3.4 are not compatible with Ruby 3.2 or newer. Retaining installation permission does not imply that an end-of-life Ruby still receives upstream security updates.
-
-## Releasing
-
-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.
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development, testing and release instructions.
 
 ## 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)
@@ -90,11 +85,13 @@ private
   def failure_for(notification)
     exception = exception_for(notification)
 
-    if aggregate_failure?(exception)
+    details = if aggregate_failure?(exception)
       strip_diff_colors(exception.message)
     else
       strip_diff_colors(notification.message_lines.join("\n")) << "\n" << notification.formatted_backtrace.join("\n")
     end
+
+    details.gsub(/ +$/, '')
   end
 
   def exception_for(notification)
@@ -125,19 +122,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 +135,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
@@ -164,9 +162,13 @@ private
     ?>.freeze => "&gt;".freeze,
   ).freeze
 
+  def utf8(text)
+    text.to_s.encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: "\uFFFD")
+  end
+
   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, invalid: :replace, undef: :replace, replace: "\uFFFD").gsub(ILLEGAL_REGEXP, ILLEGAL_REPLACEMENT).gsub(DISCOURAGED_REGEXP, DISCOURAGED_REPLACEMENTS)
+    utf8(text).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
@@ -182,14 +184,12 @@ private
     # We also only want to target the diff hunks because the failure message
     # itself might legitimately contain ansi escape codes.
     #
-    string.sub(STRIP_DIFF_COLORS_BLOCK_REGEXP) { |match| match.gsub(STRIP_DIFF_COLORS_CODES_REGEXP, "".freeze) }
+    # Transcode before matching: the original message may be invalid or use an
+    # encoding incompatible with the ASCII regexp. Leave XML escaping until later.
+    utf8(string).sub(STRIP_DIFF_COLORS_BLOCK_REGEXP) { |match| match.gsub(STRIP_DIFF_COLORS_CODES_REGEXP, "".freeze) }
   end
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_junit_formatter
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.1
 platform: ruby
 authors:
 - Samuel Cochran
@@ -15,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
@@ -120,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:
@@ -134,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:
   - - ">="

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