pork 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 095bec1d9b0e5589ead858fce38929b381210569
-  data.tar.gz: a311efe4b88dd95d9d3121092ebd716227d6e207
+  metadata.gz: d777bebd67882252ec22825a62266878e8afb245
+  data.tar.gz: 5b59151244bdf671ca2c239b9eb503dd43eb04a4
 SHA512:
-  metadata.gz: d580f3bb350761f874bfa061d554cb0d7c2f8a4fd74ac6fe90465c9c06100f89fba3186d452751f8a28bd72ebc4a7727ec0862b0523727cdf463f701531378d1
-  data.tar.gz: af26e6604565d1b9041b30f0a993cae03c58ac4bcf515f376eb0bdaa187c3d5b3da0b6e683b49a82daae58d8a64fe36b5edb646cf366e618744a0715af17f402
+  metadata.gz: 7345227bf8de435f9673db212c5d255dfd4ec2f11f73caa5cd9b2154d99491fe3e159c7d293e3e3b7c42d1696c935dab8c0279ccea4211e26b9a081d6763531a
+  data.tar.gz: 11175993f303c48a9984e0f967bb713b1a28c17c214badc2dc73cb98e1f8eada9d2a6ecdb14fc923121b9f01253b18da2cdf286c58c7fbbcba7701a3598af37d

data/CHANGES.md

@@ -1,5 +1,16 @@
 # CHANGES
 
+## Pork 1.2.4 -- 2015-04-25
+
+### Enhancement
+
+* Introduced `Pork.show_source` to print the source of failing tests. Using
+  this feature requires `method_source` installed.
+
+### Bugs fixed
+
+* Fixed a potential data race in parallel tests using `should`.
+
 ## Pork 1.2.3 -- 2015-04-16
 
 ### Enhancement

data/README.md

@@ -148,6 +148,10 @@ end
 ## REQUIREMENTS:
 
 * Tested with MRI (official CRuby), Rubinius and JRuby.
+* (Optional) [method_source][] if you would like to print the source for the
+  failing tests.
+
+[method_source]: https://github.com/banister/method_source
 
 ## INSTALLATION:
 
@@ -931,6 +935,25 @@ Pork.autorun(true)  # enable
 
 `require 'pork/auto'` would call `Pork.autorun`
 
+### Pork.show_source
+
+If you have [method_source][] installed, you could call this and have Pork
+print the source to the failing lines. Here's an example of what Pork would
+print with `Pork.show_source`:
+
+```
+  Replicate this test with:
+env PORK_TEST='test/test_pork.rb:12' PORK_MODE=shuffled PORK_SEED=345 /usr/bin/ruby -S test/test_pork.rb
+  test/test_pork.rb:13:in `block in <main>'
+     would 'print the source' do
+  =>   flunk
+     end
+would print the source
+Pork::Error: Flunked
+```
+
+[method_source]: https://github.com/banister/method_source
+
 ### Pork.Rainbows!
 
 Have you seen Rainbows!?
@@ -940,6 +963,7 @@ Have you seen Rainbows!?
 * Chun-Yi Liu (@trantorliu)
 * Lin Jen-Shin (@godfat)
 * Josh Kalderimis (@joshk)
+* Yang-Hsing Lin (@mz026)
 
 ## LICENSE:
 

data/Rakefile

@@ -10,5 +10,5 @@ Gemgem.init(dir) do |s|
   require 'pork/version'
   s.name    = 'pork'
   s.version = Pork::VERSION
-  %w[muack].each{ |g| s.add_development_dependency(g) }
+  %w[method_source].each{ |g| s.add_development_dependency(g) }
 end

data/lib/pork.rb

@@ -22,6 +22,11 @@ module Pork
     Pork::Stat.__send__(:include, Pork::Rainbows)
   end
 
+  def self.show_source
+    require 'pork/extra/show_source'
+    Pork::Stat.__send__(:include, Pork::ShowSource)
+  end
+
   def self.stat
     @stat ||= Pork::Stat.new
   end

data/lib/pork/extra/show_source.rb

@@ -0,0 +1,33 @@
+
+require 'method_source'
+
+module Pork
+  module ShowSource
+    def show_source test, err
+      source = test.source
+      sopath = "#{test.source_location.first}:"
+      lowers = test.source_location.last
+      uppers = lowers + source.size
+      lineno = reject_pork(test, err).find do |backtrace|
+        # find the line from the test source, exclude everything else
+        next unless backtrace.start_with?(sopath)
+        number = backtrace[/(?<=\.rb:)\d+/].to_i
+        break number if number >= lowers && number < uppers
+      end
+      return '' unless lineno # TODO: error might be coming from before block
+      lowerl = lineno - lowers
+      upperl = MethodSource.expression_at(source, lowerl + 1).
+                 count("\n") + lowerl
+      indent = source[/^\s*/].size
+      result = source.each_line.with_index.map do |source_line, index|
+        line = source_line[indent..-1] || "\n"
+        if index >= lowerl && index < upperl
+          highlight_line("  => #{line}")
+        else
+          backlight_line("     #{line}")
+        end
+      end.join
+      "\n#{result.chomp}"
+    end
+  end
+end

data/lib/pork/imp.rb

@@ -25,7 +25,7 @@ module Pork
     end
 
     def would desc=:default, opts={}, &test
-      @tests << [:would, desc, test, opts]
+      @tests << [:would, desc, test || lambda{}, opts]
     end
 
     def execute mode, *args
@@ -67,7 +67,7 @@ module Pork
         stat.incr_skips
         stat.case_skip
       else
-        err = [e, description_for("would #{desc}"), test.source_location]
+        err = [e, description_for("would #{desc}"), test]
         case e
         when Failure
           stat.add_failure(err)

data/lib/pork/mode/parallel.rb

@@ -10,7 +10,7 @@ module Pork
     def parallel stat=Stat.new, paths=all_paths
       paths.shuffle.each_slice(cores).map do |paths_slice|
         Thread.new do
-          execute(:shuffled, Stat.new, paths_slice)
+          execute(:shuffled, Stat.new(stat.io), paths_slice)
         end
       end.map(&:value).inject(stat, &:merge)
     end

data/lib/pork/more/bottomup_backtrace.rb

@@ -4,7 +4,7 @@ require 'pork/stat'
 module Pork
   module BottomupBacktrace
     private
-    def backtrace err
+    def backtrace *_
       super.reverse
     end
   end

data/lib/pork/more/color.rb

@@ -12,7 +12,7 @@ module Pork
       gray(super)
     end
 
-    def message msg
+    def show_message msg
       blue(super)
     end
 
@@ -20,6 +20,10 @@ module Pork
       magenta(super)
     end
 
+    def highlight_line line
+      "#{color(41, super.chomp)}\n"
+    end
+
     def time_spent
       cyan(super)
     end
@@ -40,7 +44,7 @@ module Pork
       end
     end
 
-    def backtrace err
+    def backtrace *_
       super.map do |b|
         path, msgs = b.split(':', 2)
         dir , file = ::File.split(path)

data/lib/pork/more/should.rb

@@ -13,10 +13,12 @@ module Pork
     def execute mode, stat=Stat.new, *args
       thread = Thread.current
       original_group, group = thread.group, ThreadGroup.new
+      original_stat = thread[:pork_stat]
       group.add(thread)
       thread[:pork_stat] = stat
       super(mode, stat, *args)
     ensure
+      thread[:pork_stat] = original_stat
       original_group.add(thread)
     end
   end

data/lib/pork/stat.rb

@@ -55,10 +55,11 @@ module Pork
 
     private
     def report_exceptions
-      exceptions.reverse_each.map do |(err, msg, source_location)|
-        "\n  #{show_command(source_location)}"   \
-        "\n  #{show_backtrace(err)}" \
-        "\n#{message(msg)}"          \
+      exceptions.reverse_each.map do |(err, msg, test)|
+        "\n  #{show_command(test.source_location)}" \
+        "\n  #{show_backtrace(test, err)}"          \
+        "#{show_source(test, err)}"                 \
+        "\n#{show_message(msg)}"                    \
         "\n#{show_exception(err)}"
       end
     end
@@ -71,19 +72,31 @@ module Pork
       "#{env(source_location)} #{Gem.ruby} -S #{$0} #{ARGV.join(' ')}"
     end
 
-    def show_backtrace err
-      backtrace(err).join("\n  ")
+    def show_backtrace test, err
+      backtrace(test, err).join("\n  ")
     end
 
-    def backtrace err
+    def backtrace test, err
       if $VERBOSE
         err.backtrace
       else
-        strip(err.backtrace.reject{ |l| l =~ %r{/lib/pork(/\w+)*\.rb:\d+} })
+        strip(reject_pork(test, err))
       end
     end
 
-    def message msg
+    def show_source _, _
+      ''
+    end
+
+    def highlight_line line
+      line
+    end
+
+    def backlight_line line
+      line
+    end
+
+    def show_message msg
       msg
     end
 
@@ -91,6 +104,15 @@ module Pork
       "#{err.class}: #{err.message}"
     end
 
+    def reject_pork test, err
+      bt = err.backtrace.reject{ |l| l =~ %r{/lib/pork(/\w+)*\.rb:\d+} }
+      if bt.empty?
+        ["#{test.source_location.join(':')}:in `block in would'"]
+      else
+        bt
+      end
+    end
+
     def strip bt
       strip_home(strip_cwd(bt))
     end

data/lib/pork/test.rb

@@ -2,6 +2,7 @@
 require 'pork/auto'
 
 Pork.autorun(false)
+Pork.show_source
 
 at_exit do
   Pork.module_eval do

data/lib/pork/version.rb

@@ -1,4 +1,4 @@
 
 module Pork
-  VERSION = '1.2.3'
+  VERSION = '1.2.4'
 end

data/pork.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: pork 1.2.3 ruby lib
+# stub: pork 1.2.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pork"
-  s.version = "1.2.3"
+  s.version = "1.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2015-04-16"
+  s.date = "2015-04-25"
   s.description = "Pork -- Simple and clean and modular testing library.\n\nInspired by [Bacon][].\n\n[Bacon]: https://github.com/chneukirchen/bacon"
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
   "lib/pork/executor.rb",
   "lib/pork/expect.rb",
   "lib/pork/extra/rainbows.rb",
+  "lib/pork/extra/show_source.rb",
   "lib/pork/imp.rb",
   "lib/pork/inspect.rb",
   "lib/pork/mode/parallel.rb",
@@ -49,7 +50,8 @@ Gem::Specification.new do |s|
   "test/test_nested.rb",
   "test/test_pork_test.rb",
   "test/test_readme.rb",
-  "test/test_should.rb"]
+  "test/test_should.rb",
+  "test/test_stat.rb"]
   s.homepage = "https://github.com/godfat/pork"
   s.licenses = ["Apache License 2.0"]
   s.rubygems_version = "2.4.6"
@@ -60,17 +62,18 @@ Gem::Specification.new do |s|
   "test/test_nested.rb",
   "test/test_pork_test.rb",
   "test/test_readme.rb",
-  "test/test_should.rb"]
+  "test/test_should.rb",
+  "test/test_stat.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<muack>, [">= 0"])
+      s.add_development_dependency(%q<method_source>, [">= 0"])
     else
-      s.add_dependency(%q<muack>, [">= 0"])
+      s.add_dependency(%q<method_source>, [">= 0"])
     end
   else
-    s.add_dependency(%q<muack>, [">= 0"])
+    s.add_dependency(%q<method_source>, [">= 0"])
   end
 end

data/test/test_nested.rb

@@ -52,7 +52,7 @@ describe 'A' do
 
   would 'skip' do
     skip
-    should.flunk
+    flunk
   end
 end
 

data/test/test_stat.rb

@@ -0,0 +1,88 @@
+
+require 'pork/test'
+require 'stringio'
+
+describe Pork::Stat do
+  before do
+    @executor = Class.new(Pork::Executor){init}
+  end
+
+  def run
+    @stat = @executor.execute(Pork.execute_mode, Pork::Stat.new(StringIO.new))
+    expect_one_error
+  end
+
+  def expect_one_error
+    expect(@stat.io.string) .eq "\e[31mE\e[0m"
+    expect(@stat.tests)     .eq 1
+    expect(@stat.assertions).eq 0
+    expect(@stat.errors)    .eq 1
+  end
+
+  would 'always have backtrace' do
+    @executor.would
+    run
+
+    err, _, test = @stat.exceptions.first
+    err.set_backtrace([])
+
+    expect(@stat.send(:show_backtrace, test, err)).not.empty?
+  end
+
+  describe 'Pork::Stat#show_source' do
+    def verify source
+      run
+      err, _, test = @stat.exceptions.first
+      yield(err) if block_given?
+      expect(@stat.send(:show_source, test, err)).include?(source)
+    end
+
+    would 'one line' do
+      @executor.would{ flunk }
+      verify('=> @executor.would{ flunk }')
+    end
+
+    would 'more lines' do
+      @executor.would do
+        flunk
+      end
+      verify(<<-SOURCE.chomp)
+     @executor.would do
+\e[41m  =>   flunk\e[0m
+     end
+      SOURCE
+    end
+
+    would 'multiple lines' do
+      @executor.would do
+        raise \
+          'error'
+      end
+      verify(<<-SOURCE.chomp)
+     @executor.would do
+\e[41m  =>   raise \\\e[0m
+\e[41m  =>     'error'\e[0m
+     end
+      SOURCE
+    end
+
+    would 'show the line in the test, not other methods' do
+      @executor.send(:define_method, :f){ flunk }
+      @executor.would do
+        f
+      end
+      verify(<<-SOURCE.chomp)
+     @executor.would do
+\e[41m  =>   f\e[0m
+     end
+      SOURCE
+    end
+
+    would 'show the line in the test, even if it is from 3rd party' do
+      @executor.would{ flunk }
+      verify("=> @executor.would{ flunk }") do |err|
+        err.set_backtrace(err.backtrace.unshift("bad.rb:#{__LINE__}"))
+      end
+    end
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: pork
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2015-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: muack
+  name: method_source
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,6 +53,7 @@ files:
 - lib/pork/executor.rb
 - lib/pork/expect.rb
 - lib/pork/extra/rainbows.rb
+- lib/pork/extra/show_source.rb
 - lib/pork/imp.rb
 - lib/pork/inspect.rb
 - lib/pork/mode/parallel.rb
@@ -74,6 +75,7 @@ files:
 - test/test_pork_test.rb
 - test/test_readme.rb
 - test/test_should.rb
+- test/test_stat.rb
 homepage: https://github.com/godfat/pork
 licenses:
 - Apache License 2.0
@@ -105,3 +107,4 @@ test_files:
 - test/test_pork_test.rb
 - test/test_readme.rb
 - test/test_should.rb
+- test/test_stat.rb