test-loop 9.1.0 → 9.1.1

data/README.md

@@ -9,17 +9,6 @@ detects and tests changes in your application in an efficient manner:
 3. Avoids running unchanged test blocks inside changed test files.
 
 
-> IMPORTANT note for Ruby on Rails users!
-> ---------------------------------------
->
-> Ensure that your `config/environments/test.rb` file disables class caching:
->
->     config.cache_classes = false
->
-> Otherwise, test-loop will appear to ignore class-level changes in your
-> models, controllers, helpers, etc. thereby causing you great frustration!
-
-
 Features
 --------
 
@@ -67,7 +56,7 @@ If installed as a Ruby gem:
 
 If installed as a Git clone:
 
-    ruby bin/test-loop
+    env RUBYLIB=lib ruby bin/test-loop
 
 
 Operation
@@ -193,6 +182,23 @@ you can query and modify the `Test::Loop` OpenStruct configuration as follows:
       end
 
 
+Known issues
+------------
+
+* Ensure that your `config/environments/test.rb` file disables class caching:
+
+      config.cache_classes = false
+
+  Otherwise, test-loop will appear to ignore class-level changes in your
+  models, controllers, helpers, etc. thereby causing you great frustration!
+
+* SQLite3 [raises `SQLite3::BusyException: database is locked` errors](
+  https://github.com/sunaku/test-loop/issues/2 ) because test-loop runs your
+  test files in parallel.  You can work around this by using an [in-memory
+  adapter for SQLite3]( https://github.com/mvz/memory_test_fix ) or by using
+  different database software (such as MySQL) for your test environment.
+
+
 License
 -------
 

data/bin/test-loop

@@ -1,233 +1,3 @@
 #!/usr/bin/env ruby
-#
-# test-loop - 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.
-#
-
-require 'ostruct'
-require 'diff/lcs'
-require 'ansi'
-
-module Test
-  Loop = OpenStruct.new
-
-  Loop.overhead_file_globs = ['{test,spec}/{test,spec}_helper.rb']
-
-  Loop.reabsorb_file_globs = Loop.overhead_file_globs +
-    ['config/**/*.{rb,yml}', 'Gemfile.lock']
-
-  Loop.test_file_matchers = {
-    # source files that correspond to test files
-    '{lib,app}/**/*.rb' => lambda do |path|
-      extn = File.extname(path)
-      base = File.basename(path, extn)
-      "{test,spec}/**/#{base}_{test,spec}#{extn}"
-    end,
-
-    # the actual test files themselves
-    '{test,spec}/**/*_{test,spec}.rb' => lambda {|path| path }
-  }
-
-  Loop.test_name_parser = lambda do |line|
-    case line
-    when /^\s*def\s+test_(\w+)/ then $1
-    when /^\s*(test|context|should|describe|it)\b.+?(['"])(.*?)\2/ then $3
-    end
-  end
-
-  Loop.before_each_test = lambda do |test_file, log_file, test_names|
-    unless test_names.empty?
-      test_name_pattern = test_names.map do |name|
-        # sanitize string interpolations and invalid method name characters
-        name.gsub(/\#\{.*?\}/, ' ').strip.gsub(/\W+/, '.*')
-      end.join('|')
-
-      case File.basename(test_file)
-      when /(\b|_)test(\b|_)/ # Test::Unit
-        ARGV.push '--name', "/#{test_name_pattern}/"
-      when /(\b|_)spec(\b|_)/ # RSpec
-        ARGV.push '--example', test_name_pattern
-      end
-    end
-  end
-
-  Loop.after_each_test =
-    lambda {|test_file, log_file, run_status, started_at, elapsed_time|}
-
-  class << Loop
-    def run
-      init_test_loop
-      register_signals
-      load_user_config
-      absorb_overhead
-      run_test_loop
-    rescue Exception => error
-      STDERR.puts error.inspect, error.backtrace
-      pause_momentarily
-      reload_master_process
-    end
-
-    private
-
-    EXEC_VECTOR = [$0, *ARGV].map {|s| s.dup.freeze }.freeze
-
-    def notify message
-      # using print() because puts() is not an atomic operation
-      print "test-loop: #{message}\n"
-    end
-
-    def register_signals
-      # puts newline to shield normal output from control-key interference:
-      # some shells like BASH emit text when control-key combos are pressed
-      trap(:INT) { puts; kill_master_and_workers }
-      trap(:QUIT) { puts; reload_master_process }
-      trap(:TSTP) { puts; forcibly_run_all_tests }
-    end
-
-    def kill_master_and_workers
-      Process.kill :KILL, -$$
-    end
-
-    def reload_master_process
-      notify 'Restarting loop...'
-      exec(*EXEC_VECTOR)
-    end
-
-    def pause_momentarily
-      sleep 1
-    end
-
-    def load_user_config
-      if File.exist? config_file = File.join(Dir.pwd, '.test-loop')
-        notify 'Loading configuration...'
-        load config_file
-      end
-    end
-
-    def absorb_overhead
-      notify 'Absorbing overhead...'
-      $LOAD_PATH.unshift 'lib', 'test', 'spec'
-      Dir[*overhead_file_globs].each do |file|
-        require File.basename(file, File.extname(file))
-      end
-    end
-
-    def init_test_loop
-      @running_files = []
-      @running_files_lock = Mutex.new
-      @lines_by_file = {} # path => readlines
-      @last_ran_at = @started_at = Time.now
-    end
-
-    def forcibly_run_all_tests
-      @last_ran_at = Time.at(0)
-      @lines_by_file.clear
-    end
-
-    def run_test_loop
-      notify 'Ready for testing!'
-      loop do
-        # figure out what test files need to be run
-        test_files = test_file_matchers.map do |source_glob, test_matcher|
-          Dir[source_glob].select {|file| File.mtime(file) > @last_ran_at }.
-          map {|path| Dir[test_matcher.call path] }
-        end.flatten.uniq
-
-        test_files = @running_files_lock.
-          synchronize { test_files - @running_files }
-
-        # fork worker processes to run the test files in parallel
-        @last_ran_at = Time.now
-        test_files.each {|file| run_test_file file }
-
-        # reabsorb test execution overhead as necessary
-        reload_master_process if Dir[*reabsorb_file_globs].
-          any? {|file| File.mtime(file) > @started_at }
-
-        pause_momentarily
-      end
-    end
-
-    def run_test_file test_file
-      @running_files_lock.synchronize { @running_files.push test_file }
-      log_file = test_file + '.log'
-
-      # cache the contents of the test file for diffing below
-      new_lines = File.readlines(test_file)
-      old_lines = @lines_by_file[test_file] || new_lines
-      @lines_by_file[test_file] = new_lines
-
-      worker_pid = fork do
-        # capture test output in log file because tests are run in parallel
-        # which makes it difficult to understand interleaved output thereof
-        $stdout.reopen log_file, 'w'
-        $stdout.sync = true
-        $stderr.reopen $stdout
-
-        # determine which test blocks have changed inside the test file
-        test_names = Diff::LCS.diff(old_lines, new_lines).flatten.map do |change|
-          catch :found do
-            # search backwards from the line that changed up to
-            # the first line in the file for test definitions
-            change.position.downto(0) do |i|
-              if test_name = test_name_parser.call(new_lines[i])
-                throw :found, test_name
-              end
-            end; nil # prevent unsuccessful search from returning an integer
-          end
-        end.compact.uniq
-
-        # tell the testing framework to run only the changed test blocks
-        before_each_test.call test_file, log_file, test_names
-
-        # after loading the user's test file, the at_exit() hook of the
-        # user's testing framework will take care of running the tests and
-        # reflecting any failures in the worker process' exit status
-        load $0 = test_file # set $0 because Test::Unit outputs it
-      end
-
-      # monitor and report on the worker's progress
-      Thread.new do
-        notify "TEST #{test_file}"
-
-        # wait for worker to finish
-        Process.waitpid worker_pid
-        run_status = $?
-        elapsed_time = Time.now - @last_ran_at
-
-        # report test results along with any failure logs
-        if run_status.success?
-          notify ANSI::Code.green("PASS #{test_file}")
-        else
-          notify ANSI::Code.red("FAIL #{test_file}")
-          STDERR.print File.read(log_file)
-        end
-
-        after_each_test.call \
-          test_file, log_file, run_status, @last_ran_at, elapsed_time
-
-        @running_files_lock.synchronize { @running_files.delete test_file }
-      end
-    end
-  end
-end
-
-Test::Loop.run if $0 == __FILE__
+require 'test/loop'
+Test::Loop.run

data/lib/test/loop.rb

@@ -0,0 +1,230 @@
+#
+# test-loop - 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.
+#
+
+require 'ostruct'
+require 'diff/lcs'
+require 'ansi'
+
+module Test
+  Loop = OpenStruct.new
+
+  Loop.overhead_file_globs = ['{test,spec}/{test,spec}_helper.rb']
+
+  Loop.reabsorb_file_globs = Loop.overhead_file_globs +
+    ['config/**/*.{rb,yml}', 'Gemfile.lock']
+
+  Loop.test_file_matchers = {
+    # source files that correspond to test files
+    '{lib,app}/**/*.rb' => lambda do |path|
+      extn = File.extname(path)
+      base = File.basename(path, extn)
+      "{test,spec}/**/#{base}_{test,spec}#{extn}"
+    end,
+
+    # the actual test files themselves
+    '{test,spec}/**/*_{test,spec}.rb' => lambda {|path| path }
+  }
+
+  Loop.test_name_parser = lambda do |line|
+    case line
+    when /^\s*def\s+test_(\w+)/ then $1
+    when /^\s*(test|context|should|describe|it)\b.+?(['"])(.*?)\2/ then $3
+    end
+  end
+
+  Loop.before_each_test = lambda do |test_file, log_file, test_names|
+    unless test_names.empty?
+      test_name_pattern = test_names.map do |name|
+        # sanitize string interpolations and invalid method name characters
+        name.gsub(/\#\{.*?\}/, ' ').strip.gsub(/\W+/, '.*')
+      end.join('|')
+
+      case File.basename(test_file)
+      when /(\b|_)test(\b|_)/ # Test::Unit
+        ARGV.push '--name', "/#{test_name_pattern}/"
+      when /(\b|_)spec(\b|_)/ # RSpec
+        ARGV.push '--example', test_name_pattern
+      end
+    end
+  end
+
+  Loop.after_each_test =
+    lambda {|test_file, log_file, run_status, started_at, elapsed_time|}
+
+  class << Loop
+    def run
+      init_test_loop
+      register_signals
+      load_user_config
+      absorb_overhead
+      run_test_loop
+    rescue Exception => error
+      STDERR.puts error.inspect, error.backtrace
+      pause_momentarily
+      reload_master_process
+    end
+
+    private
+
+    EXEC_VECTOR = [$0, *ARGV].map {|s| s.dup.freeze }.freeze
+
+    def notify message
+      # using print() because puts() is not an atomic operation
+      print "test-loop: #{message}\n"
+    end
+
+    def register_signals
+      # puts newline to shield normal output from control-key interference:
+      # some shells like BASH emit text when control-key combos are pressed
+      trap(:INT) { puts; kill_master_and_workers }
+      trap(:QUIT) { puts; reload_master_process }
+      trap(:TSTP) { puts; forcibly_run_all_tests }
+    end
+
+    def kill_master_and_workers
+      Process.kill :KILL, -$$
+    end
+
+    def reload_master_process
+      notify 'Restarting loop...'
+      exec(*EXEC_VECTOR)
+    end
+
+    def pause_momentarily
+      sleep 1
+    end
+
+    def load_user_config
+      if File.exist? config_file = File.join(Dir.pwd, '.test-loop')
+        notify 'Loading configuration...'
+        load config_file
+      end
+    end
+
+    def absorb_overhead
+      notify 'Absorbing overhead...'
+      $LOAD_PATH.unshift 'lib', 'test', 'spec'
+      Dir[*overhead_file_globs].each do |file|
+        require File.basename(file, File.extname(file))
+      end
+    end
+
+    def init_test_loop
+      @running_files = []
+      @running_files_lock = Mutex.new
+      @lines_by_file = {} # path => readlines
+      @last_ran_at = @started_at = Time.now
+    end
+
+    def forcibly_run_all_tests
+      @last_ran_at = Time.at(0)
+      @lines_by_file.clear
+    end
+
+    def run_test_loop
+      notify 'Ready for testing!'
+      loop do
+        # figure out what test files need to be run
+        test_files = test_file_matchers.map do |source_glob, test_matcher|
+          Dir[source_glob].select {|file| File.mtime(file) > @last_ran_at }.
+          map {|path| Dir[test_matcher.call path] }
+        end.flatten.uniq
+
+        test_files = @running_files_lock.
+          synchronize { test_files - @running_files }
+
+        # fork worker processes to run the test files in parallel
+        @last_ran_at = Time.now
+        test_files.each {|file| run_test_file file }
+
+        # reabsorb test execution overhead as necessary
+        reload_master_process if Dir[*reabsorb_file_globs].
+          any? {|file| File.mtime(file) > @started_at }
+
+        pause_momentarily
+      end
+    end
+
+    def run_test_file test_file
+      @running_files_lock.synchronize { @running_files.push test_file }
+      log_file = test_file + '.log'
+
+      # cache the contents of the test file for diffing below
+      new_lines = File.readlines(test_file)
+      old_lines = @lines_by_file[test_file] || new_lines
+      @lines_by_file[test_file] = new_lines
+
+      worker_pid = fork do
+        # capture test output in log file because tests are run in parallel
+        # which makes it difficult to understand interleaved output thereof
+        $stdout.reopen log_file, 'w'
+        $stdout.sync = true
+        $stderr.reopen $stdout
+
+        # determine which test blocks have changed inside the test file
+        test_names = Diff::LCS.diff(old_lines, new_lines).flatten.map do |change|
+          catch :found do
+            # search backwards from the line that changed up to
+            # the first line in the file for test definitions
+            change.position.downto(0) do |i|
+              if test_name = test_name_parser.call(new_lines[i])
+                throw :found, test_name
+              end
+            end; nil # prevent unsuccessful search from returning an integer
+          end
+        end.compact.uniq
+
+        # tell the testing framework to run only the changed test blocks
+        before_each_test.call test_file, log_file, test_names
+
+        # after loading the user's test file, the at_exit() hook of the
+        # user's testing framework will take care of running the tests and
+        # reflecting any failures in the worker process' exit status
+        load $0 = test_file # set $0 because Test::Unit outputs it
+      end
+
+      # monitor and report on the worker's progress
+      Thread.new do
+        notify "TEST #{test_file}"
+
+        # wait for worker to finish
+        Process.waitpid worker_pid
+        run_status = $?
+        elapsed_time = Time.now - @last_ran_at
+
+        # report test results along with any failure logs
+        if run_status.success?
+          notify ANSI::Code.green("PASS #{test_file}")
+        else
+          notify ANSI::Code.red("FAIL #{test_file}")
+          STDERR.print File.read(log_file)
+        end
+
+        after_each_test.call \
+          test_file, log_file, run_status, @last_ran_at, elapsed_time
+
+        @running_files_lock.synchronize { @running_files.delete test_file }
+      end
+    end
+  end
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: test-loop
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 9
-  - 1
-  - 0
-  version: 9.1.0
+  prerelease: 
+  version: 9.1.1
 platform: ruby
 authors: 
 - Suraj N. Kurapati
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-23 00:00:00 -08:00
+date: 2011-03-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,10 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 1
-        - 2
         version: 1.1.2
   type: :runtime
   version_requirements: *id001
@@ -40,10 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 2
         version: 1.2.2
   type: :runtime
   version_requirements: *id002
@@ -58,6 +46,7 @@ extra_rdoc_files: []
 files: 
 - README.md
 - bin/test-loop
+- lib/test/loop.rb
 has_rdoc: true
 homepage: http://github.com/sunaku/test-loop
 licenses: []
@@ -72,21 +61,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Continuous testing for Ruby with fork/eval