test-loop 1.2.0 → 2.0.0

data/README.md

@@ -24,7 +24,7 @@ Features
 * Supports Test::Unit, RSpec, or any other testing framework that is utilized
   by your application's `test/test_helper.rb` and `spec/spec_helper.rb` files.
 
-* Implemented in less than 40 (SLOC) lines of code! :-)
+* Implemented in less than 60 (SLOC) lines of code! :-)
 
 
 Installation
@@ -63,7 +63,46 @@ Operation
 * Press Control-C (or send the SIGINT signal) to quit the test loop.
 
 
+Configuration
+-------------
+
+test-loop looks for a configuration file named `.test-loop` in the current
+working directory.  This configuration file is a normal Ruby script which can
+define the following instance variables:
+
+* `@overhead_file_globs` is an array of file globbing patterns that describe a
+  set of Ruby scripts that are loaded into the main Ruby process as overhead.
+
+* `@reabsorb_file_globs` is an array of file globbing patterns that describe a
+  set of files which cause the overhead to be reabsorbed whenever they change.
+
+* `@source_file_to_test_file_mapping` is a hash that maps a file globbing
+  pattern describing a set of source files to a [Rake pathmap expression](
+  http://rake.rubyforge.org/classes/String.html#M000017 ) yielding a file
+  globbing pattern describing a set of test files that need to be run.  In
+  other words, whenever the source files (the hash key; left-hand side of the
+  mapping) change, their associated test files (the hash value; right-hand
+  side of the mapping) are run.
+
+* `@after_test_execution` is a proc/lambda object that is executed after tests
+  are run.  It is passed three things: the status of the test execution
+  subprocess, the time when the tests were run, and the list of test files
+  that were run.
+
+  For example, to get on-screen-display notifications through libnotify,
+  add the following to your `.test-loop` file:
+
+      @after_test_execution = lambda do |status, ran_at, files|
+        if status.success?
+          result, icon = 'PASS', 'apple-green'
+        else
+          result, icon = 'FAIL', 'apple-red'
+        end
+        system 'notify-send', '-i', icon, "#{result} at #{ran_at}", files.join("\n")
+      end
+
+
 License
 -------
 
-See the LICENSE file for details.
+See the `bin/test-loop` file.

data/bin/test-loop

@@ -1,54 +1,98 @@
 #!/usr/bin/env ruby
-require 'rake' # for String#pathmap
+# Continuous testing for Ruby with fork/eval
+# https://github.com/sunaku/test-loop#readme
+#-----------------------------------------------------------------------------
+# (the ISC license)
+#
+# Copyright 2010 Suraj N. Kurapati <sunaku@gmail.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
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#-----------------------------------------------------------------------------
 
-# absorb test execution overhead into master process
-overhead_file_glob = '{test,spec}/*{test,spec}_helper.rb'
-$LOAD_PATH.unshift 'lib' # for non-Rails applications
+require 'rake' # for String#pathmap
 
-puts 'test-loop: Absorbing overhead...'
-Dir[overhead_file_glob].each do |file|
-  $LOAD_PATH.insert 1, file.pathmap('%d')
-  require file.pathmap('%n')
+def notify message
+  puts "test-loop: #{message}"
 end
 
-# continuously watch for and test changed code
-started_at = last_ran_at = Time.now
-never_ran_at = Time.at(0)
+begin
+  notify 'Loading configuration...'
+  config_file = File.join(Dir.pwd, '.test-loop')
+  load config_file if File.exist? config_file
 
-trap :QUIT do
-  puts 'test-loop: Re-executing loop...'
-  started_at = never_ran_at
-end
+  (@overhead_file_globs ||= []).
+    push('{test,spec}/*{test,spec}_helper.rb').uniq!
 
-trap :TSTP do
-  puts 'test-loop: Testing everything...'
-  last_ran_at = never_ran_at
-end
+  (@reabsorb_file_globs ||= []).
+    concat(@overhead_file_globs).
+    push(config_file, 'config/*.{rb,yml}').uniq!
 
-puts 'test-loop: Ready for testing!'
-loop do
-  # figure out what test files need to be run
-  test_files = {
+  (@source_file_to_test_file_mapping ||= {}).merge!(
     '{test,spec}/**/*_{test,spec}.rb' => '%p',
     '{lib,app}/**/*.rb' => '{test,spec}/**/%n_{test,spec}%x',
-  }.
-  map do |source_file_glob, test_file_pathmap|
-    Dir[source_file_glob].
-    select {|file| File.mtime(file) > last_ran_at }.
-    map {|path| Dir[path.pathmap(test_file_pathmap)] }
-  end.flatten.uniq
-
-  # fork worker process to run the test files
-  unless test_files.empty?
-    last_ran_at = Time.now
-    fork { test_files.each {|file| load file } }
-    Process.wait
+  )
+
+  @after_test_execution ||= lambda {|status, ran_at, files|}
+
+  # absorb test execution overhead into master process
+  $LOAD_PATH.unshift 'lib' # for non-Rails applications
+
+  notify 'Absorbing overhead...'
+  Dir[*@overhead_file_globs].each do |file|
+    $LOAD_PATH.insert 1, file.pathmap('%d')
+    require file.pathmap('%n')
   end
 
-  # reabsorb test execution overhead as necessary
-  if Dir[overhead_file_glob].any? {|file| File.mtime(file) > started_at }
-    exec 'ruby', __FILE__, *ARGV
+  # continuously watch for and test changed code
+  started_at = last_ran_at = Time.now
+  never_ran_at = Time.at(0)
+
+  trap :QUIT do
+    notify 'Re-executing loop...'
+    started_at = never_ran_at
+  end
+
+  trap :TSTP do
+    notify 'Testing everything...'
+    last_ran_at = never_ran_at
   end
 
-  sleep 1
+  notify 'Ready for testing!'
+  loop do
+    # figure out what test files need to be run
+    test_files = @source_file_to_test_file_mapping.
+    map do |source_file_glob, test_file_pathmap|
+      Dir[source_file_glob].
+      select {|file| File.mtime(file) > last_ran_at }.
+      map {|path| Dir[path.pathmap(test_file_pathmap)] }
+    end.flatten.uniq
+
+    # fork worker process to run the test files
+    unless test_files.empty?
+      last_ran_at = Time.now
+      fork { test_files.each {|file| notify file; load file } }
+      Process.wait
+      @after_test_execution.call($?, last_ran_at, test_files)
+    end
+
+    # reabsorb test execution overhead as necessary
+    if Dir[*@reabsorb_file_globs].any? {|file| File.mtime(file) > started_at }
+      exec $0, *ARGV
+    end
+
+    sleep 1
+  end
+rescue StandardError, LoadError => error
+  puts error.inspect, error.backtrace
+  sleep 1 and exec $0, *ARGV
 end

metadata

@@ -3,10 +3,10 @@ name: test-loop
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 1
   - 2
   - 0
-  version: 1.2.0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Suraj N. Kurapati
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-23 00:00:00 -08:00
+date: 2010-12-31 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -27,7 +27,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- LICENSE
 - README.md
 - bin/test-loop
 has_rdoc: true

data/LICENSE

@@ -1,15 +0,0 @@
-(the ISC license)
-
-Copyright 2010 Suraj N. Kurapati <sunaku@gmail.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
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.