minitest-reporters 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e52b066c54c031213526e32a0674b52a5c3ae1f789dd0a8964f6d28e6492a93
-  data.tar.gz: 4a4a5716998c1c031975dac76d881f5e36b803a375334629b39a8240a8a85ac3
+  metadata.gz: de01e0afb6f385fb1d12dcf414a2f5f2c5b87363bb6300ae35985c8bc2354638
+  data.tar.gz: 3def5f8c01897b2e39395479f9599dcb6b837366512a8486ad9d7c19a6be5aab
 SHA512:
-  metadata.gz: 319f222e3c13c8d0e54b6f9360f48d1766602ec5350f358d785efdc22a199a919f8c5b25fe9169cc94bb26b2f528c9fc195d72d60ca863285ad9b990992525c5
-  data.tar.gz: b905c611851503c3e21cc9642e0251bff21eae23550c0d72d33fd1adbf985029d22307cf511f4f4329378892fd8880a11eda7a0f0de01153d40a19a7f21191b6
+  metadata.gz: db577d5beacf367f1ed9e61306b927039fe3f2c0ae7c5549094696a0ae457e39c43fc07ab1fc880caf051555e650a57d2a23d051b1e98e8e1db0e5a34609ad00
+  data.tar.gz: 8b4cf058bf3d813fa63fa71005f7eca6a5516a1c317b7bb8ca911f543c09fa8d1295f4079319ae3d19835a73b5a8a77ae619b934a13da28466efd5018160dad0

data/.github/workflows/ci.yml

@@ -5,12 +5,12 @@ on: [push, pull_request]
 jobs:
   test:
     runs-on: ubuntu-latest
-
     strategy:
       fail-fast: false
       matrix:
         ruby-version:
           - head
+          - '3.2'
           - '3.1'
           - '3.0'
           - '2.7'
@@ -18,14 +18,30 @@ jobs:
           - '2.5'
           - '2.4'
           - '2.3'
-          - '2.2'
-          - '2.1'
-          - '2.0'
           - jruby-head
           - jruby-9.3
           - jruby-9.2
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # 'bundle install' and cache
+    - name: Run tests
+      run: bundle exec rake
+
+  legacy-test:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - '2.2'
+          - '2.1'
+          - '2.0'
+    steps:
+    - uses: actions/checkout@v3
     - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
       with:

data/.yardopts

@@ -1,6 +1,5 @@
 --readme          README.md
 --markup          markdown
---markup-provider maruku
 --default-return  ""
 --title           "Minitest-reporters Documentation"
