minitest 4.7.5 → 5.0.7

data/.autotest

@@ -4,18 +4,31 @@ require 'autotest/restart'
 require 'autotest/rcov' if ENV['RCOV']
 
 Autotest.add_hook :initialize do |at|
-  at.testlib = 'minitest/unit'
+  at.testlib = 'minitest/autorun'
+
+  bench_tests = %w(TestMinitestBenchmark)
+  mock_tests = %w(TestMinitestMock TestMinitestStub)
+  spec_tests = %w(TestMinitestReporter TestMetaStatic TestMeta
+                  TestSpecInTestCase)
+  unit_tests = %w(TestMinitestGuard TestMinitestRunnable
+                  TestMinitestRunner TestMinitestTest TestMinitestUnit
+                  TestMinitestUnitInherited TestMinitestUnitOrder
+                  TestMinitestUnitRecording TestMinitestUnitTestCase)
+
+  {
+    bench_tests => "test/minitest/test_minitest_benchmark.rb",
+    mock_tests  => "test/minitest/test_minitest_mock.rb",
+    spec_tests  => "test/minitest/test_minitest_reporter.rb",
+    unit_tests  => "test/minitest/test_minitest_unit.rb",
+  }.each do |klasses, file|
+    klasses.each do |klass|
+      at.extra_class_map[klass] = file
+    end
+  end
 
-  at.extra_class_map["MiniTest::Spec"]           = "test/test_minitest_spec.rb"
-  at.extra_class_map["TestMeta"]                 = "test/test_minitest_spec.rb"
-  at.extra_class_map["TestMiniTestUnitTestCase"] = "test/test_minitest_unit.rb"
-  at.extra_class_map["TestMiniTestUnit"]         = "test/test_minitest_unit.rb"
-  at.extra_class_map["TestMiniTestUnitRecording"]= "test/test_minitest_unit.rb"
-  at.extra_class_map["TestMiniTestStub"]         = "test/test_minitest_mock.rb"
   at.add_exception 'coverage.info'
   at.add_exception 'coverage'
 end
 
 # require 'autotest/rcov'
 # Autotest::RCov.command = 'rcov_info'
-

data/History.txt

@@ -1,24 +1,144 @@
-=== 4.7.5 / 2013-06-21
+=== 5.0.7 / 2013-09-05
+
+* 2 minor enhancements:
+
+  * Added clarification about the use of thread local variables in expectations. (jemc)
+  * Added extra message about skipped tests, if any. Disable globally with $MT_NO_SKIP_MSG.
 
 * 2 bug fixes:
 
-  * Fix Spec#describe_stack to be thread local.
-  * Fix multithreaded test failures by defining Time local to mock test namespace
+  * Only require minitest, not minitest/autorun in pride_plugin. (judofyr)
+  * Require rubygems in load_plugins in case you're not using minitest/autorun.
 
-=== 4.7.4 / 2013-05-01
+=== 5.0.6 / 2013-06-28
 
-This is probably the last release of the 4.x series. It will be merged
-to ruby and will be put into maintenance mode there.
+* 3 minor enhancements:
 
-I'm not set in stone on this, but at this point further development of
-minitest (5+) will be gem-only. It is just too hard to work w/in
-ruby-core w/ test-unit compatibility holding minitest development
-back.
+  * Allow stub to pass args to blocks. (swindsor)
+  * Improved warning message about minitest/autorun to address 1.9's minitest/autorun.
+  * Made minitest/test require minitest as needed. For lib writers. (erikh)
 
