minitest 5.11.3 → 5.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c82c1408c60d4743cf06566256146090f22ab11bc5f024cbf4026fd967d7eb6
-  data.tar.gz: 93e140e22554c00911e381fa0584c52add681e5adb34bc3e575ee79459d7df6e
+  metadata.gz: b2641be64df14346ec6637e9fa14064f8f52935d4f3c67acf11bc4e2d3b95986
+  data.tar.gz: 9c9c1be3371b73c68ebfda92173d5c468d584e0cd4e405329453027397a651f7
 SHA512:
-  metadata.gz: 3621855d2763f225b2b99061c9eed994040debd9b1b032ebb3318adc42413493458b5c47569b7305954fc7575e870ad97441ce8bec7ddadb92afdd126f1f4bda
-  data.tar.gz: 19e04c6feff4f3d0cda89fadf4bd3f28415301d8adb2e5650a064cb74df57d8ee9885175738ac967d7a839496ac1c0f1c690627e8a2ca83f71edd6b0edb5b811
+  metadata.gz: e04d9e566ec0d8175bb18cee72a44bee41f363fa4dea11d8b14e6373ae4ef489d3ee01fd8308cb9ba7b710d75e25d13650cd452a61017e151ce7616bebb6bd93
+  data.tar.gz: 3d324b4e1c1fc3ba294fd6806a3069df391a950b1594b27110accc0d0afe069d1b9555760555372bb597f0f6e99afbe9cc71bd2a049d1a74f7e9f385f4bc7322

data/History.rdoc

@@ -1,3 +1,40 @@
+=== 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:

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
@@ -379,7 +391,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 +481,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 +561,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 +604,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 +631,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.
@@ -664,6 +681,7 @@ 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 +715,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"
 end
 
 desc "Find missing expectations"

data/lib/minitest.rb

@@ -8,7 +8,7 @@ require "stringio"
 # :include: README.rdoc
 
 module Minitest
-  VERSION = "5.11.3" # :nodoc:
+  VERSION = "5.12.2" # :nodoc:
   ENCS = "".respond_to? :encoding # :nodoc:
 
   @@installed_at_exit ||= false
@@ -21,7 +21,10 @@ module Minitest
   # Parallel test executor
 
   mc.send :attr_accessor, :parallel_executor
-  self.parallel_executor = Parallel::Executor.new((ENV["N"] || 2).to_i)
+
+  warn "DEPRECATED: use MT_CPU instead of N for parallel test runs" if ENV["N"]
+  n_threads = (ENV["MT_CPU"] || ENV["N"] || 2).to_i
+  self.parallel_executor = Parallel::Executor.new n_threads
 
   ##
   # Filter object for backtraces.
@@ -301,7 +304,7 @@ module Minitest
 
     def self.run reporter, options = {}
       filter = options[:filter] || "/./"
-      filter = Regexp.new $1 if filter =~ %r%/(.*)/%
+      filter = Regexp.new $1 if filter.is_a?(String) && filter =~ %r%/(.*)/%
 
       filtered_methods = self.runnable_methods.find_all { |m|
         filter === m || filter === "#{self}##{m}"
@@ -422,7 +425,8 @@ module Minitest
 
     ##
     # Returns a single character string to print based on the result
-    # of the run. Eg ".", "F", or "E".
+    # of the run. One of <tt>"."</tt>, <tt>"F"</tt>,
+    # <tt>"E"</tt> or <tt>"S"</tt>.
 
     def result_code
       raise NotImplementedError, "subclass responsibility"
@@ -560,8 +564,10 @@ module Minitest
     end
 
     ##
-    # Record a result and output the Runnable#result_code. Stores the
-    # result of the run if the run did not pass.
+    # Output and record the result of the test. Call
+    # {result#result_code}[rdoc-ref:Runnable#result_code] to get the
+    # result character string. Stores the result of the run if the run
+    # did not pass.
 
     def record result
     end
@@ -628,18 +634,63 @@ module Minitest
   #
   # If you want to create an entirely different type of output (eg,
   # CI, HTML, etc), this is the place to start.
+  #
+  # Example:
+  #
+  #   class JenkinsCIReporter < StatisticsReporter
+  #     def report
+  #       super  # Needed to calculate some statistics
+  #
+  #       print "<testsuite "
+  #       print "tests='#{count}' "
+  #       print "failures='#{failures}' "
+  #       # Remaining XML...
+  #     end
+  #   end
 
   class StatisticsReporter < Reporter
-    # :stopdoc:
+    ##
+    # Total number of assertions.
+
     attr_accessor :assertions
+
+    ##
+    # Total number of test cases.
+
     attr_accessor :count
+
+    ##
+    # An +Array+ of test cases that failed or were skipped.
+
     attr_accessor :results
+
+    ##
+    # Time the test run started. If available, the monotonic clock is
+    # used and this is a +Float+, otherwise it's an instance of
+    # +Time+.
+
     attr_accessor :start_time
+
+    ##
+    # Test run time. If available, the monotonic clock is used and
+    # this is a +Float+, otherwise it's an instance of +Time+.
+
     attr_accessor :total_time
+
+    ##
+    # Total number of tests that failed.
+
     attr_accessor :failures
+
+    ##
+    # Total number of tests that erred.
+
     attr_accessor :errors
+
+    ##
+    # Total number of tests that where skipped.
+
     attr_accessor :skips
-    # :startdoc:
 
     def initialize io = $stdout, options = {} # :nodoc:
       super
@@ -669,7 +720,10 @@ module Minitest
       results << result if not result.passed? or result.skipped?
     end
 
-    def report # :nodoc:
+    ##
+    # Report on the tracked statistics.
+
+    def report
       aggregate = results.group_by { |r| r.failure.class }
       aggregate.default = [] # dumb. group_by should provide this
 

data/lib/minitest/assertions.rb

@@ -27,6 +27,8 @@ 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"
@@ -38,9 +40,7 @@ module Minitest
                 "diff -u"
               else
                 nil
-              end unless defined? @diff
-
-      @diff
+              end
     end
 
     ##
@@ -61,12 +61,15 @@ module Minitest
       butwas = mu_pp_for_diff act
       result = nil
 
+      e1, e2 = expect.include?("\n"), expect.include?("\\n")
+      b1, b2 = butwas.include?("\n"), butwas.include?("\\n")
+
       need_to_diff =
-        (expect.include?("\n")    ||
-         butwas.include?("\n")    ||
-         expect.size > 30         ||
-         butwas.size > 30         ||
-         expect == butwas)        &&
+        (e1 ^ e2           ||
+         b1 ^ b2           ||
+         expect.size > 30  ||
+         butwas.size > 30  ||
+         expect == butwas) &&
         Minitest::Assertions.diff
 
       return "Expected: #{mu_pp exp}\n  Actual: #{mu_pp act}" unless
@@ -101,8 +104,10 @@ module Minitest
 
     ##
     # 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 +115,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 +127,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 +310,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
@@ -319,6 +349,9 @@ module Minitest
     # passed.
 
     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?
 

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.
     #