minitest 5.15.0 → 5.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d7d16c7decb91ba01a888704bd527d1e5569454b444fe1b4e41a8a3a7db7406
-  data.tar.gz: 1ee0d2823a94b63b8cd019198fe2ca20a5c3d9d7bf4918148bdfa543fb65945d
+  metadata.gz: f8a4c5be93a57704279d69e9de71e39a726d553e5f8e75ef98fca8606b5543bf
+  data.tar.gz: e821d2c514f6fdc21698c3b6f1c1dbba39de57817c1c7710881082cdce382371
 SHA512:
-  metadata.gz: 933a300969aa30dc8f254952dd17f9975cb1f3aad9c10c96260394d088b76900273773374b5ed72731356f2b7f1cfeb131583ae943322250a60401e554e11f45
-  data.tar.gz: 24a356e1d3c06e28d03860b4dca92d17b88979ebad6316fe97298207c58b29b0ae207657d0044a43ede1bf9a27ac43ca8c779e24fc9ca5ed4c920beca2eaf143
+  metadata.gz: 35335793acd5044353c3fae7e59f62c15ed321f8637e20aef8fa82269c1e2d1670f2ef92363cd94c56708e2eae50d95e7b22fed3a35219c2010f4c6a40748f9c
+  data.tar.gz: 41540290647a9fd33739b43f99bff035c4371f0f0d3e4021e8e2502fd4c02f0e10efb787ca48e31276a59c64e627a837515bbeb9e6795bb48e6f89b704c007a8

data/History.rdoc

@@ -1,3 +1,47 @@
+=== 5.16.2 / 2022-07-03
+
+* 4 bug fixes:
+
+  * Added MT_KWARGS_HACK kludge for stub to deal with ruby 2.7 kwargs nastiness. (tsugimoto)
+  * In #expect, pop Hash class from args if $MT_KWARGS_HACK. (casperisfine)
+  * In above scenario, set expected kwargs (as Objects) based on actual kwargs.
+  * Nuke ivars if exception fails to marshal twice (eg better_errors). (irphilli)
+
+=== 5.16.1 / 2022-06-20
+
+* 2 bug fixes:
+
+  * Apparently adding real kwarg support to mocks/stubs broke some code. Fixed.
+    * Use `MT_KWARGS_HACK=1` to activate the kludgy kwargs support w/ caveats.
+  * Clarified some doco wrt the block on #stub.
+
+=== 5.16.0 / 2022-06-14
+
+* 2 major enhancements:
+
+  * Added Minitest::TestTask.
+  * Dropping ruby 2.2 - 2.5. 2.6 is DTM soon too.
+
+* 11 minor enhancements:
+
+  * Added --show-skips option to show skips at end of run but not require --verbose. (MSP-Greg)
+  * Added Minitest.seed, the random seed used by the run.
+  * Calling `srand Minitest.seed` before all shuffles to ensure determinism.
+  * Extended #stub to handle kwargs for both block and call args. (SampsonCrowley)
+  * Extended Mock#__call to display kwargs.
+  * Extended Mock#expect to record kwargs.
+  * Extended Mock#method_missing to take kwargs & compare them against expected.
+  * Mock#method_missing displays better errors on arity mismatch.
+  * Removed minor optimization removing empty suites before run.
+  * Simplified test randomization (test order will change even with fixed seed).
+  * assert_match now returns the MatchData on success. (Nakilon)
+
+* 3 bug fixes:
+
+  * (Re)Fixed marshalling of exceptions, neutering them in 2 passes.
+  * Fixed more problems with rdoc.
+  * Had to patch up mock and stub to deal with <=2.7 kwargs oddities
+
 === 5.15.0 / 2021-12-14
 
 * 1 major enhancement:

data/Manifest.txt

@@ -17,6 +17,7 @@ lib/minitest/pride.rb
 lib/minitest/pride_plugin.rb
 lib/minitest/spec.rb
 lib/minitest/test.rb