-* 2 minor enhancements:
+* 1 bug fix:
+
+  * Fixed missing require in minitest/test. (erikh)
+
+=== 5.0.5 / 2013-06-20
+
+* 6 bug fixes:
+
+  * DOH! Fixed the rest of the new casing on Minitest. (splattael)
+  * Fixed typo on minitest/mock rdoc. (mrgilman/guiceolin)
+  * Make Spec::DSL.describe_stack thread local to avoid failing on my own tests.
+  * Make a fake Time.now local to the tests so they won't interfere with real reporter timings.
+  * Make everything mockable by wrapping all 'special' methods in a smarter wrapper. (bestie)
+  * Raise ArgumentError if let name starts with 'test'. (johnmaxwell)
+
+=== 5.0.4 / 2013-06-07
+
+* 5 minor enhancements:
+
+  * Added AbstractReporter, defining required Reporter API to quack properly.
+  * Added doco for writing reporters.
+  * Refactored Reporter into ProgressReporter and SummaryReporter. (idea: phiggins, code:me+scotch)
+  * Refactored SummaryReporter pushing up to StatisticsReporter. (phiggins)
+  * Removed Reporter#run_and_report... cleaner, but doesn't "fit" in the API.
 
+=== 5.0.3 / 2013-05-29
+
+* 4 minor enhancements:
+
+  * Added Runnable.with_info_handler and Runnable.on_signal.
+  * Moved io.sync restore to Reporter#run_and_report.
+  * Refactored inner loop of Reporter#report to #to_s. Callable for status updates.
+  * Restored MT4's mid-run report (^t). (tenderlove).
+
+=== 5.0.2 / 2013-05-20
+
+* 3 bug fixes:
+
+  * Gem.find_files is smarter than I remember... cause I wrote it that way. *sigh* I'm getting old.
+  * Pride wasn't doing puts through its #io. (tmiller/tenderlove)
+  * Replaced Runnable#dup and Test#dup with marshal_dump/load. Too many problems cropping up on untested rails code. (tenderlove/rubys)
+
+=== 5.0.1 / 2013-05-14
+
+* 2 bug fixes:
+
+  * Documented Assertions' need for @assertions to be defined by the includer.
+  * Only load one plugin version per name. Tries for latest.
+
+=== 5.0.0 / 2013-05-10
+
+Oh god... here we go...
+
+Minitest 5:
+
+* 4 deaths in the family:
+
+  * MiniTest.runner is dead. No more manager objects.
+  * MiniTest::Unit#record is dead. Use a Reporter instance instead.
+  * MiniTest::Unit._run_* is dead. Runnable things are responsible for their own runs.
+  * MiniTest::Unit.output is dead. No more centralized IO.
+
+* 12 major (oft incompatible) changes:
+
+  * Renamed MiniTest to Minitest. Your pinkies will thank me. (aliased to MiniTest)
+  * Removed MiniTest::Unit entirely. No more manager objects.
+  * Added Minitest::Runnable. Everything minitest can run subclasses this.
+  * Renamed MiniTest::Unit::TestCase to Minitest::Test (subclassing Runnable).
+  * Added Minitest::Benchmark.
+    * Your benchmarks need to move to their own subclass.
+    * Benchmarks using the spec DSL have to have "Bench" somewhere in their describe.
+  * MiniTest::Unit.after_tests moved to Minitest.after_tests
+  * MiniTest::Unit.autorun is now Minitest.autorun. Just require minitest/autorun pls.
+  * Removed ParallelEach#grep since it isn't used anywhere.
+  * Renamed Runnable#__name__ to Runnable#name (but uses @NAME internally).
+  * Runnable#run needs to return self. Allows for swapping of results as needed.
+
+* 8 minor moves:
+
+  * Moved Assertions module to minitest/assertions.rb
+  * Moved Expectations module to minitest/expectations.rb
+  * Moved Test to minitest/test.rb
+  * Moved everything else in minitest/unit.rb to minitest.rb
+  * minitest/unit.rb is now just a small (user-test only) compatibility layer.
+  * Moved most of minitest/pride into minitest/pride_plugin.
+  * minitest/pride now just activates pride.
+  * Moved ParallelEach under Minitest.
+
+* 9 additions:
+
+  * Added a plugin system that can extend command-line options.
+  * Added Minitest.extensions.
+  * Added Minitest.reporter (only available during startup).
+  * Added Minitest.run(args). This is the very top of any Minitest run.
+  * Added Minitest::Reporter. Everything minitest can report goes through here.
+    * Minitest.reporter is a composite so you can add your own.
+  * Added Minitest::CompositeReporter. Much easier to extend with your own reporters.
+  * Added UnexpectedError, an Assertion subclass, to wrap up errors.
+  * Minitest::Test#run is now freakin' beautiful. 47 -> 17 loc
+
+* 11 other:
+
+  * Removed Object.infect_with_assertions (it was already dead code).
+  * Runnables are responsible for knowing their result_code (eg "." or "F").
+  * Minitest.autorun now returns boolean, not exit code.
+  * Added FAQ entry for extending via modules. (phiggins)
+  * Implement Runnable#dup to cleanse state back to test results. Helps with serialization. pair:tenderlove
+  * Moved ParallelEach under Minitest.
+  * Runnable#run needs to return self. Allows for swapping of results as needed.
+  * Minitest.init_plugins passes down options.
+  * Minitest.load_plugins only loads once.
+  * Fixed minitest/pride to work with rake test loader again. (tmiller)
   * Added count/size to ParallelEach to fix use w/in stdlib's test/unit. :( (btaitelb)
