tapout 0.1.0 → 0.2.0

data/TODO

@@ -0,0 +1,5 @@
+= TODO
+
+* Add version or revision field to suite entry.
+
+

data/lib/tapout.rb

@@ -1,12 +1,10 @@
-require 'tapout/tapy_parser'
-require 'tapout/tap_legacy_parser'
-
 require 'optparse'
+require 'tapout/parsers'
 
 module TapOut
 
-  #
-  PARSERS = %w{breakdown dotprogress progressbar tap verbose}
+  # Usable formats.
+  FORMATS = %w{breakdown dotprogress html outline progressbar tap}
 
   #
   def self.cli(*argv)
@@ -34,7 +32,7 @@ module TapOut
         $DEBUG = true
       end
 
-      opt.separator("\nFORMATS:\n        " + PARSERS.join("\n        "))
+      opt.separator("\nFORMATS:\n        " + FORMATS.join("\n        "))
     end
 
     parser.parse!(argv)
@@ -51,19 +49,24 @@ module TapOut
 
     case stdin.line1
     when /^\d/
-      type = :legacy
+      type = :perl
     when /^\-/
-      type = :modern
+      type = :yaml
+    when /^\{/
+      type = :json
     else
       raise "Not a recognized TAP stream!"
     end
 
     case type
-    when :legacy
-      stream_parser = TAPLegacyParser.new(options)
+    when :perl
+      stream_parser = PerlParser.new(options)
       stream_parser.consume(stdin)
-    else
-      stream_parser = TAPYParser.new(options)
+    when :yaml
+      stream_parser = YamlParser.new(options)
+      stream_parser.consume(stdin)
+    when :json
+      stream_parser = JsonParser.new(options)
       stream_parser.consume(stdin)
     end
   end

data/lib/tapout/{tap_legacy_adapter.rb → adapters/perl.rb}

@@ -5,11 +5,9 @@ module TapOut
   # The TAP Legacy Adapter transforms traditional TAP format to 
   # modern TAP-Y format.
   #
-  # NOTE: This is still a work in progress.
-  #
-  # TODO: Add support for TAP-J.
+  # IMPORTANT: This is still very much a work in progress.
 
-  class TAPLegacyAdapter
+  class PerlAdapter
 
     #
     def initialize(input)
@@ -89,7 +87,7 @@ module TapOut
         line = cache[0]
         md = /^(\d+)\.\.(\d+)\s*$/.match(line)
         count = md[2].to_i - md[1].to_i + 1
-        entry = {'count'=> count, 'type'=>'header', 'version'=>TAP_Y_VERSION}
+        entry = {'count'=>count, 'type'=>'suite', 'rev'=>REVISION}
       when :ok
         line = cache[0]
         md = /^ok\s+(\d+)\s*\-?\s*(.*?)($|#)/.match(line)
@@ -102,7 +100,7 @@ module TapOut
         entry = convert_not_ok(md[1], md[2], data)
       when :comment
         desc = cache.map{ |c| c.sub(/^\#\s{0,1}/, '') }.join("\n")
-        entry = {'type'=>'note', 'description'=>desc.rstrip}
+        entry = {'type'=>'note', 'text'=>desc.rstrip}
       end
       output(entry)
       @cache = []
@@ -131,20 +129,23 @@ module TapOut
     private
 
     #
-    def convert_not_ok(number, label, metainfo)
+    # TODO: Any way to distinguish fail vs error?
+    def convert_not_ok(number, label, data)
       entry = {}
       entry['type']   = 'test'
       entry['status'] = 'fail'
       entry['index']  = number.to_i
       entry['label']  = label
-      if metainfo
-        entry['file']        = metainfo['file']
-        entry['line']        = metainfo['line']
-        entry['expected']    = metainfo['wanted']
-        entry['returned']    = metainfo['found']
-        entry['description'] = metainfo['description']
-        entry['source']      = metainfo['raw_test']
-        entry['extra']       = metainfo['extensions']
+      if data
+        entry['exception'] = {}
+        entry['exception']['file']    = data['file']
+        entry['exception']['line']    = data['line']
+        entry['exception']['message'] = data['description']
+
+        entry['expected'] = data['wanted']
+        entry['returned'] = data['found']
+        entry['source']   = data['raw_test']
+        entry['extra']    = data['extensions']
       end
       entry
     end
@@ -154,11 +155,11 @@ module TapOut
       groups = @entries.group_by{ |e| e['status'] }
 
       entry = {}
-      entry['count'] = @count
-      entry['type'] = 'footer'
-      entry['tally'] = {
-        'pass' => (groups['pass'] || []).size,
-        'fail' => (groups['fail'] || []).size
+      entry['type'] = 'tally'
+      entry['counts'] = {
+        'total' => @count,
+        'pass'  => (groups['pass'] || []).size,
+        'fail'  => (groups['fail'] || []).size
       }
       entry
     end

data/lib/tapout/parsers.rb

@@ -0,0 +1,4 @@
+require 'tapout/parsers/yaml'
+require 'tapout/parsers/json'
+require 'tapout/parsers/perl'
+

data/lib/tapout/parsers/json.rb

@@ -0,0 +1,38 @@
+require 'tapout/reporters'
+require 'json'
+
+module TapOut
+
+  # The TAP-J Parser takes a TAP-J stream and routes it through
+  # a TapOut report format.
+  #
+  class JsonParser
+
+    #
+    def initialize(options={})
+      format    = options[:format] || 'dotprogress'
+      @reporter = Reporters.factory(format).new
+    end
+
+    #
+    def consume(input)
+      while line = input.gets
+        self << line
+      end
+    end
+
+    #
+    def <<(line)
+      handle(line)
+    end
+
+    #
+    def handle(doc)
+      return if doc == ''
+      entry = JSON.load(doc)
+      @reporter << entry
+    end
+
+  end
+
+end

data/lib/tapout/{tap_legacy_parser.rb → parsers/perl.rb}

@@ -1,12 +1,12 @@
 require 'tapout/version'
-require 'tapout/tap_legacy_adapter'
+require 'tapout/perl_adapter'
 require 'tapout/reporters'
 
 module TapOut
 
   # The TAPLegacy Parser takes a traditional TAP stream and routes
   # it through a Tap Out report format.
-  class TAPLegacyParser
+  class perlParser
 
     # options[:format] - the report format to use
     def initialize(options={})
@@ -16,7 +16,7 @@ module TapOut
 
     # input - any object that responds to #gets
     def consume(input)
-      parser = TAPLegacyAdapter.new(input)
+      parser = PerlAdapter.new(input)
       parser | @reporter
     end
 

data/lib/tapout/{tapy_parser.rb → parsers/yaml.rb}

@@ -1,12 +1,11 @@
 require 'tapout/reporters'
-
 require 'yaml'
 
 module TapOut
 
   # The TAP-Y Parser takes a TAP-Y stream and routes it through
-  # a Tap Out report format.
-  class TAPYParser
+  # a TapOut report format.
+  class YamlParser
 
     #
     def initialize(options={})

data/lib/tapout/reporters.rb

@@ -1,6 +1,7 @@
 require 'tapout/reporters/abstract'
+require 'tapout/reporters/breakdown'
 require 'tapout/reporters/dotprogress'
-require 'tapout/reporters/verbose'
-require 'tapout/reporters/tap'
+require 'tapout/reporters/html'
+require 'tapout/reporters/outline'
 require 'tapout/reporters/progressbar'
-require 'tapout/reporters/breakdown'
+require 'tapout/reporters/tap'

data/lib/tapout/reporters/abstract.rb

@@ -49,7 +49,7 @@ module TapOut
       # report methods.
       def handle(entry)
         case entry['type']
-        when 'header'
+        when 'suite'
           start_suite(entry)
         when 'case'
           finish_case(@previous_case) if @previous_case
@@ -68,10 +68,10 @@ module TapOut
             err(entry)
           when 'omit'
             omit(entry)
-          when 'pending', 'skip'
+          when 'todo', 'skip', 'pending'
             skip(entry)
           end
-        when 'footer'
+        when 'tally'
           finish_case(@previous_case) if @previous_case
           finish_suite(entry)
         end
@@ -128,30 +128,32 @@ module TapOut
 
       # TODO: get the tally's from the footer entry ?
       def tally(entry)
-        total = entry['count'] || (@passed.size + @failed.size + @raised.size)
+        total = @passed.size + @failed.size + @raised.size #+ @skipped.size + @omitted.size
 
-        if entry['tally']
-          count_fail  = entry['tally']['fail']  || 0
-          count_error = entry['tally']['error'] || 0
+        if entry['counts']
+          total       = entry['counts']['total'] || total
+          count_fail  = entry['counts']['fail']  || 0
+          count_error = entry['counts']['error'] || 0
         else
           count_fail  = @failed.size
           count_error = @raised.size
         end
 
-        if tally = entry['tally']
-          sums = %w{pass fail error skip}.map{ |e| tally[e] || 0 }
+        if tally = entry['counts']
+          sums = %w{pass fail error todo omit}.map{ |e| tally[e] || 0 }
         else
-          sums = [@passed, @failed, @raised, @skipped].map{ |e| e.size }
+          sums = [@passed, @failed, @raised, @skipped, @omitted].map{ |e| e.size }
         end
 
+        # ???
         assertions = entry['assertions']
         failures   = entry['failures']
 
         if assertions
-          text = "%s tests: %s pass, %s fail, %s err, %s pending (%s/%s assertions)"
+          text = "%s tests: %s pass, %s fail, %s err, %s todo, %omit (%s/%s assertions)"
           text = text % [total, *sums] + [assertions - failures, assertions]
         else
-          text = "%s tests: %s pass, %s fail, %s err, %s pending"
+          text = "%s tests: %s pass, %s fail, %s err, %s todo, %s omit"
           text = text % [total, *sums]
         end
 
@@ -165,7 +167,7 @@ module TapOut
       end
 
       #
-      INTERNALS = /(lib|bin)#{Regexp.escape(File::SEPARATOR)}ko/
+      INTERNALS = /(lib|bin)#{Regexp.escape(File::SEPARATOR)}tapout/
 
       # Clean the backtrace of any reference to ko/ paths and code.
       def clean_backtrace(backtrace)
@@ -200,7 +202,7 @@ module TapOut
           end
         when Array
           snippet.each do |h|
-            s << [h.key, h.value]
+            s << [h.keys.first, h.values.first]
           end
         else
           ##backtrace = exception.backtrace.reject{ |bt| bt =~ INTERNALS }
@@ -208,17 +210,18 @@ module TapOut
           #caller =~ /(.+?):(\d+(?=:|\z))/ or return ""
           #source_file, source_line = $1, $2.to_i
 
-          if File.file?(file)
+          if file && File.file?(file)
             source = source(file)
 
             radius = 3 # number of surrounding lines to show
-            region = [source_line - radius, 1].max ..
-                     [source_line + radius, source.length].min
+            region = [line - radius, 1].max ..
+                     [line + radius, source.length].min
 
             #len = region.last.to_s.length
 
             s = region.map do |n|
-              format % [n, source[n-1].chomp]
+              #format % [n, source[n-1].chomp]
+              [n, source[n-1].chomp]
             end
           end
         end

data/lib/tapout/reporters/breakdown.rb

@@ -98,12 +98,13 @@ module TapOut
             #puts "\n-- Failures and Errors --\n"
             puts
             bad.each do |e|
-              message = e['message'].strip
+              x = e['exception']
+              message = x['message'].strip
               message = message.ansi(:red)
               puts(message)
-              puts "#{e['file']}:#{e['line']}"
+              puts "#{x['file']}:#{x['line']}"
               puts
-              puts code_snippet(e)
+              puts code_snippet(x)
             end
             puts
           end

data/lib/tapout/reporters/dotprogress.rb

@@ -42,9 +42,9 @@ module TapOut::Reporters
         #backtrace = clean_backtrace(exception.backtrace)
         $stdout.puts "#{i}. " + (e['label']).ansi(:red)
         $stdout.puts
-        $stdout.puts "    #{e['message']}"
-        $stdout.puts "    #{e['file']}:#{e['line']}" #+ backtrace[0]
-        $stdout.puts code_snippet(e)
+        $stdout.puts "    #{e['exception']['message']}"
+        $stdout.puts "    #{e['exception']['file']}:#{e['exception']['line']}" #+ backtrace[0]
+        $stdout.puts code_snippet(e['exception'])
         $stdout.puts
         i += 1
       end
@@ -53,9 +53,9 @@ module TapOut::Reporters
         #backtrace = clean_backtrace(exception.backtrace)
         $stdout.puts "#{i}. " + (e['label']).ansi(:yellow)
         $stdout.puts
-        $stdout.puts "    #{e['message']}"
-        $stdout.puts "    #{e['file']}:#{e['line']}" #+ backtrace[0..2].join("    \n")
-        $stdout.puts code_snippet(e)
+        $stdout.puts "    #{e['exception']['message']}"
+        $stdout.puts "    #{e['exception']['file']}:#{e['exception']['line']}" #+ backtrace[0..2].join("    \n")
+        $stdout.puts code_snippet(e['exception'])
         $stdout.puts
         i += 1
       end

data/lib/tapout/reporters/html.rb

@@ -0,0 +1,152 @@
+require 'test/reporters/abstract'
+
+module TapOut::Reporters
+
+  # HTML Test Reporter
+  #
+  # This reporter is rather simplistic and rough at this point --in needs
+  # of some TLC.
+  #--
+  # TODO: Make this more like a microformat and add timer info.
+  #++
+  class Html < Abstract
+
+    #
+    def start_suite(entry)
+      timer_reset
+
+      puts %[<html>]
+      puts %[<head>]
+      puts %[<title>Test Report</title>]
+      puts %[  <style>]
+      puts %[    html{ background: #fff; margin: 0; padding: 0; font-family: helvetica; }]
+      puts %[    body{ margin: 0; padding: 0;}]
+      puts %[    h3{color:#555;}]
+      puts %[    #main{ margin: 0 auto; color: #110; width: 600px; ]
+      puts %[           border-right: 1px solid #ddd; border-left: 1px solid #ddd; ]
+      puts %[           padding: 10px 30px; width: 500px; } ]
+      puts %[    .title{ color: gold; font-size: 22px; font-weight: bold; ]
+      puts %[            font-family: courier; margin-bottom: -15px;}]
+      puts %[    .tally{ font-weight: bold; margin-bottom: 10px; }]
+      puts %[    .omit{ color: cyan; }]
+      puts %[    .pass{ color: green; }]
+      puts %[    .fail{ color: red; }]
+      puts %[    .footer{ font-size: 0.7em; color: #666; margin: 20px 0; }]
+      puts %[  </style>]
+      puts %[</head>]
+      puts %[<body>]
+      puts %[<div id="main">]
+      puts %[<div class="title">R U B Y - T E S T</div>]
+      puts %[<h1>Test Report</h1>]
+    end
+
+    #
+    def start_case(entry)
+      body = []
+
+      puts "<h2>"
+      puts entry['label']
+      puts "</h2>"
+
+      puts body.join("\n")
+    end
+
+    #
+    def start_test(entry)
+      if subtext = entry['subtext']
+        if @subtext != subtext
+          @subtext = subtext
+          puts "<h3>#{subtext}</h3>"
+        end
+      end
+    end
+
+    #
+    def pass(entry)
+      puts %[<li class="pass">]
+      puts "%s %s" % [ "PASS", entry['label'] ]
+      puts %[</li>]
+    end
+
+    #
+    def fail(entry)
+      e = entry['exception']
+
+      puts %[<li class="fail">]
+      puts "FAIL #{e['message']}"
+      puts "<pre>"
+      puts clean_backtrace(e['backtrace']).join("\n")
+      puts "</pre>"
+      puts %[</li>]
+    end
+
+    #
+    def err(entry)
+      e = entry['exception']
+
+      puts %[<li class="error">]
+      puts "ERROR "
+      puts e['message'].to_s
+      puts "<pre>"
+      puts clean_backtrace(e['backtrace']).join("\n")
+      puts "</pre>"
+      puts %[</li>]
+    end
+
+    #
+    def todo(entry)
+      e = entry['exception']
+
+      puts %[<li class="pending">]
+      puts "TODO "
+      puts e['message'].to_s
+      puts %[</li>]
+    end
+
+    #
+    def omit(entry)
+      e = entry['exception']
+
+      puts %[<li class="omit">]
+      puts "OMIT "
+      puts e['message'].to_s
+      puts %[</li>]
+    end
+
+    #
+    def finish_suite(entry)
+      puts ""
+      puts %[<div class="tally">]
+      puts tally(entry)
+      puts %[</div>]
+      puts ""
+      puts ""
+      puts %[<div class="footer">]
+      puts %[Generated by <a href="http://rubyworks.github.com/tapout">TAPOUT</a>]
+      puts %[on #{Time.now}.]
+      puts %[</div>]
+      puts ""
+      puts %[</div>]
+      puts %[</div>]
+      puts ""
+      puts %[</body>]
+      puts %[</html>]
+    end
+
+  private
+
+    #
+    def timer
+      secs  = Time.now - @time
+      @time = Time.now
+      return "%0.5fs" % [secs.to_s]
+    end
+
+    #
+    def timer_reset
+      @time = Time.now
+    end
+
+  end
+
+end