minitest 5.5.1 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71d62e9fd6a176451296c021e8e03f9f6e1cd30a
-  data.tar.gz: 45c4772118f1edd8f574d85cffc5827116b62f35
+  metadata.gz: 8a1532fd0d9c25161ae3d4cae3357c707315d4d2
+  data.tar.gz: 827d205c0a4e09b33a5ec0db933ed7d0a024e718
 SHA512:
-  metadata.gz: 6b90e0a01a98ae2134536b0a9079bc5cc2c5f106bdf6c536cc5f84f8ad16cd1963f2e28cf0922d1089d757dea16bc9ae0881f100a07d7d201e651e1957499af0
-  data.tar.gz: 4ef102bf6a4123bea77619773a106a193c21755eaaba7237a0db923cc26e0b0f6aabe4844d86bf8ec98c7b97c225ab68e797705d2de8939542bb09a0f39d448f
+  metadata.gz: 1fbb8e6fef5e909de09ed424a977ee7a1d4cb9510213b1dbdce103ce28ef6b213024379e8ffedf42fd423f90464d07f6eeb50bc8c978e3131dc34b02a26a3f42
+  data.tar.gz: 7e1c4342ce4313b98020f7f715d344bc222b8ee40b65d0ee3e9213e89f7b76c39ba268022579a34656da2b2a4dffe1fcfc2ef5e765d02fc521cb7b7a10305948

data/{History.txt → History.rdoc}

@@ -1,10 +1,32 @@
+=== 5.6.0 / 2015-04-13
+
+* 4 major enhancements:
+
+  * Added Minitest::Expectation value monad.
+  * Added Minitest::Expectations#_ that returns an Expectation. Aliased to value.
+  * All expectations are added to Minitest::Expectation.
+  * At some point, the methods on Object will be deprecated and then removed.
+
+* 4 minor enhancements:
+
+  * Added a note about bundle exec pitfall in ruby 2.2+. (searls)
+  * Lazily start the parallel executor. (tenderlove)
+  * Make mocks more debugger-friendly (edward)
+  * Print out the current test run on interrupt. (riffraff)
+
+* 3 bug fixes:
+
+  * Fix failing test under Windows. (kimhmadsen)
+  * Record mocked calls before they happen so mocks can raise exceptions easier (tho I'm not a fan). (corecode)
+  * Tried to clarify mocks vs stubs terminology better. (kkirsche)
+
 === 5.5.1 / 2015-01-09
 
 * 1 bug fix:
 
   * Fixed doco problems. (zzak)
 
-=== 5.5.0 / 2014-12-12
+=== 5.5.0 / 2014-12-12 // mri 2.2.0 (as a real gem)
 
 * 1 minor enhancement:
 
@@ -149,7 +171,7 @@
 
   * Fixed missing require in minitest/test. (erikh)
 
-=== 4.7.5 / 2013-06-21
+=== 4.7.5 / 2013-06-21 // mri 2.1.1
 
 * 2 bug fixes:
 
@@ -388,7 +410,7 @@ back.
 
   * Updated information about stubbing. (daviddavis)
 
-=== 4.3.2 / 2012-11-27
+=== 4.3.2 / 2012-11-27 // mri 2.0.0
 
 * 1 minor enhancement:
 

data/Manifest.txt

@@ -1,7 +1,7 @@
 .autotest
-History.txt
+History.rdoc
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 design_rationale.rb
 lib/hoe/minitest.rb

data/{README.txt → README.rdoc}

@@ -139,6 +139,8 @@ Define your tests as methods beginning with `test_`.
 For matchers support check out:
 
 https://github.com/wojtekmach/minitest-matchers
+https://github.com/rmm5t/minitest-matchers_vaccine
+
 === Benchmarks
 
 Add benchmarks to your tests.
@@ -182,38 +184,51 @@ 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:
+
+"Mocks are pre-programmed with expectations which form a specification
+of the calls they are expected to receive. They can throw an exception
+if they receive a call they don't expect and are checked during
+verification to ensure they got all the calls they were expecting."
+
   class MemeAsker
     def initialize(meme)
       @meme = meme
     end
 
     def ask(question)
-      method = question.tr(" ","_") + "?"
+      method = question.tr(" ", "_") + "?"
       @meme.__send__(method)
     end
   end
 
   require "minitest/autorun"
 
-  describe MemeAsker do
-    before do
-      @meme = Minitest::Mock.new
-      @meme_asker = MemeAsker.new @meme
-    end
+  describe MemeAsker, :ask do
+    describe "when passed an unpunctuated question" do
+      it "should invoke the appropriate predicate method on the meme" do
+        @meme = Minitest::Mock.new
+        @meme_asker = MemeAsker.new @meme
+        @meme.expect :will_it_blend?, :return_value
 
-    describe "#ask" do
-      describe "when passed an unpunctuated question" do
-        it "should invoke the appropriate predicate method on the meme" do
-          @meme.expect :will_it_blend?, :return_value
-          @meme_asker.ask "will it blend"
-          @meme.verify
-        end
+        @meme_asker.ask "will it blend"
+
+        @meme.verify
       end
     end
   end
 
 === Stubs
 
+Mocks and stubs are defined using terminology by Fowler & Meszaros at
+http://www.martinfowler.com/bliki/TestDouble.html:
+
+"Stubs provide canned answers to calls made during the test".
+
+Minitest's stub method overrides a single method for the duration of
+the block.
+
   def test_stale_eh
     obj_under_test = Something.new
 
@@ -266,7 +281,8 @@ provided via plugins. To see them, simply run with `--help`:
 == Writing Extensions
 
 To define a plugin, add a file named minitest/XXX_plugin.rb to your
-project/gem. Minitest will find and require that file using
+project/gem. That file must be discoverable via ruby's LOAD_PATH (via
+rubygems or otherwise). 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
@@ -326,6 +342,8 @@ Using our example above, here is how we might implement MyCI:
           CI.connect(addr, port).send_results self.results
         end
       end
+
+      # code from above...
     end
 
 == FAQ
@@ -400,6 +418,13 @@ 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.
 
+=== Why am I seeing `uninitialized constant MiniTest::Test (NameError)`?
+
+Are you running the test with Bundler (e.g. via `bundle exec`)? If so, 
+in order to require minitest, you must first add the `gem 'minitest'`
+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:
 
 * arel
@@ -416,8 +441,11 @@ for you, so make sure you don't do it twice.
 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`)
+color_pound_spec_reporter   :: Test names print Ruby Object types in color with
+                               your Minitest Spec style tests.
+minispec-metadata           :: Metadata for describe/it blocks & CLI tag filter.
+                               E.g. `it "requires JS driver", js: true do` &
+                               `ruby test.rb --tag js` runs tests tagged :js.
 minitest-ansi               :: Colorize minitest output with ANSI colors.
 minitest-around             :: Around block for minitest. An alternative to
                                setup/teardown dance.
@@ -453,6 +481,7 @@ 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.
+minitest-happy              :: GLOBALLY ACTIVATE MINITEST PRIDE! RAWR!
 minitest-implicit-subject   :: Implicit declaration of the test subject.
 minitest-instrument         :: Instrument ActiveSupport::Notifications when
                                test method is executed.
@@ -464,6 +493,8 @@ minitest-macruby            :: Provides extensions to minitest for macruby UI
                                testing.
 minitest-matchers           :: Adds support for RSpec-style matchers to
                                minitest.
+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-mongoid            :: Mongoid assertion matchers for Minitest.
 minitest-must_not           :: Provides must_not as an alias for wont in
@@ -472,6 +503,7 @@ minitest-osx                :: Reporter for the Mac OS X notification center.
 minitest-parallel-db        :: Run tests in parallel with a single database.
 minitest-power_assert       :: PowerAssert for Minitest.
 minitest-predicates         :: Adds support for .predicate? methods.
+minitest-profile            :: List the 10 slowest tests in your suite.
 minitest-rails              :: Minitest integration for Rails 3.x.
 minitest-rails-capybara     :: Capybara integration for Minitest::Rails.
 minitest-reporters          :: Create customizable Minitest output formats.
@@ -481,6 +513,7 @@ minitest-should_syntax      :: RSpec-style +x.should == y+ assertions for
                                Minitest.
 minitest-shouldify          :: Adding all manner of shoulds to Minitest (bad
                                idea)
+minitest-snail              :: Print a list of tests that take too long
 minitest-spec-context       :: Provides rspec-ish context method to
                                Minitest::Spec.
 minitest-spec-expect        :: Expect syntax for Minitest::Spec (e.g.
@@ -525,8 +558,6 @@ Authors... Please send me a pull request with a description of your minitest ext
 * minitest-spec
 * minitest-spec-should
 * minitest-sugar
-* minitest_should
-* mongoid-minitest
 * spork-minitest
 
 == REQUIREMENTS:

data/Rakefile

@@ -1,12 +1,13 @@
 # -*- ruby -*-
 
-require 'rubygems'
-require 'hoe'
+require "rubygems"
+require "hoe"
 
 Hoe.plugin :seattlerb
+Hoe.plugin :rdoc
 
-Hoe.spec 'minitest' do
-  developer 'Ryan Davis', 'ryand-ruby@zenspider.com'
+Hoe.spec "minitest" do
+  developer "Ryan Davis", "ryand-ruby@zenspider.com"
 
   license "MIT"
 
@@ -25,12 +26,12 @@ task :specs do
 
   map = {
     /(must_throw)s/                        => '\1',
-    /(?!not)_same/                         => '_be_same_as',
-    /_in_/                                 => '_be_within_',
-    /_operator/                            => '_be',
-    /_includes/                            => '_include',
+    /(?!not)_same/                         => "_be_same_as",
+    /_in_/                                 => "_be_within_",
+    /_operator/                            => "_be",
+    /_includes/                            => "_include",
     /(must|wont)_(.*_of|nil|silent|empty)/ => '\1_be_\2',
-    /must_raises/                          => 'must_raise',
+    /must_raises/                          => "must_raise",
   }
 
   expectations = Minitest::Expectations.public_instance_methods.map(&:to_s)

data/lib/minitest.rb

@@ -4,10 +4,10 @@ require "mutex_m"
 require "minitest/parallel"
 
 ##
-# :include: README.txt
+# :include: README.rdoc
 
 module Minitest
-  VERSION = "5.5.1" # :nodoc:
+  VERSION = "5.6.0" # :nodoc:
   ENCS = "".respond_to? :encoding # :nodoc:
 
   @@installed_at_exit ||= false
@@ -20,7 +20,7 @@ module Minitest
   # Parallel test executor
 
   mc.send :attr_accessor, :parallel_executor
-  self.parallel_executor = Parallel::Executor.new((ENV['N'] || 2).to_i)
+  self.parallel_executor = Parallel::Executor.new((ENV["N"] || 2).to_i)
 
   ##
   # Filter object for backtraces.
@@ -107,7 +107,7 @@ module Minitest
   #           runnable.run(reporter, options)
   #             self.runnable_methods.each
   #               self.run_one_method(self, runnable_method, reporter)
-  #                 Minitest.run_one_method(klass, runnable_method, reporter)
+  #                 Minitest.run_one_method(klass, runnable_method)
   #                   klass.new(runnable_method).run
 
   def self.run args = []
@@ -123,8 +123,13 @@ module Minitest
     self.init_plugins options
     self.reporter = nil # runnables shouldn't depend on the reporter, ever
 
+    self.parallel_executor.start if parallel_executor.respond_to?(:start)
     reporter.start
-    __run reporter, options
+    begin
+      __run reporter, options
+    rescue Interrupt
+      warn "Interrupted. Exiting..."
+    end
     self.parallel_executor.shutdown
     reporter.report
 
@@ -175,13 +180,13 @@ module Minitest
         options[:verbose] = true
       end
 
-      opts.on "-n", "--name PATTERN","Filter run on /pattern/ or string." do |a|
+      opts.on "-n", "--name PATTERN", "Filter run on /regexp/ or string." do |a|
         options[:filter] = a
       end
 
       unless extensions.empty?
         opts.separator ""
-        opts.separator "Known extensions: #{extensions.join(', ')}"
+        opts.separator "Known extensions: #{extensions.join(", ")}"
 
         extensions.each do |meth|
           msg = "plugin_#{meth}_options"
@@ -277,8 +282,8 @@ module Minitest
     # reporter to record.
 
     def self.run reporter, options = {}
-      filter = options[:filter] || '/./'
-      filter = Regexp.new $1 if filter =~ /\/(.*)\//
+      filter = options[:filter] || "/./"
+      filter = Regexp.new $1 if filter =~ %r%/(.*)/%
 
       filtered_methods = self.runnable_methods.find_all { |m|
         filter === m || filter === "#{self}##{m}"
@@ -692,7 +697,7 @@ module Minitest
     end
 
     def message # :nodoc:
-      bt = Minitest::filter_backtrace(self.backtrace).join "\n    "
+      bt = Minitest.filter_backtrace(self.backtrace).join "\n    "
       "#{self.exception.class}: #{self.exception.message}\n    #{bt}"
     end
 

data/lib/minitest/assertions.rb

@@ -1,6 +1,6 @@
 require "rbconfig"
 require "tempfile"
-require 'stringio'
+require "stringio"
 
 module Minitest
   ##
@@ -25,7 +25,7 @@ module Minitest
     # figure out what diff to use.
 
     def self.diff
-      @diff = if (RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ &&
+      @diff = if (RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ &&
                   system("diff.exe", __FILE__, __FILE__)) then
                 "diff.exe -u"
               elsif Minitest::Test.maglev? then
@@ -67,7 +67,6 @@ module Minitest
          expect == butwas)        &&
         Minitest::Assertions.diff
 
-
       return "Expected: #{mu_pp exp}\n  Actual: #{mu_pp act}" unless
         need_to_diff
 
@@ -116,7 +115,7 @@ module Minitest
     # 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')
+      mu_pp(obj).gsub(/\\n/, "\n").gsub(/:0x[a-fA-F0-9]{4,}/m, ":0xXXXXXX")
     end
 
     ##
@@ -435,25 +434,25 @@ module Minitest
     def capture_subprocess_io
       _synchronize do
         begin
-      require 'tempfile'
+          require "tempfile"
 
-      captured_stdout, captured_stderr = Tempfile.new("out"), Tempfile.new("err")
+          captured_stdout, captured_stderr = Tempfile.new("out"), Tempfile.new("err")
 
-      orig_stdout, orig_stderr = $stdout.dup, $stderr.dup
-      $stdout.reopen captured_stdout
-      $stderr.reopen captured_stderr
+          orig_stdout, orig_stderr = $stdout.dup, $stderr.dup
+          $stdout.reopen captured_stdout
+          $stderr.reopen captured_stderr
 
-      yield
+          yield
 
-      $stdout.rewind
-      $stderr.rewind
+          $stdout.rewind
+          $stderr.rewind
 
-      return captured_stdout.read, captured_stderr.read
-    ensure
-      captured_stdout.unlink
-      captured_stderr.unlink
-      $stdout.reopen orig_stdout
-      $stderr.reopen orig_stderr
+          return captured_stdout.read, captured_stderr.read
+        ensure
+          captured_stdout.unlink
+          captured_stderr.unlink
+          $stdout.reopen orig_stdout
+          $stderr.reopen orig_stderr
         end
       end
     end
@@ -467,7 +466,7 @@ module Minitest
        "Class: <#{e.class}>",
        "Message: <#{e.message.inspect}>",
        "---Backtrace---",
-       "#{Minitest::filter_backtrace(e.backtrace).join("\n")}",
+       "#{Minitest.filter_backtrace(e.backtrace).join("\n")}",
        "---------------",
       ].join "\n"
     end
@@ -494,7 +493,7 @@ module Minitest
     ##
     # used for counting assertions
 
-    def pass msg = nil
+    def pass _msg = nil
       assert true
     end
 
@@ -503,7 +502,7 @@ module Minitest
 
     def refute test, msg = nil
       msg ||= "Failed refutation, no message given"
-      not assert(! test, msg)
+      not assert !test, msg
     end
 
     ##
@@ -581,7 +580,7 @@ module Minitest
     # Fails if +matcher+ <tt>=~</tt> +obj+.
 
     def refute_match matcher, obj, msg = nil
-      msg = message(msg) {"Expected #{mu_pp matcher} to not match #{mu_pp obj}"}
+      msg = message(msg) { "Expected #{mu_pp matcher} to not match #{mu_pp obj}" }
       assert_respond_to matcher, :"=~"
       matcher = Regexp.new Regexp.escape matcher if String === matcher
       refute matcher =~ obj, msg
@@ -603,7 +602,7 @@ module Minitest
 
     def refute_operator o1, op, o2 = UNDEFINED, msg = nil
       return refute_predicate o1, op, msg if UNDEFINED == o2
-      msg = message(msg) { "Expected #{mu_pp(o1)} to not be #{op} #{mu_pp(o2)}"}
+      msg = message(msg) { "Expected #{mu_pp(o1)} to not be #{op} #{mu_pp(o2)}" }
       refute o1.__send__(op, o2), msg
     end