minitest-fastfail 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+Current
+=======
+
+* Initial release

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chirantan Mitra
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# MiniTest FastFail
+
+Run minitests in dot-format. However if tests fail show full scope, description and the relevant stack-trace.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'minitest-fastfail'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-fastfail
+
+## Usage
+
+Include the gem in your project
+
+## Contributing
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, but do not mess with the VERSION. If you want to have your own version, that is fine but bump the version in a commit by itself in another branch so I can ignore it when I pull.
+* Send me a pull request.

data/lib/minitest-fastfail.rb

@@ -0,0 +1,38 @@
+require "minitest/unit"
+
+module MiniTestFastFail
+  # Based upon Alexander Kern's minitest-reporters (MIT License)
+  # @see https://github.com/CapnKernul/minitest-reporters minitest-reporters
+
+  require "minitest-fastfail/reporter"
+  require "minitest-fastfail/fast_fail_reporter"
+  require "minitest-fastfail/reporter_runner"
+  require "minitest-fastfail/before_test_hook"
+  require "minitest-fastfail/test_runner"
+
+  module Reporters
+    def self.use!(console_reporters = DefaultReporter.new)
+      use_runner!(console_reporters)
+      use_before_test_hook!
+      use_parallel_length_method!
+    end
+
+    def self.use_runner!(console_reporters)
+      runner = MiniTestFastFail::ReporterRunner.new
+      runner.reporters = Array(console_reporters)
+      MiniTest::Unit.runner = runner
+    end
+
+    def self.use_before_test_hook!
+      # available since 3.3.0
+      MiniTest::Unit::TestCase.send(:include, MiniTestFastFail::BeforeTestHook)
+    end
+
+    def self.use_parallel_length_method!
+      # available since 4.2.0
+      ::ParallelEach.send(:define_method, :length) do
+        @queue.length
+      end
+    end
+  end
+end

data/lib/minitest-fastfail/before_test_hook.rb

@@ -0,0 +1,19 @@
+module MiniTestFastFail
+  # Based upon Alexander Kern's minitest-reporters (MIT License)
+  # @see https://github.com/CapnKernul/minitest-reporters minitest-reporters
+
+  module BeforeTestHook
+    def self.before_test(instance)
+      runner = MiniTest::Unit.runner
+
+      if runner.respond_to?(:before_test)
+        runner.before_test(instance.class, instance.__name__)
+      end
+    end
+
+    def before_setup
+      BeforeTestHook.before_test(self)
+      super
+    end
+  end
+end

data/lib/minitest-fastfail/fast_fail_reporter.rb

@@ -0,0 +1,167 @@
+module MiniTestFastFail
+  # Runner for MiniTest that supports reporters.
+  #
+  # Based upon Alexander Kern's minitest-reporters (MIT License)
+  # @see https://github.com/CapnKernul/minitest-reporters minitest-reporters
+  # 
+  # which is in-turn
+  # Based upon Ryan Davis of Seattle.rb's MiniTest (MIT License).
+  #
+  # @see https://github.com/seattlerb/minitest MiniTest
+  class FastFailReporter < Reporter
+    TEST_PADDING = 2
+    TEST_SIZE = 76
+    MARK_SIZE = 3
+    INFO_PADDING = 5
+
+    def initialize(options = {})
+      @detailed_skip = options.fetch(:detailed_skip, true)
+    end
+
+    def before_suites(suites, type)
+      puts
+      puts "# Running #{type}s:"
+      puts
+    end
+
+    def before_test(suite, test)
+      @test_name = "#{suite}##{test}"
+      print "#{@test_name} = " if verbose?
+    end
+
+    def pass(suite, test, test_runner)
+      after_test('.')
+    end
+
+    def skip(suite, test, test_runner)
+      after_test('S')
+    end
+
+    def failure(suite, test, test_runner)
+      after_test('F')
+
+      puts
+      puts suite.name
+      print pad_test(naturalize(test))
+      print(pad_mark('FAIL'))
+      print_time(test)
+      puts
+      print_info(test_runner.exception)
+      puts
+    end
+
+    def error(suite, test, test_runner)
+      after_test('E')
+
+      puts
+      puts suite.name
+      print pad_test(naturalize(test))
+      print(pad_mark('ERROR'))
+      print_time(test)
+      puts
+      print_info(test_runner.exception)
+      puts
+    end
+
+    def after_suite(suite)
+    end
+
+    def after_suites(suites, type)
+      time = Time.now - runner.suites_start_time
+      status_line = "Finished %ss in %.6fs, %.4f tests/s, %.4f assertions/s." %
+        [type, time, runner.test_count / time, runner.assertion_count / time]
+
+      puts
+      puts
+      puts status_line
+
+      puts
+      print result_line
+    end
+
+    private
+
+    def suite_result
+      case
+      when runner.failures > 0; :failure
+      when runner.errors > 0; :error
+      when runner.skips > 0; :skip
+      else :pass
+      end
+    end
+
+    def after_test(result)
+      time = Time.now - runner.test_start_time
+
+      print '%.2f s = ' % time if verbose?
+      print result
+      puts if verbose?
+    end
+
+    def location(exception)
+      last_before_assertion = ''
+
+      exception.backtrace.reverse_each do |s|
+        break if s =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
+        last_before_assertion = s
+      end
+
+      last_before_assertion.sub(/:in .*$/, '')
+    end
+
+    def message_for(test_runner)
+      suite = test_runner.suite
+      test = test_runner.test
+      e = test_runner.exception
+
+      case test_runner.result
+      when :pass then nil
+      when :skip
+        if @detailed_skip
+          "Skipped:\n#{test}(#{suite}) [#{location(e)}]:\n#{e.message}\n"
+        end
+      when :failure then "Failure:\n#{test}(#{suite}) [#{location(e)}]:\n#{e.message}\n"
+      when :error
+        bt = filter_backtrace(test_runner.exception.backtrace).join "\n    "
+        "Error:\n#{test}(#{suite}):\n#{e.class}: #{e.message}\n    #{bt}\n"
+      end
+    end
+
+    def result_line
+      "%d tests, %d assertions, %d failures, %d errors, %d skips\n\n" %
+        [runner.test_count, runner.assertion_count, runner.failures, runner.errors, runner.skips]
+    end
+    
+    def print_time(test)
+      total_time = Time.now - runner.test_start_time
+      print(" (%.2fs)" % total_time)
+    end
+
+    def print_info(e)
+      e.message.each_line { |line| puts pad(line, INFO_PADDING) }
+
+      trace = filter_backtrace(e.backtrace)
+      trace.each { |line| puts pad(line, INFO_PADDING) }
+    end
+    
+    def pad(str, size)
+      ' ' * size + str
+    end
+    
+    def pad_mark(str)
+      "%#{MARK_SIZE}s" % str
+    end
+
+    def pad_test(str)
+      pad("%-#{TEST_SIZE}s" % str, TEST_PADDING)
+    end
+    
+    # Natural names for tests (without underscore)
+    #
+    # Based upon Tim Pease's Turn
+    # @see https://github.com/TwP/turn
+    def naturalize(name)
+      name.gsub("test_", "").gsub(/_/, " ")
+    end
+  end
+end

data/lib/minitest-fastfail/reporter.rb

@@ -0,0 +1,40 @@
+module MiniTestFastFail
+  # Based upon Alexander Kern's minitest-reporters (MIT License)
+  # @see https://github.com/CapnKernul/minitest-reporters minitest-reporters
+
+  class Reporter
+    def runner
+      MiniTest::Unit.runner
+    end
+
+    def filter_backtrace(backtrace)
+      MiniTest.filter_backtrace(backtrace)
+    end
+
+    def output
+      runner.output
+    end
+
+    def verbose?
+      runner.verbose
+    end
+
+    def print(*args)
+      runner.output.print(*args)
+    end
+
+    def puts(*args)
+      runner.output.puts(*args)
+    end
+
+    def before_suites(suites, type); end
+    def before_suite(suite); end
+    def before_test(suite, test); end
+    def pass(suite, test, test_runner); end
+    def skip(suite, test, test_runner); end
+    def failure(suite, test, test_runner); end
+    def error(suite, test, test_runner); end
+    def after_suite(suite); end
+    def after_suites(suites, type); end
+  end
+end

data/lib/minitest-fastfail/reporter_runner.rb

@@ -0,0 +1,93 @@
+module MiniTestFastFail
+  # Runner for MiniTest that supports reporters.
+  #
+  # Based upon Alexander Kern's minitest-reporters (MIT License)
+  # @see https://github.com/CapnKernul/minitest-reporters minitest-reporters
+  # 
+  # which is in-turn
+  # Based upon Ryan Davis of Seattle.rb's MiniTest (MIT License).
+  #
+  # @see https://github.com/seattlerb/minitest MiniTest
+  class ReporterRunner < MiniTest::Unit
+    attr_accessor :suites_start_time, :test_start_time, :reporters, :test_results
+
+    alias_method :suite_start_time, :start_time
+
+    def initialize
+      super
+      self.reporters = []
+      self.test_results = {}
+    end
+
+    def _run_suites(suites, type)
+      self.suites_start_time = Time.now
+      count_tests!(suites, type)
+      trigger_callback(:before_suites, suites, type)
+      super(suites, type)
+    ensure
+      trigger_callback(:after_suites, suites, type)
+    end
+
+    def _run_suite(suite, type)
+      trigger_callback(:before_suite, suite)
+      self.start_time = Time.now
+      super(suite, type)
+    ensure
+      trigger_callback(:after_suite, suite)
+    end
+
+    def before_test(suite, test)
+      self.test_start_time = Time.now
+      trigger_callback(:before_test, suite, test)
+    end
+
+    def record(suite, test, assertions, time, exception)
+      self.assertion_count += assertions
+
+      result = case exception
+               when nil then :pass
+               when MiniTest::Skip then :skip
+               when MiniTest::Assertion then :failure
+               else :error
+      end
+
+      test_runner = MiniTestFastFail::TestRunner.new(
+        suite,
+        test.to_sym,
+        assertions,
+        time,
+        result,
+        exception
+      )
+
+      test_results[suite] ||= {}
+      test_results[suite][test.to_sym] = test_runner
+      trigger_callback(result, suite, test, test_runner)
+    end
+
+    def puts(*args)
+    end
+
+    def print(*args)
+    end
+
+    def status(io = output)
+    end
+
+    private
+
+    def trigger_callback(callback, *args)
+      reporters.each do |reporter|
+        reporter.public_send(callback, *args)
+      end
+    end
+
+    def count_tests!(suites, type)
+      filter = options[:filter] || '/./'
+      filter = Regexp.new $1 if filter =~ /\/(.*)\//
+      self.test_count = suites.inject(0) do |acc, suite|
+        acc + suite.send("#{type}_methods").grep(filter).length
+      end
+    end
+  end
+end

data/lib/minitest-fastfail/test_runner.rb

@@ -0,0 +1,3 @@
+module MiniTestFastFail
+  TestRunner = Struct.new(:suite, :test, :assertions, :time, :result, :exception)
+end

data/lib/minitest-fastfail/version.rb

@@ -0,0 +1,3 @@
+module MiniTestFastFail
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: minitest-fastfail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Chirantan Mitra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Report minitest errors and failures instantly
+email:
+- chirantan.mitra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/minitest-fastfail/before_test_hook.rb
+- lib/minitest-fastfail/fast_fail_reporter.rb
+- lib/minitest-fastfail/reporter.rb
+- lib/minitest-fastfail/reporter_runner.rb
+- lib/minitest-fastfail/test_runner.rb
+- lib/minitest-fastfail/version.rb
+- lib/minitest-fastfail.rb
+- LICENSE
+- README.md
+- CHANGELOG.md
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 760871107831015869
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 760871107831015869
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Show a dot for each passing test. Show full description for each tests that
+  fail or have errors.
+test_files: []