minitest 5.11.3 → 5.27.0

data/README.rdoc

@@ -1,10 +1,12 @@
 = minitest/{test,spec,mock,benchmark}
 
-home :: https://github.com/seattlerb/minitest
-bugs :: https://github.com/seattlerb/minitest/issues
-rdoc :: http://docs.seattlerb.org/minitest
-vim  :: https://github.com/sunaku/vim-ruby-minitest
+home :: https://minite.st/
+code :: https://github.com/minitest/minitest
+bugs :: https://github.com/minitest/minitest/issues
+rdoc :: https://docs.seattlerb.org/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:
 
@@ -70,6 +72,7 @@ extract-method refactorings still apply.
 * 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.
 * Incredibly small and fast runner, but no bells and whistles.
 * Written by squishy human beings. Software can never be perfect. We will all eventually die.
 
@@ -93,7 +96,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"
 
@@ -117,6 +122,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
@@ -126,13 +134,13 @@ Define your tests as methods beginning with +test_+.
 
     describe "when asked about cheeseburgers" do
       it "must respond positively" do
-        @meme.i_can_has_cheezburger?.must_equal "OHAI!"
+        _(@meme.i_can_has_cheezburger?).must_equal "OHAI!"
       end
     end
 
     describe "when asked about blending possibilities" do
       it "won't say no" do
-        @meme.will_it_blend?.wont_match /^no/i
+        _(@meme.will_it_blend?).wont_match /^no/i
       end
     end
   end
@@ -144,7 +152,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"]
@@ -186,7 +194,7 @@ Output is tab-delimited to make it easy to paste into a spreadsheet.
 === Mocks
 
 Mocks and stubs defined using terminology by Fowler & Meszaros at
-http://www.martinfowler.com/bliki/TestDouble.html:
+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
@@ -220,9 +228,9 @@ verification to ensure they got all the calls they were expecting."
     end
   end
 
-**Multi-threading and Mocks**
+==== Multi-threading and Mocks
 
-Minitest mocks do not support multi-threading if it works, fine, if it doesn't
+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:
 
@@ -237,7 +245,7 @@ an example of asserting that code inside a thread is run:
 === Stubs
 
 Mocks and stubs are defined using terminology by Fowler & Meszaros at
-http://www.martinfowler.com/bliki/TestDouble.html:
+https://www.martinfowler.com/bliki/TestDouble.html:
 
 "Stubs provide canned answers to calls made during the test".
 
@@ -264,9 +272,8 @@ new non-existing method:
 
 === Running Your Tests
 
-Ideally, you'll use a rake task to run your tests, either piecemeal or
-all at once. Both rake and rails ship with rake tasks for running your
-tests. BUT! You don't have to:
+Ideally, you'll use a rake task to run your tests (see below), either
+piecemeal or all at once. BUT! You don't have to:
 
     % ruby -Ilib:test test/minitest/test_minitest_test.rb
     Run options: --seed 37685
@@ -294,6 +301,45 @@ provided via plugins. To see them, simply run with +--help+:
         -p, --pride                      Pride. Show your testing pride!
         -a, --autotest                   Connect to autotest server.
 
+=== Rake Tasks
+
+You can set up a rake task to run all your tests by adding this to your Rakefile:
+
+    require "minitest/test_task"
+
+    Minitest::TestTask.create # named test, sensible defaults
+
+    # or more explicitly:
+
+    Minitest::TestTask.create(:test) do |t|
+      t.libs << "test"
+      t.libs << "lib"
+      t.warning = false
+      t.test_globs = ["test/**/*_test.rb"]
+    end
+
+    task :default => :test
+
+Each of these will generate 4 tasks:
+
+    rake test          :: Run the test suite.
+    rake test:cmd      :: Print out the test command.
+    rake test:isolated :: Show which test files fail when run separately.
+    rake test:slow     :: Show bottom 25 tests sorted by time.
+
+=== Rake Task Variables
+
+There are a bunch of variables you can supply to rake to modify the run.
+
+    MT_LIB_EXTRAS :: Extra libs to dynamically override/inject for custom runs.
+    N             :: -n: Tests to run (string or /regexp/).
+    X             :: -x: Tests to exclude (string or /regexp/).
+    A             :: Any extra arguments. Honors shell quoting.
+    MT_CPU        :: How many threads to use for parallel test runs
+    SEED          :: -s --seed Sets random seed.
+    TESTOPTS      :: Deprecated, same as A
+    FILTER        :: Deprecated, same as A
+
 == Writing Extensions
 
 To define a plugin, add a file named minitest/XXX_plugin.rb to your
@@ -364,6 +410,46 @@ Using our example above, here is how we might implement MyCI:
 
 == FAQ
 
