lineman 0.9.0

data/README.md

@@ -0,0 +1,82 @@
+`lineman` is a test runner for
+[test-unit](https://github.com/test-unit/test-unit) that prints a line per test,
+with statistics about its performance.
+
+Example output:
+
+    NPCRobotTest
+        test: should have a cool nickname                 0:1      0.01    N
+        test: should have big birthday party              1:1      0.00     
+        test: should have pizzas for party                0:0      0.00   ON
+        test: should not dance                            0:0      0.00  P  
+    NPCRobotTest                                          1:2      0.01  PON
+    test/npc_robot_test                                   1:2      0.01  PON
+
+    ========
+    Failures
+    ========
+
+      1) Failure:
+    test: should have a cool nickname(NPCRobotTest) [test/npc_robot_test.rb:30]:
+    <"claptrap"> expected but was
+    <"Claptrap">.
+
+    diff:
+    - claptrap
+    ? ^
+    + Claptrap
+    ? ^
+
+      2) Failure:
+    test: should have big birthday party(NPCRobotTest) [test/npc_robot_test.rb:14]:
+    Pending block should not be passed: acquaintances != friends.
+
+
+    =========
+    Omissions
+    =========
+
+      1) Omission: I am not sure what a pizza is
+    test: should have pizzas for party(NPCRobotTest)
+    test/npc_robot_test.rb:43:in `block in <class:NPCRobotTest>'
+
+
+    ========
+    Pendings
+    ========
+
+      1) Pending: pended.
+    test: should not dance(NPCRobotTest)
+    test/npc_robot_test.rb:23:in `block in <class:NPCRobotTest>'
+
+
+    =============
+    Notifications
+    =============
+
+      1) Notification: Claptrap
+    test: should have a cool nickname(NPCRobotTest)
+    test/npc_robot_test.rb:29:in `block in <class:NPCRobotTest>'
+
+      2) Notification: NPCRobotTest#test: should have pizzas for party was redefined
+    test: should have pizzas for party(NPCRobotTest)
+    test/npc_robot_test.rb:42:in `<class:NPCRobotTest>'
+    test/npc_robot_test.rb:10:in `<main>'
+
+
+
+    Finished in 0.013893
+    4 tests, 3 assertions, 2 failures, 0 errors, 1 pendings, 1 omissions, 2 notifications
+
+The characters P, O, and N that are reported in the last column map to calls to
+`pend`, `omit`, and `notify` inside of the test.  (These are part of test-unit).
+
+Usage:
+
+* put lineman in you bundle or otherwise install the gem
+* `Test::Unit::AutoRunner.default_runner = 'lineman'`
+* You could also specify --runner on the command line or your test-unit.yml
+* Run your tests!
+
+Make pull requests and be friendly.
+

data/lib/test/unit/runner/statistics.rb

@@ -0,0 +1,21 @@
+require 'test/unit/ui/statistics/base_runner'
+
+
+module Test::Unit # :nodoc:
+  class << self
+    def require_statistics_runners # :nodoc:
+      stat_dir = File.expand_path('../ui/statistics/runners',
+                                  File.dirname(__FILE__))
+      Dir["#{stat_dir}/*.rb"].each do |f|
+        require_relative "../ui/statistics/runners/#{File.basename(f)}"
+      end
+    end
+  end
+
+  require_statistics_runners
+  Test::Unit::UI::Statistics::BaseRunner.each_subclass do |subclass|
+    AutoRunner.register_runner(subclass.name) do |_auto_runner|
+      subclass
+    end
+  end
+end

data/lib/test/unit/ui/statistics/base_runner.rb

@@ -0,0 +1,146 @@
+require 'test/unit/ui/testrunner'
+require 'test/unit/ui/testrunnermediator'
+require_relative '../statistics'
+
+module Test::Unit::UI::Statistics
+
+  # Inherit from this class to create a runner that has access to statistics.
+  #
+  # Implement any/all of the following callbacks in your subclass:
+  # * reset
+  # * started
+  # * finished
+  # * suite_started
+  # * suite_finished
+  # * case_started
+  # * case_finished
+  # * assertion
+  # * error
+  # * failure
+  # * pending
+  # * omission
+  # * notification
+  # * fault
+  #
+  class BaseRunner < Test::Unit::UI::TestRunner # :nodoc:
+
+    attr_accessor :result
+
+    # Case Statistics
+    def cstat
+      @method_metrics
+    end
+
+    # Suite Statistics
+    def sstat
+      @suite_stack.last
+    end
+
+    def self.inherited kls #:nodoc:
+      (@@subclasses ||= []) << kls
+    end
+
+    def self.each_subclass #:nodoc:
+      @@subclasses.each {|kls| yield kls }
+    end
+
+    def initialize suite, options={} #:nodoc:
+      super
+      @suite_stack = []
+      @output = options[:output] || STDOUT
+    end
+
+    # Inherited from TestRunner, sets up callbacks via i-var.
+    def attach_to_mediator #:nodoc:
+      @mediator.add_listener(Test::Unit::UI::TestRunnerMediator::RESET,
+                             &callback(:reset))
+      @mediator.add_listener(Test::Unit::UI::TestRunnerMediator::STARTED,
+                             &callback(:stats_started, :started))
+      @mediator.add_listener(Test::Unit::UI::TestRunnerMediator::FINISHED,
+                             &callback(:finished))
+      @mediator.add_listener(Test::Unit::TestSuite::STARTED_OBJECT,
+                             &callback(:stats_suite_started, :suite_started))
+      @mediator.add_listener(Test::Unit::TestSuite::FINISHED_OBJECT,
+                             &callback(:suite_finished, :stats_suite_finished))
+      @mediator.add_listener(Test::Unit::TestCase::STARTED,
+                             &callback(:stats_case_started, :case_started))
+      @mediator.add_listener(Test::Unit::TestCase::FINISHED,
+                             &callback(:stats_case_finished, :case_finished))
+      @mediator.add_listener(Test::Unit::TestResult::PASS_ASSERTION,
+                             &callback(:stats_assertion, :assertion))
+      @mediator.add_listener(Test::Unit::TestResult::FAULT,
+                             &callback(:stats_fault, :fault))
+    end
+
+    # Forward to methods (in-order) that we might respond to.
+    def callback *types #:nodoc:
+      ->(*args) { types.select{|t| respond_to?(t) }.each{|t| send(t, *args) }}
+    end
+
+    def stats_started result #:nodoc:
+      @result = result
+    end
+
+    def stats_suite_started testsuite #:nodoc:
+      @suite_stack << SuiteStatistics.new(testsuite)
+    end
+
+    def stats_suite_finished testsuite #:nodoc:
+      @suite_stack.pop
+    end
+
+    def stats_case_started name #:nodoc:
+      @method_metrics = CaseStatistics.new(@result)
+    end
+
+    def stats_case_finished name #:nodoc:
+      @method_metrics.complete
+      update_suites_with_case_statistics
+    end
+
+    def stats_assertion testresult #:nodoc:
+      @method_metrics.pass += 1
+    end
+
+    def stats_fault fault #:nodoc:
+      base_type = fault.class.name.split('::').last.downcase
+      stat_method_name = "stats_handle_#{base_type}".to_sym
+      method_name = "#{base_type}".to_sym
+      send(stat_method_name, fault)
+      if respond_to?(method_name)
+        send(method_name, fault)
+      end
+    end
+
+    def stats_handle_error fault #:nodoc:
+      # Don't count errors before setup (i.e. in startup).
+      return unless @method_metrics
+      @method_metrics.errs += 1
+    end
+
+    def stats_handle_failure fault #:nodoc:
+      # The PASS_ASSERTION message just means it was run, we handle failures
+      @method_metrics.fail += 1
+      @method_metrics.pass -= 1
+    end
+
+    def stats_handle_pending fault #:nodoc:
+      @method_metrics.pend += 1
+    end
+
+    def stats_handle_omission fault #:nodoc:
+      @method_metrics.omit += 1
+    end
+
+    def stats_handle_notification fault #:nodoc:
+      @method_metrics.note += 1
+    end
+
+    def update_suites_with_case_statistics #:nodoc:
+      @suite_stack.each do |suite|
+        suite.add_test_case_statistics @method_metrics
+      end
+    end
+
+  end
+end

data/lib/test/unit/ui/statistics/runners/lineman.rb

@@ -0,0 +1,109 @@
+require_relative '../base_runner'
+#require 'test/unit/color-scheme'
+#require 'test/unit/code-snippet-fetcher'
+#require 'test/unit/diff'
+
+
+module Test::Unit::UI::Statistics::Lineman
+  class TestRunner < Test::Unit::UI::Statistics::BaseRunner
+
+    def self.name
+      'lineman'
+    end
+
+    # callback
+    def reset size
+      puts "Preparing to run #{size} tests"
+    end
+
+    # callback
+    def finished time
+      show_faults
+      puts "Finished in #{time.inspect}"
+      puts result.to_s
+    end
+
+    # callback
+    def suite_started testcase
+      puts "%-0.80s" % testcase
+    end
+
+    # callback
+    def suite_finished testcase
+      two_point_time = ("%.2f" % sstat.elapsed_time)
+      extended_actions = ''
+      extended_actions += (sstat.errs.nonzero? ? 'E' : ' ')
+      extended_actions += (sstat.pend.nonzero? ? 'P' : ' ')
+      extended_actions += (sstat.omit.nonzero? ? 'O' : ' ')
+      extended_actions += (sstat.note.nonzero? ? 'N' : ' ')
+      puts "%-50.50s %4.4s:%-4.4s %6.6s %s" % [testcase,
+                                              sstat.pass,
+                                              sstat.fail,
+                                              two_point_time,
+                                              extended_actions]
+    end
+
+    # callback
+    def case_started test_name
+      output_name = test_name.gsub(/\(#{sstat.test_suite.to_s}\)$/, '')
+      print "    %-46.46s " % output_name
+    end
+
+    # callback
+    def case_finished test_name
+      two_point_time = ("%.2f" % cstat.elapsed_time)
+      if cstat.errs.nonzero?
+        err_or_pass_fail = 'ERROR'
+      else
+        err_or_pass_fail = '%4.4s:%-4.4s' % [cstat.pass,
+                                             cstat.fail]
+      end
+      extended_actions = ''
+      extended_actions += (cstat.pend.nonzero? ? 'P' : ' ')
+      extended_actions += (cstat.omit.nonzero? ? 'O' : ' ')
+      extended_actions += (cstat.note.nonzero? ? 'N' : ' ')
+      puts "%9.9s %6.6s  %s" % [err_or_pass_fail, two_point_time,
+                                extended_actions]
+    end
+
+    def show_faults
+      puts "\n"
+      order = [Test::Unit::Error, Test::Unit::Failure, Test::Unit::Omission,
+               Test::Unit::Pending, Test::Unit::Notification]
+      order.each do |type|
+        faults = result.faults.select {|f| f.is_a?(type) }
+        if faults.length.nonzero?
+          type_str = "#{type.to_s.split('::').last}s"
+          puts "=" * type_str.length
+          puts type_str
+          puts "=" * type_str.length
+          puts ''
+          max_width = faults.length.to_s.length
+          faults.each_with_index do |f,i|
+            puts "  %#{max_width}i) %s\n" % [i+1, f.long_display]
+            puts ''
+          end
+          puts ''
+        end
+      end
+      puts "\n"
+    end
+
+    def fault_header_line num, fault
+      "  %#{@exception_max_width}i) %s:" % [num, fault.label]
+    end
+
+    def fault_location_line fault
+      "#{fault.test_name} #{fault.location}:"
+    end
+
+    def fault_message fault
+      fault.message
+    end
+
+    def exception_backtrace fault
+      "    " + fault.backtrace.join("\n    ")
+    end
+
+  end
+end

data/lib/test/unit/ui/statistics.rb

@@ -0,0 +1,65 @@
+module Test::Unit::UI::Statistics
+  class CaseStatistics
+    attr_accessor :pass
+    attr_accessor :fail
+    attr_accessor :errs
+    attr_accessor :pend
+    attr_accessor :omit
+    attr_accessor :note
+
+    def initialize results
+      self.pass = 0
+      self.fail = 0
+      self.errs = 0
+      self.pend = 0
+      self.omit = 0
+      self.note = 0
+      @start_time = Time.now
+      @end_time = nil
+    end
+
+    def elapsed_time
+      end_time - @start_time
+    end
+
+    def end_time
+      @end_time ? @end_time : Time.now
+    end
+
+    def complete
+      @end_time = Time.now
+    end
+  end
+
+
+  class SuiteStatistics
+    attr_reader :test_suite
+    attr_accessor :forward_class
+
+    def initialize test_suite
+      @test_suite = test_suite
+      @aggregate_statistics = []
+    end
+
+    def add_test_case_statistics stats
+      @aggregate_statistics << stats
+    end
+
+    def aggregate sym
+      @aggregate_statistics.inject(0) {|a,v| a + v.send(sym) }
+    end
+
+    def method_missing sym, *args
+      if respond_to?(sym)
+        aggregate(sym)
+      else
+        super
+      end
+    end
+
+    def respond_to? sym
+      Test::Unit::TestResult.instance_methods.include?(sym) or
+          CaseStatistics.instance_methods.include?(sym)
+    end
+  end
+end

data/lineman.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name = 'lineman'
+  s.version = '0.9.0'
+  s.date = '2012-10-07'
+
+  s.summary = 'A test runner (UI) for test-unit'
+  s.description = 'Lineman provides clean output for your tests, giving you one line for each test that shows the name along with some statistics.'
+
+  s.authors = ['Todd Willey (xtoddx)']
+  s.email = 'xtoddx@gmail.com'
+  s.homepage = 'http://github.com/xtoddx/lineman'
+
+  s.require_paths = %w[lib]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md]
+
+  s.add_dependency('test-unit', '~> 2.4')
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {spec,tests}/*`.split("\n")
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: lineman
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Todd Willey (xtoddx)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &70263140719340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70263140719340
+description: Lineman provides clean output for your tests, giving you one line for
+  each test that shows the name along with some statistics.
+email: xtoddx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/test/unit/runner/statistics.rb
+- lib/test/unit/ui/statistics.rb
+- lib/test/unit/ui/statistics/base_runner.rb
+- lib/test/unit/ui/statistics/runners/lineman.rb
+- lineman.gemspec
+homepage: http://github.com/xtoddx/lineman
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: A test runner (UI) for test-unit
+test_files: []
+has_rdoc: