tapout 0.4.2 → 0.4.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f06f3d6528ca8666a65d9b3b2534c69b90a1ffcc
+  data.tar.gz: a3cf2becce94f8281a017965750df1192d2a73dc
+SHA512:
+  metadata.gz: 4e6d0606742ac06e568612e92d138850136f3863cc3163872c4388946e8f06118874ae3a961ac358e4ae3d2d4169a13512b2cb4b0c5220a50046834d54f88ea3
+  data.tar.gz: fcf37269ea2495e8138670852e7446486aedd15e1acf27476df3cadbc036b6ad5fab116f665801a2bfd3679d1ea3d50cb05f60b3546db41b9a95397d17eb0ca8

data/.index

@@ -60,11 +60,11 @@ customs: []
 paths:
   lib:
   - lib
-created: '2010-12-23'
-summary: Progressive TAP Harness
-title: TAPOUT
-version: 0.4.2
 name: tapout
+title: TAPOUT
+summary: Progressive TAP Harness
+created: '2010-12-23'
 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.
-date: '2013-03-17'
+version: 0.4.3
+date: '2013-11-18'

data/HISTORY.md

@@ -1,5 +1,17 @@
 # RELEASE HISTORY
 
+## 0.4.3 / 2013-11-18
+
+New feature allows producers to emit a *pause document* and 
+*resume document* code to halt and resume test result processing.
+While processing is halted, $stdin is directed back to $stdout
+uninterpreted.
+
+Changes:
+
+* Add support for pause and resume code.
+
+
 ## 0.4.2 / 2013-03-18
 
 This release adds support for trace depth and snippet size options.

data/README.md

@@ -33,16 +33,17 @@ For information about TAP, see http://testanything.org/wiki/index.php/Main_Page.
 
 To use TAPOUT you need either a plugin for your current test framework, or use of
 a test framework that supports TAP-Y/J out of the box. You can find a 
