minitest 5.11.3 → 5.14.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c82c1408c60d4743cf06566256146090f22ab11bc5f024cbf4026fd967d7eb6
-  data.tar.gz: 93e140e22554c00911e381fa0584c52add681e5adb34bc3e575ee79459d7df6e
+  metadata.gz: 1edfa85bfac65503ab66f88d6ca07571a6e788bfd9eb513399cc60ffeae32e1f
+  data.tar.gz: 68a4cc4fcf8b54f8ba97dbda48e7ee4a8f818c67a3c4021920d5c6e4dfe9866c
 SHA512:
-  metadata.gz: 3621855d2763f225b2b99061c9eed994040debd9b1b032ebb3318adc42413493458b5c47569b7305954fc7575e870ad97441ce8bec7ddadb92afdd126f1f4bda
-  data.tar.gz: 19e04c6feff4f3d0cda89fadf4bd3f28415301d8adb2e5650a064cb74df57d8ee9885175738ac967d7a839496ac1c0f1c690627e8a2ca83f71edd6b0edb5b811
+  metadata.gz: 7f808ea45c7d6755da784bc6d70356f6beb7b794bd4df3cf509ce08d762f125c1bcafd92c406c73ea6a13809d836c75812fed83605f18b1d82e6f16b98e97004
+  data.tar.gz: d75f3b41034e4a70b8f372a79af5971eb2a589f87a4a80bfc20f23ebf1e5ac50235bfa5c300a25bba99f55746a8148cddde804cc9181d941ad62c71626482e06

data/History.rdoc

@@ -1,3 +1,103 @@
+=== 5.14.4 / 2021-02-23
+
+* 1 bug fix:
+
+  * Fixed deprecation warning using stub with methods using keyword arguments. (Nakilon)
+
+=== 5.14.3 / 2021-01-05
+
+* 1 bug fix:
+
+  * Bumped require_ruby_version to < 4 (trunk = 3.1).
+
+=== 5.14.2 / 2020-08-31
+
+* 1 bug fix:
+
+  * Bumped ruby version to include 3.0 (trunk).
+
+=== 5.14.1 / 2020-05-15
+
+* 3 minor enhancements:
+
+  * Minitest.filter_backtrace returns original backtrace if filter comes back empty.
+  * Minitest::BacktraceFilter now returns entire backtrace if $MT_DEBUG set in env.
+  * Return true on a successful refute. (jusleg)
+
+* 1 bug fix:
+
+  * Fixed expectation doco to not use global expectations.
+
+=== 5.14.0 / 2020-01-11
+
+* 2 minor enhancements:
+
+  * Block-assertions (eg assert_output) now error if raised inside the block. (casperisfine)
+  * Changed assert_raises to only catch Assertion since that covers Skip and friends.
+
+* 3 bug fixes:
+
+  * Added example for value wrapper with block to Expectations module. (stomar)
+  * Fixed use of must/wont_be_within_delta on Expectation instance. (stomar)
+  * Renamed UnexpectedError#exception to #error to avoid problems with reraising. (casperisfine)
+
+=== 5.13.0 / 2019-10-29
+
+* 9 minor enhancements:
+
+  * Added Minitest::Guard#osx?
+  * Added examples to documentation for assert_raises. (lxxxvi)
+  * Added expectations #path_must_exist and #path_wont_exist. Not thrilled with the names.
+  * Added fail_after(year, month, day, msg) to allow time-bombing after a deadline.
+  * Added skip_until(year, month, day, msg) to allow deferring until a deadline.
+  * Deprecated Minitest::Guard#maglev?
+  * Deprecated Minitest::Guard#rubinius?
+  * Finally added assert_path_exists and refute_path_exists. (deivid-rodriguez)
+  * Refactored and pulled Assertions#things_to_diff out of #diff. (BurdetteLamar)
+
+* 3 bug fixes:
+
+  * Fix autorun bug that affects fork exit status in tests. (dylanahsmith/jhawthorn)
+  * Improved documentation for _/value/expect, especially for blocks. (svoop)
+  * Support new Proc#to_s format. (ko1)
+
+=== 5.12.2 / 2019-09-28
+
+* 1 bug fix:
+
+  * After chatting w/ @y-yagi and others, decided to lower support to include ruby 2.2.
+
+=== 5.12.1 / 2019-09-28
+
+* 1 minor enhancement:
+
+  * Added documentation for Reporter classes. (sshaw)
+
+* 3 bug fixes:
+
+  * Avoid using 'match?' to support older ruby versions. (y-yagi)
+  * Fixed broken link to reference on goodness-of-fit testing. (havenwood)
+  * Update requirements in readme and Rakefile/hoe spec.
+
+=== 5.12.0 / 2019-09-22
+
+* 8 minor enhancements:
+
+  * Added a descriptive error if assert_output or assert_raises called without a block. (okuramasafumi)
+  * Changed mu_pp_for_diff to make having both \n and \\n easier to debug.
+  * Deprecated $N for specifying number of parallel test runners. Use MT_CPU.
+  * Deprecated use of global expectations. To be removed from MT6.
+  * Extended Assertions#mu_pp to encoding validity output for strings to improve diffs.
+  * Extended Assertions#mu_pp to output encoding and validity if invalid to improve diffs.
+  * Extended Assertions#mu_pp_for_diff to make escaped newlines more obvious in diffs.
+  * Fail gracefully when expectation used outside of `it`.
+
+* 3 bug fixes:
+
+  * Check `option[:filter]` klass before match. Fixes 2.6 warning. (y-yagi)
+  * Fixed Assertions#diff from recalculating if set to nil
+  * Fixed spec section of readme to not use deprecated global expectations. (CheezItMan)
+
 === 5.11.3 / 2018-01-26
 
 * 1 bug fix:
@@ -123,7 +223,7 @@
 * 2 bug fixes:
 
   * Re-release to refresh gem certificate signing. ugh.
-  * Fixed hoe/minitest to not augment load path if we're actually testing minitest.  
+  * Fixed hoe/minitest to not augment load path if we're actually testing minitest.
 
 === 5.9.0 / 2016-05-16
 
@@ -147,7 +247,7 @@
 * 2 bug fixes:
 
   * Re-release to refresh gem certificate signing. ugh.
-  * Fixed hoe/minitest to not augment load path if we're actually testing minitest.  
+  * Fixed hoe/minitest to not augment load path if we're actually testing minitest.
 
 === 5.8.4 / 2016-01-21
 
@@ -1307,4 +1407,3 @@ back.
 * 1 major enhancement
 
   * Birthday!
-

data/Manifest.txt

@@ -19,6 +19,7 @@ lib/minitest/spec.rb
 lib/minitest/test.rb
 lib/minitest/unit.rb
 test/minitest/metametameta.rb
+test/minitest/test_minitest_assertions.rb
 test/minitest/test_minitest_benchmark.rb
 test/minitest/test_minitest_mock.rb
 test/minitest/test_minitest_reporter.rb

data/README.rdoc

@@ -126,13 +126,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
@@ -220,9 +220,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:
 
@@ -294,6 +294,18 @@ provided via plugins. To see them, simply run with +--help+:
         -p, --pride                      Pride. Show your testing pride!
         -a, --autotest                   Connect to autotest server.
 
+You can set up a rake task to run all your tests by adding this to your Rakefile:
+
+    require "rake/testtask"
+
+    Rake::TestTask.new(:test) do |t|
+      t.libs << "test"
+      t.libs << "lib"
+      t.test_files = FileList["test/**/test_*.rb"]
+    end
+
+    task :default => :test
+
 == Writing Extensions
 
 To define a plugin, add a file named minitest/XXX_plugin.rb to your
@@ -364,6 +376,42 @@ 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 fairly 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.
+
+(As of 2021-01-31)
+
+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?
+
+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 |
+  |  2.5 | Maint*  | 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?
 
 The following implementation and test:
@@ -379,7 +427,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 +517,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 +597,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
@@ -589,6 +640,7 @@ 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.
@@ -615,6 +667,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.
@@ -660,10 +713,12 @@ 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
                                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.
 rspec2minitest              :: Easily translate any RSpec matchers to Minitest
@@ -697,8 +752,7 @@ Authors... Please send me a pull request with a description of your minitest ext
 
 == 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

@@ -11,21 +11,7 @@ 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 [">= 2.2", "< 4.0"]
 end
 
 desc "Find missing expectations"
@@ -35,7 +21,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 +32,8 @@ task :specs do
     /_includes/                            => "_include",
     /(must|wont)_(.*_of|nil|silent|empty)/ => '\1_be_\2',
     /must_raises/                          => "must_raise",
+    /(must|wont)_predicate/                => '\1_be',
+    /(must|wont)_path_exists/              => 'path_\1_exist',
   }
 
   expectations = Minitest::Expectations.public_instance_methods.map(&:to_s)

data/lib/minitest/assertions.rb

@@ -27,20 +27,18 @@ module Minitest
     # figure out what diff to use.
 
     def self.diff
+      return @diff if defined? @diff
+
       @diff = if (RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ &&
                   system("diff.exe", __FILE__, __FILE__)) then
                 "diff.exe -u"
