minitest 5.16.2 → 6.0.5

data/README.rdoc

@@ -1,15 +1,17 @@
-= minitest/{test,spec,mock,benchmark}
+= minitest/{test,spec,benchmark}
 
-home :: https://github.com/seattlerb/minitest
-bugs :: https://github.com/seattlerb/minitest/issues
+home :: https://minite.st/
+code :: https://github.com/minitest/minitest
+bugs :: https://github.com/minitest/minitest/issues
 rdoc :: https://docs.seattlerb.org/minitest
-vim  :: https://github.com/sunaku/vim-ruby-minitest
+clog :: https://github.com/minitest/minitest/blob/master/History.rdoc
 emacs:: https://github.com/arthurnn/minitest-emacs
+vim  :: https://github.com/vim-test/vim-test
 
 == DESCRIPTION:
 
 minitest provides a complete suite of testing facilities supporting
-TDD, BDD, mocking, and benchmarking.
+TDD, BDD, and benchmarking.
 
     "I had a class with Jim Weirich on testing last week and we were
      allowed to choose our testing frameworks. Kirk Haines and I were
@@ -35,9 +37,6 @@ algorithms in a repeatable manner. Now you can assert that your newb
 co-worker doesn't replace your linear algorithm with an exponential
 one!
 
-minitest/mock by Steven Baker, is a beautifully tiny mock (and stub)
-object framework.
-
 minitest/pride shows pride in testing and adds coloring to your test
 output. I guess it is an example of how to write IO pipes too. :P
 
@@ -67,7 +66,6 @@ extract-method refactorings still apply.
 * minitest/autorun - the easy and explicit way to run all your tests.
 * minitest/test - a very fast, simple, and clean test system.
 * minitest/spec - a very fast, simple, and clean spec system.
-* minitest/mock - a simple and clean mock/stub system.
 * minitest/benchmark - an awesome way to assert your algorithm's performance.
 * minitest/pride - show your pride in testing!
 * minitest/test_task - a full-featured and clean rake task generator.
@@ -94,7 +92,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"
 
@@ -118,6 +118,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
@@ -145,7 +148,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"]
@@ -184,85 +187,6 @@ outputs something like:
 
 Output is tab-delimited to make it easy to paste into a spreadsheet.
 
-=== Mocks
-
-Mocks and stubs defined using terminology by Fowler & Meszaros at
-https://www.martinfowler.com/bliki/TestDouble.html:
-
-"Mocks are pre-programmed with expectations which form a specification
-of the calls they are expected to receive. They can throw an exception
-if they receive a call they don't expect and are checked during
-verification to ensure they got all the calls they were expecting."
-
-  class MemeAsker
-    def initialize(meme)
-      @meme = meme
-    end
-
-    def ask(question)
-      method = question.tr(" ", "_") + "?"
-      @meme.__send__(method)
-    end
-  end
-
-  require "minitest/autorun"
-
-  describe MemeAsker, :ask do
-    describe "when passed an unpunctuated question" do
-      it "should invoke the appropriate predicate method on the meme" do
-        @meme = Minitest::Mock.new
-        @meme_asker = MemeAsker.new @meme
-        @meme.expect :will_it_blend?, :return_value
-
-        @meme_asker.ask "will it blend"
-
-        @meme.verify
-      end
-    end
-  end
-
-==== Multi-threading and Mocks
-
-Minitest mocks do not support multi-threading. If it works, fine, if it doesn't
-you can use regular ruby patterns and facilities like local variables. Here's
-an example of asserting that code inside a thread is run:
-
-  def test_called_inside_thread
-    called = false
-    pr = Proc.new { called = true }
-    thread = Thread.new(&pr)
-    thread.join
-    assert called, "proc not called"
-  end
-
-=== Stubs
-
-Mocks and stubs are defined using terminology by Fowler & Meszaros at
-https://www.martinfowler.com/bliki/TestDouble.html:
-
-"Stubs provide canned answers to calls made during the test".
-
-Minitest's stub method overrides a single method for the duration of
-the block.
-
-  def test_stale_eh
-    obj_under_test = Something.new
-
-    refute obj_under_test.stale?
-
-    Time.stub :now, Time.at(0) do   # stub goes away once the block is done
-      assert obj_under_test.stale?
-    end
-  end
-
-A note on stubbing: In order to stub a method, the method must
-actually exist prior to stubbing. Use a singleton method to create a
-new non-existing method:
-
-  def obj_under_test.fake_method
-    ...
-  end
-
 === Running Your Tests
 
 Ideally, you'll use a rake task to run your tests (see below), either