-[list of plugins here](https://https://github.com/rubyworks/tapout/wiki)
+[list of plugins here](https://github.com/rubyworks/tapout/wiki)
 under the section "Producers".
 
-Using a test framework that produces a TAP-Y output stream, simply pipe
-the stream into `tapout`.
+With a test framework that produces a TAP-Y/J output stream in hand pipe the
+output stream into the `tapout` command by using a standard command line pipe.
 
     $ rubytest -y -Ilib test/foo.rb | tapout
 
-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 `dot`.
+TAPOUT supports a variety of output formats. The default is the common
+dot-progress format (simply called `dot`). Other formats are selectable
+via the `tapout` command's first argument.
 
     $ rubytest -y -Ilib test/foo.rb | tapout progessbar
 
@@ -57,12 +58,49 @@ 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.
+If your test framework does not support TAP-Y/J, but does support traditional
+TAP, TAPOUT will automatically recognize the difference by TAP's `1..N` header
+and automatically translate it.
 
     $ rubytest -ftap -Ilib test/foo.rb | tapout progressbar
 
 
+## Bypassing
+
+Since tapout receives test results via a pipe, it has no direct control over
+the producer, i.e the test runner. If you need to tell tapout to stop processing
+the output then you can send a *PAUSE DOCUMENT* code. Likewise you can restart
+processing by sending a *RESUME DOCUMENT* code. These codes are taken
+from ASCII codes for DLE (Data Link Escape) and ETB (End of Transmission Block),
+respectively. When tapout receives a *PAUSE DOCUMENT* code, it stops interpreting
+any data it receives as test results and instead just routes `$stdin` back
+to `$stdout` unmodified.
+
+A good example of this is debugging with Pry using `binding.pry`.
+
+    def test_something
+      STDOUT.puts 16.chr  # tells tapout to pause processing
+      binding.pry
+      STDOUT.puts 23.char # tells tapout to start again
+      assert somthing
+    end
+
+As it turns out, if your are using TAP-Y (not TAP-J) then you can also
+use YAML's *END DOCUMENT* and *NEW DOCUMENT* markers to acheive the
+same effect.
+
+    def test_something
+      STDOUT.puts "..."  # tells tapout to pause processing
+      binding.pry
+      STDOUT.puts "---"  # tells tapout to start again
+      assert somthing
+    end
+
+But remember that **only works for YAML**!
+
+Note: when sending these codes, be sure to send a newline character as well. 
+
+
 ## Legal
 
 Copyright (c) 2010 Rubyworks

data/demo/01_reporters/fixtures/tapy.yml

@@ -65,7 +65,7 @@ status: pass
 label: test_passing
 time: 1.04997403
 ---
-type: tally
+type: final
 time: 1.000800203
 counts:
   total: 3

data/lib/tapout/parsers/abstract.rb

@@ -0,0 +1,27 @@
+require 'tapout/reporters'
+
+module Tapout
+
+  class AbstractParser
+
+    # ASCII DLE (Data Link Escape)
+    PAUSE_DOCUMENT  = 16.chr + "\n" #"...\n"
+
+    # ASCII ETB (End of Transmission Block)
+    RESUME_DOCUMENT = 23.chr + "\n" #"---\n"
+
+    # Passthru incoming data directly to `$stdout`.
+    #
+    def passthru(doc=nil)
+      $stdout << doc if doc
+      while line = @input.gets
+        return line if line == RESUME_DOCUMENT
+        $stdout << line
+      end
+      return ''
+    end
+
+  end
+
+end
+

data/lib/tapout/parsers/json.rb

@@ -1,3 +1,4 @@
+require 'tapout/parsers/abstract'
 require 'tapout/reporters'
 require 'json'
 
@@ -6,34 +7,57 @@ module Tapout
   # The TAP-J Parser takes a TAP-J stream and routes it through
   # a Tapout report format.
   #
-  class JsonParser
+  class JsonParser < AbstractParser
 
     #
     def initialize(options={})
       format    = options[:format]
       @reporter = Reporters.factory(format).new
+      @input    = options[:input] || $stdin
     end
 
+    # Read from input using `gets` and parse, routing entries to reporter.
     #
-    def consume(input)
+    # input - Input channel, defaults to $stdin. [#gets]
+    #
+    # Returns reporter exit code.
+    def consume(input=nil)
+      @input = input if input
+
       while line = input.gets
-        self << line
+        case line
+        when PAUSE_DOCUMENT
+          passthru
+        when RESUME_DOCUMENT  # has no effect here
+        else
+          handle(line)
+        end
       end
+
       @reporter.finalize
     end
 
-    #
-    def <<(line)
-      handle(line)
-    end
+    # Alias for consume.
+    alias read consume
 
+    # Handle document entry.
     #
-    def handle(doc)
-      return if doc == ''
-      entry = JSON.load(doc)
-      @reporter << entry
+    # Returns nothing.
+    def handle(entry)
+      return if entry.empty?
+      return if entry == RESUME_DOCUMENT
+
+      begin
+        data = JSON.load(entry)
+        @reporter << data
+      rescue JSON::ParserError
+        passthru(entry)
+      end
     end
 
+    # Alias for handle.
+    alias << handle
+
   end
 
 end

data/lib/tapout/parsers/perl.rb

@@ -1,12 +1,13 @@
 require 'tapout/version'
 require 'tapout/adapters/perl'
 require 'tapout/reporters'
+require 'tapout/parsers/abstract'
 
 module Tapout
 
-  # The TAPLegacy Parser takes a traditional TAP stream and routes
-  # it through a Tap Out report format.
-  class PerlParser
+  # This legacy parser takes a traditional TAP stream and routes
+  # it through a Tapout report format.
+  class PerlParser < AbstractParser
 
     # options[:format] - the report format to use
     def initialize(options={})

data/lib/tapout/parsers/yaml.rb

@@ -1,59 +1,76 @@
+require 'tapout/parsers/abstract'
 require 'tapout/reporters'
 require 'yaml'
 
 module Tapout
 
   # The TAP-Y Parser takes a TAP-Y stream and routes it through
-  # a Tapout report format.
+  # a tapout report format.
   #
-  class YamlParser
+  class YamlParser < AbstractParser
+
+    NEW_DOCUMENT = /^\-\-\-/
+    END_DOCUMENT = /^\.\.\.\s*$/
 
     #
     def initialize(options={})
       format    = options[:format]
       @reporter = Reporters.factory(format).new
-      @doc      = ''
-      @done = false
+      @input    = options[:input] || $stdin
     end
 
+    # Read from input using `gets` and parse, routing
+    # entries to reporter.
     #
-    def consume(input)
-      @doc  = ''
-      @done = false
-      while line = input.gets
-        self << line
-      end
-      handle unless @done   # in case `...` was left out
-      return @reporter.exit_code
-    end
+    # input - Input channel, defaults to $stdin. [#gets]
+    #
+    # Returns reporter exit code.
+    def consume(input=nil)
+      @input = input if input
 
-    # TODO: write this as a YAML stream parser
-    def <<(line)
-      case line
-      when /^\-\-\-/
-        handle #@doc
-        @doc << line
-      when /^\.\.\./
-        handle #@doc
-        stop
-      else
-        @doc << line
+      entry = ''
+      while line = @input.gets
+        case line
+        when PAUSE_DOCUMENT
+          passthru
+        when RESUME_DOCUMENT # (no effect)
+        when END_DOCUMENT
+          handle(entry)
+          entry = passthru
+        when NEW_DOCUMENT
+          handle(entry)
+          entry = line
+        else
+          entry << line
+        end
       end
-    end
+      handle(entry)  # in case final `...` was left out
 
-    #
-    def handle
-      return if @doc == ''
-      entry = YAML.load(@doc)
-      @reporter << entry
-      @doc = ''
+      @reporter.finalize  #@reporter.exit_code
     end
 
+    # Alias for consume.
+    alias read consume
+
+    # Handle document entry.
     #
-    def stop
-      @done = true
+    # Returns nothing.
+    def handle(entry)
+      return if entry.empty?
+      return if entry == NEW_DOCUMENT
+      return if entry == RESUME_DOCUMENT
+
+      begin
+        data = YAML.load(entry)
+        @reporter << data
+      rescue Psych::SyntaxError
+        passthru(entry)
+      end
     end
 
+    # Alias for handle.
+    alias << handle
+
   end
 
 end

data/lib/tapout/reporters/dot_reporter.rb

@@ -77,7 +77,7 @@ module Tapout::Reporters
 
       time, rate, avg = time_tally(entry)
 
-      total, pass, fail, error, todo, omit = count_tally(entry)
+      # total, pass, fail, error, todo, omit = count_tally(entry)
 
       #total = @passed.size + @failed.size + @raised.size + @skipped.size + @omitted.size
       #total = entry['counts']['total'] || total
@@ -89,7 +89,7 @@ module Tapout::Reporters
       puts
       puts "Finished in %.3fs (%.3f test/s, %.6fs avg.)" % [time, rate, avg]
       puts
-      puts "%s tests: %s pass, %s fail, %s exit, %s todo, %s omit" % [total, pass, fail, error, todo, omit]
+      puts tally_message(entry)
     end
 
   end

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: tapout
 version: !ruby/object:Gem::Version
-  version: 0.4.2
-  prerelease: 
+  version: 0.4.3
 platform: ruby
 authors:
 - Thomas Sawyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ergo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: qed
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ae
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Tapout is a TAP consumer that can take any TAP, TAP-Y or TAP-J stream
@@ -100,9 +89,9 @@ executables:
 extensions: []
 extra_rdoc_files:
 - COPYING.md
-- HISTORY.md
 - README.md
 - TAP-YJ.md
+- HISTORY.md
 files:
 - .index
 - .yardopts
@@ -119,6 +108,7 @@ files:
 - lib/tapout/cli.rb
 - lib/tapout/config.rb
 - lib/tapout/core_ext.rb
+- lib/tapout/parsers/abstract.rb
 - lib/tapout/parsers/json.rb
 - lib/tapout/parsers/perl.rb
 - lib/tapout/parsers/yaml.rb
@@ -138,33 +128,31 @@ files:
 - lib/tapout/version.rb
 - lib/tapout.rb
 - COPYING.md
-- HISTORY.md
 - README.md
 - TAP-YJ.md
+- HISTORY.md
 homepage: http://rubyworks.github.com/tapout
 licenses:
 - BSD-2-Clause
+metadata: {}
 post_install_message: 
 rdoc_options: []
 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.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Progressive TAP Harness
 test_files: []
-has_rdoc: