tapout 0.3.2 → 0.4.0

data/.ruby

@@ -21,6 +21,10 @@ requirements:
   groups:
   - test
   development: true
+- name: ae
+  groups:
+  - test
+  development: true
 dependencies: []
 conflicts: []
 repositories:
@@ -29,17 +33,22 @@ repositories:
   name: upstream
 resources:
   home: http://rubyworks.github.com/tapout
+  wiki: http://github.com/rubyworks/tapout/wiki
+  docs: http://rubydoc.info/gems/tapout/frames
   code: http://github.com/rubyworks/tapout
+  bugs: http://github.com/rubyworks/tapout/issues
+  mail: http://groups.google.com/rubyworks-mailinglist
+  chat: irc://chat.us.freenode.net#rubyworks
 extra: {}
 load_path:
 - lib
 revision: 0
 created: '2010-12-23'
 summary: Progressive TAP Harness
-title: TapOut
-version: 0.3.2
+title: TAPOUT
+version: 0.4.0
 name: tapout
 description: Tapout is a TAP consumer that can take any TAP, TAP-Y or TAP-J stream
   and output it in a variety of useful formats.
 organization: RubyWorks
-date: '2011-11-08'
+date: '2012-02-01'

data/.yardopts

@@ -1,7 +1,8 @@
---title "Tap Out"
+--title "TAPout"
 --readme README.rdoc
---output-dir site/doc
+--protected
 --private
-lib/**/*.rb -
-[A-Z][A-Z]*
-
+lib
+-
+[A-Z]*.*
+TAP-YJ.md

data/HISTORY.rdoc

@@ -1,5 +1,21 @@
 = RELEASE HISTORY
 
+== 0.4.0 / 2012-02-01
+
+TAP-Y/J spec now supports `stdout` and `stderr` fields. This allows test
+frameworks to capture stdout and stderr while running tests and pipe them
+through with the TAP stream, which tapout can then include in the test
+report output. This release also brings a great deal of improvement to test
+reports in general, from better time stats to much improved backtrace output.
+
+Changes:
+
+* Rename namespace to Tapout, instead of TapOut.
+* Add support for `stdout` and `stderr` fields to spec.
+* Add common config for all reporters.
+* Add common code snippet functionality to all reporters.
+* Add markdown reporter.
+
 
 == 0.3.2 / 2011-11-08
 

data/README.rdoc

