tapout 0.2.3 → 0.3.0

data/.ruby

@@ -29,17 +29,18 @@ resources:
   code: http://github.com/rubyworks/tapout
 load_path:
 - lib
-extra: {}
-date: '2011-10-07'
-version: 0.2.3
-alternatives: []
-revision: 0
+extra:
+  manifest: MANIFEST
 source:
 - PROFILE
+alternatives: []
+revision: 0
 name: tapout
 title: TapOut
+version: 0.3.0
 summary: Progressive TAP Harness
 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
 created: '2010-12-23'
+date: '2011-10-08'

data/HISTORY.rdoc

@@ -1,6 +1,17 @@
 = RELEASE HISTORY
 
 
+== 0.3.0 / 2011-10-09
+
+This release supports revision 3 of the TAP-Y/J specification, which adds `final`
+to the document types. The `final` document is the last document of a test suite.
+It takes the place of `tally`, which is now simply an optional running subtotal
+document. 
+
+This release also makes some intreface imporvements to the `Reporters::Abstract`
+base class and ports over all applicable reporters from othe Turn project.
+
+
 == 0.2.3 / 2011-10-08
 
 Exit code are important for a test output format. This release addressed that

data/PROFILE

@@ -1,6 +1,6 @@
 --- 
 name: tapout
-version: 0.2.3
+version: 0.3.0
 
 title: TapOut
 summary: Progressive TAP Harness

data/TAP-YJ.md

@@ -1,4 +1,4 @@
-# TAP-Y/J Format
+# TAP-Y/J Specification
 
 TAP-Y and TAP-J are test streams. They are essentially the same except
 for the underlying format used, which are YAML and JSON repsectively.
@@ -26,12 +26,15 @@ A `suite` document marks the beginning of a forthcoming stream of tests,
 i.e. a <i>test suite</i>. All TAP-Y streams MUST begin with a suite
 document.
 
+
     ---
     type: suite
     start: 2011-10-10 12:12:32
     count: 2
+    seed: 32154
     rev: 2
 
+
 The `start` field marks the date and time testing began. It MUST be
 an ISO-8601 formated timestamp.
 
@@ -40,6 +43,9 @@ If the number of test units is unknown, the total can be omitted or
 marked as `~` (nil). The total should only indicate the number of
 <i>test units</i>, not any enumeration of <i>test cases</i>.
 
+The `seed` is provided if the test runner has randomized the order of
+execution unit tests. The seed can be used to reproduce the same order.
+
 The `rev` field provides the version of the TAP-Y/J format that is
 being used. The specification will change little, if at all, as it
 become more mainstream. But just in case, having a revision field
@@ -50,12 +56,14 @@ apps to adjust to any future variation.
 
 The `case` type indicates the start of a test case.
 
+
     ---
     type: case
     subtype: feature
     label: Multiplication
     level: 0
 
+
 The case document MAY provide a `class` which is a label for the
 typ of test case. For example, a test framwework that uses Gherkin
 nomenclature would classify a test case as a "feature".
@@ -79,6 +87,7 @@ common fields.
 
 Here is an example of a passing unit document.
 
+
     ---
     type: test
     subtype: step
@@ -100,6 +109,7 @@ Here is an example of a passing unit document.
       code: Foo#*
     time: 0.01
 
+
 Besides the `status`, all test documents MUST have a `label`.
 
 A test document MAY provide a `setup` field, which is used to describe
@@ -140,6 +150,7 @@ If a test has a status other than `pass` it MUST also provide a `exception`
 subsection which is used to describe the nature of the failure, error or
 omission.
 
+
     ---
     type: test
     subtype: step
@@ -176,6 +187,7 @@ omission.
         - test/test_foo.rb:45
     time: 0.02
 
+
 The `exception` section MUST give the `message`, describing the nature
 of the failure or exception. In this subsection, `file` and `line` indicate
 the location in code that triggered the exception or failed assertion.
@@ -200,25 +212,28 @@ code with having to do additional processing.
 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.
 
+
 The note document is simply used to interject any information the 
 tester might want to know, but doesn't properly fit elsewhere in the
 stream. A note cna appear any where in the document stream prior
 to the tally.
 
-### Tally
+### Final & Tally
+
+The `final` and `tally` types are the same. The difference is only that a `tally`
+entry is a running tally, and can technically occur anywhere in the document
+stream. The `final` entry on the other hand incidates the end of a test suite,
+which will be followed by an end-document-marker (`...`).
 
-While a running tally can technically occur anywhere in the document
-stream without consequence, it generally incidates the end of a test
-suite, which is strictly complete with the end-document-marker (`...`)
-appears.
 
   ---
-  type : tally
+  type : final
   time : 0.03
   counts:
     total: 2
@@ -229,11 +244,17 @@ appears.
     todo : 0
   ...
 
-A tally document MUST provide a counts mapping with the `total` number of
+
+A tally/final document MUST provide a counts mapping with the `total` number of
 tests (this MUST be same as `count` in the suite document if it was given)
 and the totals for each test status. It SHOULD also give the time elapsed
 since the suite time.
 
