minitest 5.25.5 → 5.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2ea23b9f86dd37b5f5f3d45fb451303827cbdf9414215d8f769da3624184325
-  data.tar.gz: 3d976e8b864261af92ba50d466235e4fa529f31d3560d60ec4deba8e724fc872
+  metadata.gz: 99c81ecf40f2e6edde9201cded0808484223cdf20d3e819e1b043e50bcc2564c
+  data.tar.gz: 543e61e5ac5da94ddbaaa51969b0b5dbf2ea91b400c13fd88830396a22627867
 SHA512:
-  metadata.gz: 1258d24412b8461fe9a94acb9b795a1cd2a25db2d16f924ce6367662478d9e0672532636b5a2ccd809f549ba8ba6ab8f0cbeb6e8a249b1b91161cc4297f31c92
-  data.tar.gz: 4d6a977e948f40d05e7786d07656616e9f3a4e4469a59e7b5a8e571b8f6821284989156ca4225e8e7a29cfe640bbaf544248697e14536f7c63946ffc2a34232e
+  metadata.gz: 1e73adb8391043dc989b7dd2c307f5e5af72f2f2e51ef1e0fda7654cff90755fd920e2003f86ef0fa62bae2fbc9e9ec9a7a6bea76abc6a46c5b7f0500fa5b337
+  data.tar.gz: 3a860d654d72db62a86397b6849fa5509e21e5f5a021e920b0bca46d147cd8f5d7d5203ad28eb73b22b2a643683db0e8fa8948437688ec18642ef21666e3095f

data/History.rdoc

@@ -1,3 +1,35 @@
+=== 5.26.1 / 2025-11-08
+
+The Ocean Shores, Slightly Less Tipsy Edition!
+
+* 3 bug fixes:
+
+  * Add links to API doco in README.
+  * Add missing require thread.
+  * Bumped ruby version to include 4.0 (trunk). (hsbt)
+    (see also 5.14.2)
+
+=== 5.26.0 / 2025-10-07
+
+The Seattle.rb Nerd Party, Slightly Tipsy Edition!
+
+* 2 minor enhancements:
+
+  * Added extra documentation to Minitest::TestTask options.
+  * Make parallelize_me! a no-op when n_threads=1.
+
+* 9 bug fixes:
+
+  * Bypass parallel_executor entirely when n_threads=1.
+  * Don't require rubygems in Rakefile... it is 2025.
+  * Ensure that minitest exits non-zero on Interrupt. (tavianator)
+  * Fix Minitest.run sequence rdoc to include loop vars and read consistently.
+  * Fix call to parallel_executor.shutdown when it isn't defined.
+  * Removed some 1.8/1.9-based code from the assertions and expectations.
+  * Still fighting with rdoc? Yup. Still fighting with rdoc...
+  * Switched assert_equal's diff from Tempfile.open to Tempfile.create.
+  * Use Regexp.escape for BASE_RE in case pwd has special chars. (astra_1993)
+
 === 5.25.5 / 2025-03-12
 
 * 4 bug fixes:

data/README.rdoc

@@ -95,7 +95,9 @@ Given that you'd like to test the following class:
 
 === Unit tests
 
-Define your tests as methods beginning with +test_+.
+Define your tests as methods beginning with +test_+. Use
+{assertions}[/minitest/Minitest/Assertions.html] to test for results
+or state.
 
   require "minitest/autorun"
 
@@ -119,6 +121,9 @@ Define your tests as methods beginning with +test_+.
 
 === Specs
 
+Use {expectations}[/minitest/Minitest/Expectations.html] to check
+results or state. They must be wrapped in a value call (eg +_+).
+
   require "minitest/autorun"
 
   describe Meme do
@@ -146,7 +151,7 @@ For matchers support check out:
 
 === Benchmarks
 
-Add benchmarks to your tests.
+Add {benchmarks}[/minitest/Minitest/Benchmark.html] to your tests.
 
   # optionally run benchmarks, good for CI-only work!
   require "minitest/benchmark" if ENV["BENCH"]

data/Rakefile

@@ -1,6 +1,5 @@
 # -*- ruby -*-
 
-require "rubygems"
 require "hoe"
 $:.unshift "lib" # to pick up lib/minitest/test_task.rb when minitest not installed
 
@@ -12,7 +11,7 @@ Hoe.spec "minitest" do
 
   license "MIT"
 
-  require_ruby_version [">= 2.7", "< 4.0"]
+  require_ruby_version ">= 2.7"
 end
 
 desc "Find missing expectations"

data/design_rationale.rb

@@ -2,25 +2,27 @@
 ###############################################################################
 describe Thingy do                     # class TestThingy < Minitest::Test
   before do                            #   def setup
