pork 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6be40200d742b7e914299393fd153df6aa2f221
-  data.tar.gz: 5727e914add3a14a117f3a2783f511dbf7309e49
+  metadata.gz: 67d12f898ed53bc341734b4a53f3571e158eed58
+  data.tar.gz: 5930a1821b4ec2bd8bad6d0168baf26561a2edbb
 SHA512:
-  metadata.gz: 5334721d9e117e448255baaca63a13d1295ccbb0518b40bf436925b6dbe9dc14a2ea9884c90024b7bb4f5e565bf106243b022ea34c0b4a4cc67ab83f6abc6f0e
-  data.tar.gz: 20d9b914a4d068d8a6fc4f5660df4ca29523873e2da69680059192775bb5db10336b455cb04db937a4fe7beabb9affa6e751ab0fd43e17b202efa4ad2d029159
+  metadata.gz: 2839c6e48efb8957c9abb05e83f61f0458de4e85e0db11ad5d3b0854891eadcbdfe5b665dc60182b6bf1e5d47c09e670167b4d71d1fcb808977eabc4c63bef2f
+  data.tar.gz: 0fc345ebec361a78a0ba7fba004194197a25f3508ce5d7f70b215a059990ef53581354dff2ce686c1c1c1b922a034bbf24160629e76a16dd514b9f7b20430a15

data/CHANGES.md

@@ -1,5 +1,11 @@
 # CHANGES
 
+## Pork 1.1.3 -- 2015-02-04
+
+* Fixed exit status.
+* Introduced `require 'pork/more'` for colored output and bottom-up backtrace.
+* Introduced `Pork.Rainbows!` for fun.
+
 ## Pork 1.1.2 -- 2015-01-28
 
 * Really fixed passing `ENV['PORK_MODE']=execute`. I should sleep now.

data/README.md

@@ -284,6 +284,7 @@ Here's what `require 'pork/auto'` would do:
 ``` ruby
 require 'pork'
 require 'pork/should'
+require 'pork/more'
 extend Pork::API
 Pork.autorun
 ```
@@ -329,6 +330,12 @@ could re-enable it.
 
 [mutant]: https://github.com/mbj/mutant
 
+Also note that there's a number of plugins would be loaded upon:
+
+``` ruby
+require 'pork/more'
+```
+
 ## Where's the pork command?
 
 It's not implemented. No strong reasons. You could simply run the tests by
@@ -860,6 +867,10 @@ Pork.inspect_failure_mode :newline
 
 Then it would always use the mode we specified.
 
+### Pork.Rainbows!
+
+Have you seen Rainbows!?
+
 ## CONTRIBUTORS:
 
 * Chun-Yi Liu (@trantorliu)

data/TODO.md

@@ -0,0 +1,4 @@
+
+* remove sequential tests
+* introduce configs
+* plugin: color/reverse backtrace, replicating command, inspect mode

data/lib/pork.rb

@@ -17,6 +17,11 @@ module Pork
     @execute = execute || @execute ||= :execute
   end
 
+  def self.Rainbows!
+    require 'pork/extra/rainbows'
+    Pork::Stat.__send__(:include, Pork::Rainbows)
+  end
+
   def self.stat
     @stat ||= Pork::Stat.new
   end
@@ -32,8 +37,8 @@ module Pork
   def self.trap sig='SIGINT'
     Signal.trap(sig) do
       stat.report
-      puts "\nterminated by signal SIGINT"
-      exit! 255
+      puts "\nterminated by signal #{sig}"
+      exit 255
     end
   end
 
@@ -49,7 +54,7 @@ module Pork
         end
       else
         puts "Cannot find test: #{ENV['PORK_TEST']}"
-        exit! 254
+        exit 254
       end
     else
       @stat = Executor.public_send(execute_mode, stat)
@@ -67,7 +72,7 @@ module Pork
       trap
       run
       stat.report
-      exit! stat.failures.size + stat.errors.size + ($! && 1).to_i
+      exit stat.failures + stat.errors + ($! && 1).to_i
     end
   end
 end

data/lib/pork/auto.rb

@@ -1,5 +1,6 @@
 
 require 'pork'
 require 'pork/should'
+require 'pork/more'
 extend Pork::API
 Pork.autorun

data/lib/pork/extra/rainbows.rb

@@ -0,0 +1,23 @@
+
+module Pork
+  module Rainbows
+    def case_pass msg='.'
+      @rainbows ||= 0
+      io.print( color256(rainbows(@rainbows)){msg} )
+      @rainbows  += 1
+    end
+
+    private
+    def color256 rgb
+      "\e[38;5;#{rgb}m#{yield}\e[0m"
+    end
+
+    def rainbows i
+      n = (i%42) / 6.0
+      r = Math.sin(n + 0*Math::PI/3) * 3 + 3
+      g = Math.sin(n + 2*Math::PI/3) * 3 + 3
+      b = Math.sin(n + 4*Math::PI/3) * 3 + 3
+      16 + 36*r.to_i + 6*g.to_i + b.to_i
+    end
+  end
+end

