minitap 0.3.0 → 0.3.1

data/.ruby

@@ -29,9 +29,9 @@ load_path:
 extra: {}
 name: minitap
 title: MiniTap
-date: '2011-10-09'
+date: '2011-10-18'
 alternatives: []
-version: 0.3.0
+version: 0.3.1
 revision: 0
 source:
 - ruby.yml

data/HISTORY.rdoc

@@ -1,9 +1,21 @@
 = RELEASE HISTORY
 
+== 0.3.1 / 2011-10-18
+
+This release includes two basic improvements: better backtrace filtering,
+and file fields given relative to current working directory instead of
+absolute paths. In future maybe this can be configurable, if someone makes
+the case that absolute paths are needed.
+
+Changes:
+
+* Improve backtrace filtering.
+* Make file fields relative to working directory.
+
 
 == 0.3.0 / 2011-10-09
 
-Support version 3 of TAP-Y/H spec. This simply entailed renaming
+Support version 3 of TAP-Y/J spec. This simply entailed renaming
 the `tally` document to `final`.
 
 Changes:
@@ -19,7 +31,7 @@ the hood.
 
 Changes:
 
-* Adjust usage decumentation.
+* Adjust usage documentation.
 
 
 == 0.1.0 / 2011-10-06

data/lib/minitap.rb

@@ -1,6 +1,7 @@
 # MiniTest adaptor for tapout.
 
 require 'minitest/unit'
+require 'minitap/ignore_callers'
 require 'stringio'
 
 # Becuase of some wierdness in MiniTest
@@ -25,8 +26,13 @@ module MiniTest
     # TAP-Y/J Revision
     REVISION = 3
 
+    # Backtrace patterns to be omitted.
+    IGNORE_CALLERS = ::RUBY_IGNORE_CALLERS
+
+    #
     attr_accessor :suite_start_time, :test_start_time, :reporters
     
+    # Initialize new MiniTap MiniTest runner.
     def initialize
       self.report = {}
       self.errors = 0
@@ -225,6 +231,7 @@ module MiniTest
     def tapout_skip(suite, test, test_runner)
       e = test_runner.exeception
       e_file, e_line = location(test_runner.exception)
+      r_file = e_file.sub(Dir.pwd+'/', '')
 
       doc = {
         'type'        => 'test',
@@ -247,9 +254,10 @@ module MiniTest
         #  'code' => Foo#*
         'exception' => {
           'message'   => clean_message(e.message),
-          'file'      => e_file,
+          'class'     => e.class.name,
+          'file'      => r_file,
           'line'      => e_line,
-          #'source'   => '',
+          'source'    => source(e_file)[e_line-1].strip,
           'snippet'   => code_snippet(e_file, e_line),
           'backtrace' => filter_backtrace(e.backtrace)
         },
@@ -262,6 +270,7 @@ module MiniTest
     def tapout_failure(suite, test, test_runner)
       e = test_runner.exception
       e_file, e_line = location(test_runner.exception)
+      r_file = e_file.sub(Dir.pwd+'/', '')
 
       doc = {
         'type'        => 'test',
@@ -284,9 +293,10 @@ module MiniTest
         #  'code' => Foo#*
         'exception' => {
           'message'   => clean_message(e.message),
-          'file'      => e_file,
+          'class'     => e.class.name,
+          'file'      => r_file,
           'line'      => e_line,
-          #'source'    => '',
+          'source'    => source(e_file)[e_line-1].strip,
           'snippet'   => code_snippet(e_file, e_line),
           'backtrace' => filter_backtrace(e.backtrace)
         },
@@ -299,6 +309,7 @@ module MiniTest
     def tapout_error(suite, test, test_runner)
       e = test_runner.exception
       e_file, e_line = location(test_runner.exception)
+      r_file = e_file.sub(Dir.pwd+'/', '')
 
       doc = {
         'type'        => 'test',
@@ -321,9 +332,10 @@ module MiniTest
         #  'code' => Foo#*
         'exception' => {
           'message'   => clean_message("#{e.class}: #{e.message}"),
-          'file'      => e_file,
+          'class'     => e.class.name,
+          'file'      => r_file,
           'line'      => e_line,
-          #'source'    => '',
+          'source'    => source(e_file)[e_line-1].strip,
           'snippet'   => code_snippet(e_file, e_line),
           'backtrace' => filter_backtrace(e.backtrace)
         },
@@ -333,63 +345,44 @@ module MiniTest
     end
 
     #
-    INTERNALS = /(lib|bin)#{Regexp.escape(File::SEPARATOR)}tapout/
-
-    #
-    def filter_backtrace(bt)
-      bt = clean_backtrace(bt)
-      bt = MiniTest::filter_backtrace(bt)
-      bt
-    end
-
-    # Clean the backtrace of any reference to ko/ paths and code.
-    def clean_backtrace(backtrace)
-      trace = backtrace.reject{ |bt| bt =~ INTERNALS }
+    #def filter_backtrace(backtrace)
+    #  trace = backtrace
+    #  trace = clean_backtrace(trace)
+    #  trace = MiniTest::filter_backtrace(trace)
+    #  trace
+    #end
+
+    # Clean the backtrace of any reference to test framework itself.
+    def filter_backtrace(backtrace)
+      ## remove backtraces that match any pattern in IGNORE_CALLERS
+      trace = backtrace.reject{|b| IGNORE_CALLERS.any?{|i| i=~b}}
+      ## remove `:in ...` portion of backtraces
       trace = trace.map do |bt| 
-        if i = bt.index(':in')
-          bt[0...i]
-        else
-          bt
-        end
+        i = bt.index(':in')
+        i ? bt[0...i] :  bt
       end
+      ## now apply MiniTest's own filter (note: doesn't work if done first, why?)
+      trace = MiniTest::filter_backtrace(trace)
+      ## if the backtrace is empty now then revert to the original
       trace = backtrace if trace.empty?
+      ## simplify paths to be relative to current workding diectory
       trace = trace.map{ |bt| bt.sub(Dir.pwd+File::SEPARATOR,'') }
-      trace
+      return trace
     end
 
     # Returns a String of source code.
     def code_snippet(file, line)
       s = []
-
-      #case snippet
-      #when String
-      #  lines = snippet.lines.to_a
-      #  index = line - ((lines.size - 1) / 2)
-      #  lines.each do |line|
-      #    s << [index, line]
-      #    index += 1
-      #  end
-      #when Array
-      #  snippet.each do |h|
-      #    s << [h.key, h.value]
-      #  end
-      #else
-        ##backtrace = exception.backtrace.reject{ |bt| bt =~ INTERNALS }
-        ##backtrace.first =~ /(.+?):(\d+(?=:|\z))/ or return ""
-        #caller =~ /(.+?):(\d+(?=:|\z))/ or return ""
-        #source_file, source_line = $1, $2.to_i
-
-        if File.file?(file)
-          source = source(file)
-          radius = 2 # TODO: make customizable (number of surrounding lines to show)
-          region = [line - radius, 1].max ..
-                   [line + radius, source.length].min
-
-          s = region.map do |n|
-            {n => source[n-1].chomp}
-          end
+      if File.file?(file)
+        source = source(file)
+        radius = 2 # TODO: make customizable (number of surrounding lines to show)
+        region = [line - radius, 1].max ..
+                 [line + radius, source.length].min
+
+        s = region.map do |n|
+          {n => source[n-1].chomp}
         end
-      #end
+      end
       return s
     end
 
@@ -504,7 +497,7 @@ module MiniTest
 
   #
   class TapJ < MiniTap
-    def initialize
+    def initializebacktrace
       require 'json'
       super
     end

data/lib/minitap/ignore_callers.rb

@@ -0,0 +1,8 @@
+ignore = /(lib|bin)#{Regexp.escape(File::SEPARATOR)}minitap/
+
+if defined?(RUBY_IGNORE_CALLERS)
+  RUBY_IGNORE_CALLERS << ignore
+else
+  RUBY_IGNORE_CALLERS = [ignore]
+end
+

data/spec/applique/cli.rb

@@ -0,0 +1,34 @@
+require 'tapout'
+
+When 'Given a MiniTest testcase' do |text|
+  @test = text
+end
+
+When 'Running it with the (((.*?))) format' do |type|
+  File.open('test.rb', 'w'){ |f| f << test_helper(type) + "\n\n" + @test }
+  @out    = `ruby test.rb`
+  @stream = YAML.load_documents(@out)
+end
+
+#When '(((\w+))) reporter should run without error' do |format|
+#  $stdin  = StringIO.new(@tapy)
+#  $stdout = StringIO.new(out = '')
+#
+#  TapOut.cli(format)
+#end
+
+def test_helper(type)
+  if type == 'TAP-Y' then
+    %Q{
+      require 'minitap'
+      MiniTest::Unit.runner = MiniTest::TapY.new
+      require 'minitest/autorun'
+    }
+  else
+    %Q{
+      require 'minitap'
+      MiniTest::Unit.runner = MiniTest::TapJ.new
+      require 'minitest/autorun'
+    }
+  end
+end

data/spec/fixtures/tapy.yml

@@ -0,0 +1,78 @@
+---
+type: suite
+start: '2011-10-06 18:48:08'
+count: 3
+seed: 36440
+rev: 2
+---
+type: case
+subtype: ''
+label: ExampleTestCase
+level: 0
+---
+type: test
+subtype: ''
+status: error
+label: test_error
+exception:
+  message: ! 'RuntimeError:'
+  file: example.rb
+  line: 10
+  snippet:
+  - 8: ''
+  - 9: ! '  def test_error'
+  - 10: ! '    raise'
+  - 11: ! '  end'
+  - 12: ''
+  backtrace:
+  - example.rb:10
+time: 0.001054606
+---
+type: test
+subtype: ''
+status: fail
+label: test_failing
+exception:
+  message: ! "Expected: \"1\"\n  Actual: \"2\""
+  file: example.rb
+  line: 14
+  snippet:
+  - 12: ''
+  - 13: ! '  def test_failing'
+  - 14: ! '    assert_equal(''1'', ''2'')'
+  - 15: ! '  end'
+  - 16: ''
+  backtrace:
+  - example.rb:14
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:456
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:103
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:88
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:88
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:88
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:73
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:73
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:73
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:146
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:72
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:48
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:47
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:47
+time: 0.046170916
+---
+type: test
+subtype: ''
+status: pass
+label: test_passing
+time: 1.04997403
+---
+type: tally
+time: 1.000800203
+counts:
+  total: 3
+  pass: 1
+  fail: 1
+  error: 1
+  omit: 0
+  todo: 0
+...
+

data/spec/minitap.rdoc

@@ -0,0 +1,94 @@
+= MiniTap 
+
+Given a MiniTest testcase:
+
+  class ExampleTestCase < MiniTest::Unit::TestCase
+    def test_error
+      raise
+    end
+
+    def test_failing
+      assert_equal('1', '2')
+    end
+
+    def test_passing
+      sleep 1
+      assert_equal('1', '1')
+    end
+  end
+
+Running it with the TAP-Y format should work without error.
+
+The resulting document stream should exhibit the following
+characteristics.
+
+There should be six sections.
+
+  @stream.size  #=> 6
+
+The first should be a `suite` with a count of `3`.
+
+  @stream.first['type']   #=> 'suite'
+  @stream.first['count']  #=> 3
+
+The second should be `case` entry.
+
+  @stream[1]['type']   #=> 'case'
+  @stream[1]['label']  #=> 'ExampleTestCase'
+  @stream[1]['level']  #=> 0
+
+The next three documents are the unit tests, which can occur in any order.
+There one that shoud have a status of `pass`, another of `fail` and the
+third of `error`.
+
+  passing_test = @stream.find{ |d| d['type'] == 'test' && d['status'] == 'pass' }
+  failing_test = @stream.find{ |d| d['type'] == 'test' && d['status'] == 'fail' }
+  erring_test  = @stream.find{ |d| d['type'] == 'test' && d['status'] == 'error' }
+
+The passing test should have the following charactersitics.
+
+  passing_test['label']  #=> 'test_passing'
+
+The failing test should
+
+  failing_test['label']               #=> "test_failing"
+  failing_test['exception']['class']  #=> "MiniTest::Assertion"
+  failing_test['exception']['file']   #=> "test.rb"
+  failing_test['exception']['line']   #=> 13
+  failing_test['exception']['source'] #=> "assert_equal('1', '2')"
+
+The failing test should also not have any mention of minitap in the
+backtrace.
+
+  failing_test['exception']['backtrace'].each do |e|
+    /minitap/.refute.match(e)
+  end
+
+The erring test should 
+
+  erring_test['label']               #=> 'test_error'
+  erring_test['exception']['class']  #=> 'RuntimeError'
+  erring_test['exception']['file']   #=> 'test.rb'
+  erring_test['exception']['line']   #=> 9
+  erring_test['exception']['source'] #=> 'raise'
+
+The erring test should also not have any mention of minitap in the
+backtrace.
+
+  erring_test['exception']['backtrace'].each do |e|
+    /minitap/.refute.match(e)
+  end
+
+The last should a `final` document.
+
+  @stream.last['type']  #=> 'final'
+
+And it should have the following counts.
+
+  @stream.last['counts']['total']  #=> 3
+  @stream.last['counts']['error']  #=> 1
+  @stream.last['counts']['fail']   #=> 1
+  @stream.last['counts']['pass']   #=> 1
+  @stream.last['counts']['omit']   #=> 0
+  @stream.last['counts']['todo']   #=> 0
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitap
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-09 00:00:00.000000000 Z
+date: 2011-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tapout
-  requirement: &18982920 !ruby/object:Gem::Requirement
+  requirement: &12384040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *18982920
+  version_requirements: *12384040
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &18982400 !ruby/object:Gem::Requirement
+  requirement: &12383440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18982400
+  version_requirements: *12383440
 - !ruby/object:Gem::Dependency
   name: reap
-  requirement: &18981680 !ruby/object:Gem::Requirement
+  requirement: &12382640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18981680
+  version_requirements: *12382640
 description: MiniTap provides a custom MiniTest reporter that outs TAP-Y or TAP-J
   formatted output.
 email:
@@ -56,7 +56,11 @@ extra_rdoc_files:
 - COPYING.rdoc
 files:
 - .ruby
+- lib/minitap/ignore_callers.rb
 - lib/minitap.rb
+- spec/applique/cli.rb
+- spec/fixtures/tapy.yml
+- spec/minitap.rdoc
 - HISTORY.rdoc
 - README.rdoc
 - COPYING.rdoc