pork 1.5.0 → 2.1.0

data/lib/pork/more/color.rb

@@ -1,6 +1,4 @@
 
-require 'pork'
-
 module Pork
   module Color
     def msg_skip   ;  yellow(super); end

data/lib/pork/more/should.rb

@@ -1,27 +1,27 @@
 
-require 'pork/executor'
-
 module Kernel
   def should *args, &block
-    stat = Thread.current.group.list.find{ |t| t[:pork_stat] }[:pork_stat]
+    stat = Thread.current.group.list.find do |t|
+      t.thread_variable_get(:pork_stat)
+    end.thread_variable_get(:pork_stat)
     Pork::Expect.new(stat, self, *args, &block)
   end
 end
 
 module Pork
   module Should
-    def execute mode, stat=Stat.new, *args
+    def execute stat=Stat.new, *args
       thread = Thread.current
       original_group, group = thread.group, ThreadGroup.new
-      original_stat = thread[:pork_stat]
+      original_stat = thread.thread_variable_get(:pork_stat)
       group.add(thread)
-      thread[:pork_stat] = stat
-      super(mode, stat, *args)
+      thread.thread_variable_set(:pork_stat, stat)
+      super(stat, *args)
     ensure
-      thread[:pork_stat] = original_stat
+      thread.thread_variable_set(:pork_stat, original_stat)
       original_group.add(thread)
     end
   end
 
-  Executor.extend(Should)
+  execute_extensions << Should
 end

data/lib/pork/report/description.rb

@@ -3,7 +3,7 @@ require 'pork/report/dot'
 
 module Pork
   class Description < Dot
-    attr_accessor :last_executor
+    attr_accessor :last_suite
 
     def msg_pass
       msg = "\ro"
@@ -19,17 +19,17 @@ module Pork
     def msg_errored; "\r#{super}"; end
 
     def case_start context
-      self.last_executor ||= Executor
-      executor = context.class
-      levels = executor.ancestors.drop(1).count{ |a| a <= Executor }
+      self.last_suite ||= Suite
+      suite = context.class
+      levels = suite.ancestors.drop(1).count{ |a| a <= Suite }
 
-      if executor != Executor && last_executor != executor
-        io.puts "#{'  ' * (levels - 1)}#{executor.desc}"
+      if suite != Suite && last_suite != suite
+        io.puts "#{'  ' * (levels - 1)}#{suite.desc}"
       end
 
       io.print "#{'  ' * levels}#{context.pork_description}"
 
-      self.last_executor = executor
+      self.last_suite = suite
     end
 
     def case_end

data/lib/pork/report/progressbar.rb

@@ -75,12 +75,11 @@ module Pork
       end
     end
 
-    def case_pass   ; end
     def case_skip   ; end
     def case_failed ; self.failed = true; end
     def case_errored; self.failed = true; end
 
-    def case_end
+    def case_pass
       bar.tick
     end
 

data/lib/pork/report.rb

@@ -5,7 +5,8 @@ module Pork
   module Report::Imp
     def initialize o=$stdout
       super
-      extend(*Pork.report_extensions.reverse) if Pork.report_extensions.any?
+      extensions = Pork.report_extensions
+      extend(*extensions.reverse) if extensions.any?
     end
 
     def case_start _; end
@@ -85,10 +86,16 @@ module Pork
     end
 
     def backtrace test, err
-      if $VERBOSE
+      bt = if $VERBOSE
         err.backtrace
       else
-        strip(reject_pork(test, err))
+        strip(reject_pork(test, err.backtrace))
+      end
+
+      if bt.empty?
+        ["#{test.source_location.join(':')}:in `block in would'"]
+      else
+        bt
       end
     end
 
@@ -112,13 +119,8 @@ 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
+    def reject_pork test, bt
+      bt.reject{ |l| l =~ %r{/lib/pork(/\w+)*\.rb:\d+} }
     end
 
     def strip bt
@@ -126,11 +128,13 @@ module Pork
     end
 
     def strip_home bt
-      bt.map{ |path| path.sub(ENV['HOME'], '~') }
+      home = ENV['HOME']
+      bt.map{ |path| path.sub(home, '~') }
     end
 
     def strip_cwd bt