+lib/minitest/test_task.rb
 lib/minitest/unit.rb
 test/minitest/metametameta.rb
 test/minitest/test_minitest_assertions.rb
@@ -25,3 +26,4 @@ test/minitest/test_minitest_mock.rb
 test/minitest/test_minitest_reporter.rb
 test/minitest/test_minitest_spec.rb
 test/minitest/test_minitest_test.rb
+test/minitest/test_minitest_test_task.rb

data/README.rdoc

@@ -2,7 +2,7 @@
 
 home :: https://github.com/seattlerb/minitest
 bugs :: https://github.com/seattlerb/minitest/issues
-rdoc :: http://docs.seattlerb.org/minitest
+rdoc :: https://docs.seattlerb.org/minitest
 vim  :: https://github.com/sunaku/vim-ruby-minitest
 emacs:: https://github.com/arthurnn/minitest-emacs
 
@@ -70,6 +70,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.
 
@@ -186,7 +187,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
@@ -237,7 +238,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 +265,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,18 +294,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 "rake/testtask"
+    require "minitest/test_task"
+
+    Minitest::TestTask.create # named test, sensible defaults
 
-    Rake::TestTask.new(:test) do |t|
+    # or more explicitly:
+
+    Minitest::TestTask.create(:test) do |t|
       t.libs << "test"
       t.libs << "lib"
-      t.test_files = FileList["test/**/test_*.rb"]
+      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
@@ -726,6 +753,9 @@ rematch                     :: Declutter your test files from large hardcoded da
                                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:
 
@@ -751,7 +781,7 @@ 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:
 

data/Rakefile

@@ -11,7 +11,7 @@ Hoe.spec "minitest" do
 
   license "MIT"
 
-  require_ruby_version [">= 2.2", "< 4.0"]
+  require_ruby_version [">= 2.6", "< 4.0"]
 end
 
 desc "Find missing expectations"

data/lib/minitest/assertions.rb

@@ -293,6 +293,8 @@ module Minitest
       assert_respond_to matcher, :"=~"
       matcher = Regexp.new Regexp.escape matcher if String === matcher
       assert matcher =~ obj, msg
+
+      Regexp.last_match
     end
 
     ##

data/lib/minitest/benchmark.rb

@@ -217,7 +217,7 @@ module Minitest
     ##
     # Takes an array of x/y pairs and calculates the general R^2 value.
     #
-    # See: http://en.wikipedia.org/wiki/Coefficient_of_determination
+    # See: https://en.wikipedia.org/wiki/Coefficient_of_determination
 
     def fit_error xys
       y_bar  = sigma(xys) { |_, y| y } / xys.size.to_f
@@ -232,7 +232,7 @@ module Minitest
     #
     # Takes x and y values and returns [a, b, r^2].
     #
-    # See: http://mathworld.wolfram.com/LeastSquaresFittingExponential.html
+    # See: https://mathworld.wolfram.com/LeastSquaresFittingExponential.html
 
     def fit_exponential xs, ys
       n     = xs.size
@@ -254,7 +254,7 @@ module Minitest
     #
     # Takes x and y values and returns [a, b, r^2].
     #
-    # See: http://mathworld.wolfram.com/LeastSquaresFittingLogarithmic.html
+    # See: https://mathworld.wolfram.com/LeastSquaresFittingLogarithmic.html
 
     def fit_logarithmic xs, ys
       n     = xs.size
@@ -276,7 +276,7 @@ module Minitest
     #
     # Takes x and y values and returns [a, b, r^2].
     #
-    # See: http://mathworld.wolfram.com/LeastSquaresFitting.html
+    # See: https://mathworld.wolfram.com/LeastSquaresFitting.html
 
     def fit_linear xs, ys
       n   = xs.size
@@ -298,7 +298,7 @@ module Minitest
     #
     # Takes x and y values and returns [a, b, r^2].
     #