@@ -405,39 +329,43 @@ Using our example above, here is how we might implement MyCI:
 
 === What versions are compatible with what? Or what versions are supported?
 
-Minitest is a dependency of rails, which until fairly recently had an
+Minitest is a dependency of rails, which until very recently had an
 overzealous backwards compatibility policy. As such, I'm stuck
-supporting versions of ruby that are long past EOL. Once rails 5.2 is
-dropped (hopefully April 2021), I get to drop a bunch of versions of
-ruby that I have to currently test against.
+supporting versions of ruby that are long past EOL. Hopefully I'll be
+able to support only current versions of ruby sometime in the near
+future.
+
+NOTICE: At this point, I will only locally test/dev against the
+currently 3 supported (non-EOL) versions of ruby. I cannot and will
+not maintain that many builds.
 
-(As of 2021-01-31)
+(As of 2025-02-03)
 
 Current versions of rails: (https://endoflife.date/rails)
 
-  | rails | min ruby | rec ruby | minitest | status   |
-  |-------+----------+----------+----------+----------|
-  |   7.0 | >= 2.7   |      3.0 | >= 5.1   | Future   |
-  |   6.1 | >= 2.5   |      3.0 | >= 5.1   | Current  |
-  |   6.0 | >= 2.5   |      2.6 | >= 5.1   | Security |
-  |   5.2 | >= 2.2.2 |      2.5 | ~> 5.1   | Security | EOL @railsconf 2021?
+  | rails | min ruby | minitest | status   |  EOL Date  |
+  |-------+----------+----------+----------+------------|
+  |   8.1 | >= 3.2   | >= 5.1   | Current  | 2027-10-07 |
+  |   8.0 | >= 3.2   | >= 5.1   | Current  | 2026-11-07 |
+  |   7.2 | >= 3.1   | >= 5.1   | Security | 2026-08-09 |
+  |   7.1 | >= 2.7   | >= 5.1   | EOL      | 2025-10-01 |
+
+If you want to look at the requirements for a specific version, run:
+
+    gem spec -r --ruby rails -v 8.0.0
 
 Current versions of ruby: (https://endoflife.date/ruby)
 
   | ruby | Status  |   EOL Date |
   |------+---------+------------|
-  |  3.0 | Current | 2024-03-31 |
-  |  2.7 | Maint   | 2023-03-31 |
-  |  2.6 | Maint*  | 2022-03-31 |
+  |  3.4 | Current | 2028-03-31 |
+  |  3.3 | Maint   | 2027-03-31 |
+  |  3.2 | Security| 2026-03-31 |
+  |  3.1 | EOL     | 2025-03-31 |
+  |  3.0 | EOL     | 2024-03-31 |
+  |  2.7 | EOL     | 2023-03-31 |
+  |  2.6 | EOL     | 2022-03-31 |
   |  2.5 | EOL     | 2021-03-31 |
-  |  2.4 | EOL     | 2020-03-31 |
-  |  2.3 | EOL     | 2019-03-31 |
-  |  2.2 | EOL     | 2018-03-31 |
-
-See also:
-
-* https://www.fastruby.io/blog/ruby/rails/versions/compatibility-table.html
-* https://jamesjeffersconsulting.com/ruby-rails-version-matrix/
 
 === How to test SimpleDelegates?
 
@@ -641,6 +569,7 @@ minitest-capistrano         :: Assertions and expectations for testing
                                Capistrano recipes.
 minitest-capybara           :: Capybara matchers support for minitest unit and
                                spec.
+minitest-cc                 :: It provides minimal information about code coverage.
 minitest-chef-handler       :: Run Minitest suites as Chef report handlers
 minitest-ci                 :: CI reporter plugin for Minitest.
 minitest-context            :: Defines contexts for code reuse in Minitest
@@ -675,6 +604,9 @@ minitest-happy              :: GLOBALLY ACTIVATE MINITEST PRIDE! RAWR!
 minitest-have_tag           :: Adds Minitest assertions to test for the existence of
                                HTML tags, including contents, within a provided string.
 minitest-heat               :: Reporting that builds a heat map of failure locations
+minitest-holdify            :: Stop maintaining large expected values in your
+                               test/fixture files! Hold them automatically.
+                               Update them effortlessly.
 minitest-hooks              :: Around and before_all/after_all/around_all hooks
 minitest-hyper              :: Pretty, single-page HTML reports for your Minitest runs
 minitest-implicit-subject   :: Implicit declaration of the test subject.
@@ -739,7 +671,7 @@ minitest-stub-const         :: Stub constants for the duration of a block.
 minitest-tags               :: Add tags for minitest.
 minitest-unordered          :: Adds a new assertion to minitest for checking the
                                contents of a collection, ignoring element order.
-minitest-vcr                :: Automatic cassette managment with Minitest::Spec
+minitest-vcr                :: Automatic cassette management with Minitest::Spec
                                and VCR.
 minitest_log                :: Adds structured logging, data explication, and verdicts.
 minitest_owrapper           :: Get tests results as a TestResult object.
@@ -749,12 +681,10 @@ mongoid-minitest            :: Minitest matchers for Mongoid.
 mutant-minitest             :: Minitest integration for mutant.
 pry-rescue                  :: A pry plugin w/ minitest support. See
                                pry-rescue/minitest.rb.
-rematch                     :: Declutter your test files from large hardcoded data
-                               and update them automatically when your code changes.
 rspec2minitest              :: Easily translate any RSpec matchers to Minitest
                                assertions and expectations.
-stubberry                   :: Multiple stubbing 'berries', sweet and useful 
-                               stub helpers and assertions. ( stub_must, 
+stubberry                   :: Multiple stubbing 'berries', sweet and useful
+                               stub helpers and assertions. ( stub_must,
                                assert_method_called, stubbing ORM objects by id )
 
 == Unknown Extensions:
@@ -785,7 +715,7 @@ Authors... Please send me a pull request with a description of your minitest ext
 
 == REQUIREMENTS:
 
-* Ruby 2.3+. No magic is involved. I hope.
+* Ruby 3.2+. No magic is involved. I hope.
 
 == INSTALL:
 

data/Rakefile

@@ -1,17 +1,26 @@
 # -*- ruby -*-
 
-require "rubygems"
 require "hoe"
+$:.unshift "lib" # to pick up lib/minitest/test_task.rb when minitest not installed
 
 Hoe.plugin :seattlerb
+Hoe.plugin :isolate
 Hoe.plugin :rdoc
+Hoe.plugin :cov
 
 Hoe.spec "minitest" do
   developer "Ryan Davis", "ryand-ruby@zenspider.com"
 
   license "MIT"
 
-  require_ruby_version [">= 2.6", "< 4.0"]
+  require_ruby_version ">= 3.2"
+
+  dependency "prism", "~> 1.5"
+  dependency "drb",   "~> 2.0"
+
+  self.rdoc_locations << "l:/home/www/minite.st/html/docs"
+
+  self.cov_filter = %w[ tmp ]
 end
 
 desc "Find missing expectations"
@@ -32,6 +41,7 @@ task :specs do
     /_includes/                            => "_include",
     /(must|wont)_(.*_of|nil|silent|empty)/ => '\1_be_\2',
     /must_raises/                          => "must_raise",
+    /(must|wont)_pattern/                  => '\1_pattern_match',
     /(must|wont)_predicate/                => '\1_be',
     /(must|wont)_path_exists/              => 'path_\1_exist',
   }
@@ -71,4 +81,9 @@ task :bugs do
   sh "for f in bug*.rb ; do echo $f; echo; #{Gem.ruby} -Ilib $f && rm $f ; done"
 end
 
+Minitest::TestTask.create :testW0 do |t|
+  t.warning = false
+  t.test_prelude = "$-w = nil"
+end
+
 # vim: syntax=Ruby

data/bin/minitest

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S ruby
+
+require_relative "../lib/minitest/sprint"
+
+Minitest::Sprint.run

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/hoe/minitest.rb

@@ -1,6 +1,7 @@
 # :stopdoc:
 
 class Hoe
+  # empty
 end
 
 module Hoe::Minitest
@@ -10,13 +11,14 @@ module Hoe::Minitest
 
   def initialize_minitest
     unless minitest? then
-      dir = "../../minitest/dev/lib"
+      dir = File.expand_path "../..", __FILE__
+
       Hoe.add_include_dirs dir if File.directory? dir
     end
 
     gem "minitest"
     require "minitest"
-    version = Minitest::VERSION.split(/\./).first(2).join(".")
+    version = Minitest::VERSION.split(".").first(2).join "."
 
     dependency "minitest", "~> #{version}", :development unless
       minitest? or ENV["MT_NO_ISOLATE"]