rubytest 0.3.1 → 0.4.0

data/.ruby

@@ -1,6 +1,7 @@
 ---
 source:
 - var
+- var/
 authors:
 - name: trans
   email: transfire@gmail.com
@@ -8,8 +9,6 @@ copyrights:
 - holder: RubyWorks
   year: '2011'
   license: BSD-2-Clause
-replacements: []
-alternatives: []
 requirements:
 - name: ansi
 - name: detroit
@@ -21,14 +20,15 @@ requirements:
   - test
   development: true
 dependencies: []
+alternatives: []
 conflicts: []
 repositories:
 - uri: git@github.com:rubyworks/ruby-test.git
   scm: git
   name: upstream
 resources:
-  home: http://rubyworks.github.com/ruby-test
-  code: http://github.com/rubyworks/ruby-test
+  home: http://rubyworks.github.com/rubytest
+  code: http://github.com/rubyworks/rubytest
   mail: http://groups.google.com/group/rubyworks-mailinglist
 extra: {}
 load_path:
@@ -37,9 +37,9 @@ revision: 0
 created: '2011-07-23'
 summary: Ruby Universal Test Harness
 title: Ruby Test
-version: 0.3.1
+version: 0.4.0
 name: rubytest
 description: ! "Ruby Test is a universal test harness for Ruby. It can handle any
   compliant \ntest framework, even running tests from multiple frameworks in a single
   pass."
-date: '2011-12-23'
+date: '2012-02-25'

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    rubytest (0.3.1)
+      ansi
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ae (1.8.1)
+      ansi
+    ansi (1.4.1)
+    detroit (0.2.0)
+      facets
+      pom
+    facets (2.9.2)
+    pom (2.1.1)
+    qed (2.6.3)
+      ae (>= 1.7)
+      ansi
+      facets (>= 2.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  detroit
+  qed
+  rubytest!

data/HISTORY.md

@@ -1,5 +1,16 @@
 # RELEASE HISTORY
 
+## 0.4.0 / 2012-02-25
+
+This release primarily consists of implementation tweaks. The most significant
+change is in support of exception priorities, which justify the major verison bump.
+
+Changes:
+
+* Add preliminary support for exception priorities.
+* Capture output for TAP-Y/J reporters.
+
+
 ## 0.3.0 / 2011-12-22
 
 Technically this is a fairly minor release that improves backtrace output

data/README.md

@@ -30,12 +30,12 @@ to be a failed assertion rather than simply an error. Ruby Test extends the
 Exception class to support this method for all exceptions.
 
 A test framework may raise a `NotImplementedError` to have a test recorded
-as "pending" --a _todo_ item to remind the developer of tests that still
+as *todo* --a _pending_ exception to remind the developer of tests that still
 need to be written. The `NotImplementedError` is a standard Ruby exception
-and a subclass of `ScriptError`.
-
-If the `NotImplmentedError` responds in the affirmative to `#assertion?` then
-the test is taken to be a purposeful _omission_, rather than simply pending.
+and a subclass of `ScriptError`. The exception can also set a priority level
+to indicate the urgency of the pending test. Priorities of -1 or lower
+will generally not be brought to the attention of testers unless explicitly 
+configured to do so.
 
 That is the crux of Ruby Test specification. Ruby Test supports some
 additional features that can makes its usage even more convenient.

data/bin/ruby-test

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'rubytest'
+Test::Runner.cli(*ARGV)
+

data/demo/applique/ae.rb

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

data/demo/applique/rubytest.rb

@@ -0,0 +1,2 @@
+require 'rubytest'
+

data/lib/rubytest/code_snippet.rb

@@ -25,7 +25,7 @@ module Test
     #
     def initialize(file, line)
       @file = file
-      @line = line || 1
+      @line = (line || 1).to_i
       @code = CodeSnippet.cache(file)
     end
 

data/lib/rubytest/core_ext/exception.rb

@@ -1,8 +1,19 @@
 class Exception
+
   def set_assertion(boolean)
     @assertion = boolean
-  end
+  end unless defined?(:set_assertion)
+
   def assertion?
     @assertion
-  end
+  end unless defined?(:assertion?)
+
+  def set_priority(integer)
+    @priority = integer.to_i
+  end unless defined?(:set_priority)
+
+  def priority
+    @priority ||= 0
+  end unless defined?(:priority)
+
 end

data/lib/rubytest/core_ext/file.rb

@@ -0,0 +1,8 @@
+class File
+
+  #
+  def self.localname(path)
+    path.sub(Dir.pwd+'/','')
+  end
+
+end

data/lib/rubytest/core_ext.rb

@@ -1,9 +1,11 @@
 if RUBY_VERSION < '1.9'
   require 'rubytest/core_ext/assertion'
   require 'rubytest/core_ext/exception'
+  require 'rubytest/core_ext/file'
   require 'rubytest/core_ext/string'
 else
   require_relative 'core_ext/assertion'
   require_relative 'core_ext/exception'
+  require_relative 'core_ext/file'
   require_relative 'core_ext/string'
 end

data/lib/rubytest/reporters/abstract.rb

@@ -187,7 +187,7 @@ module Test
       def clean_backtrace(exception)
         trace = (Exception === exception ? exception.backtrace : exception)
         return trace if $DEBUG
-        trace = trace.reject{ |t| RUBY_IGNORE_CALLERS.any?{ |r| r =~ t }}
+        trace = trace.reject{ |t| $RUBY_IGNORE_CALLERS.any?{ |r| r =~ t }}
         trace = trace.map do |t|
           i = t.index(':in')
           i ? t[0...i] : t
@@ -198,7 +198,7 @@ module Test
         #  exception.set_backtrace(trace) if Exception === exception
         #  exception
         #end
-        trace.uniq
+        trace.uniq.map{ |bt| File.localname(bt) }
       end
 
       # That an exception, backtrace or source code text and line
@@ -216,17 +216,13 @@ module Test
         end
       end
 
-      #--
-      # TODO: Show more of the file name than just the basename.
-      #++
-
       #
       def file_and_line(exception)
         line = clean_backtrace(exception)[0]
         return "" unless line
         i = line.rindex(':in')
         line = i ? line[0...i] : line
-        File.basename(line)
+        File.localname(line)
       end
 
       #
@@ -240,7 +236,7 @@ module Test
         return ["", 0] unless line
         i = line.rindex(':in')
         line = i ? line[0...i] : line
-        f, l = File.basename(line).split(':')
+        f, l = File.localname(line).split(':')
         return [f, l.to_i]
       end
 

data/lib/rubytest/reporters/abstract_hash.rb

@@ -7,9 +7,12 @@ module Test::Reporters
   #
   class AbstractHash < Abstract
 
+    #
+    # @return [Hash]
     #
     def begin_suite(suite)
       require 'yaml'
+      require 'stringio'
 
       @start_time = Time.now
       @case_level = 0
@@ -23,9 +26,13 @@ module Test::Reporters
         'count' => total_count(suite)
       }
 
+      h['seed'] = suite.seed if suite.respond_to?(:seed)
+
       return h
     end
 
+    #
+    # @return [Hash]
     #
     def begin_case(test_case)
       h = {}
@@ -44,13 +51,21 @@ module Test::Reporters
     #
     def begin_test(test)
       @test_index += 1
+
+      @stdout, @stderr = $stdout, $stderr
+      $stdout, $stderr = StringIO.new, StringIO.new
     end
 
+    # Ruby Test use the term "skip", where as TAP-Y/J uses "omit".
     #
-    def pass(test) #, backtrace=nil)
+    # @todo Maybe the terms can ultimately be reconciled.
+    #
+    # @return [Hash]
+    #
+    def skip_test(test)
       h = {}
       h['type'  ] = 'test'
-      h['status'] = 'pass'
+      h['status'] = 'omit'
 
       merge_subtype      h, test
       merge_setup        h, test
@@ -58,16 +73,20 @@ module Test::Reporters
       #merge_comparison  h, test, exception
       #merge_coverage    h, test
       merge_source       h, test
+      #merge_exception    h, test, exception
+      merge_output       h
       merge_time         h
 
       return h
     end
 
     #
-    def fail(test, exception)
+    # @return [Hash]
+    #
+    def pass(test) #, backtrace=nil)
       h = {}
       h['type'  ] = 'test'
-      h['status'] = 'fail'
+      h['status'] = 'pass'
 
       merge_subtype      h, test
       merge_setup        h, test
@@ -75,75 +94,95 @@ module Test::Reporters
       #merge_comparison  h, test, exception
       #merge_coverage    h, test
       merge_source       h, test
-      merge_exception    h, test, exception
+      merge_output       h
       merge_time         h
- 
+
       return h
     end
 
     #
-    def error(test, exception)
+    # @return [Hash]
+    #
+    def fail(test, exception)
       h = {}
       h['type'  ] = 'test'
-      h['status'] = 'error'
+      h['status'] = 'fail'
 
       merge_subtype      h, test
+      merge_priority     h, test, exception
       merge_setup        h, test
       merge_label        h, test
       #merge_comparison  h, test, exception
       #merge_coverage    h, test
       merge_source       h, test
-      merge_exception    h, test, exception, true
+      merge_exception    h, test, exception
+      merge_output       h
       merge_time         h
-
+ 
       return h
     end
 
     #
-    def todo(test, exception)
+    # @return [Hash]
+    #
+    def error(test, exception)
       h = {}
       h['type'  ] = 'test'
-      h['status'] = 'todo'
+      h['status'] = 'error'
 
       merge_subtype      h, test
+      merge_priority     h, test, exception
       merge_setup        h, test
       merge_label        h, test
       #merge_comparison  h, test, exception
       #merge_coverage    h, test
       merge_source       h, test
-      merge_exception    h, test, exception
+      merge_exception    h, test, exception, true
+      merge_output       h
       merge_time         h
 
       return h
     end
 
     #
-    def omit(test, exception)
+    # @return [Hash]
+    #
+    def todo(test, exception)
       h = {}
-      h['type'  ] = 'test'
-      h['status'] = 'omit'
+      h['type'  ]   = 'test'
+      h['status']   = 'todo'
 
       merge_subtype      h, test
+      merge_priority     h, test, exception
       merge_setup        h, test
       merge_label        h, test
       #merge_comparison  h, test, exception
       #merge_coverage    h, test
       merge_source       h, test
       merge_exception    h, test, exception
+      merge_output       h
       merge_time         h
 
       return h
     end
 
+    #
+    def end_test(test)
+      super(test)
+      $stdout, $stderr = @stdout, @stderr
+    end
+
     #
     def end_case(test_case)
       @case_level -= 1
     end
 
+    #
+    # @return [Hash]
     #
     def end_suite(suite)
       h = {
-        'type'  => 'tally',
+        'type'  => 'final',
         'time'  => Time.now - @start_time,
         'counts' => {
           'total' => total,
@@ -159,12 +198,23 @@ module Test::Reporters
 
   private
 
+    # For todo entries in particulr, i.e. NotImplementedError
+    # exception, the return value represents the "todo" priority
+    # level. The `Exception#priority` method returns an Integer
+    # to set the priority level higher or lower, where higher
+    # the number the more urgent the priority.
+    #
+    def merge_priority(hash, test, exception)
+      level = exception.priority
+      h['priority'] = level.to_i
+    end
+
     #
     def merge_subtype(hash, test)
       hash['subtype'] = test.type.to_s if test.respond_to?(:type)
     end
 
-    # TODO: topic or setup ?
+    # RubyTest uses the term `topic`, where as TAP-Y/J uses `setup`.
     def merge_setup(hash, test)
       #hash['setup'] = test.setup.to_s if test.respond_to?(:setup)
       hash['setup'] = test.topic.to_s if test.respond_to?(:topic)
@@ -175,7 +225,7 @@ module Test::Reporters
       hash['label'] = test.to_s.strip
     end
 
-    # NOTE: Not presently used.
+    # TODO: This is not presently used.
     def merge_comparison(hash, test, exception)
       hash['returned'] = exception.returned
       hash['expected'] = exception.expected
@@ -203,17 +253,37 @@ module Test::Reporters
       hash['exception']['backtrace'] = clean_backtrace(exception) if bt
     end
 
-    # TODO: Really?
+    # TODO: This is still an "idea in progress" for both RybyTest and Tap-Y/J.
+    #
+    # There are a number of different types of code coverage.
+    #
+    #   http://en.wikipedia.org/wiki/Code_coverage
+    #
+    # If we were to provide this, we'd have LOC coverage, probably
+    # given as a list of `file:from-to`, and UNIT coverage, a list
+    # of classes/modules and methods addressed.
+    #
     def merge_coverage(hash, test)
-      if test.respond_to?(:file_coverage) or test.respond_to?(:code_coverage)
-        fc = test.file_coverage
-        cc = test.code_coverage
+      loc, unit = nil, nil
+      if test.respond_to?(:loc)
+        loc = test.loc
+      end
+      if test.respond_to?(:unit)
+        unit = test.unit
+      end
+      if loc or unit
         hash['coverage'] = {}
-        hash['coverage']['file'] = fc if fc
-        hash['coverage']['code'] = cc if cc
+        hash['coverage']['loc']  = loc  if loc
+        hash['coverage']['unit'] = unit if unit
       end
     end
 
+    #
+    def merge_output(hash)
+      hash['stdout'] = $stdout.string
+      hash['stderr'] = $stderr.string
+    end
+
     #
     def merge_time(hash)
       hash['time'] = Time.now - @start_time

data/lib/rubytest/reporters/dotprogress.rb

@@ -66,6 +66,7 @@ module Test::Reporters
           puts "    #{exception}"
           puts "    #{file_and_line(exception)}"
           puts code(exception)
+          puts "    " + clean_backtrace(exception).join("\n    ")
           puts
         end
       end
@@ -77,6 +78,7 @@ module Test::Reporters
           puts "    #{exception}"
           puts "    #{file_and_line(exception)}"
           puts code(exception)
+          puts "    " + clean_backtrace(exception).join("\n    ")
           puts
         end
       end

data/lib/rubytest/reporters/tapj.rb

@@ -6,6 +6,8 @@ module Test::Reporters
   #
   class Tapj < AbstractHash
 
+    REVISION = 5
+
     #
     def initialize(runner)
       require 'json'
@@ -14,7 +16,9 @@ module Test::Reporters
 
     #
     def begin_suite(suite)
-      puts super(suite).to_json
+      hash = super(suite)
+      hash['rev'] = REVISION
+      puts hash.to_json
     end
 
     #

data/lib/rubytest/reporters/tapy.rb

@@ -6,6 +6,8 @@ module Test::Reporters
   #
   class Tapy < AbstractHash
 
+    REVISION = 5
+
     #
     def initialize(runner)
       require 'json'
@@ -14,7 +16,9 @@ module Test::Reporters
 
     #
     def begin_suite(suite)
-      puts super(suite).to_yaml
+      hash = super(suite)
+      hash['rev'] = REVISION
+      puts hash.to_json
     end
 
     #

data/lib/rubytest/runner.rb

@@ -168,15 +168,16 @@ module Test
 
   private
 
-    # Add to RUBY_IGNORE_CALLERS.
+    # Add to $RUBY_IGNORE_CALLERS.
     #
     # @todo Improve on this!
     def ignore_callers
       ignore_path   = File.expand_path(File.join(__FILE__, '../../..'))
       ignore_regexp = Regexp.new(Regexp.escape(ignore_path))
 
-      ::RUBY_IGNORE_CALLERS << ignore_regexp
-      ::RUBY_IGNORE_CALLERS << /bin\/rubytest/
+      $RUBY_IGNORE_CALLERS ||= {}
+      $RUBY_IGNORE_CALLERS << ignore_regexp
+      $RUBY_IGNORE_CALLERS << /bin\/rubytest/
     end
 
     #
@@ -233,11 +234,11 @@ module Test
       rescue *OPEN_ERRORS => exception
         raise exception
       rescue NotImplementedError => exception
-        if exception.assertion?
-          observers.each{ |o| o.omit(test, exception) }
-        else
+        #if exception.assertion?  # TODO: May require assertion? for todo in future
           observers.each{ |o| o.todo(test, exception) }
-        end
+        #else
+        #  observers.each{ |o| o.error(test, exception) }
+        #end
       rescue Exception => exception
         if exception.assertion?
           observers.each{ |o| o.fail(test, exception) }

data/lib/rubytest.rb

@@ -1,9 +1,9 @@
 # Ruby Test - a Universal Ruby Test Harness
 
 $TEST_SUITE = [] unless defined?($TEST_SUITE)
+$RUBY_IGNORE_CALLERS = [] unless defined?($RUBY_IGNORE_CALLERS)
 
-RUBY_IGNORE_CALLERS = [] unless defined?(RUBY_IGNORE_CALLERS)
-
+require 'brass'
 require 'ansi/core'
 
 if RUBY_VERSION < '1.9'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubytest
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-23 00:00:00.000000000 Z
+date: 2012-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &31513800 !ruby/object:Gem::Requirement
+  requirement: &25844320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *31513800
+  version_requirements: *25844320
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &31513160 !ruby/object:Gem::Requirement
+  requirement: &25843760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *31513160
+  version_requirements: *25843760
 - !ruby/object:Gem::Dependency
   name: qed
-  requirement: &31512480 !ruby/object:Gem::Requirement
+  requirement: &25843200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,13 +43,14 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *31512480
+  version_requirements: *25843200
 description: ! "Ruby Test is a universal test harness for Ruby. It can handle any
   compliant \ntest framework, even running tests from multiple frameworks in a single
   pass."
 email:
 - transfire@gmail.com
 executables:
+- ruby-test
 - rubytest
 extensions: []
 extra_rdoc_files:
@@ -59,16 +60,19 @@ extra_rdoc_files:
 files:
 - .ruby
 - .test
+- bin/ruby-test
 - bin/rubytest
 - demo/01_test.md
 - demo/02_case.md
-- demo/applique/ruby-test.rb
+- demo/applique/ae.rb
+- demo/applique/rubytest.rb
 - lib/rubytest/autorun.rb
 - lib/rubytest/cli.rb
 - lib/rubytest/code_snippet.rb
 - lib/rubytest/config.rb
 - lib/rubytest/core_ext/assertion.rb
 - lib/rubytest/core_ext/exception.rb
+- lib/rubytest/core_ext/file.rb
 - lib/rubytest/core_ext/string.rb
 - lib/rubytest/core_ext.rb
 - lib/rubytest/rake.rb
@@ -88,10 +92,11 @@ files:
 - lib/rubytest.rb
 - lib/test.rb
 - test/basic_case.rb
+- Gemfile.lock
 - HISTORY.md
 - README.md
 - NOTICE.md
-homepage: http://rubyworks.github.com/ruby-test
+homepage: http://rubyworks.github.com/rubytest
 licenses:
 - BSD-2-Clause
 post_install_message: 
@@ -112,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Ruby Universal Test Harness

data/demo/applique/ruby-test.rb

@@ -1,2 +0,0 @@
-require 'test/runner'
-