minitest 5.10.3 → 5.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 32d4df1397bf8fc366b4b18555936d7c92853121
-  data.tar.gz: 4000474506d5056f3117b1a93e1bc4019dfd15af
+SHA256:
+  metadata.gz: 6db5992e9a08e2dc6f38cae45eb2b363db069130b15103a42dbc62e675f89120
+  data.tar.gz: 61852113ccc15d225be0e9f751315833be115e10215a88911fde0b3d933b0622
 SHA512:
-  metadata.gz: 195277b6093c3650634809f445c274d8df6bfafb4f32be448f4cdde07de9edf47c64e4f05cdf3572bf79f61e2597ce33c2b7821cd147d4c8bd2f251451e86098
-  data.tar.gz: a8a16930df76274303310ba4faf115914913bea38b559ec4edfad8ae2a835fb22e7d6308c88eadf93044ea422b334d65e33c8c59f15f0ece27a962b1fc8d7e9c
+  metadata.gz: 3b3d3f7ba9ec79e2e8f5a286c47b97fb588e5b1b8e157c598e930257342f7b82b8b37fdde2687196a5efa0e3ef1f713aecf64f9bddad3f562a6f13718dc387c8
+  data.tar.gz: ee3c67d52c3fd56d0514b067774771738297225670478f945f7144797914bc7a975d5c8f064a54efbffbe08084ee0fcd4d6c903e80f25e2dcd19fa38644a5afc

data.tar.gz.sig

@@ -1,2 +1,2 @@
-V���%s�g�e�Q�K�͝P�u�I}����I6I}Kj��ڳt�8a"w��TFig�"��(��Hڞ�Ӱ�V�ص^���
�Z=�j�=���'����-���i*-u�/�d���1�z��/��X�E8a���	�•�z֍?!�$�:�uwR"b��C��3L���j��Tk��!�Y6���޶���n^/w�o@J
- /���-�*�^~)Z�Y'��,5��vCM 1��B�����N�y�8
+^&�_�&��&��H�f��F�9��"r�l�@*S0�Oq�qg�mfBG��ٮ��3�w��1xM"U󠑪���Sj��5t�+�cO����в��g����X树>#�W��y̧�����$���ID�>�S����X��ɂo���b
+O���D6����ܔ�0Y�R��
�nA�rø@�l��b����7g�$^F�7�:����}TK�{�Y~e��z��eR8j{8w���.1r��fr�.6��tr��Ta(n���

data/History.rdoc

@@ -1,3 +1,91 @@
+=== 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:
+
+  * Pushed #error? up to Reportable module. (composerinteralia)
+
+=== 5.11.2 / 2018-01-25
+
+* 1 minor enhancement:
+
+  * Reversed Test < Result. Back to < Runnable and using Reportable for shared code.
+
+* 2 bug fixes:
+
+  * Fixed Result#location for instances of Test. (alexisbernard)
+  * Fixed deprecation message for Runnable#marshal_dump. (y-yagi)
+
+=== 5.11.1 / 2018-01-02
+
+* 1 bug fix:
+
+  * Fixed Result (a superclass of Test) overriding Runnable's name accessors. (y-yagi, MSP-Greg)
+
+=== 5.11.0 / 2018-01-01
+
+* 2 major enhancements:
+
+  * Added Minitest::Result and Minitest::Result.from(runnable).
+  * Changed Minitest::Test to subclass Result and refactored methods up.
+
+* 7 minor enhancements:
+
+  * Added --no-plugins and MT_NO_PLUGINS to bypass MT plugin autoloading. Helps with bad actors installed globally.
+  * Added bench_performance_{logarithmic,power} for spec-style benchmarks. (rickhull)
+  * Added deprecation warning for Runnable#marshal_dump.
+  * Minitest.run_one_method now checks for instance of Result, not exact same class.
+  * Minitest::Test.run returns a Result version of self, not self.
+  * ProgressReporter#prerecord now explicitly prints klass.name. Allows for fakers.
+
+* 4 bug fixes:
+
+  * Object.stub no longer calls the passed block if stubbed with a callable.
+  * Object.stub now passes blocks down to the callable result.
+  * Pushed Minitest::Test#time & #time_it up to Runnable.
+  * Test nil equality directly in assert_equal. Fixes #679. (voxik)
+
+=== 5.11.0b1 / 2017-12-20
+
+* 2 major enhancements:
+
+  * Added Minitest::Result and Minitest::Result.from(runnable).
+  * Changed Minitest::Test to subclass Result and refactored methods up.
+
+* 6 minor enhancements:
+
+  * Added --no-plugins and MT_NO_PLUGINS to bypass MT plugin autoloading. Helps with bad actors installed globally.
+  * Added bench_performance_{logarithmic,power} for spec-style benchmarks. (rickhull)
+  * Minitest.run_one_method now checks for instance of Result, not exact same class.
+  * Minitest::Test.run returns a Result version of self, not self.
+  * ProgressReporter#prerecord now explicitly prints klass.name. Allows for fakers.
+  * Removed Runnable.marshal_dump/load.
+
+* 4 bug fixes:
+
+  * Object.stub no longer calls the passed block if stubbed with a callable.
+  * Object.stub now passes blocks down to the callable result.
+  * Pushed Minitest::Test#time & #time_it up to Runnable.
+  * Test nil equality directly in assert_equal. Fixes #679. (voxik)
+
 === 5.10.3 / 2017-07-21
 
 * 1 minor enhancement:

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
@@ -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
 
@@ -434,11 +446,26 @@ you want to extend your test using setup/teardown via a module, just
 make sure you ALWAYS call super. before/after automatically call super
 for you, so make sure you don't do it twice.
 
+=== How to run code before a group of tests?
+
+Use a constant with begin...end like this:
+
+  describe Blah do
+    SETUP = begin
+       # ... this runs once when describe Blah starts
+    end
+    # ...
+  end
+
+This can be useful for expensive initializations or sharing state.
+Remember, this is just ruby code, so you need to make sure this
+technique and sharing state doesn't interfere with your tests.
+
 === Why am I seeing <tt>uninitialized constant MiniTest::Test (NameError)</tt>?
 
-Are you running the test with Bundler (e.g. via <tt>bundle exec</tt> )? If so, 
+Are you running the test with Bundler (e.g. via <tt>bundle exec</tt> )? If so,
 in order to require minitest, you must first add the <tt>gem 'minitest'</tt>
-to your Gemfile and run +bundle+. Once it's installed, you should be 
+to your Gemfile and run +bundle+. Once it's installed, you should be
 able to require minitest and run your tests.
 
 == Prominent Projects using Minitest:
@@ -506,7 +533,7 @@ If you see failures like either of these, you are probably missing diff tool:
 
 
 If you use Cygwin or MSYS2 or similar there are packages that include a
-GNU diff for Widnows. If you don't, you can download GNU diffutils from
+GNU diff for Windows. If you don't, you can download GNU diffutils from
 http://gnuwin32.sourceforge.net/packages/diffutils.htm
 (make sure to add it to your PATH).
 
@@ -578,7 +605,7 @@ 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 
+minitest-have_tag           :: Adds Minitest assertions to test for the existence of
                                HTML tags, including contents, within a provided string.
 minitest-hooks              :: Around and before_all/after_all/around_all hooks
 minitest-hyper              :: Pretty, single-page HTML reports for your Minitest runs
@@ -588,6 +615,7 @@ minitest-instrument         :: Instrument ActiveSupport::Notifications when
 minitest-instrument-db      :: Store information about speed of test execution
                                provided by minitest-instrument in database.
 minitest-junit              :: JUnit-style XML reporter for minitest.
+minitest-keyword            :: Use Minitest assertions with keyword arguments.
 minitest-libnotify          :: Test notifier for minitest via libnotify.
 minitest-line               :: Run test at line number.
 minitest-logger             :: Define assert_log and enable minitest to test log messages.
@@ -599,6 +627,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.
@@ -614,10 +643,10 @@ minitest-rails-capybara     :: Capybara integration for Minitest::Rails.
 minitest-reporters          :: Create customizable Minitest output formats.
 minitest-rg                 :: Colored red/green output for Minitest.
 minitest-rspec_mocks        :: Use RSpec Mocks with Minitest.
-minitest-server             :: minitest-server provides a client/server setup 
-                               with your minitest process, allowing your test 
+minitest-server             :: minitest-server provides a client/server setup
+                               with your minitest process, allowing your test
                                run to send its results directly to a handler.
-minitest-sequel             :: Minitest assertions to speed-up development and 
+minitest-sequel             :: Minitest assertions to speed-up development and
                                testing of Ruby Sequel database setups.
 minitest-shared_description :: Support for shared specs and shared spec
                                subclasses
@@ -648,6 +677,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

data/lib/minitest.rb

@@ -8,7 +8,7 @@ require "stringio"
 # :include: README.rdoc
 
 module Minitest
-  VERSION = "5.10.3" # :nodoc:
+  VERSION = "5.12.0" # :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.
@@ -118,7 +121,7 @@ module Minitest
   #                   klass.new(runnable_method).run
 
   def self.run args = []
-    self.load_plugins
+    self.load_plugins unless args.delete("--no-plugins") || ENV["MT_NO_PLUGINS"]
 
     options = process_args args
 
@@ -175,6 +178,8 @@ module Minitest
         exit
       end
 
+      opts.on "--no-plugins", "Bypass minitest plugin auto-loading (or set $MT_NO_PLUGINS)."
+
       desc = "Sets random seed. Also via env. Eg: SEED=n rake"
       opts.on "-s", "--seed SEED", Integer, desc do |m|
         options[:seed] = m.to_i
@@ -252,6 +257,19 @@ module Minitest
 
     attr_accessor :failures
 
+    ##
+    # The time it took to run.
+
+    attr_accessor :time
+
+    def time_it # :nodoc:
+      t0 = Minitest.clock_time
+
+      yield
+    ensure
+      self.time = Minitest.clock_time - t0
+    end
+
     ##
     # Name of the run.
 
@@ -266,11 +284,6 @@ module Minitest
       @NAME = o
     end
 
-    def self.inherited klass # :nodoc:
-      self.runnables << klass
-      super
-    end
-
     ##
     # Returns all instance methods matching the pattern +re+.
 
@@ -291,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}"
@@ -367,12 +380,20 @@ module Minitest
       @@runnables
     end
 
+    @@marshal_dump_warned = false
+
     def marshal_dump # :nodoc:
-      [self.name, self.failures, self.assertions]
+      unless @@marshal_dump_warned then
+        warn ["Minitest::Runnable#marshal_dump is deprecated.",
+              "You might be violating internals. From", caller.first].join " "
+        @@marshal_dump_warned = true
+      end
+
+      [self.name, self.failures, self.assertions, self.time]
     end
 
     def marshal_load ary # :nodoc:
-      self.name, self.failures, self.assertions = ary
+      self.name, self.failures, self.assertions, self.time = ary
     end
 
     def failure # :nodoc:
@@ -418,6 +439,109 @@ module Minitest
     end
   end
 
+  ##
+  # Shared code for anything that can get passed to a Reporter. See
+  # Minitest::Test & Minitest::Result.
+
+  module Reportable
+    ##
+    # Did this run pass?
+    #
+    # Note: skipped runs are not considered passing, but they don't
+    # cause the process to exit non-zero.
+
+    def passed?
+      not self.failure
+    end
+
+    ##
+    # The location identifier of this test. Depends on a method
+    # existing called class_name.
+
+    def location
+      loc = " [#{self.failure.location}]" unless passed? or error?
+      "#{self.class_name}##{self.name}#{loc}"
+    end
+
+    def class_name # :nodoc:
+      raise NotImplementedError, "subclass responsibility"
+    end
+
+    ##
+    # Returns ".", "F", or "E" based on the result of the run.
+
+    def result_code
+      self.failure and self.failure.result_code or "."
+    end
+
+    ##
+    # Was this run skipped?
+
+    def skipped?
+      self.failure and Skip === self.failure
+    end
+
+    ##
+    # Did this run error?
+
+    def error?
+      self.failures.any? { |f| UnexpectedError === f }
+    end
+  end
+
+  ##
+  # This represents a test result in a clean way that can be
+  # marshalled over a wire. Tests can do anything they want to the
+  # test instance and can create conditions that cause Marshal.dump to
+  # blow up. By using Result.from(a_test) you can be reasonably sure
+  # that the test result can be marshalled.
+
+  class Result < Runnable
+    include Minitest::Reportable
+
+    undef_method :marshal_dump
+    undef_method :marshal_load
+
+    ##
+    # The class name of the test result.
+
+    attr_accessor :klass
+
+    ##
+    # The location of the test method.
+
+    attr_accessor :source_location
+
+    ##
+    # Create a new test result from a Runnable instance.
+
+    def self.from runnable
+      o = runnable
+
+      r = self.new o.name
+      r.klass      = o.class.name
+      r.assertions = o.assertions
+      r.failures   = o.failures.dup
+      r.time       = o.time
+
+      r.source_location = o.method(o.name).source_location rescue ["unknown", -1]
+
+      r
+    end
+
+    def class_name # :nodoc:
+      self.klass # for Minitest::Reportable
+    end
+
+    def to_s # :nodoc:
+      return location if passed? and not skipped?
+
+      failures.map { |failure|
+        "#{failure.result_label}:\n#{self.location}:\n#{failure.message}\n"
+      }.join "\n"
+    end
+  end
+
   ##
   # Defines the API for Reporters. Subclass this and override whatever
   # you want. Go nuts.
@@ -488,7 +612,7 @@ module Minitest
   class ProgressReporter < Reporter
     def prerecord klass, name #:nodoc:
       if options[:verbose] then
-        io.print "%s#%s = " % [klass, name]
+        io.print "%s#%s = " % [klass.name, name]
         io.flush
       end
     end
@@ -837,7 +961,7 @@ module Minitest
 
   def self.run_one_method klass, method_name # :nodoc:
     result = klass.new(method_name).run
-    raise "#{klass}#run _must_ return self" unless klass === result
+    raise "#{klass}#run _must_ return a Result" unless Result === result
     result
   end
 
@@ -853,6 +977,13 @@ module Minitest
     end
   end
 
+  class Runnable # re-open
+    def self.inherited klass # :nodoc:
+      self.runnables << klass
+      super
+    end
+  end
+
   # :startdoc:
 end