-    do_some_setup                      #     super
-  end                                  #     do_some_setup
-                                       #   end
-  it "should do the first thing" do    #
-    1.must_equal 1                     #   def test_first_thing
-  end                                  #     assert_equal 1, 1
-                                       #   end
-  describe SubThingy do                # end
-    before do                          #
-      do_more_setup                    # class TestSubThingy < TestThingy
-    end                                #   def setup
                                        #     super
-    it "should do the second thing" do #     do_more_setup
-      2.must_equal 2                   #   end
-    end                                #
-  end                                  #   def test_second_thing
-end                                    #     assert_equal 2, 2
-                                       #   end
+    do_some_setup                      #     do_some_setup
+  end                                  #   end
+                                       #
+  it "should do the first thing" do    #   def test_first_thing
+    _(1).must_equal 1                  #     assert_equal 1, 1
+  end                                  #   end
                                        # end
+                                       #
+  describe SubThingy do                # class TestSubThingy < TestThingy
+    before do                          #   def setup
+                                       #     super
+      do_more_setup                    #     do_more_setup
+    end                                #   end
+                                       #
+    it "should do the second thing" do #   def test_second_thing
+      _(2).must_equal 2                #     assert_equal 2, 2
+    end                                #   end
+  end                                  # end
+end                                    #
+                                       #
 ###############################################################################
 # runs 2 specs                         # runs 3 tests
 ###############################################################################
@@ -33,7 +35,7 @@ class ThingySpec < Minitest::Spec
   end
 
   def test_should_do_the_first_thing
-    assert_equal 1, 1
+    _(1).must_equal 1
   end
 end
 
@@ -47,6 +49,6 @@ class SubThingySpec < ThingySpec
   remove_method :test_should_do_the_first_thing
 
   def test_should_do_the_second_thing
-    assert_equal 2, 2
+    _(2).must_equal 2
   end
 end

data/lib/minitest/assertions.rb

@@ -62,11 +62,11 @@ module Minitest
       return "Expected: #{mu_pp exp}\n  Actual: #{mu_pp act}" unless
         expect
 
-      Tempfile.open "expect" do |a|
+      Tempfile.create "expect" do |a|
         a.puts expect
         a.flush
 
-        Tempfile.open "butwas" do |b|
+        Tempfile.create "butwas" do |b|
           b.puts butwas
           b.flush
 
@@ -500,14 +500,9 @@ module Minitest
       value = catch sym do
         begin
           yield
-        rescue ThreadError => e       # wtf?!? 1.8 + threads == suck
-          default += ", not :#{e.message[/uncaught throw \`(\w+?)\'/, 1]}"
-        rescue ArgumentError => e     # 1.9 exception
+        rescue ArgumentError => e     # 1.9+ exception
           raise e unless e.message.include? "uncaught throw"
           default += ", not #{e.message.split(/ /).last}"
-        rescue NameError => e         # 1.8 exception
-          raise e unless e.name == sym
-          default += ", not #{e.name.inspect}"
         end
         caught = false
       end

data/lib/minitest/parallel.rb

@@ -1,3 +1,5 @@
+require "thread"
+
 module Minitest
   module Parallel # :nodoc:
 

data/lib/minitest/spec.rb

@@ -38,7 +38,11 @@ class Module # :nodoc:
   end
 end
 
-Minitest::Expectation = Struct.new :target, :ctx # :nodoc:
+# :stopdoc:
+module Minitest # fucking hell rdoc...
+  Expectation = Struct.new :target, :ctx
+end
+# :startdoc:
 
 ##
 # Kernel extensions for minitest
@@ -285,9 +289,7 @@ class Minitest::Spec < Minitest::Test
       defined?(@name) ? @name : super
     end
 
-    def to_s # :nodoc:
-      name # Can't alias due to 1.8.7, not sure why
-    end
+    alias to_s name
 
     attr_reader :desc # :nodoc:
     alias specify it

data/lib/minitest/test.rb

@@ -58,6 +58,7 @@ module Minitest
     # tests are awesome.
 
     def self.parallelize_me!
+      return unless Minitest.parallel_executor
       include Minitest::Parallel::Test
       extend Minitest::Parallel::Test::ClassMethods
     end

data/lib/minitest/test_task.rb

@@ -44,8 +44,16 @@ module Minitest # :nodoc:
     WINDOWS = RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ # :nodoc:
 
     ##
-    # Create several test-oriented tasks under +name+. Takes an
-    # optional block to customize variables.
+    # Create several test-oriented tasks under +name+ (default:
+    # "test"). Takes an optional block to customize variables.
+    # Examples:
+    #
+    #   Minitest::TestTask.create # named "test", all defaults
+    #
+    #   Minitest::TestTask.create do |t|
+    #     t.warning = false # my tests are noisy
+    #     t.framework = %(require_relative "./test/helper.rb")
+    #   end
 
     def self.create name = :test, &block
       task = new name