-    # See: http://mathworld.wolfram.com/LeastSquaresFittingPowerLaw.html
+    # See: https://mathworld.wolfram.com/LeastSquaresFittingPowerLaw.html
 
     def fit_power xs, ys
       n       = xs.size

data/lib/minitest/mock.rb

@@ -28,11 +28,19 @@ module Minitest # :nodoc:
     end
 
     overridden_methods.map(&:to_sym).each do |method_id|
-      define_method method_id do |*args, &b|
+      define_method method_id do |*args, **kwargs, &b|
         if @expected_calls.key? method_id then
-          method_missing(method_id, *args, &b)
+          if kwargs.empty? then # FIX: drop this after 2.7 dead
+            method_missing(method_id, *args, &b)
+          else
+            method_missing(method_id, *args, **kwargs, &b)
+          end
         else
-          super(*args, &b)
+          if kwargs.empty? then # FIX: drop this after 2.7 dead
+            super(*args, &b)
+          else
+            super(*args, **kwargs, &b)
+          end
         end
       end
     end
@@ -43,9 +51,11 @@ module Minitest # :nodoc:
       @actual_calls   = Hash.new { |calls, name| calls[name] = [] }
     end
 
+    @@KW_WARNED = false # :nodoc:
+
     ##
-    # Expect that method +name+ is called, optionally with +args+ or a
-    # +blk+, and returns +retval+.
+    # Expect that method +name+ is called, optionally with +args+ (and
+    # +kwargs+ or a +blk+, and returns +retval+.
     #
     #   @mock.expect(:meaning_of_life, 42)
     #   @mock.meaning_of_life # => 42
@@ -78,15 +88,31 @@ module Minitest # :nodoc:
     #   @mock.ordinal_increment # => raises MockExpectationError "No more expects available for :ordinal_increment"
     #
 
-    def expect name, retval, args = [], &blk
+    def expect name, retval, args = [], **kwargs, &blk
       name = name.to_sym
 
       if block_given?
         raise ArgumentError, "args ignored when block given" unless args.empty?
+        raise ArgumentError, "kwargs ignored when block given" unless kwargs.empty?
         @expected_calls[name] << { :retval => retval, :block => blk }
       else
         raise ArgumentError, "args must be an array" unless Array === args
-        @expected_calls[name] << { :retval => retval, :args => args }
+
+        if ENV["MT_KWARGS_HAC\K"] && (Hash === args.last ||
+                                      Hash ==  args.last) then
+          if kwargs.empty? then
+            kwargs = args.pop
+          else
+            unless @@KW_WARNED then
+              from = caller.first
+              warn "Using MT_KWARGS_HAC\K yet passing kwargs. From #{from}"
+              @@KW_WARNED = true
+            end
+          end
+        end
+
+        @expected_calls[name] <<
+          { :retval => retval, :args => args, :kwargs => kwargs }
       end
       self
     end
@@ -94,7 +120,13 @@ module Minitest # :nodoc:
     def __call name, data # :nodoc:
       case data
       when Hash then
-        "#{name}(#{data[:args].inspect[1..-2]}) => #{data[:retval].inspect}"
+        args   = data[:args].inspect[1..-2]
+        kwargs = data[:kwargs]
+        if kwargs && !kwargs.empty? then
+          args << ", " unless args.empty?
+          args << kwargs.inspect[1..-2]
+        end
+        "#{name}(#{args}) => #{data[:retval].inspect}"
       else
         data.map { |d| __call name, d }.join ", "
       end
@@ -115,10 +147,10 @@ module Minitest # :nodoc:
       true
     end
 
-    def method_missing sym, *args, &block # :nodoc:
+    def method_missing sym, *args, **kwargs, &block # :nodoc:
       unless @expected_calls.key?(sym) then
         if @delegator && @delegator.respond_to?(sym)
-          return @delegator.public_send(sym, *args, &block)
+          return @delegator.public_send(sym, *args, **kwargs, &block)
         else
           raise NoMethodError, "unmocked method %p, expected one of %p" %
             [sym, @expected_calls.keys.sort_by(&:to_s)]
@@ -129,26 +161,34 @@ module Minitest # :nodoc:
       expected_call = @expected_calls[sym][index]
 
       unless expected_call then
-        raise MockExpectationError, "No more expects available for %p: %p" %
-          [sym, args]
+        raise MockExpectationError, "No more expects available for %p: %p %p" %
+          [sym, args, kwargs]
       end
 
-      expected_args, retval, val_block =
-        expected_call.values_at(:args, :retval, :block)
+      expected_args, expected_kwargs, retval, val_block =
+        expected_call.values_at(:args, :kwargs, :retval, :block)
+
+      expected_kwargs = kwargs.map { |ak, av| [ak, Object] }.to_h if
+        Hash == expected_kwargs
 
       if val_block then
         # keep "verify" happy
         @actual_calls[sym] << expected_call
 
-        raise MockExpectationError, "mocked method %p failed block w/ %p" %
-          [sym, args] unless val_block.call(*args, &block)
+        raise MockExpectationError, "mocked method %p failed block w/ %p %p" %
+          [sym, args, kwargs] unless val_block.call(*args, **kwargs, &block)
 
         return retval
       end
 
       if expected_args.size != args.size then
-        raise ArgumentError, "mocked method %p expects %d arguments, got %d" %
-          [sym, expected_args.size, args.size]
+        raise ArgumentError, "mocked method %p expects %d arguments, got %p" %
+          [sym, expected_args.size, args]
+      end
+
+      if expected_kwargs.size != kwargs.size then
+        raise ArgumentError, "mocked method %p expects %d keyword arguments, got %p" %
+          [sym, expected_kwargs.size, kwargs]
       end
 
       zipped_args = expected_args.zip(args)
@@ -157,13 +197,33 @@ module Minitest # :nodoc:
       }
 
       unless fully_matched then
-        raise MockExpectationError, "mocked method %p called with unexpected arguments %p" %
-          [sym, args]
+        fmt = "mocked method %p called with unexpected arguments %p"
+        raise MockExpectationError, fmt % [sym, args]
+      end
+
+      unless expected_kwargs.keys.sort == kwargs.keys.sort then
+        fmt = "mocked method %p called with unexpected keywords %p vs %p"
+        raise MockExpectationError, fmt % [sym, expected_kwargs.keys, kwargs.keys]
+      end
+
+      zipped_kwargs = expected_kwargs.map { |ek, ev|
+        av = kwargs[ek]
+        [ek, [ev, av]]
+      }.to_h
+
+      fully_matched = zipped_kwargs.all? { |ek, (ev, av)|
+        ev === av or ev == av
+      }
+
+      unless fully_matched then
+        fmt = "mocked method %p called with unexpected keyword arguments %p vs %p"
+        raise MockExpectationError, fmt % [sym, expected_kwargs, kwargs]
       end
 
       @actual_calls[sym] << {
         :retval => retval,
-        :args => zipped_args.map! { |mod, a| mod === a ? mod : a },
+        :args => zipped_args.map { |e, a| e === a ? e : a },
+        :kwargs => zipped_kwargs.map { |k, (e, a)| [k, e === a ? e : a] }.to_h,
       }
 
       retval
@@ -211,31 +271,50 @@ class Object
   # NOTE: keyword args in callables are NOT checked for correctness
   # against the existing method. Too many edge cases to be worth it.
 
-  def stub name, val_or_callable, *block_args
+  def stub name, val_or_callable, *block_args, **block_kwargs, &block
     new_name = "__minitest_stub__#{name}"
 
     metaclass = class << self; self; end
 
     if respond_to? name and not methods.map(&:to_s).include? name.to_s then