+=== What versions are compatible with what? Or what versions are supported?
+
+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. 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 2025-02-03)
+
+Current versions of rails: (https://endoflife.date/rails)
+
+  | 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.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 |
+
 === How to test SimpleDelegates?
 
 The following implementation and test:
@@ -379,7 +465,7 @@ The following implementation and test:
       end
 
       it "must respond to work" do
-        @worker.must_respond_to :work
+        _(@worker).must_respond_to :work
       end
     end
 
@@ -469,6 +555,8 @@ able to require minitest and run your tests.
 
 == Developing Minitest:
 
+Minitest requires {Hoe}[https://rubygems.org/gems/hoe].
+
 === Minitest's own tests require UTF-8 external encoding.
 
 This is a common problem in Windows, where the default external Encoding is
@@ -547,6 +635,7 @@ minispec-metadata           :: Metadata for describe/it blocks & CLI tag filter.
                                E.g. <tt>it "requires JS driver", js: true do</tt> &
                                <tt>ruby test.rb --tag js</tt> runs tests tagged :js.
 minispec-rails              :: Minimal support to use Spec style in Rails 5+.
+mini-apivore                :: for swagger based automated API testing.
 minitest-around             :: Around block for minitest. An alternative to
                                setup/teardown dance.
 minitest-assert_errors      :: Adds Minitest assertions to test for errors raised
@@ -563,6 +652,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
@@ -589,12 +679,14 @@ minitest-firemock           :: Makes your Minitest mocks more resilient.
 minitest-focus              :: Focus on one test at a time.
 minitest-gcstats            :: A minitest plugin that adds a report of the top
                                tests by number of objects allocated.
+minitest-global_expectations:: Support minitest expectation methods for all objects
 minitest-great_expectations :: Generally useful additions to minitest's
                                assertions and expectations.
 minitest-growl              :: Test notifier for minitest via growl.
 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-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.
@@ -615,6 +707,7 @@ minitest-matchers           :: Adds support for RSpec-style matchers to
 minitest-matchers_vaccine   :: Adds assertions that adhere to the matcher spec,
                                but without any expectation infections.
 minitest-metadata           :: Annotate tests with metadata (key-value).
+minitest-mock_expectations  :: Provides method call assertions for minitest.
 minitest-mongoid            :: Mongoid assertion matchers for Minitest.
 minitest-must_not           :: Provides must_not as an alias for wont in
                                Minitest.
@@ -658,16 +751,23 @@ 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.
 minitest_should             :: Shoulda style syntax for minitest test::unit.
 minitest_tu_shim            :: Bridges between test/unit and minitest.
 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, 
+                               assert_method_called, stubbing ORM objects by id )
 
 == Unknown Extensions:
 
@@ -693,12 +793,11 @@ Authors... Please send me a pull request with a description of your minitest ext
 
 == Minitest related goods
 
-* minitest/pride fabric: http://www.spoonflower.com/fabric/3928730-again-by-katie_allen
+* minitest/pride fabric: https://www.spoonflower.com/fabric/3928730-again-by-katie_allen
 
 == REQUIREMENTS:
 
-* Ruby 1.8.7+. No magic is involved. I hope.
-* NOTE: 1.8 and 1.9 will be dropped in minitest 6+.
+* Ruby 2.3+. No magic is involved. I hope.
 
 == INSTALL:
 

data/Rakefile

@@ -1,7 +1,7 @@
 # -*- ruby -*-
 
-require "rubygems"
 require "hoe"
+$:.unshift "lib" # to pick up lib/minitest/test_task.rb when minitest not installed
 
 Hoe.plugin :seattlerb
 Hoe.plugin :rdoc
@@ -11,21 +11,24 @@ Hoe.spec "minitest" do
 
   license "MIT"
 
-  ## TODO: uncomment this on the last point release on 5.x
-  #
-  #   self.post_install_message = <<-"EOM"
-  # NOTE: minitest 5 will be the last in the minitest family to support
-  #       ruby 1.8 and 1.9 (and maybe 2.0?). If you need to keep using 1.8
-  #       or 1.9, you need to pin your dependency to minitest with
-  #       something like "~> 5.0".
-  #
-  #       Further, minitest 6 will be dropping the following:
-  #
-  #       + MiniTest (it's been Minitest for *years*)
-  #       + MiniTest::Unit
-  #       + MiniTest::Unit::TestCase
-  #       + assert_send (unless you argue for it well)
-  #   EOM
+  require_ruby_version ">= 3.1"
+
+  self.post_install_message = <<~EOM
+    NOTE: minitest 5 will be the last in the minitest family to support
+          ruby 1.8 to 2.7. If you need to keep using these versions,
+          you need to pin your dependency to minitest with something
+          like "~> 5.0". See History.rdoc to locate compatible
+          versions.
+
+          Further, minitest 6 will be dropping the following:
+
+          + MiniTest (it's been Minitest for >10 years)
+          + MiniTest::Unit
+          + MiniTest::Unit::TestCase
+          + assert_send (unless you argue for it well)
+          + assert_equal nil, obj
+          + mocks and stubs: moving minitest/mock.rb to its own gem
+  EOM
 end
 
 desc "Find missing expectations"
@@ -35,7 +38,7 @@ task :specs do
   require "minitest/spec"
 
   pos_prefix, neg_prefix = "must", "wont"
-  skip_re = /^(must|wont)$|wont_(throw)|must_(block|not?_|nothing|raise$)/x
+  skip_re = /^(must|wont)$|wont_(throw)|must_(block|not?_|nothing|send|raise$)/x
   dont_flip_re = /(must|wont)_(include|respond_to)/
 
   map = {
@@ -46,6 +49,9 @@ 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',
   }
 
   expectations = Minitest::Expectations.public_instance_methods.map(&:to_s)
@@ -83,4 +89,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/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"]
@@ -24,9 +26,5 @@ module Hoe::Minitest
 
   def define_minitest_tasks
     self.testlib = :minitest
-
-    # make sure we use the gemmed minitest on 1.9
-    self.test_prelude = 'gem "minitest"' unless
-      minitest? or ENV["MT_NO_ISOLATE"]
   end
 end