tork 19.8.2 → 19.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d43b1c853bce71a2d45e8c10285f62086b87d695
-  data.tar.gz: 121972db46e71b3ae1638e1db88aa7d97caeaf36
+  metadata.gz: db7c9496a3b8d6e14495d3cf7697adbed44650d5
+  data.tar.gz: 1aac8ca254bc58ebe2561f7aeeef8eb7a7ee672c
 SHA512:
-  metadata.gz: 9ae7a869ff7da979724748a11376e3eb20e67bca33708845f9c6205cfe72c705306866f79b8232f00011d8f56a9f28335dc7acefa6b4570cea48d9b41353f51f
-  data.tar.gz: a1cde8d17f54545c9d7fd329fc9f2a0ec3a4b9f0644fadcee29b2f7396af9a0975452777e233d9e340a0725fb7fe8252a76215ff47eaeb006bf7c10ee9775a37
+  metadata.gz: a730b6a80141971a6c8eee69fa45aed9ff464ea23a4d0c85b4a91241f8e60ae7cdc3f1c05e23d0348fea55fb227784c007d4ea0d785d95ead7a52b798ae684dc
+  data.tar.gz: 12e0de85fbb9ca6b2075251068979b78e945e22d0b85f42c121211d9018ee4ae308476bf5a189e0b078449fbc1001c1d74c7a0fb7a68ac1d126237ed9046662d

data/VERSION.markdown

@@ -1,3 +1,30 @@
+## Version 19.9.0 (2014-07-17)
+
+### Minor:
+
+  * Add support for testing outside `test/` and `spec/` directories.  This
+    change lets you run test files directly from the current working directory
+    without having to put them inside special `test/` and `spec/` directories.
+
+    This can be useful if you are learning Ruby or writing tests for simple
+    scripts because you need not create a directory structure that is fit for
+    a larger application just for the sole purpose of running your tests!
+
+  * Drop the `default` configuration helper and load the `config.rb` files of
+    all configuration helpers on startup instead.  This way, each helper can
+    itself detect whether it is needed from inside its own `config.rb` file.
+
+  * Censor Tork internals from test failure backtraces so that users can
+    inspect them quickly to find where errors are arising in their code.
+
+### Patch:
+
+  * Only 1 worker was being used on a dual-core system.
+
+### Other:
+
+  * tork(1): use complete sentences in the help message.
+
 ## Version 19.8.2 (2014-07-01)
 
 This release adds support for RSpec 3+ in the `spec` configuration helper.

data/bin/tork

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK 1 2014-07-01 19.8.2
+# TORK 1 2014-07-17 19.9.0
 
 ## NAME
 
@@ -46,7 +46,7 @@ This program can be controlled remotely by multiple tork-remote(1) instances.
 ## FILES
 
 *.tork/config.rb*
-  Optional Ruby script that is loaded inside the driver process on startup.
+  Optional Ruby script that is loaded inside this Tork process on startup.
   It can read and change the `ENV['TORK_CONFIGS']` environment variable.
 
 ## ENVIRONMENT
@@ -54,21 +54,7 @@ This program can be controlled remotely by multiple tork-remote(1) instances.
 `TORK_CONFIGS`
   Colon-separated (:) list of either paths to directories that contain
   configuration files or names of the following configuration helpers.
-  If this variable is not set, then its value is assumed to be "default".
 
-  > `default`
-  >   Loads the following configuration helpers (as appropriate) if your
-  >   current working directory appears to utilize what they configure.
-  >   See below for complete descriptions of these configuration helpers.
-  >
-  >   * bundler
-  >   * rails
-  >   * devise
-  >   * test
-  >   * spec
-  >   * cucumber
-  >   * factory_girl
-  >
   > `dotlog`
   >   Hides log files by prefixing their names with a period (dot).
   >
@@ -129,6 +115,7 @@ tork-runner(1), tork-driver(1), tork-master(1)
 
 =end =========================================================================
 
+TORK_DOLLAR_ZERO = $0
 $0 = File.basename(__FILE__) # for easier identification in ps(1) output
 
 require 'binman'

data/bin/tork-driver

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK-DRIVER 1 2014-07-01 19.8.2
+# TORK-DRIVER 1 2014-07-17 19.9.0
 
 ## NAME
 
@@ -51,7 +51,7 @@ to stdout.
 ## FILES
 
 *.tork/config.rb*
-  Optional Ruby script that is loaded inside the driver process on startup.
+  Optional Ruby script that is loaded inside this Tork process on startup.
   It can read and change the `ENV['TORK_CONFIGS']` environment variable.
 
 `.tork/driver.rb`

data/bin/tork-engine

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK-ENGINE 1 2014-07-01 19.8.2
+# TORK-ENGINE 1 2014-07-17 19.9.0
 
 ## NAME
 
@@ -76,7 +76,7 @@ to stdout.
 ## FILES
 
 *.tork/config.rb*
-  Optional Ruby script that is loaded inside the driver process on startup.
+  Optional Ruby script that is loaded inside this Tork process on startup.
   It can read and change the `ENV['TORK_CONFIGS']` environment variable.
 
 *.tork/engine.rb*

data/bin/tork-herald

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK-HERALD 1 2014-07-01 19.8.2
+# TORK-HERALD 1 2014-07-17 19.9.0
 
 ## NAME
 

data/bin/tork-master

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK-MASTER 1 2014-07-01 19.8.2
+# TORK-MASTER 1 2014-07-17 19.9.0
 
 ## NAME
 
@@ -66,7 +66,7 @@ to stdout.
 ## FILES
 
 *.tork/config.rb*
-  Optional Ruby script that is loaded inside the driver process on startup.
+  Optional Ruby script that is loaded inside this Tork process on startup.
   It can read and change the `ENV['TORK_CONFIGS']` environment variable.
 
 *.tork/master.rb*

data/bin/tork-notify

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK-NOTIFY 1 2014-07-01 19.8.2
+# TORK-NOTIFY 1 2014-07-17 19.9.0
 
 ## NAME
 

data/bin/tork-runner

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# TORK-RUNNER 1 2014-07-01 19.8.2
+# TORK-RUNNER 1 2014-07-17 19.9.0
 
 ## NAME
 

data/lib/tork/cliapp.rb

@@ -3,17 +3,6 @@ require 'tork/server'
 module Tork
 class CLIApp < Server
 
-  COMMANDS = {
-    't' => :run_test_file,
-    'a' => :run_all_test_files,
-    's' => :stop_running_test_files,
-    'k' => [:stop_running_test_files, :SIGKILL],
-    'p' => :rerun_passed_test_files,
-    'f' => :rerun_failed_test_files,
-    'o' => :reabsorb_overhead,
-    'q' => :quit,
-  }
-
   def loop
     tell @clients, 'Absorbing test execution overhead...', false
     @driver = popen('tork-driver')
@@ -29,6 +18,10 @@ protected
     help client
   end
 
+  BACKTRACE_CENSOR = /\n\s+(?:from\s)?#{
+    Regexp.union(File.expand_path('../../..', __FILE__), TORK_DOLLAR_ZERO)
+  }[^:]*:\d+:.+$/
+
   def recv client, message
     case client
     when @driver
@@ -51,7 +44,12 @@ protected
                 when :fail then "\e[31m%s\e[0m" # red
                 end
         message = color % message if color and STDOUT.tty?
-        message = [message, File.read(log_file), message] if event_sym == :fail
+
+        if event_sym == :fail
+          # censor Tork internals from test failure backtraces
+          log = File.read(log_file).gsub(BACKTRACE_CENSOR, '')
+          message = [message, log, message]
+        end
 
         tell @clients, message, false
       end
@@ -69,12 +67,29 @@ protected
 
 private
 
+  COMMANDS = {
+    't' => :run_test_file,
+    'a' => :run_all_test_files,
+    's' => :stop_running_test_files,
+    'k' => [:stop_running_test_files, :SIGKILL],
+    'p' => :rerun_passed_test_files,
+    'f' => :rerun_failed_test_files,
+    'o' => :reabsorb_overhead,
+    'q' => :quit,
+  }
+
   def help client
-    COMMANDS.each do |key, cmd|
-      desc = Array(cmd).join(' with ').to_s.tr('_', ' ')
-      tell client, "Type #{key} then ENTER to #{desc}.", false
-    end
-    tell client, 'Type h then ENTER to see this message.', false
+    tell client, <<HELP, false
+Type a then ENTER to run all test files.
+Type t then SPACE then a filename then ENTER to run a specific test file.
+Type s then ENTER to stop currently running test files.
+Type k then ENTER to stop currently running test files with SIGKILL.
+Type p then ENTER to re-run passing test files.
+Type f then ENTER to re-run failing test files.
+Type o then ENTER to reabsorb test execution overhead.
+Type h then ENTER to see this help message.
+Type q then ENTER to quit.
+HELP
   end
 
 end

data/lib/tork/config.rb

@@ -1,17 +1,17 @@
 module Tork
   # Loads all Ruby scripts found having the given name in (1) the directories
-  # specified in the TORK_CONFIGS environment variable, (2) the subdirectories
+  # specified in the given $TORK_CONFIGS search path, (2) the subdirectories
   # of lib/tork/config/, and (3) the user's .tork/ directory; in that order.
   #
   # @return [Array] paths of Ruby scripts that were loaded
   #
-  def self.config name
-    dirs = ENV['TORK_CONFIGS'].strip.split(/:+/).reject(&:empty?).uniq.
+  def self.config name, search_path=ENV['TORK_CONFIGS']
+    dirs = search_path.to_s.strip.split(/:+/).reject(&:empty?).uniq.
            map {|dir| [dir, __FILE__.sub(/\.rb$/, "/#{dir}")] }.flatten
 
     Dir["{#{dirs.join(',')},.tork}/#{name}.rb"].each {|script| load script }
   end
 end
 
-ENV['TORK_CONFIGS'] ||= 'default'.freeze # ENV values come frozen by default
-Tork.config :config
+ENV['TORK_CONFIGS'] ||= String.new.freeze # ENV values come frozen by default
+Tork.config :config, '*'

data/lib/tork/config/bundler/config.rb

@@ -0,0 +1 @@
+ENV['TORK_CONFIGS'] += ':bundler' if Dir['Gemfile{,.lock}'].any?

data/lib/tork/config/cucumber/config.rb

@@ -0,0 +1 @@
+ENV['TORK_CONFIGS'] += ':cucumber' if File.directory? 'features'

data/lib/tork/config/devise/config.rb

@@ -0,0 +1 @@
+ENV['TORK_CONFIGS'] += ':devise' if File.exist? 'config/initializers/devise.rb'

data/lib/tork/config/factory_girl/config.rb

@@ -0,0 +1 @@
+ENV['TORK_CONFIGS'] += ':factory_girl' if Dir['{test,spec}/factories/'].any?

data/lib/tork/config/rails/config.rb

@@ -0,0 +1 @@
+ENV['TORK_CONFIGS'] += ':rails' if Dir['script/{rails,console}'].any?

data/lib/tork/config/spec/config.rb

@@ -0,0 +1,4 @@
+$tork_config_spec_glob = '**/{spec_*,*_spec}.rb'
+$tork_config_spec_grep = %r{.*(\bspec_[^/]+|[^/]+_spec)\.rb$}
+
+ENV['TORK_CONFIGS'] += ':spec' if Dir['spec/', $tork_config_spec_glob].any?

data/lib/tork/config/spec/driver.rb

@@ -1,17 +1,13 @@
-Tork::Driver::REABSORB_FILE_GREPS.push 'spec/spec_helper.rb'
+Tork::Driver::REABSORB_FILE_GREPS.push /\bspec_helper\.rb$/
 
-Tork::Driver::ALL_TEST_FILE_GLOBS.push 'spec/**/{spec_*,*_spec}.rb'
+Tork::Driver::ALL_TEST_FILE_GLOBS.push $tork_config_spec_glob
 
 Tork::Driver::TEST_FILE_GLOBBERS.update(
   # source files that correspond to test files
-  %r{^lib/.*?([^/]+)\.rb$} => lambda do |matches|
-    target = matches[1]
-    "spec/**/{spec_#{target},#{target}_spec}.rb"
+  %r{([^/]+)\.rb$} => lambda do |matches|
+    $tork_config_spec_glob.gsub(/(?<=_)\*|\*(?=_)/, matches[1])
   end,
 
   # the actual test files themselves
-  %r{^spec/.+\.rb$} => lambda do |matches|
-    target = matches[0]
-    target if File.basename(target) =~ /^spec_|_spec\./
-  end
+  $tork_config_spec_grep => lambda {|matches| matches[0] }
 )

data/lib/tork/config/spec/master.rb

@@ -1,4 +1,5 @@
 $LOAD_PATH.unshift 'spec' unless $LOAD_PATH.include? 'spec'
 $LOAD_PATH.unshift 'lib' unless $LOAD_PATH.include? 'lib'
 require 'spec_helper' if File.exist? 'spec/spec_helper.rb'
+require './spec_helper' if File.exist? 'spec_helper.rb'
 require 'rspec/autorun' if defined? RSpec

data/lib/tork/config/spec/worker.rb

@@ -5,7 +5,7 @@ rescue LoadError, NameError
   # ignore
 end
 
-if $tork_test_file.start_with? 'spec/' and $tork_line_numbers.any?
+if $tork_line_numbers.any? and $tork_test_file =~ $tork_config_spec_grep
   if rspec_version and rspec_version >= '3.0'
     ARGV.push [$tork_test_file, *$tork_line_numbers].join(':')
   else

data/lib/tork/config/test/config.rb

@@ -0,0 +1,10 @@
+# people generally prefix or suffix their test file names with these labels
+# https://en.wikibooks.org/wiki/Ruby_Programming/Unit_testing#Naming_Conventions
+labels = %w[ test ts tc t ]
+labels_glob = '{' + labels.join(',') + '}'
+labels_grep = '(' + labels.join('|') + ')'
+
+$tork_config_test_glob = "**/{#{labels_glob}_*,*_#{labels_glob}}.rb"
+$tork_config_test_grep = %r{.*(\b#{labels_grep}_[^/]+|[^/]+_#{labels_grep})\.rb$}
+
+ENV['TORK_CONFIGS'] += ':test' if Dir['test/', $tork_config_test_glob].any?

data/lib/tork/config/test/driver.rb

@@ -1,17 +1,13 @@
-Tork::Driver::REABSORB_FILE_GREPS.push 'test/test_helper.rb'
+Tork::Driver::REABSORB_FILE_GREPS.push /\btest_helper\.rb$/
 
-Tork::Driver::ALL_TEST_FILE_GLOBS.push 'test/**/{test_*,*_test}.rb'
+Tork::Driver::ALL_TEST_FILE_GLOBS.push $tork_config_test_glob
 
 Tork::Driver::TEST_FILE_GLOBBERS.update(
   # source files that correspond to test files
-  %r{^lib/.*?([^/]+)\.rb$} => lambda do |matches|
-    target = matches[1]
-    "test/**/{test_#{target},#{target}_test}.rb"
+  %r{([^/]+)\.rb$} => lambda do |matches|
+    $tork_config_test_glob.gsub(/(?<=_)\*|\*(?=_)/, matches[1])
   end,
 
   # the actual test files themselves
-  %r{^test/.+\.rb$} => lambda do |matches|
-    target = matches[0]
-    target if File.basename(target) =~ /^test_|_test\./
-  end
+  $tork_config_test_grep => lambda {|matches| matches[0] }
 )

data/lib/tork/config/test/master.rb

@@ -1,4 +1,5 @@
 $LOAD_PATH.unshift 'test' unless $LOAD_PATH.include? 'test'
 $LOAD_PATH.unshift 'lib' unless $LOAD_PATH.include? 'lib'
 require 'test_helper' if File.exist? 'test/test_helper.rb'
+require './test_helper' if File.exist? 'test_helper.rb'
 require 'minitest/autorun' if defined? MiniTest

data/lib/tork/config/test/worker.rb

@@ -1,4 +1,4 @@
-if $tork_test_file.start_with? 'test/' and $tork_line_numbers.any?
+if $tork_line_numbers.any? and $tork_test_file =~ $tork_config_test_grep
   test_file_lines = File.readlines($tork_test_file)
   test_names = $tork_line_numbers.map do |line|
     catch :found do

data/lib/tork/engine.rb

@@ -51,7 +51,7 @@ class Engine < Server
 
   def stop_running_test_files signal=nil
     if @running_test_files.empty?
-      tell @client, 'There are no running test files to stop.'
+      tell @client, 'There are no test files currently running.'
     else
       send @master, [:stop, signal].compact
       @running_test_files.clear
@@ -60,7 +60,7 @@ class Engine < Server
 
   def rerun_passed_test_files
     if @passed_test_files.empty?
-      tell @client, 'There are no passed test files to re-run.'
+      tell @client, 'There are no passing test files to re-run.'
     else
       run_test_files @passed_test_files
     end
@@ -68,7 +68,7 @@ class Engine < Server
 
   def rerun_failed_test_files
     if @failed_test_files.empty?
-      tell @client, 'There are no failed test files to re-run.'
+      tell @client, 'There are no failing test files to re-run.'
     else
       run_test_files @failed_test_files
     end

data/lib/tork/master.rb

@@ -31,7 +31,7 @@ class Master < Server
 
   def test test_file, line_numbers
     # throttle forking rate to meet the maximum concurrent workers limit
-    sleep 1 until @command_by_worker_pid.size < @worker_number_pool.size
+    sleep 1 until @command_by_worker_pid.size <= @worker_number_pool.size
 
     $tork_test_file = test_file
     $tork_line_numbers = line_numbers

data/lib/tork/version.rb

@@ -1,3 +1,3 @@
 module Tork
-  VERSION = "19.8.2"
+  VERSION = "19.9.0"
 end

data/man/index.html

@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 3.0.0 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 3.0.1 https://github.com/sunaku/md2man" />
   <title>man/index</title>
   <link rel="stylesheet" href="style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->