-      metaclass.send :define_method, name do |*args|
-        super(*args)
+      metaclass.send :define_method, name do |*args, **kwargs|
+        super(*args, **kwargs)
       end
     end
 
     metaclass.send :alias_method, new_name, name
 
-    metaclass.send :define_method, name do |*args, &blk|
-      if val_or_callable.respond_to? :call then
-        val_or_callable.call(*args, &blk)
-      else
-        blk.call(*block_args) if blk
-        val_or_callable
+    if ENV["MT_KWARGS_HAC\K"] then
+      metaclass.send :define_method, name do |*args, &blk|
+        if val_or_callable.respond_to? :call then
+          val_or_callable.call(*args, &blk)
+        else
+          blk.call(*block_args, **block_kwargs) if blk
+          val_or_callable
+        end
+      end
+    else
+      metaclass.send :define_method, name do |*args, **kwargs, &blk|
+        if val_or_callable.respond_to? :call then
+          if kwargs.empty? then # FIX: drop this after 2.7 dead
+            val_or_callable.call(*args, &blk)
+          else
+            val_or_callable.call(*args, **kwargs, &blk)
+          end
+        else
+          if blk then
+            if block_kwargs.empty? then # FIX: drop this after 2.7 dead
+              blk.call(*block_args)
+            else
+              blk.call(*block_args, **block_kwargs)
+            end
+          end
+          val_or_callable
+        end
       end
     end
 
-    metaclass.send(:ruby2_keywords, name) if metaclass.respond_to?(:ruby2_keywords, true)
-
-    yield self
+    block[self]
   ensure
     metaclass.send :undef_method, name
     metaclass.send :alias_method, name, new_name

data/lib/minitest/pride_plugin.rb

@@ -48,7 +48,7 @@ module Minitest
     def initialize io # :nodoc:
       @io = io
       # stolen from /System/Library/Perl/5.10.0/Term/ANSIColor.pm
-      # also reference http://en.wikipedia.org/wiki/ANSI_escape_code
+      # also reference https://en.wikipedia.org/wiki/ANSI_escape_code
       @colors ||= (31..36).to_a
       @size   = @colors.size
       @index  = 0

data/lib/minitest/spec.rb

@@ -66,7 +66,7 @@ module Kernel
   #
   # For some suggestions on how to improve your specs, try:
   #
-  # http://betterspecs.org
+  # https://betterspecs.org
   #
   # but do note that several items there are debatable or specific to
   # rspec.

data/lib/minitest/test.rb

@@ -67,8 +67,8 @@ module Minitest
 
       case self.test_order
       when :random, :parallel then
-        max = methods.size
-        methods.sort.sort_by { rand max }
+        srand Minitest.seed
+        methods.sort.shuffle
       when :alpha, :sorted then
         methods.sort
       else
@@ -203,12 +203,34 @@ module Minitest
 
     def sanitize_exception e # :nodoc:
       Marshal.dump e
-      e
+      e                                         # good: use as-is
     rescue TypeError
+      neuter_exception e
+    end
+
+    def neuter_exception e
       bt = e.backtrace
-      e = RuntimeError.new "Wrapped undumpable exception for: #{e.class}: #{e.message}"
-      e.set_backtrace bt
-      e
+      msg = e.message.dup
+
+      new_exception e.class, msg, bt            # e.class can be a problem...
+    rescue TypeError
+      msg.prepend "Neutered Exception #{e.class}: "
+
+      new_exception RuntimeError, msg, bt, true # but if this raises, we die
+    end
+
+    def new_exception klass, msg, bt, kill = false
+      ne = klass.new msg
+      ne.set_backtrace bt
+
+      if kill then
+        ne.instance_variables.each do |v|
+          ne.remove_instance_variable v
+        end
+      end
+
+      Marshal.dump ne                           # can raise TypeError
+      ne
     end
 
     def with_info_handler &block # :nodoc: