test-unit 3.5.6 → 3.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76204c43946c95b92e409e9c59e020ca48d320d2b822af282501fbdaebe168b9
-  data.tar.gz: 179f9510fdde6181202a061baff981b84c06c6b255026757659f95f1c8d6695d
+  metadata.gz: 87316242bf95be028eca18e6b4da38984f75fb2e2e6b97641c17b4724f802102
+  data.tar.gz: ce1ae80016128f58874503100e09ae3ebd150f08482c48c6c7cc92cf0c6e9b4f
 SHA512:
-  metadata.gz: fa93c81087b59e439aee294d98b0854127b3d9117729b9d9bcaf8e0f7672fbbab3fbf4a69b6b4902c5c44cc9d367ea10a3cdca9f27062875ca1c169c53efc3a8
-  data.tar.gz: f2e46b643c095e2a5538b984e5aa0082bfd98afd591b28a8e86cb3a261048a970783dd0c59e8b471e383087444e64f6dfe457a88402eef8318e7a369c3d4e25b
+  metadata.gz: 3b6928cb432d65c2b1cbfc30a6bba8fce92c527b067f6986bb363ea31aeba30bbc3a2596863a7dc4b5e70e1763818b39715746d3bfc11531f948b576500b08fe
+  data.tar.gz: b6f9ebaff9aae704c5e4e6037d73d5a7983913defa1c0e744b6d8d77c7a10e765ff90aa6d0785bf90aeefbe8de2282dd5d6d6652daf380ec275b428a2cce3df7

data/README.md

@@ -19,7 +19,7 @@ test-unit ships as part of Ruby as a bundled gem. To check which version is incl
 It's only necessary to install the gem if you need a newer version.
 
 test-unit is the original Ruby unit testing library, and is still active.
-It is one of two unit testing libraries bundled with Ruby, the other being [minitest](https://github.com/seattlerb/minitest).
+It is one of two unit testing libraries bundled with Ruby, the other being [minitest](https://github.com/minitest/minitest).
 
 When deciding which to use, consider:
 

data/doc/text/news.md

@@ -1,10 +1,42 @@
 # News
 
+## 3.5.8 - 2023-05-12 {#version-3-5-8}
+
+### Improvements
+
+  * doc: Improved document for multi Ractor mode.
+    [GH-226][https://github.com/test-unit/test-unit/issues/226]
+    [Patch by Luke Gruber]
+
+  * doc: Updated minitest's URL.
+    [GH-228][https://github.com/test-unit/test-unit/issues/228]
+    [Patch by Koichi ITO]
+
+  * UI: console: Added `--progress-style` option.
+
+  * UI: console: Compacted `--verbose=important-only` output..
+
+  * UI: console: Changed the default output level to `important-only`
+      on GitHub Actions.
+
+### Thanks
+
+  * Luke Gruber
+
+  * Koichi ITO
+
+## 3.5.7 - 2022-12-15 {#version-3-5-7}
+
+### Improvements
+
+  * [UI][console]: Changed to use color escape sequence for each line
+    instead of each output that may consist with multiple lines.
+
 ## 3.5.6 - 2022-12-15 {#version-3-5-6}
 
 ### Improvements
 
-  * Enabled 256 colors output on GitHub Actions by default.
+  * [UI][console]: Enabled 256 colors output on GitHub Actions by default.
 
 ## 3.5.5 - 2022-10-04 {#version-3-5-5}
 

data/lib/test/unit/runner/console.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2008-2017  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2008-2023  Sutou Kouhei <kou@clear-code.com>
 
 module Test
   module Unit
@@ -18,7 +18,7 @@ module Test
         ["verbose", UI::Console::OutputLevel::VERBOSE],
       ]
       opts.on('-v', '--verbose=[LEVEL]', output_levels,
-              "Set the output level (default is verbose).",
+              "Set the output level (default is normal).",
               "(#{auto_runner.keyword_display(output_levels)})") do |level|
         level ||= output_levels.assoc("verbose")[1]
         auto_runner.runner_options[:output_level] = level
@@ -51,6 +51,17 @@ module Test
         auto_runner.runner_options[:progress_row_max] = max
       end
 
+      progress_styles = [
+        ["inplace", :inplace],
+        ["mark", :mark],
+        ["fault-only", :fault_only],
+      ]
+      opts.on("--progress-style=STYLE", progress_styles,
+              "Uses STYLE as progress style",
+              "(#{auto_runner.keyword_display(progress_styles)}") do |style|
+        auto_runner.runner_options[:progress_style] = style
+      end
+
       opts.on("--no-show-detail-immediately",
               "Shows not passed test details immediately.",
               "(default is yes)") do |boolean|

data/lib/test/unit/testcase.rb

@@ -357,7 +357,7 @@ module Test
         # Ractor mode is enabled in the current process and it's not
         # disabled even when only one Ractor is running after running
         # a test that uses Ractor on Ruby 3.0. It will be solved in
-        # Ruby 3.1.
+        # the future.
         #
         # This is implemented by setting the `:ractor` attribute of
         # the test to `true`.

data/lib/test/unit/ui/console/testrunner.rb

@@ -3,7 +3,7 @@
 # Author:: Nathaniel Talbott.
 # Copyright::
 #   * Copyright (c) 2000-2003 Nathaniel Talbott. All rights reserved.
-#   * Copyright (c) 2008-2017 Kouhei Sutou <kou@clear-code.com>
+#   * Copyright (c) 2008-2023 Sutou Kouhei <kou@clear-code.com>
 # License:: Ruby license.
 
 begin
@@ -36,12 +36,15 @@ module Test
           # STDOUT.
           def initialize(suite, options={})
             super
-            @output_level = @options[:output_level] || NORMAL
+            @output_level = @options[:output_level] || guess_output_level
             @output = @options[:output] || STDOUT
             @use_color = @options[:use_color]
             @use_color = guess_color_availability if @use_color.nil?
             @color_scheme = @options[:color_scheme] || ColorScheme.default
             @reset_color = Color.new("reset")
+            @progress_style = @options[:progress_style] || guess_progress_style
+            @progress_marks = ["|", "/", "-", "\\", "|", "/", "-", "\\"]
+            @progress_mark_index = 0
             @progress_row = 0
             @progress_row_max = @options[:progress_row_max]
             @progress_row_max ||= guess_progress_row_max
@@ -114,10 +117,13 @@ module Test
               nl if output?(NORMAL) and !output?(VERBOSE)
               output_faults
             end
-            nl(PROGRESS_ONLY)
-            change_output_level(IMPORTANT_FAULTS_ONLY) do
-              output_statistics(elapsed_time)
+            case @progress_style
+            when :inplace
+              output_single("\r", nil, PROGRESS_ONLY)
+            when :mark
+              nl(PROGRESS_ONLY)
             end
+            output_statistics(elapsed_time)
           end
 
           def output_faults
@@ -322,9 +328,13 @@ module Test
           end
 
           def output_statistics(elapsed_time)
-            output("Finished in #{elapsed_time} seconds.")
+            change_output_level(IMPORTANT_FAULTS_ONLY) do
+              output("Finished in #{elapsed_time} seconds.")
+            end
             output_summary_marker
-            output(@result)
+            change_output_level(IMPORTANT_FAULTS_ONLY) do
+              output(@result)
+            end
             output("%g%% passed" % @result.pass_percentage)
             unless elapsed_time.zero?
               output_summary_marker
@@ -339,11 +349,8 @@ module Test
           end
 
           def output_summary_marker
-            if @progress_row_max > 0
-              output("-" * @progress_row_max, summary_marker_color)
-            else
-              nl
-            end
+            return if @progress_row_max <= 0
+            output("-" * @progress_row_max, summary_marker_color)
           end
 
           def test_started(test)
@@ -372,7 +379,15 @@ module Test
 
           def test_finished(test)
             unless @already_outputted
-              output_progress(".", color("pass-marker"))
+              case @progress_style
+              when :inplace
+                mark = @progress_marks[@progress_mark_index]
+                @progress_mark_index =
+                  (@progress_mark_index + 1) % @progress_marks.size
+                output_progress(mark, color("pass-marker"))
+              when :mark
+                output_progress(".", color("pass-marker"))
+              end
             end
             @already_outputted = false
 
@@ -435,18 +450,24 @@ module Test
 
           def output_single(something, color=nil, level=nil)
             return false unless output?(level)
-            if @use_color and color
-              something = "%s%s%s" % [color.escape_sequence,
-                                      something,
-                                      @reset_color.escape_sequence]
+            something.to_s.each_line do |line|
+              if @use_color and color
+                line = "%s%s%s" % [color.escape_sequence,
+                                   line,
+                                   @reset_color.escape_sequence]
+              end
+              @output.write(line)
             end
-            @output.write(something)
             @output.flush
             true
           end
 
           def output_progress(mark, color=nil)
-            if output_single(mark, color, PROGRESS_ONLY)
+            if @progress_style == :inplace
+              output_single("\r#{mark}", color, PROGRESS_ONLY)
+            else
+              return unless output?(PROGRESS_ONLY)
+              output_single(mark, color)
               return unless @progress_row_max > 0
               @progress_row += mark.size
               if @progress_row >= @progress_row_max
@@ -457,24 +478,29 @@ module Test
           end
 
           def output_progress_in_detail_marker(fault)
-            if @progress_row_max > 0
-              output("=" * @progress_row_max)
-            else
-              nl
-            end
+            return if @progress_row_max <= 0
+            output("=" * @progress_row_max)
           end
 
           def output_progress_in_detail(fault)
             return if @output_level == SILENT
-            nl
-            output_progress_in_detail_marker(fault)
-            if categorize_fault(fault) == :need_detail_faults
-              output_fault_in_detail(fault)
+            need_detail_faults = (categorize_fault(fault) == :need_detail_faults)
+            if need_detail_faults
+              log_level = IMPORTANT_FAULTS_ONLY
             else
-              output_fault_in_short(fault)
+              log_level = @current_output_level
+            end
+            change_output_level(log_level) do
+              nl(NORMAL)
+              output_progress_in_detail_marker(fault)
+              if need_detail_faults
+                output_fault_in_detail(fault)
+              else
+                output_fault_in_short(fault)
+              end
+              output_progress_in_detail_marker(fault)
+              @progress_row = 0
             end
-            output_progress_in_detail_marker(fault)
-            @progress_row = 0
           end
 
           def output?(level)
@@ -508,6 +534,14 @@ module Test
             color("#{@result.status}-marker")
           end
 
+          def guess_output_level
+            if ENV["GITHUB_ACTIONS"] == "true"
+              IMPORTANT_FAULTS_ONLY
+            else
+              NORMAL
+            end
+          end
+
           TERM_COLOR_SUPPORT = /
             color|  # explicitly claims color support in the name
             direct| # explicitly claims "direct color" (24 bit) support
@@ -538,6 +572,14 @@ module Test
             end
           end
 
+          def guess_progress_style
+            if ENV["GITHUB_ACTIONS"] == "true"
+              :fault_only
+            else
+              :inplace
+            end
+          end
+
           def windows?
             /mswin|mingw/ === RUBY_PLATFORM
           end

data/lib/test/unit/version.rb

@@ -1,5 +1,5 @@
 module Test
   module Unit
-    VERSION = "3.5.6"
+    VERSION = "3.5.8"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test-unit
 version: !ruby/object:Gem::Version
-  version: 3.5.6
+  version: 3.5.8
 platform: ruby
 authors:
 - Kouhei Sutou
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-14 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: power_assert
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: An xUnit family unit testing framework for Ruby.