-  * Allow disabling of info_signal handler in runner. (erikh)
+
+* 5 voodoo:
+
+  * Removed mutex from minitest.rb (phiggins)
+  * Removed mutex from test.rb (phiggins)
+  * Removed Minitest::Reporter.synchronize (phiggins)
+  * Removed Minitest::Test.synchronize (phiggins)
+  * Upon loading minitest/parallel_each, record, capture_io and capture_subprocess_io are doped with synchronization code. (phiggins)
 
 === 4.7.3 / 2013-04-20
 

data/Manifest.txt

@@ -5,16 +5,22 @@ README.txt
 Rakefile
 design_rationale.rb
 lib/hoe/minitest.rb
+lib/minitest.rb
+lib/minitest/assertions.rb
 lib/minitest/autorun.rb
 lib/minitest/benchmark.rb
+lib/minitest/expectations.rb
 lib/minitest/hell.rb
 lib/minitest/mock.rb
 lib/minitest/parallel_each.rb
 lib/minitest/pride.rb
+lib/minitest/pride_plugin.rb
 lib/minitest/spec.rb
+lib/minitest/test.rb
 lib/minitest/unit.rb
 test/minitest/metametameta.rb
 test/minitest/test_minitest_benchmark.rb
 test/minitest/test_minitest_mock.rb
+test/minitest/test_minitest_reporter.rb
 test/minitest/test_minitest_spec.rb
 test/minitest/test_minitest_unit.rb

data/README.txt

@@ -90,9 +90,9 @@ Given that you'd like to test the following class:
 
 === Unit tests
 
-  require 'minitest/autorun'
+  require "minitest/autorun"
 
-  class TestMeme < MiniTest::Unit::TestCase
+  class TestMeme < Minitest::Test
     def setup
       @meme = Meme.new
     end
@@ -112,7 +112,7 @@ Given that you'd like to test the following class:
 
 === Specs
 
-  require 'minitest/autorun'
+  require "minitest/autorun"
 
   describe Meme do
     before do
@@ -138,13 +138,12 @@ https://github.com/zenspider/minitest-matchers
 
 === Benchmarks
 
-Add benchmarks to your regular unit tests. If the unit tests fail, the
-benchmarks won't run.
+Add benchmarks to your tests.
 
   # optionally run benchmarks, good for CI-only work!
-  require 'minitest/benchmark' if ENV["BENCH"]
+  require "minitest/benchmark" if ENV["BENCH"]
 
-  class TestMeme < MiniTest::Unit::TestCase
+  class TestMeme < Minitest::Benchmark
     # Override self.bench_range or default range is [1, 10, 100, 1_000, 10_000]
     def bench_my_algorithm
       assert_performance_linear 0.9999 do |n| # n is a range value
@@ -155,9 +154,10 @@ benchmarks won't run.
 
 Or add them to your specs. If you make benchmarks optional, you'll
 need to wrap your benchmarks in a conditional since the methods won't