+Tally documents are very rare, if used at all. They only make sense for very
+large test suites as a progress report mechanism. As a rule of thumb, TAP-Y/J
+consumer apps will ignore them unless a configuration option (e.g. `--verbose`)
+is used.
+
 As mentioned, the test stream ends when a full ellipsis (<code>...</code>)
 appears.
 
@@ -241,7 +262,6 @@ As you can see TAP-Y streams provides a great deal of detail. They are not
 intended for the end-user, but rather to pipe to a consuming app to process
 into a human readable form.
 
-
 ## Glossery of Fields
 
 ### count
@@ -321,10 +341,10 @@ On the other hand, `todo` means the test will be used in the future
 but implementation has not been completed. It serves as reminder to developers
 to write a missing test.
 
-### tally
+### counts
 
-The footer MUST provide a tally for all status categories. This is like `count`
-but broken down into status groups.
+The footer MUST provide counts for all status categories and the total.
+This is like `count` in the suite entry but broken down into status groups.
 
 ### time
 

data/lib/tapout.rb

@@ -3,27 +3,35 @@ require 'tapout/parsers'
 
 module TapOut
 
-  # Usable formats.
-  FORMATS = %w{breakdown dotprogress html outline progressbar tap}
+  #
+  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] [format]"
+      opt.banner = "tapout [options] [reporter]"
 
       opt.separator("\nOPTIONS:")
 
-      #opt.on('--format', '-f FORMAT', 'Report format') do |fmt|
-      #  options[:format] = fmt
-      #end
-
       #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
@@ -32,7 +40,7 @@ module TapOut
         $DEBUG = true
       end
 
-      opt.separator("\nFORMATS:\n        " + FORMATS.join("\n        "))
+      opt.separator("\nREPORTERS:\n        " + Reporters.index.keys.join("\n        "))
     end
 
     parser.parse!(argv)

data/lib/tapout.yml

@@ -0,0 +1,46 @@
+---
+authors:
+- name: Thomas Sawyer
+  email: transfire@gmail.com
+copyrights:
+- holder: Thomas Sawyer
+  year: '2010'
+  license: BSD-2-Clause
+replacements: []
+conflicts: []
+requirements:
+- name: ansi
+- name: json
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: qed
+  groups:
+  - test
+  development: true
+dependencies: []
+repositories:
+- uri: git://github.com/rubyworks/tapout.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/tapout
+  code: http://github.com/rubyworks/tapout
+load_path:
+- lib
+extra:
+  manifest: MANIFEST
+source:
+- PROFILE
+alternatives: []
+revision: 0
+name: tapout
+title: TapOut
+version: 0.3.0
+summary: Progressive TAP Harness
+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
+created: '2010-12-23'
+date: '2011-10-08'

data/lib/tapout/adapters/perl.rb

@@ -156,7 +156,7 @@ module TapOut
       groups = @entries.group_by{ |e| e['status'] }
 
       entry = {}
