tork 17.0.1 → 17.1.0

data/HISTORY.markdown

@@ -1,3 +1,25 @@
+------------------------------------------------------------------------------
+Version 17.1.0 (2012-01-30)
+------------------------------------------------------------------------------
+
+Improvements:
+
+  * Added `Tork::Config.test_event_hooks` configuration option.
+
+  * Added `tork/config/notify` configuration helper for receiving
+    edge-triggered notifications (via libnotify, growl, or
+    xmessage) about changes in test files' pass/fail status.
+
+  * Added `tork/config/factory_girl` configuration helper for properly
+    clearing factory definitions before forking and then finding them after
+    forking to avoid `FactoryGirl::DuplicateDefinitionError`.  (Mark Hayes)
+
+  * Lambda functions in `Tork::Config.test_file_globbers` can now return
+    multiple globs in an array, in addition to just a single glob or `nil`.
+
+  * Added support for the MiniTest convention of naming test files as
+    `test/**/test_*.rb` and `spec/**/spec_*.rb`.
+
 ------------------------------------------------------------------------------
 Version 17.0.1 (2012-01-29)
 ------------------------------------------------------------------------------

data/LICENSE

@@ -11,6 +11,7 @@ Thanks to 2012 Spencer Steffen <spencer@citrusme.com>
 Thanks to 2012 Jesse Cooke <jesse@jc00ke.com>
 Thanks to 2012 Benjamin Quorning <benjamin@quorning.net>
 Thanks to 2012 Nicolas Fouché <nicolas.fouche@gmail.com>
+Thanks to 2012 Mark Hayes <mark@deployfx.com>
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

data/README.markdown

@@ -39,7 +39,7 @@ Features
 
   * You can override the modular `tork*` programs with your own in $PATH.
 
-  * Its core is written in less than 370 lines (SLOC) of pure Ruby code! :-)
+  * Its core is written in about 370 lines (SLOC) of pure Ruby code! :-)
 
 ### Architecture
 
@@ -105,7 +105,7 @@ You can monitor your test processes from another terminal:
 
 ### With [Ruby on Rails]
 
-For Rails 3 or newer, use the rails configuration helper (see below).
+For Rails 3 or newer, use the `tork/config/rails` configuration helper.
 Otherwise, ensure that your `config/environments/test.rb` file contains:
 
     config.cache_classes = false
@@ -117,26 +117,6 @@ adapter][memory_test_fix].  Otherwise, you *might* face these errors:
 
 > cannot start a transaction within a transaction
 
-### With [factory_girl]
-
-Do not load your factories into the master process as part of your test
-execution overhead in your test/spec helper because that would necessitate
-overhead reabsorption whenever you change or create factory definitions.
-
-Instead, use `at_exit()` to wait until (1) after the master process has forked
-a worker process and (2) just before that worker process runs its test suite
-(whose execution is started by your test framework's own `at_exit()` handler):
-
-    # in your test/spec helper
-    require 'factory_girl'
-    at_exit { FactoryGirl.find_definitions unless $! }
-
-This way, worker processes will pick up changes in your factories "for free"
-whenever they (re)run your test files.  Skip if Ruby is exiting because of a
-raised exception (denoted by the `$!` global variable in the snippet above).
-
-As a bonus, this arrangement also works when tests are run outside of Tork!
-
 ------------------------------------------------------------------------------
 Configuration
 ------------------------------------------------------------------------------
@@ -172,6 +152,16 @@ Or in your configuration file:
 
     require 'tork/config/cucumber'
 
+### [factory_girl]
+
+At the command line:
+
+    tork factory_girl
+
+Or in your configuration file:
+
+    require 'tork/config/factory_girl'
+
 ### [parallel_tests]
 
 At the command line:
@@ -202,6 +192,16 @@ Or in your configuration file:
 
     require 'tork/config/logdir'
 
+### Receive notifications via libnotify, growl, or xmessage(1)
+
+At the command line:
+
+    tork notify
+
+Or in your configuration file:
+
+    require 'tork/config/notify'
+
 ------------------------------------------------------------------------------
 Configuration options
 -----------------------------------------------------------------------------
@@ -235,8 +235,9 @@ your Ruby application.
 
 Hash that maps (1) a regular expression describing a set of file paths to (2)
 a lambda function that accepts the path to a changed file and a `MatchData`
-object containing the results of the regular expression matching, and yields a
-file globbing pattern that describes a set of test files that need to be run.
+object containing the results of the regular expression matching, and yields
+one or more file globbing patterns (a single string, or an array of strings)
+that describe a set of test files that need to be run.
 
 In other words, whenever the source files (the regular expression) change,
 their associated test files (result of calling the lambda function) are run.
@@ -254,6 +255,23 @@ Then you would add the following to your configuration file:
       "{test,spec}/**/#{name}_#{name.reverse}.rb"
     end
 
+Going further, if you suppose that test files could optionally have "test" or
+"spec" prefixed or appended to their already peculiar names, like so:
+
+  * `lib/hello.rb` => `test/hello_olleh_test.rb`
+  * `lib/hello.rb` => `test/test_hello_olleh.rb`
+  * `app/world.rb` => `spec/world_ldrow_spec.rb`
+  * `app/world.rb` => `spec/spec_world_ldrow.rb`
+
+Then you would add the following to your configuration file:
+
+    Tork::Config.test_file_globbers[%r<^(lib|app)/.+\.rb$>] = lambda do |path, matches|
+      name = File.basename(path, '.rb')
+      ["{test,spec}/**/#{name}_#{name.reverse}.rb",
+       "{test,spec}/**/#{name}_#{name.reverse}_{test,spec}.rb",
+       "{test,spec}/**/{test,spec}_#{name}_#{name.reverse}.rb"]
+    end
+
 In addition, these lambda functions can return `nil` if they do not wish for a
 particular source file to be tested.  For example, to ignore tests for all
 source files except those within a `models/` directory, you would write:
@@ -261,12 +279,14 @@ source files except those within a `models/` directory, you would write:
     Tork::Config.test_file_globbers[%r<^(lib|app)/.+\.rb$>] = lambda do |path, matches|
       if path.include? '/models/'
         "{test,spec}/**/#{File.basename(path)}"
+      #else     # implied by the Ruby language
+        #nil    # implied by the Ruby language
       end
     end
 
 ### Tork::Config.before_fork_hooks
 
-Array of lambda functions that are executed inside `tork-master` before a
+Array of lambda functions that are invoked inside `tork-master` before a
 worker process is forked to run a test file.  These functions are given:
 
 1. The sequence number of the worker process that will be forked shortly.
@@ -293,7 +313,7 @@ For example, to see some real values:
 
 ### Tork::Config.after_fork_hooks
 
-Array of lambda functions that are executed inside a worker process forked
+Array of lambda functions that are invoked inside a worker process forked
 by `tork-master`.  These functions are given:
 
 1. The sequence number of the worker process.
@@ -323,6 +343,18 @@ The first function in this array instructs Test::Unit and RSpec to only run
 those tests that are defined on the given line numbers.  This accelerates your
 test-driven development cycle by only running tests you are currently editing.
 
+### Tork::Config.test_event_hooks
+
+Array of lambda functions that are invoked inside `tork-driver` whenever it
+receives a status message (passed into those functions) from `tork-master`.
+Run `tork-master --help` for more information about these status messages.
+
+For example, to see some real values:
+
+    Tork::Config.test_event_hooks.push lambda {|message_from_tork_master|
+      p :test_event_hooks => message_from_tork_master
+    }
+
 ------------------------------------------------------------------------------
 License
 ------------------------------------------------------------------------------

data/bin/tork

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin
 
-TORK 1 2012-01-29 17.0.1
+TORK 1 2012-01-30 17.1.0
 ==============================================================================
 
 NAME

data/bin/tork-driver

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin
 
-TORK-DRIVER 1 2012-01-29 17.0.1
+TORK-DRIVER 1 2012-01-30 17.1.0
 ==============================================================================
 
 NAME

data/bin/tork-herald

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin
 
-TORK-HERALD 1 2012-01-29 17.0.1
+TORK-HERALD 1 2012-01-30 17.1.0
 ==============================================================================
 
 NAME

data/bin/tork-master

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin
 
-TORK-MASTER 1 2012-01-29 17.0.1
+TORK-MASTER 1 2012-01-30 17.1.0
 ==============================================================================
 
 NAME

data/lib/tork/config.rb

@@ -22,19 +22,21 @@ module Tork
   Config.overhead_file_globs = ['{test,spec}/{test,spec}_helper.rb']
 
   Config.reabsorb_file_greps = [/^#{Regexp.quote(_user_config_file)}$/,
-                                %r<(test|spec)/\1_helper\.rb>]
+                                %r<^(test|spec)/\1_helper\.rb$>]
 
-  Config.all_test_file_globs = ['{test,spec}/**/*_{test,spec}.rb']
+  Config.all_test_file_globs = ['{test,spec}/**/*_{test,spec}.rb',
+                                '{test,spec}/**/{test,spec}_*.rb']
 
   Config.test_file_globbers = {
     # source files that correspond to test files
     %r<^lib/.+\.rb$> => lambda do |path, matches|
       base = File.basename(path, '.rb')
-      "{test,spec}/**/#{base}_{test,spec}.rb"
+      ["{test,spec}/**/#{base}_{test,spec}.rb",
+       "{test,spec}/**/{test,spec}_#{base}.rb"]
     end,
 
     # the actual test files themselves
-    %r<^(test|spec)/.+_\1\.rb$> => lambda {|path, matches| path }
+    %r<^(test|spec)/.*(\1_[^/]+|[^/]+_\1)\.rb$> => proc {|path| path }
   }
 
   Config.before_fork_hooks = []
@@ -74,6 +76,8 @@ module Tork
     end
   ]
 
+  Config.test_event_hooks = []
+
   #---------------------------------------------------------------------------
   # overrides
   #---------------------------------------------------------------------------

data/lib/tork/config/factory_girl.rb

@@ -0,0 +1,10 @@
+require 'tork/config'
+
+Tork::Config.before_fork_hooks.push proc {
+  require 'factory_girl'
+  FactoryGirl.factories.clear
+}
+
+Tork::Config.after_fork_hooks.push proc {
+  FactoryGirl.find_definitions
+}

data/lib/tork/config/notify.rb

@@ -0,0 +1,34 @@
+require 'tork/config'
+require 'set'
+
+failed_test_files = Set.new
+
+Tork::Config.test_event_hooks.push lambda {|message|
+  event, test_file, line_numbers, log_file, worker_number, exit_status = message
+
+  # make notifications edge-triggered: pass => fail or vice versa.
+  # we do not care about pass => pass or fail => fail transitions.
+  case event.to_sym
+  when :fail
+    if failed_test_files.add? test_file
+      icon = 'dialog-error'
+    end
+  when :pass
+    if line_numbers.empty? and failed_test_files.delete? test_file
+      icon = 'dialog-information'
+    end
+  end
+
+  if icon
+    title = [event.upcase, test_file].join(' ')
+
+    statistics = File.readlines(log_file).grep(/^\d+ \w+,/).join.
+      gsub(/\e\[\d+(;\d+)?m/, '') # strip ANSI SGR escape codes
+
+    Thread.new do # run in background
+      system 'notify-send', '-i', icon, title, statistics or
+      system 'growlnotify', '-a', 'Xcode', '-m', statistics, title or
+      system 'xmessage', '-timeout', '5', '-title', title, statistics
+    end
+  end
+}

data/lib/tork/driver.rb

@@ -53,7 +53,8 @@ module Driver
         @passed_test_files.delete file
       end
 
-      @client.send message
+      @client.send message # propagate output downstream
+      Config.test_event_hooks.each {|hook| hook.call message }
     end
 
     @master.send [:load, Config.overhead_load_paths,
@@ -72,8 +73,8 @@ module Driver
 
         # find and run the tests that correspond to the changed file
         Config.test_file_globbers.each do |regexp, globber|
-          if regexp =~ changed_file and glob = globber.call(changed_file, $~)
-            run_test_files Dir[glob]
+          if regexp =~ changed_file and globs = globber.call(changed_file, $~)
+            run_test_files Dir[*globs]
           end
         end
 

data/lib/tork/master.rb

@@ -10,7 +10,7 @@ module Master
   def load paths, files
     $LOAD_PATH.unshift(*paths)
 
-    files.each do |file|
+    @overhead_files = files.each do |file|
       branch, leaf = File.split(file)
       file = leaf if paths.include? branch
       require file.sub(/\.rb$/, '')
@@ -20,6 +20,8 @@ module Master
   end
 
   def test test_file, line_numbers
+    return if @overhead_files.include? test_file
+
     # throttle forking rate to meet the maximum concurrent workers limit
     sleep 1 until @command_by_worker_pid.size < Config.max_forked_workers
 

data/lib/tork/version.rb

@@ -1,3 +1,3 @@
 module Tork
-  VERSION = "17.0.1"
+  VERSION = "17.1.0"
 end

data/man/man1/tork-driver.1

@@ -1,4 +1,4 @@
-.TH TORK\-DRIVER 1 2012\-01\-29 17.0.1
+.TH TORK\-DRIVER 1 2012\-01\-30 17.1.0
 .SH NAME
 .PP
 tork\-driver \- drives 

data/man/man1/tork-herald.1

@@ -1,4 +1,4 @@
-.TH TORK\-HERALD 1 2012\-01\-29 17.0.1
+.TH TORK\-HERALD 1 2012\-01\-30 17.1.0
 .SH NAME
 .PP
 tork\-herald \- reports modified files

data/man/man1/tork-master.1

@@ -1,4 +1,4 @@
-.TH TORK\-MASTER 1 2012\-01\-29 17.0.1
+.TH TORK\-MASTER 1 2012\-01\-30 17.1.0
 .SH NAME
 .PP
 tork\-master \- absorbs overhead and runs tests

data/man/man1/tork.1

@@ -1,4 +1,4 @@
-.TH TORK 1 2012\-01\-29 17.0.1
+.TH TORK 1 2012\-01\-30 17.1.0
 .SH NAME
 .PP
 tork \- Continuous testing tool for Ruby

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tork
 version: !ruby/object:Gem::Version
-  version: 17.0.1
+  version: 17.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-29 00:00:00.000000000 Z
+date: 2012-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binman
-  requirement: &13745920 !ruby/object:Gem::Requirement
+  requirement: &9258640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *13745920
+  version_requirements: *9258640
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &13745380 !ruby/object:Gem::Requirement
+  requirement: &9258120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -36,10 +36,10 @@ dependencies:
         version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *13745380
+  version_requirements: *9258120
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &13744640 !ruby/object:Gem::Requirement
+  requirement: &9257380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -50,10 +50,10 @@ dependencies:
         version: '1'
   type: :runtime
   prerelease: false
-  version_requirements: *13744640
+  version_requirements: *9257380
 - !ruby/object:Gem::Dependency
   name: diff-lcs
-  requirement: &13743900 !ruby/object:Gem::Requirement
+  requirement: &9256640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -64,10 +64,10 @@ dependencies:
         version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *13743900
+  version_requirements: *9256640
 - !ruby/object:Gem::Dependency
   name: md2man
-  requirement: &13743120 !ruby/object:Gem::Requirement
+  requirement: &9255920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -75,10 +75,10 @@ dependencies:
         version: '1'
   type: :development
   prerelease: false
-  version_requirements: *13743120
+  version_requirements: *9255920
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &13742600 !ruby/object:Gem::Requirement
+  requirement: &9255380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,7 +89,7 @@ dependencies:
         version: '1'
   type: :development
   prerelease: false
-  version_requirements: *13742600
+  version_requirements: *9255380
 description: Continuous testing tool for Ruby.
 email:
 - sunaku@gmail.com
@@ -116,7 +116,9 @@ files:
 - lib/tork/config.rb
 - lib/tork/config/cucumber.rb
 - lib/tork/config/dotlog.rb
+- lib/tork/config/factory_girl.rb
 - lib/tork/config/logdir.rb
+- lib/tork/config/notify.rb
 - lib/tork/config/parallel_tests.rb
 - lib/tork/config/rails.rb
 - lib/tork/driver.rb