-be defined.
+be defined. In minitest 5, the describe name needs to match
+/Bench(mark)?$/.
 
-  describe Meme do
+  describe "Meme Benchmark" do
     if ENV["BENCH"] then
       bench_performance_linear "my_algorithm", 0.9999 do |n|
         100.times do
@@ -190,11 +190,11 @@ Output is tab-delimited to make it easy to paste into a spreadsheet.
     end
   end
 
-  require 'minitest/autorun'
+  require "minitest/autorun"
 
   describe MemeAsker do
     before do
-      @meme = MiniTest::Mock.new
+      @meme = Minitest::Mock.new
       @meme_asker = MemeAsker.new @meme
     end
 
@@ -229,57 +229,70 @@ new non-existing method:
     ...
   end
 
-=== Customizable Test Runner Types:
-
-MiniTest::Unit.runner=(runner) provides an easy way of creating custom
-test runners for specialized needs. Justin Weiss provides the
-following real-world example to create an alternative to regular
-fixture loading:
+== Writing Extensions
 
-  class MiniTestWithHooks::Unit < MiniTest::Unit
-    def before_suites
-    end
+To define a plugin, add a file named minitest/XXX_plugin.rb to your
+project/gem. Minitest will find and require that file using
+Gem.find_files. It will then try to call plugin_XXX_init during
+startup. The option processor will also try to call plugin_XXX_options
+passing the OptionParser instance and the current options hash. This
+lets you register your own command-line options. Here's a totally
+bogus example:
 
-    def after_suites
-    end
+    # minitest/bogus_plugin.rb:
 
-    def _run_suites(suites, type)
-      begin
-        before_suites
-        super(suites, type)
-      ensure
-        after_suites
+    module Minitest
+      def self.plugin_bogus_options(opts, options)
+        opts.on "--myci", "Report results to my CI" do
+          options[:myci] = true
+          options[:myci_addr] = get_myci_addr
+          options[:myci_port] = get_myci_port
+        end
       end
-    end
 
-    def _run_suite(suite, type)
-      begin
-        suite.before_suite
-        super(suite, type)
-      ensure
-        suite.after_suite
+      def self.plugin_bogus_init(options)
+        self.reporter << MyCI.new(options) if options[:myci]
       end
     end
-  end
 
-  module MiniTestWithTransactions
-    class Unit < MiniTestWithHooks::Unit
-      include TestSetupHelper
+=== Adding custom reporters
 
-      def before_suites
-        super
-        setup_nested_transactions
-        # load any data we want available for all tests
-      end
+Minitest uses composite reporter to output test results using multiple
+reporter instances. You can add new reporters to the composite during
+the init_plugins phase. As we saw in +plugin_bonus_init+ above, you
+simply add your reporter instance to the composite via +<<+.
+
++AbstractReporter+ defines the API for reporters. You may subclass it
+and override any method you want to achieve your desired behavior.
+
+start   :: Called when the run has started.
+record  :: Called for each result, passed or otherwise.
+report  :: Called at the end of the run.
+passed? :: Called to see if you detected any problems.
+
+Using our example above, here is how we might implement MyCI:
+
+    # minitest/bogus_plugin.rb
+
+    module Minitest
+      class MyCI < AbstractReporter
+        attr_accessor :results, :addr, :port
+
+        def initialize options
+          self.results = []
+          self.addr = options[:myci_addr]
+          self.port = options[:myci_port]
+        end
+
+        def record result
+          self.results << result
+        end
 
-      def after_suites
-        teardown_nested_transactions
-        super
+        def report
+          CI.connect(addr, port).send_results self.results
+        end
       end
     end
-  end
-
-  MiniTest::Unit.runner = MiniTestWithTransactions::Unit.new
 
 == FAQ
 
@@ -315,25 +328,59 @@ Expectations are put on Object (one level down) so the Worker
 fails.
 
 You can bypass `SimpleDelegate#method_missing` by extending the worker
-with `MiniTest::Expectations`. You can either do that in your setup at
+with `Minitest::Expectations`. You can either do that in your setup at
 the instance level, like:
 
     before do
       @worker = Worker.new(Object.new)
-      @worker.extend MiniTest::Expectations
+      @worker.extend Minitest::Expectations
     end
 
 or you can extend the Worker class (within the test file!), like:
 
     class Worker
-      include ::MiniTest::Expectations
+      include ::Minitest::Expectations
+    end
+
+=== How to share code across test classes?
+
+Use a module. That's exactly what they're for:
+
+    module UsefulStuff
+      def useful_method
+        # ...
+      end
+    end
+
+    describe Blah do
+      include UsefulStuff
+
+      def test_whatever
+        # useful_method available here
+      end
     end
 
+Remember, `describe` simply creates test classes. It's just ruby at
+the end of the day and all your normal Good Ruby Rules (tm) apply. If
+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.
+
+== Prominent Projects using Minitest:
+
+* arel
+* journey
+* mime-types
+* nokogiri
+* rails (active_support et al)
+* rake
+* rdoc
+
 == Known Extensions:
 
-capybara_minitest_spec      :: Bridge between Capybara RSpec matchers and MiniTest::Spec expectations (e.g. page.must_have_content('Title')).
+capybara_minitest_spec      :: Bridge between Capybara RSpec matchers and MiniTest::Spec expectations (e.g. page.must_have_content("Title")).
 minispec-metadata           :: Metadata for describe/it blocks
-                               (e.g. `it 'requires JS driver', js: true do`)
+                               (e.g. `it "requires JS driver", js: true do`)
 minitest-ansi               :: Colorize minitest output with ANSI colors.
 minitest-around             :: Around block for minitest. An alternative to setup/teardown dance.
 minitest-capistrano         :: Assertions and expectations for testing Capistrano recipes
@@ -350,6 +397,7 @@ minitest-emoji              :: Print out emoji for your test passes, fails, and
 minitest-english            :: Semantically symmetric aliases for assertions and expectations.
 minitest-excludes           :: Clean API for excluding certain tests you
                                don't want to run under certain conditions.
+minitest-filesystem         :: Adds assertion and expectation to help testing filesystem contents.
 minitest-firemock           :: Makes your MiniTest mocks more resilient.
 minitest-great_expectations :: Generally useful additions to minitest's assertions and expectations
 minitest-growl              :: Test notifier for minitest via growl.
@@ -359,6 +407,7 @@ minitest-instrument         :: Instrument ActiveSupport::Notifications when
 minitest-instrument-db      :: Store information about speed of test
                                execution provided by minitest-instrument in database
 minitest-libnotify          :: Test notifier for minitest via libnotify.
+minitest-line               :: Run test at line number
 minitest-macruby            :: Provides extensions to minitest for macruby UI testing.
 minitest-matchers           :: Adds support for RSpec-style matchers to minitest.
 minitest-metadata           :: Annotate tests with metadata (key-value).
@@ -372,6 +421,7 @@ minitest-reporters          :: Create customizable MiniTest output formats
 minitest-should_syntax      :: RSpec-style +x.should == y+ assertions for MiniTest
 minitest-shouldify          :: Adding all manner of shoulds to MiniTest (bad idea)
 minitest-spec-context       :: Provides rspec-ish context method to MiniTest::Spec
+minitest-spec-expect        :: Expect syntax for MiniTest::Spec - expect(sequences).to_include :celery_man
 minitest-spec-magic         :: Minitest::Spec extensions for Rails and beyond
 minitest-spec-rails         :: Drop in MiniTest::Spec superclass for ActiveSupport::TestCase.
 minitest-stub-const         :: Stub constants for the duration of a block
@@ -416,11 +466,11 @@ Authors... Please send me a pull request with a description of your minitest ext
   sudo gem install minitest
 
 On 1.9, you already have it. To get newer candy you can still install
-the gem, but you'll need to activate the gem explicitly to use it:
+the gem, and then requiring "minitest/autorun" should automatically
+pull it in. If not, you'll need to do it yourself:
 