---hide-void-return
+--hide-void-return

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-### [dev](https://github.com/kern/minitest-reporters/compare/v1.6.1...master)
+### [dev](https://github.com/minitest-reporters/minitest-reporters/compare/v1.7.0...master)
+
+### [1.7.0](https://github.com/minitest-reporters/minitest-reporters/compare/v1.6.1...v1.7.0)
+
+* Minor documentation improvements [#343](https://github.com/minitest-reporters/minitest-reporters/pull/343)
+* Fixed homepage link in gemspec [#333](https://github.com/minitest-reporters/minitest-reporters/pull/333) contributed by [andyw8](https://github.com/andyw8)
+* Added Ruby 3.2 to the CI matrix [#335](https://github.com/minitest-reporters/minitest-reporters/pull/335) contributed by [petergoldstein](https://github.com/petergoldstein)
+* Updated `JUnitReporter` to output a failure screenshot path when included in the minitest result [#346](https://github.com/minitest-reporters/minitest-reporters/pull/346) contributed by [matteeyah](https://github.com/matteeyah)
+* Fixed backwards fraction in `ProgressReporter` default format [#348](https://github.com/minitest-reporters/minitest-reporters/pull/348) contributed by [notEthan](https://github.com/notEthan)
+* Added option `suppress_inline_failure_output` to `SpecReporter` to provide an explicit switch, separate from `print_failure_summary`, for suppressing inline failure messages. Until this change, the `print_failure_summary` would do both: print a failure/error summary after all tests run and suppress the inline failure messages. With this change `print_failure_summary` will just add a summary at the end of a test run, and it will no longer suppress the inline failure messages. [#352](https://github.com/minitest-reporters/minitest-reporters/pull/352) contributed by [rthbound](https://github.com/rthbound)
 
 ### [1.6.1](https://github.com/kern/minitest-reporters/compare/v1.6.0...v1.6.1)
 

data/README.md

@@ -46,11 +46,11 @@ export MINITEST_REPORTER=JUnitReporter
 Detection of those systems is based on presence of certain ENV variables and are evaluated in the following order:
 
 ```
- MINITEST_REPORTER => use reporter indicated in env variable
- TM_PID => use RubyMateReporter
- RM_INFO => use RubyMineReporter
- TEAMCITY_VERSION => use RubyMineReporter
- VIM => disable all Reporters
+MINITEST_REPORTER => use reporter indicated in env variable
+TM_PID => use RubyMateReporter
+RM_INFO => use RubyMineReporter
+TEAMCITY_VERSION => use RubyMineReporter
+VIM => disable all Reporters
 ```
 
 The following reporters are provided:
@@ -77,15 +77,15 @@ Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(:color => tru
 
 **Default Reporter**
 
-![Default Reporter](./assets/default-reporter.png?raw=true)
+![Default Reporter](https://raw.githubusercontent.com/minitest-reporters/minitest-reporters/master/assets/default-reporter.png)
 
 **Spec Reporter**
 
-![Spec Reporter](./assets/spec-reporter.png?raw=true)
+![Spec Reporter](https://raw.githubusercontent.com/minitest-reporters/minitest-reporters/master/assets/spec-reporter.png)
 
 **Progress Reporter**
 
-![Progress Reporter](./assets/progress-reporter.png?raw=true)
+![Progress Reporter](https://raw.githubusercontent.com/minitest-reporters/minitest-reporters/master/assets/progress-reporter.png)
 
 ## Caveats ##
 
@@ -104,11 +104,11 @@ happening if you see overly long or otherwise unexpected backtraces.)
 To avoid that, you must manually tell minitest-reporters which filter to use. In Rails,
 do this in `test_helper.rb`:
 ```ruby
-    Minitest::Reporters.use!(
-      Minitest::Reporters::DefaultReporter.new,
-      ENV,
-      Minitest.backtrace_filter
-    )
+Minitest::Reporters.use!(
+  Minitest::Reporters::DefaultReporter.new,
+  ENV,
+  Minitest.backtrace_filter
+)
 ```
 The third parameter to `.use!`, in this case `Minitest.backtrace_filter`, should be a
 filter object. In the above example, you're telling minitest-reporters to use the filter

data/lib/minitest/reporters/junit_reporter.rb

@@ -86,31 +86,23 @@ module Minitest
         suite_result = analyze_suite(tests)
         file_path = get_relative_path(tests.first)
 
-        if @timestamp_report
-          xml.testsuite(:name => suite, :filepath => file_path,
-                                    :skipped => suite_result[:skip_count], :failures => suite_result[:fail_count],
-                                    :errors => suite_result[:error_count], :tests => suite_result[:test_count],
-                                    :assertions => suite_result[:assertion_count], :time => suite_result[:time],
-                                    :timestamp => suite_result[:timestamp]) do
-            tests.each do |test|
-              lineno = get_source_location(test).last
-              xml.testcase(:name => test.name, :lineno => lineno, :classname => suite, :assertions => test.assertions,
-                           :time => test.time, :file => file_path) do
-                xml << xml_message_for(test) unless test.passed?
-              end
-            end
-          end
-        else
-         xml.testsuite(:name => suite, :filepath => file_path,
-                                    :skipped => suite_result[:skip_count], :failures => suite_result[:fail_count],
-                                    :errors => suite_result[:error_count], :tests => suite_result[:test_count],
-                                    :assertions => suite_result[:assertion_count], :time => suite_result[:time]) do
-            tests.each do |test|
-              lineno = get_source_location(test).last
-              xml.testcase(:name => test.name, :lineno => lineno, :classname => suite, :assertions => test.assertions,
-                           :time => test.time, :file => file_path) do
-                xml << xml_message_for(test) unless test.passed?
-              end
+        testsuite_attributes = {
+          :name => suite, :filepath => file_path, :skipped => suite_result[:skip_count],
+          :failures => suite_result[:fail_count], :errors => suite_result[:error_count],
+          :tests => suite_result[:test_count], :assertions => suite_result[:assertion_count],
+          :time => suite_result[:time]
+        }
+        testsuite_attributes[:timestamp] = suite_result[:timestamp] if @timestamp_report
+
+        xml.testsuite(testsuite_attributes) do
+          tests.each do |test|
+            lineno = get_source_location(test).last
+            xml.testcase(
+              :name => test.name, :lineno => lineno, :classname => suite,
+              :assertions => test.assertions, :time => test.time, :file => file_path
+            ) do
+              xml << xml_message_for(test) unless test.passed?
+              xml << xml_attachment_for(test) if test.respond_to?('metadata') && test.metadata[:failure_screenshot_path]
             end
           end
         end
@@ -155,6 +147,12 @@ module Minitest
         end
       end
 
+      def xml_attachment_for(test)
+        xml = Builder::XmlMarkup.new(:indent => 2, :margin => 2)
+
+        xml.tag!('system-out', "[[ATTACHMENT|#{test.metadata[:failure_screenshot_path]}]]")
+      end
+
       def location(exception)
         last_before_assertion = ''
         exception.backtrace.reverse_each do |s|

data/lib/minitest/reporters/progress_reporter.rb

@@ -24,7 +24,7 @@ module Minitest
           starting_at:    count,
           progress_mark:  green(PROGRESS_MARK),
           remainder_mark: ' ',
-          format:         options.fetch(:format, '  %C/%c: [%B] %p%% %a, %e'),
+          format:         options.fetch(:format, '  %c/%C: [%B] %p%% %a, %e'),
           autostart:      false
         )
       end

data/lib/minitest/reporters/spec_reporter.rb

@@ -12,12 +12,15 @@ module Minitest
 
       # The constructor takes an `options` hash
       # @param options [Hash]
-      # @option options print_failure_summary [Boolean] wether to print the errors at the bottom of the
-      #   report or inline as they happen.
+      # @option options print_failure_summary [Boolean] whether to print the errors at the bottom of the
+      #   report.
+      # @option options suppress_inline_failure_output [Boolean] whether to suppress the printing of errors
+      #   inline with the test results as they occur.
       #
       def initialize(options = {})
         super
         @print_failure_summary = options[:print_failure_summary]
+        @suppress_inline_failure_output = options[:suppress_inline_failure_output]
       end
 
       def start
@@ -50,7 +53,7 @@ module Minitest
       def record(test)
         super
         record_print_status(test)
-        record_print_failures_if_any(test) unless @print_failure_summary
+        record_print_failures_if_any(test) if @suppress_inline_failure_output
       end
 
       protected

data/lib/minitest/reporters/version.rb

@@ -1,5 +1,5 @@
 module Minitest
   module Reporters
-    VERSION = '1.6.1'.freeze
+    VERSION = '1.7.0'.freeze
   end
 end

data/minitest-reporters.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Alexander Kern']
   s.email       = ['alex@kernul.com']
-  s.homepage    = 'https://github.com/CapnKernul/minitest-reporters'
+  s.homepage    = 'https://github.com/minitest-reporters/minitest-reporters'
   s.summary     = %q{Create customizable Minitest output formats}
   s.description = %q{Death to haphazard monkey-patching! Extend Minitest through simple hooks.}
   s.license     = 'MIT'
@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'ruby-progressbar'
   s.add_dependency 'builder'
 
-  s.add_development_dependency 'maruku'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rubocop'
 

data/test/integration/reporters/junit_reporter_test.rb

@@ -8,5 +8,21 @@ module MinitestReportersTest
       output = `ruby #{test_filename} 2>&1`
       refute_match 'No such file or directory', output
     end
+
+    if Gem::Version.new(Minitest::VERSION) >= Gem::Version.new('5.19.0')
+      def test_outputs_screenshot_metadata
+        test = Minitest::Test.new('test_fail')
+        test.define_singleton_method(:test_fail) { assert false }
+        test.metadata = { failure_screenshot_path: 'screenshot.png' }
+
+        reporter = Minitest::Reporters::JUnitReporter.new('test/tmp')
+        reporter.start
+        reporter.record(test.run)
+        reporter.report
+
+        test_output = File.read('test/tmp/TEST-Minitest-Test.xml')
+        assert_includes test_output, '<system-out>[[ATTACHMENT|screenshot.png]]</system-out>'
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-reporters
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Alexander Kern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-27 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: maruku
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -167,7 +153,7 @@ files:
 - test/unit/minitest/minitest_reporter_plugin_test.rb
 - test/unit/minitest/reporters_test.rb
 - test/unit/minitest/spec_reporter_test.rb
-homepage: https://github.com/CapnKernul/minitest-reporters
+homepage: https://github.com/minitest-reporters/minitest-reporters
 licenses:
 - MIT
 metadata: {}