-              elsif Minitest::Test.maglev? then
-                "diff -u"
               elsif system("gdiff", __FILE__, __FILE__)
                 "gdiff -u" # solaris and kin suck
               elsif system("diff", __FILE__, __FILE__)
                 "diff -u"
               else
                 nil
-              end unless defined? @diff
-
-      @diff
+              end
     end
 
     ##
@@ -55,22 +53,16 @@ module Minitest
     # diff command or if it doesn't make sense to diff the output
     # (single line, short output), then it simply returns a basic
     # comparison between the two.
+    #
+    # See +things_to_diff+ for more info.
 
     def diff exp, act
-      expect = mu_pp_for_diff exp
-      butwas = mu_pp_for_diff act
       result = nil
 
-      need_to_diff =
-        (expect.include?("\n")    ||
-         butwas.include?("\n")    ||
-         expect.size > 30         ||
-         butwas.size > 30         ||
-         expect == butwas)        &&
-        Minitest::Assertions.diff
+      expect, butwas = things_to_diff(exp, act)
 
       return "Expected: #{mu_pp exp}\n  Actual: #{mu_pp act}" unless
-        need_to_diff
+        expect
 
       Tempfile.open("expect") do |a|
         a.puts expect
@@ -99,10 +91,40 @@ module Minitest
       result
     end
 
+    ##
+    # Returns things to diff [expect, butwas], or [nil, nil] if nothing to diff.
+    #
+    # Criterion:
+    #
+    # 1. Strings include newlines or escaped newlines, but not both.
+    # 2. or:  String lengths are > 30 characters.
+    # 3. or:  Strings are equal to each other (but maybe different encodings?).
+    # 4. and: we found a diff executable.
+
+    def things_to_diff exp, act
+      expect = mu_pp_for_diff exp
+      butwas = mu_pp_for_diff act
+
+      e1, e2 = expect.include?("\n"), expect.include?("\\n")
+      b1, b2 = butwas.include?("\n"), butwas.include?("\\n")
+
+      need_to_diff =
+        (e1 ^ e2                  ||
+         b1 ^ b2                  ||
+         expect.size > 30         ||
+         butwas.size > 30         ||
+         expect == butwas)        &&
+        Minitest::Assertions.diff
+
+      need_to_diff && [expect, butwas]
+    end
+
     ##
     # This returns a human-readable version of +obj+. By default
-    # #inspect is called. You can override this to use #pretty_print
+    # #inspect is called. You can override this to use #pretty_inspect
     # if you want.
+    #
+    # See Minitest::Test.make_my_diffs_pretty!
 
     def mu_pp obj
       s = obj.inspect
@@ -110,8 +132,11 @@ module Minitest
       if defined? Encoding then
         s = s.encode Encoding.default_external
 
-        if String === obj && obj.encoding != Encoding.default_external then
-          s = "# encoding: #{obj.encoding}\n#{s}"
+        if String === obj && (obj.encoding != Encoding.default_external ||
+                              !obj.valid_encoding?) then
+          enc = "# encoding: #{obj.encoding}"
+          val = "#    valid: #{obj.valid_encoding?}"
+          s = "#{enc}\n#{val}\n#{s}"
         end
       end
 
@@ -119,13 +144,32 @@ module Minitest
     end
 
     ##
-    # This returns a diff-able human-readable version of +obj+. This
-    # differs from the regular mu_pp because it expands escaped
-    # newlines and makes hex-values generic (like object_ids). This
+    # This returns a diff-able more human-readable version of +obj+.
+    # This differs from the regular mu_pp because it expands escaped
+    # newlines and makes hex-values (like object_ids) generic. This
     # uses mu_pp to do the first pass and then cleans it up.
 
     def mu_pp_for_diff obj
-      mu_pp(obj).gsub(/\\n/, "\n").gsub(/:0x[a-fA-F0-9]{4,}/m, ":0xXXXXXX")
+      str = mu_pp obj
+
+      # both '\n' & '\\n' (_after_ mu_pp (aka inspect))
+      single = !!str.match(/(?<!\\|^)\\n/)
+      double = !!str.match(/(?<=\\|^)\\n/)
+
+      process =
+        if single ^ double then
+          if single then
+            lambda { |s| s == "\\n"   ? "\n"    : s } # unescape
+          else
+            lambda { |s| s == "\\\\n" ? "\\n\n" : s } # unescape a bit, add nls
+          end
+        else
+          :itself                                     # leave it alone
+        end
+
+      str.
+        gsub(/\\?\\n/, &process).
+        gsub(/:0x[a-fA-F0-9]{4,}/m, ":0xXXXXXX") # anonymize hex values
     end
 
     ##
@@ -283,6 +327,9 @@ module Minitest
     # See also: #assert_silent
 
     def assert_output stdout = nil, stderr = nil
+      flunk "assert_output requires a block to capture output." unless
+        block_given?
+
       out, err = capture_io do
         yield
       end
@@ -294,6 +341,18 @@ module Minitest
       x = send out_msg, stdout, out, "In stdout" if out_msg
 
       (!stdout || x) && (!stderr || y)
+    rescue Assertion
+      raise
+    rescue => e
+      raise UnexpectedError, e
+    end
+
+    ##
+    # Fails unless +path+ exists.
+
+    def assert_path_exists path, msg = nil
+      msg = message(msg) { "Expected path '#{path}' to exist" }
+      assert File.exist?(path), msg
     end
 
     ##
@@ -316,9 +375,26 @@ module Minitest
     #
     # +exp+ takes an optional message on the end to help explain
     # failures and defaults to StandardError if no exception class is
-    # passed.
+    # passed. Eg:
+    #
+    #   assert_raises(CustomError) { method_with_custom_error }
+    #
+    # With custom error message:
+    #
+    #   assert_raises(CustomError, 'This should have raised CustomError') { method_with_custom_error }
+    #
+    # Using the returned object:
+    #
+    #   error = assert_raises(CustomError) do
+    #     raise CustomError, 'This is really bad'
+    #   end
+    #
+    #   assert_equal 'This is really bad', error.message
 
     def assert_raises *exp
+      flunk "assert_raises requires a block to capture errors." unless
+        block_given?
+
       msg = "#{exp.pop}.\n" if String === exp.last
       exp << StandardError if exp.empty?
 
@@ -327,7 +403,7 @@ module Minitest
       rescue *exp => e
         pass # count assertion
         return e
-      rescue Minitest::Skip, Minitest::Assertion
+      rescue Minitest::Assertion # incl Skip & UnexpectedError
         # don't count assertion
         raise
       rescue SignalException, SystemExit
@@ -413,6 +489,10 @@ module Minitest
       end
 
       assert caught, message(msg) { default }
+    rescue Assertion
+      raise
+    rescue => e
+      raise UnexpectedError, e
     end
 
     ##
@@ -485,6 +565,11 @@ module Minitest
           captured_stderr.unlink
           $stdout.reopen orig_stdout
           $stderr.reopen orig_stderr
+
+          orig_stdout.close
+          orig_stderr.close
+          captured_stdout.close
+          captured_stderr.close
         end
       end
     end
@@ -504,7 +589,16 @@ module Minitest
     end
 
     ##
-    # Fails with +msg+
+    # Fails after a given date (in the local time zone). This allows
+    # you to put time-bombs in your tests if you need to keep
+    # something around until a later date lest you forget about it.
+
+    def fail_after y,m,d,msg
+      flunk msg if Time.now > Time.local(y, m, d)
+    end
+
+    ##
+    # Fails with +msg+.
 
     def flunk msg = nil
       msg ||= "Epic Fail!"
@@ -534,7 +628,7 @@ module Minitest
 
     def refute test, msg = nil
       msg ||= message { "Expected #{mu_pp(test)} to not be truthy" }
-      not assert !test, msg
+      assert !test, msg
     end
 
     ##
@@ -638,6 +732,14 @@ module Minitest
       refute o1.__send__(op, o2), msg
     end
 
+    ##
+    # Fails if +path+ exists.
+
+    def refute_path_exists path, msg = nil
+      msg = message(msg) { "Expected path '#{path}' to not exist" }
+      refute File.exist?(path), msg
+    end
+
     ##
     # For testing with predicates.
     #
@@ -683,6 +785,18 @@ module Minitest
       raise Minitest::Skip, msg, bt
     end
 
+    ##
+    # Skips the current run until a given date (in the local time
+    # zone). This allows you to put some fixes on hold until a later
+    # date, but still holds you accountable and prevents you from
+    # forgetting it.
+
+    def skip_until y,m,d,msg
+      skip msg if Time.now < Time.local(y, m, d)
+      where = caller.first.split(/:/, 3).first(2).join ":"
+      warn "Stale skip_until %p at %s" % [msg, where]
+    end
+
     ##
     # Was this testcase skipped? Meant for #teardown.
 

data/lib/minitest/benchmark.rb

@@ -109,8 +109,8 @@ module Minitest
     # is applied against the slope itself. As such, you probably want
     # to tighten it from the default.
     #
-    # See http://www.graphpad.com/curvefit/goodness_of_fit.htm for
-    # more details.
+    # See https://www.graphpad.com/guides/prism/8/curve-fitting/reg_intepretingnonlinr2.htm
+    # for more details.
     #
     # Fit is calculated by #fit_linear.
     #