-      entry['type'] = 'tally'
+      entry['type'] = 'final'
       entry['counts'] = {
         'total' => @count,
         'pass'  => (groups['pass'] || []).size,

data/lib/tapout/core_ext.rb

@@ -0,0 +1,31 @@
+# Borrowed methods from Ruby Facets.
+
+class String
+
+  # Aligns each line n spaces.
+  def tab(n)
+    gsub(/^ */, ' ' * n)
+  end
+
+  # Preserves relative tabbing.
+  # The first non-empty line ends up with n spaces before nonspace.
+  def tabto(n)
+    if self =~ /^( *)\S/
+      indent(n - $1.length)
+    else
+      self
+    end
+  end
+
+  # Indent left or right by n spaces.
+  # (This used to be called #tab and aliased as #indent.)
+  def indent(n, c=' ')
+    if n >= 0
+      gsub(/^/, c * n)
+    else
+      gsub(/^#{Regexp.escape(c)}{0,#{-n}}/, "")
+    end
+  end
+
+end
+

data/lib/tapout/parsers/json.rb

@@ -19,7 +19,7 @@ module TapOut
       while line = input.gets
         self << line
       end
-      return @reporter.exit_code
+      @reporter.finalize
     end
 
     #

data/lib/tapout/reporters.rb

@@ -1,7 +1,11 @@
 require 'tapout/reporters/abstract'
-require 'tapout/reporters/breakdown'
-require 'tapout/reporters/dotprogress'
-require 'tapout/reporters/html'
-require 'tapout/reporters/outline'
-require 'tapout/reporters/progressbar'
-require 'tapout/reporters/tap'
+
+require 'tapout/reporters/dot_reporter'
+require 'tapout/reporters/pretty_reporter'
+require 'tapout/reporters/turn_reporter'
+require 'tapout/reporters/html_reporter'
+require 'tapout/reporters/outline_reporter'
+require 'tapout/reporters/progress_reporter'
+require 'tapout/reporters/breakdown_reporter'
+require 'tapout/reporters/tap_reporter'
+

data/lib/tapout/reporters/abstract.rb

@@ -22,9 +22,11 @@ module TapOut
     #
     # TODO: Simplify this class and have the sublcasses handle more of the load.
     class Abstract
+
       # When Abstract is inherited it saves a reference to it in `Reporters.index`.
       def self.inherited(subclass)
         name = subclass.name.split('::').last.downcase
+        name = name.chomp('reporter')
         Reporters.index[name] = subclass
       end
 
@@ -36,55 +38,16 @@ module TapOut
         @skipped = []
         @omitted = []
 
-        @source        = {}
-        @previous_case = nil
-        @exit_code     = 0  # assume passing
+        @case_stack = []
+        @source     = {}
+        @exit_code  = 0  # assume passing
       end
 
-      # Exit code.
-      def exit_code
+      # When all is said and done.
+      def finalize
         @exit_code
       end
 
-      #
-      def <<(entry)
-        handle(entry)
-      end
-
-      # Handler method. This dispatches a given entry to the appropriate
-      # report methods.
-      def handle(entry)
-        case entry['type']
-        when 'suite'
-          start_suite(entry)
-        when 'case'
-          finish_case(@previous_case) if @previous_case
-          @previous_case = entry
-          start_case(entry)
-        when 'note'
-          note(entry)
-        when 'test'
-          test(entry)
-          case entry['status']
-          when 'pass'
-            pass(entry)
-          when 'fail'
-            @exit_code = -1
-            fail(entry)
-          when 'error'
-            @exit_code = -1
-            err(entry)
-          when 'omit'
-            omit(entry)
-          when 'todo', 'skip', 'pending'
-            skip(entry)
-          end
-        when 'tally'
-          finish_case(@previous_case) if @previous_case
-          finish_suite(entry)
-        end
-      end
-
       # Handle header.
       def start_suite(entry)
       end
@@ -93,12 +56,8 @@ module TapOut
       def start_case(entry)
       end
 
-      # Handle an arbitray note.
-      def note(entry)
-      end
-
       # Handle test. This is run before the status handlers.
-      def test(entry)
+      def start_test(entry)
       end
 
       # Handle test with pass status.
@@ -112,7 +71,7 @@ module TapOut
       end
 
       # Handle test with error status.
-      def err(entry)
+      def error(entry)
         @raised << entry
       end
 
@@ -126,16 +85,79 @@ module TapOut
         @skipped << entry
       end
 
+      # Handle an arbitray note.
+      def note(entry)
+      end
+
+      # Handle running tally.
+      def tally(entry)
+      end
+
+      # When a test unit is complete.
+      def finish_test(entry)
+      end
+
       # When a test case is complete.
       def finish_case(entry)
       end
 
-      # Handle footer.
+      # Handle final entry.
       def finish_suite(entry)
       end
 
-      # TODO: get the tally's from the footer entry ?
-      def tally(entry)
+      # -- H A N D L E R --
+
+      #
+      def <<(entry)
+        handle(entry)
+      end
+
+      # Handler method. This dispatches a given entry to the appropriate
+      # report methods.
+      def handle(entry)
+        case entry['type']
+        when 'suite'
+          start_suite(entry)
+        when 'case'
+          complete_cases(entry)
+          @case_stack << entry
+          start_case(entry)
+        when 'note'
+          note(entry)
+        when 'test'
+          start_test(entry)
+          case entry['status']
+          when 'pass'
+            pass(entry)
+          when 'fail'
+            @exit_code = -1
+            fail(entry)
+          when 'error'
+            @exit_code = -1
+            error(entry)
+          when 'omit'
+            omit(entry)
+          when 'todo', 'skip', 'pending'
+            skip(entry)
+          end
+          finish_test(entry)
+        when 'tally'
+          tally(entry)
+        when 'final'
+          complete_cases
+          finish_suite(entry)
+        end
+      end
+
+      # Get the exit code.
+      def exit_code
+        @exit_code
+      end
+
+      # Generate a tally message given a tally or final entry.
+      #
+      # @return [String] tally message
+      def tally_message(entry)
         total = @passed.size + @failed.size + @raised.size #+ @skipped.size + @omitted.size
 
         if entry['counts']
@@ -174,7 +196,9 @@ module TapOut
         end
       end
 
+      # Used to clean-up backtrace.
       #
+      # TODO: Use Rubinius global system instead.
       INTERNALS = /(lib|bin)#{Regexp.escape(File::SEPARATOR)}tapout/
 
       # Clean the backtrace of any reference to ko/ paths and code.
@@ -270,6 +294,19 @@ module TapOut
         returnf source_file, source_line
       end
 
+      #
+      def complete_cases(case_entry=nil)
+        if case_entry
+          while @case_stack.last and @case_stack.last['level'].to_i >= case_entry['level'].to_i
+            finish_case(@case_stack.pop)
+          end
+        else
+          while @case_stack.last
+            finish_case(@case_stack.pop)
+          end
+        end
+      end
+
     end#class Abstract
 
   end#module Reporters