@@ -69,9 +77,18 @@ module Minitest # :nodoc:
 
     ##
     # The code to load the framework. Defaults to requiring
-    # minitest/autorun...
+    # minitest/autorun.
+    #
+    # If you have a test helper file that requires minitest/autorun
+    # and anything else your project standardizes on, then you'll
+    # probably want to change this to:
     #
-    # Why do I have this as an option?
+    #   Minitest::TestTask.create do |t|
+    #     t.framework = %(require_relative "./test/helper.rb")
+    #   end
+    #
+    # or something similar. NOTE: if you do this, then helper must
+    # require "minitest/autorun" at the top to start the tests.
 
     attr_accessor :framework
 
@@ -100,6 +117,11 @@ module Minitest # :nodoc:
 
     ##
     # Optional: Additional ruby to run before the test framework is loaded.
+    # Example:
+    #
+    #   Minitest::TestTask.create "test:cov" do |t|
+    #     t.test_prelude = %(require "simplecov")
+    #   end
 
     attr_accessor :test_prelude
 

data/lib/minitest.rb

@@ -10,7 +10,7 @@ require_relative "minitest/compress"
 # runtime. See +Minitest.run+ for more information.
 
 module Minitest
-  VERSION = "5.25.5" # :nodoc:
+  VERSION = "5.26.1" # :nodoc:
 
   @@installed_at_exit ||= false
   @@after_run = []
@@ -36,7 +36,7 @@ module Minitest
   warn "DEPRECATED: use MT_CPU instead of N for parallel test runs" if ENV["N"] && ENV["N"].to_i > 0
   n_threads = (ENV["MT_CPU"] || ENV["N"] || Etc.nprocessors).to_i
 
-  self.parallel_executor = Parallel::Executor.new n_threads
+  self.parallel_executor = Parallel::Executor.new n_threads if n_threads > 1
 
   ##
   # Filter object for backtraces.
@@ -259,12 +259,13 @@ module Minitest
   #       Minitest.process_args
   #       Minitest.init_plugins
   #       Minitest.__run(reporter, options)
-  #         Runnable.runnables.each
+  #         Runnable.runnables.each |runnable_klass|
   #           runnable_klass.run(reporter, options)
-  #             self.runnable_methods.each
-  #               self.run_one_method(self, runnable_method, reporter)
-  #                 Minitest.run_one_method(klass, runnable_method)
-  #                   klass.new(runnable_method).run
+  #             filtered_methods = runnable_methods.select {...}.reject {...}
+  #             filtered_methods.each |runnable_method|
+  #               runnable_klass.run_one_method(self, runnable_method, reporter)
+  #                 Minitest.run_one_method(runnable_klass, runnable_method)
+  #                   runnable_klass.new(runnable_method).run
 
   def self.run args = []
     self.load_plugins unless args.delete("--no-plugins") || ENV["MT_NO_PLUGINS"]
@@ -286,18 +287,19 @@ module Minitest
     reporter.start
     begin
       __run reporter, options
+      finished = true
     rescue Interrupt
       warn "Interrupted. Exiting..."
     end
-    self.parallel_executor.shutdown
+    self.parallel_executor.shutdown if parallel_executor.respond_to? :shutdown
 
     # might have been removed/replaced during init_plugins:
     summary = reporter.reporters.grep(SummaryReporter).first
 
     reporter.report
 
-    return empty_run! options if summary && summary.count == 0
-    reporter.passed?
+    return empty_run! options if finished && summary && summary.count == 0
+    finished and reporter.passed?
   end
 
   def self.empty_run! options # :nodoc:
@@ -409,6 +411,7 @@ module Minitest
       pos = Regexp.new $1 if pos.kind_of?(String) && pos =~ %r%/(.*)/%
       neg = Regexp.new $1 if neg.kind_of?(String) && neg =~ %r%/(.*)/%
 
+      # at most 1-2% slower than a 1-pass version, stop optimizing this
       filtered_methods = self.runnable_methods
         .select { |m| !pos ||  pos === m || pos === "#{self}##{m}"  }
         .reject { |m|  neg && (neg === m || neg === "#{self}##{m}") }
@@ -572,7 +575,7 @@ module Minitest
     def skipped?
       raise NotImplementedError, "subclass responsibility"
     end
-  end
+  end # Runnable
 
   ##
   # Shared code for anything that can get passed to a Reporter. See
@@ -624,7 +627,7 @@ module Minitest
     def error?
       self.failures.any? UnexpectedError
     end
-  end
+  end # Reportable
 
   ##
   # This represents a test result in a clean way that can be
@@ -678,7 +681,7 @@ module Minitest
         "#{failure.result_label}:\n#{self.location}:\n#{failure.message}\n"
       }.join "\n"
     end
-  end
+  end # Result
 
   ##
   # Defines the API for Reporters. Subclass this and override whatever
@@ -728,7 +731,7 @@ module Minitest
     def synchronize &block # :nodoc:
       @mutex.synchronize(&block)
     end
-  end
+  end # AbstractReportera
 
   class Reporter < AbstractReporter # :nodoc:
     ##
@@ -883,7 +886,7 @@ module Minitest
       self.warnings   = aggregate[UnexpectedWarning].size
       self.skips      = aggregate[Skip].size
     end
-  end
+  end # StatisticsReporter
 
   ##
   # A reporter that prints the header, summary, and failure details at
@@ -961,7 +964,7 @@ module Minitest
       "%d runs, %d assertions, %d failures, %d errors, %d skips%s" %
         [count, assertions, failures, errors, skips, extra.join]
     end
-  end
+  end # SummaryReporter
 
   ##
   # Dispatch to multiple reporters as one.
@@ -1012,7 +1015,7 @@ module Minitest
     def report # :nodoc:
       self.reporters.each(&:report)
     end
-  end
+  end # CompositeReporter
 
   ##
   # Represents run failures.
@@ -1079,7 +1082,7 @@ module Minitest
       self.error.backtrace
     end
 
-    BASE_RE = %r%#{Dir.pwd}/% # :nodoc:
+    BASE_RE = %r%#{Regexp.escape Dir.pwd}/% # :nodoc:
 
     def message # :nodoc:
       bt = Minitest.filter_backtrace(self.backtrace).join("\n    ")

data/test/minitest/test_minitest_assertions.rb

@@ -318,13 +318,13 @@ class TestMinitestAssertions < Minitest::Test
   end
 
   def test_assert_equal_string_both_escaped_unescaped_newlines
-    msg = <<~EOM
+    msg = <<~'EOM' # NOTE: single quotes on heredoc
           --- expected
           +++ actual
           @@ -1,2 +1 @@
-          -"A\\n
+          -"A\n
           -B"
-          +"A\\n\\\\nB"
+          +"A\n\\nB"
           EOM
 
     assert_triggered msg do

data/test/minitest/test_minitest_spec.rb

@@ -108,7 +108,7 @@ describe Minitest::Spec do
   end
 
   it "needs to catch an expected exception" do
-    @assertion_count = 2
+    @assertion_count -= 2
 
     expect { raise "blah" }.must_raise RuntimeError
     expect { raise Minitest::Assertion }.must_raise Minitest::Assertion
@@ -710,8 +710,6 @@ describe Minitest::Spec do
 end
 
 describe Minitest::Spec, :let do
-  i_suck_and_my_tests_are_order_dependent!
-
   def _count
     $let_count ||= 0
   end
@@ -722,21 +720,21 @@ describe Minitest::Spec, :let do
   end
 
   it "is evaluated once per example" do
-    _(_count).must_equal 0
+    exp = _count + 1
 
-    _(count).must_equal 1
-    _(count).must_equal 1
+    _(count).must_equal exp
+    _(count).must_equal exp
 
-    _(_count).must_equal 1
+    _(_count).must_equal exp
   end
 
   it "is REALLY evaluated once per example" do
-    _(_count).must_equal 1
+    exp = _count + 1
 
-    _(count).must_equal 2
-    _(count).must_equal 2
+    _(count).must_equal exp
+    _(count).must_equal exp
 
-    _(_count).must_equal 2
+    _(_count).must_equal exp
   end
 
   it 'raises an error if the name begins with "test"' do

data/test/minitest/test_minitest_test.rb

@@ -662,7 +662,7 @@ class TestMinitestRunner < MetaMetaMetaTestCase
       2 runs, 2 assertions, 0 failures, 0 errors, 0 skips
     EOM
 
-    skip if Minitest.parallel_executor.size < 2 # locks up test runner if 1 CPU
+    skip unless Minitest.parallel_executor # locks up test runner if 1 CPU
 
     assert_report expected do |reporter|
       reporter.extend Module.new {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest
 version: !ruby/object:Gem::Version
-  version: 5.25.5
+  version: 5.26.1
 platform: ruby
 authors:
 - Ryan Davis
@@ -28,7 +28,7 @@ cert_chain:
   bwfinv7Yp5fA6AysuZLhCykyfDuZVRrUp0Vb68YCKsLjJly/Theak+euNTxvHsB+
   al9oSgPPHICMEX65qvLywitx
   -----END CERTIFICATE-----
-date: 2025-03-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.3'
 description: |-
   minitest provides a complete suite of testing facilities supporting
   TDD, BDD, mocking, and benchmarking.
@@ -176,16 +176,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.7'
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.7.2
 specification_version: 4
 summary: minitest provides a complete suite of testing facilities supporting TDD,
   BDD, mocking, and benchmarking