-      bt.map{ |path| path.sub("#{Dir.pwd}/", '') }
+      cwd = Dir.pwd
+      bt.map{ |path| path.sub("#{cwd}/", '') }
     end
 
     def pork_test source_location
@@ -152,5 +156,5 @@ module Pork
     end
   end
 
-  Report.__send__(:include, Report::Imp)
+  Report.include(Report::Imp)
 end

data/lib/pork/runner.rb

@@ -0,0 +1,54 @@
+
+require 'pork/error'
+
+module Pork
+  class Runner < Struct.new(:suite, :seed, :stat, :desc, :test, :env)
+    def run
+      assertions = stat.assertions
+      context = suite.new(stat, desc, [])
+
+      stat.reporter.case_start(context)
+
+      passed = protected do
+        env.run_before(context)
+        context.instance_eval(&test)
+      end
+
+      protected{ env.run_after(context) }
+
+      if passed
+        if assertions == stat.assertions
+          protected{ raise Error.new('Missing assertions') }
+        else
+          stat.reporter.case_pass
+        end
+      end
+
+      stat.incr_tests
+      stat.reporter.case_end
+    end
+
+    private
+    def protected
+      yield
+      true
+    rescue *stat.protected_exceptions => e
+      case e
+      when Skip
+        stat.incr_skips
+        stat.reporter.case_skip
+      else
+        err = [e, suite.description_for("would #{desc}"), test, seed]
+        case e
+        when Failure
+          stat.add_failure(err)
+          stat.reporter.case_failed
+        else
+          stat.add_error(err)
+          stat.reporter.case_errored
+        end
+      end
+      false
+    end
+  end
+end

data/lib/pork/stat.rb

@@ -63,5 +63,5 @@ module Pork
     end
   end
 
-  Stat.__send__(:include, Stat::Imp)
+  Stat.include(Stat::Imp)
 end

data/lib/pork/suite.rb

@@ -0,0 +1,74 @@
+
+require 'fiber'
+
+require 'pork/runner'
+require 'pork/context'
+
+module Pork
+  class Suite < Struct.new(:pork_stat, :pork_description, :pork_fibers)
+    module Imp
+      attr_reader :desc, :tests
+
+      def before &block; @tests << [:before, block]; end
+      def after  &block; @tests << [:after , block]; end
+
+      def around &block
+        before do
+          fiber = Fiber.new{ instance_exec(Fiber.method(:yield), &block) }
+          pork_fibers << fiber
+          fiber.resume
+        end
+
+        after do
+          fiber = pork_fibers.pop
+          fiber.resume if fiber.alive?
+        end
+      end
+
+      def copy  desc=:default, &suite
+        @stash[desc] = suite
+      end
+      def paste desc=:default, *args
+        module_exec(*args, &search_stash(desc))
+      end
+
+      def describe desc=:default, opts={}, &suite
+        executor = Class.new(self){ init(desc) }
+        executor.module_eval(&suite)
+        @tests << [:describe, executor, suite, opts]
+      end
+
+      def would desc=:default, opts={}, &test
+        raise ArgumentError.new("no block given") unless test
+        @tests << [:would   , desc    , test, opts]
+      end
+
+      def description_for name=''
+        if @super_executor
+          "#{@super_executor.description_for}#{@desc}: #{name}"
+        else
+          name
+        end
+      end
+
+      def run *args
+        Runner.new(self, Pork.reseed, *args).run
+      end
+
+      private
+      def init desc=''
+        @desc, @tests, @stash = desc, [], {}
+        @super_executor = ancestors[1..-1].find{ |a| a <= Suite }
+      end
+
+      protected
+      def search_stash desc
+        @stash[desc] or @super_executor && @super_executor.search_stash(desc)
+      end
+    end
+
+    extend Imp
+    include Context
+    init
+  end
+end

data/lib/pork/version.rb

@@ -1,4 +1,4 @@
 
 module Pork
-  VERSION = '1.5.0'
+  VERSION = '2.1.0'
 end

data/lib/pork.rb

@@ -1,17 +1,9 @@
 
+require 'pork/api'
+require 'pork/stat'
 require 'pork/executor'
 
 module Pork
-  module API
-    module_function
-    def before █ Executor.before(&block); end
-    def after  █ Executor.after( &block); end
-    def copy     desc=:default, █ Executor.copy(    desc, &block); end
-    def paste    desc=:default, *args ; Executor.paste(   desc, *args ); end
-    def describe desc=:default, &suite; Executor.describe(desc, &suite); end
-    def would    desc=:default, &test ; Executor.would(   desc, &test ); end
-  end
-
   # default to :shuffled while eliminating warnings for uninitialized ivar
   def self.execute_mode mode=nil
     @execute_mode = mode || @execute_mode ||= :shuffled
@@ -31,6 +23,10 @@ module Pork
     @report_extensions ||= []
   end
 
+  def self.execute_extensions
+    @execute_extensions ||= []
+  end
+
   def self.protected_exceptions
     @protected_exceptions ||= [Pork::Error, StandardError]
   end
@@ -50,11 +46,7 @@ module Pork
   end
 
   def self.seed
-    @seed ||= if Random.const_defined?(:DEFAULT)
-                Random::DEFAULT.seed
-              else
-                Thread.current.randomizer.seed # Rubinius (rbx)
-              end
+    @seed ||= Random.seed
   end
 
   def self.reseed
@@ -87,13 +79,13 @@ module Pork
   def self.execute
     if ENV['PORK_TEST']
       if tests = Executor[ENV['PORK_TEST']]
-        @stat = Executor.execute(execute_mode, stat, tests)
+        @stat = Executor.execute(:paths => tests)
       else
         puts "Cannot find test: #{ENV['PORK_TEST']}"
         exit 254
       end
     else
-      @stat = Executor.execute(execute_mode, stat)
+      @stat = Executor.execute
     end
   end
 
@@ -102,7 +94,7 @@ module Pork
     execute_mode(ENV['PORK_MODE'])
     report_mode(ENV['PORK_REPORT'])
     trap
-    stat.loaded(@at, @files)
+    stat.loaded(@at, @files) if instance_variable_defined?(:@at)
     execute
     stat.report
   end

data/pork.gemspec

@@ -1,20 +1,20 @@
 # -*- encoding: utf-8 -*-
-# stub: pork 1.5.0 ruby lib
+# stub: pork 2.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pork".freeze
-  s.version = "1.5.0"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Lin Jen-Shin (godfat)".freeze]
-  s.date = "2016-03-10"
+  s.date = "2022-12-28"
   s.description = "Pork -- Simple and clean and modular testing library.\n\nInspired by [Bacon][].\n\n[Bacon]: https://github.com/chneukirchen/bacon".freeze
   s.email = ["godfat (XD) godfat.org".freeze]
   s.files = [
   ".gitignore".freeze,
+  ".gitlab-ci.yml".freeze,
   ".gitmodules".freeze,
-  ".travis.yml".freeze,
   "CHANGES.md".freeze,
   "Gemfile".freeze,
   "LICENSE".freeze,
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   "Rakefile".freeze,
   "TODO.md".freeze,
   "lib/pork.rb".freeze,
+  "lib/pork/api.rb".freeze,
   "lib/pork/auto.rb".freeze,
   "lib/pork/context.rb".freeze,
   "lib/pork/env.rb".freeze,
@@ -30,9 +31,8 @@ Gem::Specification.new do |s|
   "lib/pork/expect.rb".freeze,
   "lib/pork/extra/rainbows.rb".freeze,
   "lib/pork/extra/show_source.rb".freeze,
-  "lib/pork/imp.rb".freeze,
   "lib/pork/inspect.rb".freeze,
-  "lib/pork/isolate.rb".freeze,
+  "lib/pork/isolator.rb".freeze,
   "lib/pork/mode/parallel.rb".freeze,
   "lib/pork/mode/sequential.rb".freeze,
   "lib/pork/mode/shuffled.rb".freeze,
@@ -44,46 +44,46 @@ Gem::Specification.new do |s|
   "lib/pork/report/description.rb".freeze,
   "lib/pork/report/dot.rb".freeze,
   "lib/pork/report/progressbar.rb".freeze,
+  "lib/pork/runner.rb".freeze,
   "lib/pork/stat.rb".freeze,
+  "lib/pork/suite.rb".freeze,
   "lib/pork/test.rb".freeze,
   "lib/pork/version.rb".freeze,
   "pork.gemspec".freeze,
   "task/README.md".freeze,
   "task/gemgem.rb".freeze,
+  "test/test_around.rb".freeze,
   "test/test_bacon.rb".freeze,
   "test/test_expect.rb".freeze,
   "test/test_inspect.rb".freeze,
+  "test/test_isolator.rb".freeze,
+  "test/test_meta.rb".freeze,
   "test/test_nested.rb".freeze,
   "test/test_pork_test.rb".freeze,
   "test/test_readme.rb".freeze,
   "test/test_should.rb".freeze,
-  "test/test_stat.rb".freeze]
+  "test/test_stat.rb".freeze,
+  "test/test_suite.rb".freeze]
   s.homepage = "https://github.com/godfat/pork".freeze