-  require 'rubygems'
-  gem 'minitest' # ensures you're using the gem, and not the built in MT
-  require 'minitest/autorun'
+  gem "minitest"     # ensures you"re using the gem, and not the built-in MT
+  require "minitest/autorun"
 
   # ... usual testing stuffs ...
 

data/Rakefile

@@ -1,7 +1,5 @@
 # -*- ruby -*-
 
-$TESTING_MINIUNIT = true
-
 require 'rubygems'
 require 'hoe'
 
@@ -14,10 +12,6 @@ Hoe.spec 'minitest' do
   self.testlib = :minitest
 end
 
-def loc dir
-  system "find #{dir} -name \\*.rb | xargs wc -l | tail -1"
-end
-
 desc "Find missing expectations"
 task :specs do
   $:.unshift "lib"
@@ -38,8 +32,8 @@ task :specs do
     /must_raises/                          => 'must_raise',
   }
 
-  expectations = MiniTest::Expectations.public_instance_methods.map(&:to_s)
-  assertions   = MiniTest::Assertions.public_instance_methods.map(&:to_s)
+  expectations = Minitest::Expectations.public_instance_methods.map(&:to_s)
+  assertions   = Minitest::Assertions.public_instance_methods.map(&:to_s)
 
   assertions.sort.each do |assertion|
     expectation = case assertion
@@ -63,32 +57,10 @@ task :specs do
     puts
     puts "##"
     puts "# :method: #{expectation}"
-    puts "# See MiniTest::Assertions##{assertion}"
+    puts "# See Minitest::Assertions##{assertion}"
     puts
     puts "infect_an_assertion #{args.join ", "}"
   end
 end
 
-desc "stupid line count"
-task :dickwag do
-  puts
-  puts "miniunit"
-  puts
-  print " lib  loc"; loc "lib"
-  print " test loc"; loc "test"
-  print " totl loc"; loc "lib test"
-  print " flog = "; system "flog -s lib"
-
-  puts
-  puts "test/unit"
-  puts
-  Dir.chdir File.expand_path("~/Work/svn/ruby/ruby_1_8") do
-    print " lib  loc"; loc "lib/test"
-    print " test loc"; loc "test/testunit"
-    print " totl loc"; loc "lib/test test/testunit"
-    print " flog = "; system "flog -s lib/test"
-  end
-  puts
-end
-
 # vim: syntax=Ruby

data/design_rationale.rb

@@ -1,6 +1,6 @@
 # Specs:                               # Equivalent Unit Tests:
 ###############################################################################
-describe Thingy do                     # class TestThingy < MiniTest::Unit::TestCase
+describe Thingy do                     # class TestThingy < Minitest::Test
   before do                            #   def setup
     do_some_setup                      #     super
   end                                  #     do_some_setup
@@ -26,7 +26,7 @@ end                                    #     assert_equal 2, 2
 ###############################################################################
 # The specs generate:
 
-class ThingySpec < MiniTest::Spec
+class ThingySpec < Minitest::Spec
   def setup
     super
     do_some_setup

data/lib/hoe/minitest.rb

@@ -5,18 +5,22 @@ end
 
 module Hoe::Minitest
   def initialize_minitest
+    dir = "../../minitest/dev/lib"
+    Hoe.add_include_dirs dir if File.directory? dir
+
     gem "minitest"
-    require 'minitest/unit'
-    version = MiniTest::Unit::VERSION.split(/\./).first(2).join(".")
+    require "minitest"
+    version = Minitest::VERSION.split(/\./).first(2).join(".")
 
-    dependency 'minitest', "~> #{version}", :development unless
-      self.name == "minitest"
+    dependency "minitest", "~> #{version}", :development unless
+      self.name == "minitest" or ENV["MT_NO_ISOLATE"]
   end
 
   def define_minitest_tasks
     self.testlib = :minitest
 
     # make sure we use the gemmed minitest on 1.9
-    self.test_prelude = 'gem "minitest"'
+    self.test_prelude = 'gem "minitest"' unless
+      self.name == "minitest" or ENV["MT_NO_ISOLATE"]
   end
 end