data/lib/pork/imp.rb

@@ -52,7 +52,7 @@ module Pork
         if assertions == stat.assertions
           raise Error.new('Missing assertions')
         end
-        stat.io.print '.'
+        stat.case_pass
       end
     ensure
       stat.incr_tests
@@ -65,13 +65,13 @@ module Pork
       case e
       when Skip
         stat.incr_skips
-        stat.io.print 's'
+        stat.case_skip
       when Failure
         stat.add_failure(e, description_for("would #{desc}"))
-        stat.io.print 'F'
+        stat.case_failed
       when Error, StandardError
         stat.add_error(  e, description_for("would #{desc}"))
-        stat.io.print 'E'
+        stat.case_errored
       end
     end
 

data/lib/pork/more.rb

@@ -0,0 +1,8 @@
+
+require 'pork/stat'
+
+require 'pork/more/bottomup_backtrace'
+require 'pork/more/color'
+
+Pork::Stat.__send__(:include, Pork::BottomupBacktrace)
+Pork::Stat.__send__(:include, Pork::Color)

data/lib/pork/more/bottomup_backtrace.rb

@@ -0,0 +1,9 @@
+
+module Pork
+  module BottomupBacktrace
+    private
+    def backtrace err
+      super.reverse
+    end
+  end
+end

data/lib/pork/more/color.rb

@@ -0,0 +1,59 @@
+
+module Pork
+  module Color
+    def case_skip    msg='s'; super(yellow {msg}); end
+    def case_failed  msg='F'; super(magenta{msg}); end
+    def case_errored msg='E'; super(red    {msg}); end
+
+    private
+    def command name
+      gray{super}
+    end
+
+    def message msg
+      blue{super}
+    end
+
+    def show_exception err
+      magenta{super}
+    end
+
+    def time_spent
+      cyan{super}
+    end
+
+    def numbers
+      super.zip(%w[green green magenta red yellow]).map do |(num, col)|
+        if num == 0
+          num
+        else
+          send(col){ num }
+        end
+      end
+    end
+
+    def backtrace err
+      super.map do |b|
+        path, msgs = b.split(':', 2)
+        dir , file = ::File.split(path)
+        msg = msgs.sub(/(\d+):/){red{$1}+':'}.sub(/`.+?'/){green{$&}}
+
+        "#{dir+'/'}#{yellow{file}}:#{msg}"
+      end
+    end
+
+    def    gray █ color('1;30', &block); end
+    def   black █ color(   30 , &block); end
+    def     red █ color(   31 , &block); end
+    def   green █ color(   32 , &block); end
+    def  yellow █ color(   33 , &block); end
+    def    blue █ color(   34 , &block); end
+    def magenta █ color(   35 , &block); end
+    def    cyan █ color(   36 , &block); end
+    def   white █ color(   37 , &block); end
+
+    def color rgb
+      "\e[#{rgb}m#{yield}\e[0m"
+    end
+  end
+end

data/lib/pork/stat.rb

@@ -2,26 +2,42 @@
 require 'thread'
 
 module Pork
-  class Stat < Struct.new(:io, :start, :mutex,
-                          :tests, :assertions, :skips, :failures, :errors)
+  Stat = Struct.new(:io, :start, :mutex,
+                    :tests, :assertions, :skips, :failures, :errors,
+                    :exceptions)
+
+  Stat::Imp = Module.new do
     def initialize io=$stdout, st=Time.now, mu=Mutex.new,
-                   t=0, a=0, s=0, f=[], e=[]
+                   t=0, a=0, s=0, f=0, e=0, x=[]
       super
     end
     def incr_assertions; mutex.synchronize{ self.assertions += 1 }; end
     def incr_tests     ; mutex.synchronize{ self.tests      += 1 }; end
     def incr_skips     ; mutex.synchronize{ self.skips      += 1 }; end
-    def add_failure *e ; mutex.synchronize{ failures        << e }; end
-    def add_error   *e ; mutex.synchronize{ errors          << e }; end
-    def passed?; failures.size + errors.size == 0                      ; end
-    def numbers; [tests, assertions, failures.size, errors.size, skips]; end
+    def add_failure *err
+      mutex.synchronize do
+        self.failures += 1
+        exceptions << err
+      end
+    end
+    def add_error *err
+      mutex.synchronize do
+        self.errors += 1
+        exceptions << err
+      end
+    end
+    def case_pass    msg='.'; io.print msg; end
+    def case_skip    msg='s'; io.print msg; end
+    def case_failed  msg='F'; io.print msg; end
+    def case_errored msg='E'; io.print msg; end
+    def passed?; exceptions.size == 0                        ; end
+    def numbers; [tests, assertions, failures, errors, skips]; end
+    def time_spent; Time.now - start; end
     def report
       io.puts
-      io.puts (failures + errors).map{ |(e, m)|
-        "\n#{m}\n#{e.class}: #{e.message}\n  #{backtrace(e)}\n#{command(m)}"
-      }
-      io.printf("\nFinished in %f seconds.\n", Time.now - start)
-      io.printf("%d tests, %d assertions, %d failures, %d errors, %d skips\n",
+      io.puts report_exceptions
+      io.printf("\nFinished in %s seconds.\n", time_spent)
+      io.printf("%s tests, %s assertions, %s failures, %s errors, %s skips\n",
                 *numbers)
     end
     def merge stat
@@ -30,29 +46,53 @@ module Pork
     end
 
     private
-    def backtrace e
+    def report_exceptions
+      exceptions.reverse.map do |(err, msg)|
+        "\n  #{show_command(msg)}"   \
+        "\n  #{show_backtrace(err)}" \
+        "\n#{message(msg)}"          \
+        "\n#{show_exception(err)}"
+      end
+    end
+
+    def show_command name
+      "Replicate this test with:\n#{command(name)}"
+    end
+
+    def command name
+      "#{env(name)} #{Gem.ruby} -S #{$0} #{ARGV.join(' ')}"
+    end
+
+    def show_backtrace err
+      backtrace(err).join("\n  ")
+    end
+
+    def backtrace err
       if $VERBOSE
-        e.backtrace
+        err.backtrace
       else
-        strip(e.backtrace.reject{ |line| line =~ %r{/pork(/\w+)?\.rb:\d+} })
-      end.join("\n  ")
+        strip(err.backtrace.reject{ |line| line =~ %r{/pork(/\w+)?\.rb:\d+} })
+      end
     end
 
-    def strip backtrace
-      strip_home(strip_cwd(backtrace))
+    def message msg
+      msg
     end
 
-    def strip_home backtrace
-      backtrace.map{ |path| path.sub(ENV['HOME'], '~') }
+    def show_exception err
+      "#{err.class}: #{err.message}"
     end
 
-    def strip_cwd backtrace
-      backtrace.map{ |path| path.sub(Dir.pwd, '.') }
+    def strip bt
+      strip_home(strip_cwd(bt))
     end
 
-    def command name
-      "You can replicate this test with the following command:\n  " \
-      "#{env(name)} #{Gem.ruby} -S #{$0} #{ARGV.join(' ')}"
+    def strip_home bt
+      bt.map{ |path| path.sub(ENV['HOME'], '~') }
+    end
+
+    def strip_cwd bt
+      bt.map{ |path| path.sub(Dir.pwd, '.') }
     end
 
     def env name
@@ -71,4 +111,6 @@ module Pork
       "PORK_SEED=#{Pork.seed}"
     end
   end
+
+  Stat.__send__(:include, Stat::Imp)
 end

data/lib/pork/version.rb

@@ -1,4 +1,4 @@
 
 module Pork
-  VERSION = '1.1.2'
+  VERSION = '1.1.3'
 end

data/pork.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: pork 1.1.2 ruby lib
+# stub: pork 1.1.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pork"
-  s.version = "1.1.2"
+  s.version = "1.1.3"
 
   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-01-28"
+  s.date = "2015-02-04"
   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 = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   "LICENSE",
   "README.md",
   "Rakefile",
+  "TODO.md",
   "lib/mutant/integration/pork.rb",
   "lib/pork.rb",
   "lib/pork/auto.rb",
@@ -28,11 +29,15 @@ Gem::Specification.new do |s|
   "lib/pork/error.rb",
   "lib/pork/executor.rb",
   "lib/pork/expect.rb",
+  "lib/pork/extra/rainbows.rb",
   "lib/pork/imp.rb",
   "lib/pork/inspect.rb",
   "lib/pork/isolate.rb",
   "lib/pork/mode/parallel.rb",
   "lib/pork/mode/shuffle.rb",
+  "lib/pork/more.rb",
+  "lib/pork/more/bottomup_backtrace.rb",
+  "lib/pork/more/color.rb",
   "lib/pork/should.rb",
   "lib/pork/stat.rb",
   "lib/pork/test.rb",

data/task/gemgem.rb

@@ -102,6 +102,7 @@ module Gemgem
       if ENV['CI']
         require 'coveralls'
         SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+        SimpleCov.command_name('pork')
       end
       SimpleCov.start do
         add_filter('test/')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pork
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-28 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: muack
@@ -44,6 +44,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- TODO.md
 - lib/mutant/integration/pork.rb
 - lib/pork.rb
 - lib/pork/auto.rb
@@ -52,11 +53,15 @@ files:
 - lib/pork/error.rb
 - lib/pork/executor.rb
 - lib/pork/expect.rb
+- lib/pork/extra/rainbows.rb
 - lib/pork/imp.rb
 - lib/pork/inspect.rb
 - lib/pork/isolate.rb
 - lib/pork/mode/parallel.rb
 - lib/pork/mode/shuffle.rb
+- lib/pork/more.rb
+- lib/pork/more/bottomup_backtrace.rb
+- lib/pork/more/color.rb
 - lib/pork/should.rb
 - lib/pork/stat.rb
 - lib/pork/test.rb