@@ -1,6 +1,7 @@
-= Tap Out
+= TAPOUT
 
 {Website}[http://rubyworks.github.com/tapout] |
+{User Guide}[http://github.com/rubyworks/tapout/wiki] |
 {Development}[http://github.com/rubyworks/tapout] |
 {Report Issue}[http://github.com/rubyworks/tapout/issues]
 
@@ -9,15 +10,16 @@
 
 == DESCRIPTION
 
-TapOut is a TAP handler. TapOut supports TAP-Y/J as well as traditional TAP.
-
+*TAPOUT* is a TAP handler which supports TAP-Y/J as well as traditional TAP streams.
 TAP-Y/J is a modernization of TAP using pure YAML/JSON streams.
+
 Traditional TAP has less detail than TAP-Y/J, but it can still be translated
-with fairly good results. TapOut includes a TAP adapter to handle the
-translation transparently. Currently TapOut supports TAP v12 with minor
-some limitations.
+with fairly good results. TAPOUT includes a TAP adapter to handle the
+translation transparently. Currently TAPOUT supports TAP v12 with some minor
+limitations.
 
-To learn about the TAP-Y/J specification, see the {TAP-YJ.rdoc} file.
+To learn about the TAP-Y/J specification, see the {TAP-Y/J Specification}[https://github.com/rubyworks/tapout/wiki/Specification]
+document.
 
 For information about TAP, see http://testanything.org/wiki/index.php/Main_Page.
 
@@ -27,17 +29,17 @@ For information about TAP, see http://testanything.org/wiki/index.php/Main_Page.
 Using a test framework that produces a TAP-Y output stream, simply pipe
 the stream into `tapout`.
 
-  $ ruby-test -y -Ilib test/foo.rb | tapout
+  $ rubytest -y -Ilib test/foo.rb | tapout
 
-TapOut supports a variety of output formats. These are selectable via the 
+TAPOUT supports a variety of output formats. These are selectable via the 
 first argument. The default if not given, as in the example above, is `dotprogress`.
 
-  $ ruby-test -y -Ilib test/foo.rb | tapout progessbar
+  $ rubytest -y -Ilib test/foo.rb | tapout progessbar
 
-TapOut is smart enough to match the closest matching format name. So, for
+TAPOUT is smart enough to match the closest matching format name. So, for
 example, the above could be written as:
 
-  $ ruby-test -y -Ilib test/foo.rb | tapout pro
+  $ rubytest -y -Ilib test/foo.rb | tapout pro
 
 And tapout will know to use the `progressbar` format.
 
@@ -46,16 +48,16 @@ To see a list of supported formats use the list subcommand:
   $ tapout --help
 
 If your test framework does not support TAP-Y, but does support traditional
-TAP, TapOut will automatically recognize the difference by TAP's `1..N` header.
+TAP, TAPOUT will automatically recognize the difference by TAP's `1..N` header.
 
-  $ ruby-test -ftap -Ilib test/foo.rb | tapout progressbar
+  $ rubytest -ftap -Ilib test/foo.rb | tapout progressbar
 
 
 == COPYRIGHTS
 
-TapOut - Copyright (c) 2010 Rubyworks
+TAPOUT - Copyright (c) 2010 Rubyworks
 
-TapOut is licensed under the terms of the *BSD-2-Clause* license.
+TAPOUT is distributable in accordance with the *BSD-2-Clause* license.
 
 See COPYING.rdoc for details.
 

data/TAP-YJ.md

@@ -214,10 +214,10 @@ The `note` type is used to interject a message between tests that
 is not tied to a specific unit or case. It has only a few fields.
 
 
-  ---
-  type: note
-  text:
-    This is an example note.
+    ---
+    type: note
+    text:
+      This is an example note.
 
 
 The note document is simply used to interject any information the 
@@ -233,17 +233,17 @@ stream. The `final` entry on the other hand incidates the end of a test suite,
 which will be followed by an end-document-marker (`...`).
 
 
-  ---
-  type : final
-  time : 0.03
-  counts:
-    total: 2
-    pass : 1
-    fail : 1
-    error: 0
-    omit : 0
-    todo : 0
-  ...
+    ---
+    type : final
+    time : 0.03
+    counts:
+      total: 2
+      pass : 1
+      fail : 1
+      error: 0
+      omit : 0
+      todo : 0
+    ...
 
 
 A tally/final document MUST provide a counts mapping with the `total` number of

data/bin/tapout

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
 require 'tapout'
-TapOut.cli(*ARGV)
+Tapout.cli(*ARGV)

data/demo/applique/ae.rb

@@ -0,0 +1 @@
+require 'ae'

data/{spec → demo}/issues/default_reporter.rdoc

@@ -30,7 +30,7 @@ Instead of having each parser worry about setting the default
 we can let the factory method do it when `nil` is passed as an
 argument.
 
-    reporter = TapOut::Reporters.factory(nil)
+    reporter = Tapout::Reporters.factory(nil)
 
-    reporter #=> TapOut::Reporters::DotReporter
+    reporter #=> Tapout::Reporters::DotReporter
 

data/{spec → demo}/perl_adapter.rdoc

@@ -23,7 +23,7 @@ The PerlAdapter can convert the stream into TAP-Y.
 
   stream = StringIO.new(@tap)
 
-  adapter = TapOut::PerlAdapter.new(stream)
+  adapter = Tapout::PerlAdapter.new(stream)
 
   entries = adapter.to_a
 
@@ -36,7 +36,7 @@ Or pipe the converted stream directly to another stream.
 
   stream = StringIO.new(@tap)
 
-  adapter = TapOut::PerlAdapter.new(stream)
+  adapter = Tapout::PerlAdapter.new(stream)
 
   output = ""
 
@@ -57,7 +57,7 @@ Let's see if this works.
 
   stream = StringIO.new(@tap)
 
-  adapter = TapOut::PerlAdapter.new(stream)
+  adapter = Tapout::PerlAdapter.new(stream)
 
   entries = adapter.to_a
 

data/{spec → demo}/reporters/applique/cli.rb

@@ -8,6 +8,6 @@ When '(((\w+))) reporter should run without error' do |format|
   $stdin  = StringIO.new(@tapy)
   $stdout = StringIO.new(out = '')
 
-  TapOut.cli(format)
+  Tapout.cli(format)
 end
 

data/lib/tapout.rb

@@ -1,104 +1,8 @@
-require 'optparse'
-require 'tapout/parsers'
-
-module TapOut
-
-  # Default trace depth.
-  @trace = nil
-
-  #
-  def self.trace
-    @trace
-  end
-
-  #
-  def self.trace=(depth)
-    @trace = depth.to_i
-  end
-
-  # Command line interface.
-  #
-  def self.cli(*argv)
-    options = {}
-    type    = :modern
-
-    parser = OptionParser.new do |opt|
-      opt.banner = "tapout [options] [reporter]"
-
-      opt.separator("\nOPTIONS:")
-
-      #opt.on('-t', '--tap', 'Consume legacy TAP input') do |fmt|
-      #  type = :legacy
-      #end
-
-      opt.on('--trace', '-t DEPTH', 'set backtrace depth') do |depth|
-        self.trace = depth
-      end
-
-      opt.on('--no-color', 'Supress ANSI color codes') do
-        $ansi = false  # TODO: Is this correct?
-      end
 
-      opt.on('--debug', 'Run with $DEBUG flag on') do |fmt|
-        $DEBUG = true
-      end
-
-      opt.separator("\nREPORTERS:\n        " + Reporters.index.keys.join("\n        "))
-    end
-
-    parser.parse!(argv)
-
-    options[:format] = argv.first
-
-    # TODO: would be nice if it could automatically determine which
-    #c = $stdin.getc
-    #    $stdin.pos = 0
-    #type = :legacy if c =~ /\d/
-    #type = :modern if c == '-'
-
-    stdin = Curmudgeon.new($stdin)
-
-    case stdin.line1
-    when /^\d/
-      type = :perl
-    when /^\-/
-      type = :yaml
-    when /^\{/
-      type = :json
-    else
-      raise "Not a recognized TAP stream!"
-    end
-
-    case type
-    when :perl
-      stream_parser = PerlParser.new(options)
-      exit_code     = stream_parser.consume(stdin)
-    when :yaml
-      stream_parser = YamlParser.new(options)
-      exit_code     = stream_parser.consume(stdin)
-    when :json
-      stream_parser = JsonParser.new(options)
-      exit_code     = stream_parser.consume(stdin)
-    end
-
-    exit(exit_code || 0)
-  end
+module Tapout
+end
 
-  #
-  class Curmudgeon #< IO
-    def initialize(input)
-      @input = input
-      @line1 = input.gets
-    end
-    def line1
-      @line1
-    end
-    def gets
-      (class << self; self; end).class_eval %{
-        def gets; @input.gets; end
-      }
-      return @line1
-    end
-  end
+require 'tapout/config'
+require 'tapout/cli'
+require 'tapout/parsers'
 
-end

data/lib/tapout.yml

@@ -21,6 +21,10 @@ requirements:
   groups:
   - test
   development: true
+- name: ae
+  groups:
+  - test
+  development: true
 dependencies: []
 conflicts: []
 repositories:
@@ -29,17 +33,22 @@ repositories:
   name: upstream
 resources:
   home: http://rubyworks.github.com/tapout
+  wiki: http://github.com/rubyworks/tapout/wiki
+  docs: http://rubydoc.info/gems/tapout/frames
   code: http://github.com/rubyworks/tapout
+  bugs: http://github.com/rubyworks/tapout/issues
+  mail: http://groups.google.com/rubyworks-mailinglist
+  chat: irc://chat.us.freenode.net#rubyworks
 extra: {}
 load_path:
 - lib
 revision: 0
 created: '2010-12-23'
 summary: Progressive TAP Harness
-title: TapOut
-version: 0.3.2
+title: TAPOUT
+version: 0.4.0
 name: tapout
 description: Tapout is a TAP consumer that can take any TAP, TAP-Y or TAP-J stream
   and output it in a variety of useful formats.
 organization: RubyWorks
-date: '2011-11-08'
+date: '2012-02-01'

data/lib/tapout/adapters/perl.rb

@@ -1,6 +1,6 @@
 require 'tapout/version'
 
-module TapOut
+module Tapout
 
   # The TAP Legacy Adapter transforms traditional TAP format to 
   # modern TAP-Y format.

data/lib/tapout/cli.rb

@@ -0,0 +1,98 @@
+module Tapout
+
+  require 'optparse'
+
+  # Command line interface.
+  #
+  def self.cli(*argv)
+    options = {}
+    type    = :modern
+
+    parser = OptionParser.new do |opt|
+      opt.banner = "tapout [options] [reporter]"
+
+      opt.separator("\nOPTIONS:")
+
+      #opt.on('-t', '--tap', 'Consume legacy TAP input') do |fmt|
+      #  type = :legacy
+      #end
+
+      opt.on('--trace', '-t DEPTH', 'set backtrace depth') do |depth|
+        self.config.trace = depth
+      end
+
+      opt.on('--lines', '-l LINES', 'number of surrounding source code lines') do |lines|
+        self.config.lines = lines.to_i
+      end
+
+      opt.on('--minimal', '-m', 'show only errors, failures and pending tests') do |val|
+        self.config.minimal = val
+      end
+
+      opt.on('--no-color', 'Supress ANSI color codes') do
+        $ansi = false
+      end
+
+      opt.on('--debug', 'Run with $DEBUG flag on') do |fmt|
+        $DEBUG = true
+      end
+
+      opt.separator("\nREPORTERS:\n        " + Reporters.index.keys.join("\n        "))
+    end
+
+    parser.parse!(argv)
+
+    options[:format] = argv.first
+
+    # TODO: would be nice if it could automatically determine which
+    #c = $stdin.getc
+    #    $stdin.pos = 0
+    #type = :legacy if c =~ /\d/
+    #type = :modern if c == '-'
+
+    stdin = Curmudgeon.new($stdin)
+
+    case stdin.line1
+    when /^\d/
+      type = :perl
+    when /^\-/
+      type = :yaml
+    when /^\{/
+      type = :json
+    else
+      raise "Not a recognized TAP stream!"
+    end
+
+    case type
+    when :perl
+      stream_parser = PerlParser.new(options)
+      exit_code     = stream_parser.consume(stdin)
+    when :yaml
+      stream_parser = YamlParser.new(options)
+      exit_code     = stream_parser.consume(stdin)
+    when :json
+      stream_parser = JsonParser.new(options)
+      exit_code     = stream_parser.consume(stdin)
+    end
+
+    exit(exit_code || 0)
+  end
+
+  #
+  class Curmudgeon #< IO
+    def initialize(input)
+      @input = input
+      @line1 = input.gets
+    end
+    def line1
+      @line1
+    end
+    def gets
+      (class << self; self; end).class_eval %{
+        def gets; @input.gets; end
+      }
+      return @line1
+    end
+  end
+
+end