-  s.licenses = ["Apache License 2.0".freeze]
-  s.rubygems_version = "2.6.1".freeze
+  s.licenses = ["Apache-2.0".freeze]
+  s.rubygems_version = "3.4.1".freeze
   s.summary = "Pork -- Simple and clean and modular testing library.".freeze
   s.test_files = [
+  "test/test_around.rb".freeze,
   "test/test_bacon.rb".freeze,
   "test/test_expect.rb".freeze,
   "test/test_inspect.rb".freeze,
+  "test/test_isolator.rb".freeze,
+  "test/test_meta.rb".freeze,
   "test/test_nested.rb".freeze,
   "test/test_pork_test.rb".freeze,
   "test/test_readme.rb".freeze,
   "test/test_should.rb".freeze,
-  "test/test_stat.rb".freeze]
+  "test/test_stat.rb".freeze,
+  "test/test_suite.rb".freeze]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  s.specification_version = 4
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<method_source>.freeze, [">= 0"])
-      s.add_development_dependency(%q<ruby-progressbar>.freeze, [">= 0"])
-    else
-      s.add_dependency(%q<method_source>.freeze, [">= 0"])
-      s.add_dependency(%q<ruby-progressbar>.freeze, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<method_source>.freeze, [">= 0"])
-    s.add_dependency(%q<ruby-progressbar>.freeze, [">= 0"])
-  end
+  s.add_development_dependency(%q<method_source>.freeze, [">= 0"])
+  s.add_development_dependency(%q<ruby-progressbar>.freeze, [">= 0"])
 end

data/task/README.md

@@ -4,16 +4,16 @@
 
 Provided tasks:
 
-    rake clean        # Remove ignored files
+    rake clean        # Trash ignored files
     rake gem:build    # Build gem
     rake gem:install  # Install gem
     rake gem:release  # Release gem
     rake gem:spec     # Generate gemspec
-    rake test         # Run tests in memory
+    rake test         # Run tests
 
 ## REQUIREMENTS:
 
-* Tested with MRI (official CRuby) 1.9.3, 2.0.0, Rubinius and JRuby.
+* Tested with MRI (official CRuby) and JRuby.
 
 ## INSTALLATION:
 
@@ -23,13 +23,13 @@ And in Rakefile:
 
 ``` ruby
 begin
-  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+  require "#{__dir__}/task/gemgem"
 rescue LoadError
-  sh 'git submodule update --init'
+  sh 'git submodule update --init --recursive'
   exec Gem.ruby, '-S', $PROGRAM_NAME, *ARGV
 end
 
-Gemgem.init(dir) do |s|
+Gemgem.init(__dir__, :submodules => %w[your-dep]) do |s|
   s.name    = 'your-gem'
   s.version = '0.1.0'
 end
@@ -37,9 +37,9 @@ end
 
 ## LICENSE:
 
-Apache License 2.0
+Apache License 2.0 (Apache-2.0)
 
-Copyright (c) 2011-2013, Lin Jen-Shin (godfat)
+Copyright (c) 2011-2021, Lin Jen-Shin (godfat)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/task/gemgem.rb

@@ -1,7 +1,7 @@
 
 module Gemgem
   class << self
-    attr_accessor :dir, :spec, :spec_create
+    attr_accessor :dir, :spec, :submodules, :spec_create
   end
 
   module_function
@@ -11,12 +11,14 @@ module Gemgem
   def pkg_dir    ; "#{dir}/pkg"                       ; end
   def escaped_dir; @escaped_dir ||= Regexp.escape(dir); end
 
-  def init dir, &block
+  def init dir, options={}, &block
     self.dir = dir
-    $LOAD_PATH.unshift("#{dir}/lib")
     ENV['RUBYLIB'] = "#{dir}/lib:#{ENV['RUBYLIB']}"
     ENV['PATH']    = "#{dir}/bin:#{ENV['PATH']}"
+    self.submodules  = options[:submodules] || []
     self.spec_create = block
+
+    $LOAD_PATH.unshift("#{dir}/lib", *submodules_libs)
   end
 
   def create
@@ -26,7 +28,7 @@ module Gemgem
 
       s.description = description.join
       s.summary     = description.first
-      s.license     = readme['LICENSE'].sub(/.+\n\n/, '').lines.first.strip
+      s.license     = license
 
       s.date        = Time.now.strftime('%Y-%m-%d')
       s.files       = gem_files
@@ -40,6 +42,7 @@ module Gemgem
 
   def gem_install
     require 'rubygems/commands/install_command'
+    require 'rubygems/package'
     # read ~/.gemrc
     Gem.use_paths(Gem.configuration[:gemhome], Gem.configuration[:gempath])
     Gem::Command.extra_args = Gem.configuration[:gem]
@@ -49,7 +52,8 @@ module Gemgem
     cmd.handle_options([])
 
     # install
-    install = Gem::Installer.new(gem_path, cmd.options)
+    gem_package = Gem::Package.new(gem_path)
+    install = Gem::Installer.new(gem_package, cmd.options)
     install.install
     puts "\e[35mGem installed: \e[33m#{strip_path(install.gem_dir)}\e[0m"
   end
@@ -115,6 +119,7 @@ module Gemgem
       SimpleCov.start do
         add_filter('test/')
         add_filter('test.rb')
+        submodules_libs.each(&method(:add_filter))
       end
     end
 
@@ -159,11 +164,15 @@ module Gemgem
   end
 
   def strip_home_path path
-    path.sub(ENV['HOME'], '~')
+    path.sub(/\A#{Regexp.escape(ENV['HOME'])}\//, '~/')
   end
 
   def strip_cwd_path path
-    path.sub(Dir.pwd, '.')
+    path.sub(/\A#{Regexp.escape(Dir.pwd)}\//, '')
+  end
+
+  def submodules_libs
+    submodules.map{ |path| "#{dir}/#{path}/lib" }
   end
 
   def git *args
@@ -201,6 +210,11 @@ module Gemgem
     @description ||= (readme['DESCRIPTION']||'').sub(/.+\n\n/, '').lines.to_a
   end
 
+  def license
+    readme['LICENSE'].sub(/.+\n\n/, '').lines.first.
+      split(/[()]/).map(&:strip).reject(&:empty?).last
+  end
+
   def all_files
     @all_files ||= fold_files(glob).sort
   end
@@ -221,7 +235,8 @@ module Gemgem
 
   def gem_files
     @gem_files ||= all_files.reject{ |f|
-      f =~ ignored_pattern && !git_files.include?(f)
+      f =~ submodules_pattern ||
+        (f =~ ignored_pattern && !git_files.include?(f))
     }
   end
 
@@ -253,6 +268,15 @@ module Gemgem
                          end
   end
 
+  def submodules_pattern
+    @submodules_pattern ||= if submodules.empty?
+                              /^$/
+                            else
+                              Regexp.new(submodules.map{ |path|
+                                "^#{Regexp.escape(path)}/" }.join('|'))
+                            end
+  end
+
   def expand_patterns pathes
     # http://git-scm.com/docs/gitignore
     pathes.flat_map{ |path|