testr 14.1.0 → 14.1.1

data/HISTORY.markdown

@@ -1,3 +1,34 @@
+------------------------------------------------------------------------------
+Version 14.1.1 (2011-12-07)
+------------------------------------------------------------------------------
+
+Bug fixes:
+
+  * Do not fail when given test file no longer exists.
+
+  * Make xUnit `--name` option regexp case-insensitive.
+
+  * RSpec does not accept regexp for `--example` option;
+    see https://github.com/rspec/rspec-core/issues/445
+    and https://github.com/dchelimsky/rspec/issues/44
+
+  * Ruby 187 does not have Symbol#upcase() method.
+
+Housekeeping:
+
+  * README: add another SQLite3 error to known issues.
+    Thanks to Luke Wendling for contributing this patch.
+
+  * README: add a section explaining usage and theory.
+
+  * README: show example earlier in factory_girl tip.
+
+  * README: update lines of code statistic: 372 SLOC.
+
+  * Better variable naming for self-documentation.
+
+  * Upgrade to binman 2.0.0 for UNIX man pages.
+
 ------------------------------------------------------------------------------
 Version 14.1.0 (2011-11-03)
 ------------------------------------------------------------------------------

data/README.markdown

@@ -28,7 +28,7 @@ Features
 
   * Configurable through a Ruby script in your current working directory.
 
-  * Implemented in less than 360 lines (SLOC) of pure Ruby code! :-)
+  * Implemented in less than 380 lines (SLOC) of pure Ruby code! :-)
 
 ------------------------------------------------------------------------------
 Architecture
@@ -43,6 +43,23 @@ Following UNIX philosophy, TestR is made of simple text-based programs:
 
 You can build your own custom TestR user interface by wrapping `testr-driver`!
 
+------------------------------------------------------------------------------
+Usage and theory of operation
+------------------------------------------------------------------------------
+
+Run `testr` to launch the command-line user interface for `testr-driver`.  It
+will present a menu of commands and then wait for you to input a command while
+the driver waits for `testr-herald` to tell it about changes in your tests.
+
+When the driver hears about changes in your test files, it tells the master to
+fork a worker process to run the tests affected by those changes.  This is all
+performed automatically.  But what if you want to manually run a test file?
+
+You can re-run any test file by simply saving it!  When you do, TestR tries to
+figure out which tests inside your newly saved test file have changed (using
+diff and regexps) and then attempts to run just those.  To make it run *all*
+tests in your saved file, simply save the file *again* without changing it.
+
 ------------------------------------------------------------------------------
 Prerequisites
 ------------------------------------------------------------------------------
@@ -252,15 +269,15 @@ whenever you change an existing factory definition or create a new one.
 
 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).
+(whose execution is started by your test framework's own `at_exit()` handler):
+
+    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.  Also, don't load your factories or do
 anything else in your `at_exit()` handler if Ruby is exiting because of a
-raised exception (denoted by the `$!` global variable in the snippet below).
-
-    require 'factory_girl'
-    at_exit { FactoryGirl.find_definitions unless $! }
+raised exception (denoted by the `$!` global variable in the snippet above).
 
 ------------------------------------------------------------------------------
 Known issues
@@ -277,12 +294,14 @@ Known issues
     Otherwise, TestR will appear to ignore source-code changes in your
     models, controllers, helpers, and other Ruby source files.
 
-  * SQLite3 [raises `SQLite3::BusyException: database is locked` errors](
-    https://github.com/sunaku/test-loop/issues/2 ) because TestR 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
+  * If SQLite3 raises one of the following errors, try using an [in-memory
+    adapter for SQLite3]( https://github.com/mvz/memory_test_fix ) or use
     different database software (such as MySQL) for your test environment.
 
+    * SQLite3::BusyException: database is locked
+
+    * cannot start a transaction within a transaction
+
 ------------------------------------------------------------------------------
 License
 ------------------------------------------------------------------------------

data/Rakefile

@@ -1,2 +1 @@
 require "bundler/gem_tasks"
-require 'binman/rake_tasks'

data/bin/testr

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 =begin
 
-TESTR 1 "2011-11-03" "14.1.0" "TestR User Manuals"
-==================================================
+TESTR 1 "2011-12-07" "14.1.1"
+=============================
 
 NAME
 ----
@@ -52,14 +52,15 @@ require 'json'
 require 'testr/client'
 
 @driver = TestR::Client::Transceiver.new('testr-driver') do |line|
-  event, *details = JSON.load(line)
+  evstr, *details = JSON.load(line)
+  event = evstr.to_sym
 
-  case event = event.to_sym
+  case event
   when :load then warn 'testr: Overhead absorbed. Ready for testing!'
   when :over then warn 'testr: Reabsorbing changed overhead files...'
   else
     test_file, test_names, *details = details
-    message = [event.upcase, test_file, test_names.inspect, details].join(' ')
+    message = [evstr.upcase, test_file, test_names.inspect, details].join(' ')
 
     color = case event
             when :pass then "\e[34m%s\e[0m" # blue

data/bin/testr-driver

@@ -1,13 +1,13 @@
 #!/usr/bin/env ruby
 =begin
 
-TESTR-DRIVER 1 "2011-11-03" "14.1.0" "TestR User Manuals"
-=========================================================
+TESTR-DRIVER 1 "2011-12-07" "14.1.1"
+====================================
 
 NAME
 ----
 
-testr-driver - tells master to run tests and keeps track of test results
+testr-driver - drives testr-master(1) and does bookkeeping
 
 SYNOPSIS
 --------
@@ -46,8 +46,8 @@ OPTIONS
 FILES
 -----
 
-`.testr.rb`
-  Ruby script in the directory where testr(1) is run.
+*.testr.rb*
+  Optional Ruby script for configuring testr(1).
 
 SEE ALSO
 --------

data/bin/testr-herald

@@ -1,13 +1,13 @@
 #!/usr/bin/env ruby
 =begin
 
-TESTR-HERALD 1 "2011-11-03" "14.1.0" "TestR User Manuals"
-=========================================================
+TESTR-HERALD 1 "2011-12-07" "14.1.1"
+====================================
 
 NAME
 ----
 
-testr-herald - monitors current directory tree and reports modified files
+testr-herald - reports modified files
 
 SYNOPSIS
 --------

data/bin/testr-master

@@ -1,13 +1,13 @@
 #!/usr/bin/env ruby
 =begin
 
-TESTR-MASTER 1 "2011-11-03" "14.1.0" "TestR User Manuals"
-=========================================================
+TESTR-MASTER 1 "2011-12-07" "14.1.1"
+====================================
 
 NAME
 ----
 
-testr-master - absorbs test execution overhead and forks to run your tests
+testr-master - absorbs overhead and runs tests
 
 SYNOPSIS
 --------
@@ -57,8 +57,8 @@ OPTIONS
 FILES
 -----
 
-`.testr.rb`
-  Ruby script in the directory where testr(1) is run.
+*.testr.rb*
+  Optional Ruby script for configuring testr(1).
 
 SEE ALSO
 --------

data/lib/testr/config.rb

@@ -46,14 +46,16 @@ module TestR
     # tell testing framework to only run the named tests inside the test file
     lambda do |worker_number, log_file, test_file, test_names|
       unless test_names.empty?
-        regexp = test_names.map {|name|
-          # sanitize string interpolations and invalid method name characters
-          name.gsub(/\#\{.*?\}/, ' ').strip.gsub(/\W+/, '.*')
-        }.join('|')
-
         case File.basename(test_file)
-        when /(\b|_)test(\b|_)/ then ARGV.push '--name', "/#{regexp}/"
-        when /(\b|_)spec(\b|_)/ then ARGV.push '--example', regexp.source
+        when /(\b|_)test(\b|_)/ # Test::Unit
+          ARGV.push '--name', "/(?i:#{
+            test_names.map do |name|
+              # elide string interpolation and invalid method name characters
+              name.gsub(/\#\{.*?\}/, ' ').strip.gsub(/\W+/, '.*')
+            end.join('|')
+          })/"
+        when /(\b|_)spec(\b|_)/ # RSpec
+          test_names.each {|name| ARGV.push '--example', name }
         end
       end
     end

data/lib/testr/driver.rb

@@ -104,7 +104,7 @@ private
   end
 
   def run_test_file file
-    unless @waiting_test_files.include? file
+    if File.exist? file and not @waiting_test_files.include? file
       @waiting_test_files.push file
       @master.send [:test, file, find_changed_test_names(file)]
     end

data/lib/testr/server.rb

@@ -28,8 +28,8 @@ module Server
     end
   end
 
-  def self.extended target
-    trap(:SIGTERM){ target.quit }
+  def self.extended server
+    trap(:SIGTERM){ server.quit }
   end
 
 end

data/lib/testr/version.rb

@@ -1,3 +1,3 @@
 module TestR
-  VERSION = "14.1.0"
+  VERSION = "14.1.1"
 end

data/man/man1/testr-driver.1

@@ -1,47 +1,48 @@
-.TH TESTR-DRIVER 1 "2011-11-03" "14.1.0" "TestR User Manuals"
+.TH TESTR\-DRIVER 1 "2011\-12\-07" "14.1.1"
 .SH NAME
 .PP
-testr-driver \- tells master to run tests and keeps track of test results
+testr\-driver \- drives 
+.BR testr\-master (1) 
+and does bookkeeping
 .SH SYNOPSIS
 .PP
-\fBtestr-driver\fP [\fIOPTION\fP]...
+\fB\fCtestr-driver\fR [\fIOPTION\fP]...
 .SH DESCRIPTION
 .PP
-This program reads the following single-line commands (JSON arrays) from its
+This program reads the following single\-line commands (JSON arrays) from its
 standard input stream and performs the respective actions as described below.
 It also funnels the standard output stream of 
-.BR testr-master (1) 
+.BR testr\-master (1) 
 into its own.
 .TP
-\fB["run_all_test_files"]\fP
+\fB\fC["run_all_test_files"]\fR
 Runs all test files found within and beneath the current working directory.
 .TP
-\fB["stop_running_test_files"]\fP
+\fB\fC["stop_running_test_files"]\fR
 Stops any test files that are currently running.
 .TP
-\fB["rerun_passed_test_files"]\fP
+\fB\fC["rerun_passed_test_files"]\fR
 Runs all test files that have passed during their most recent run.
 .TP
-\fB["reabsorb_overhead_files"]\fP
+\fB\fC["reabsorb_overhead_files"]\fR
 Stops any test files that are currently running, reabsorbs the test
 execution overhead, and resumes running those interrupted test files.
 .TP
-\fB["quit"]\fP
+\fB\fC["quit"]\fR
 Stops all tests that are currently running and exits.
 .SH OPTIONS
 .TP
-\fB-h\fP, \fB--help\fP
+\fB\fC-h\fR, \fB\fC--help\fR
 Display this help manual using 
 .BR man (1).
 .SH FILES
 .TP
-\fB.testr.rb\fP
-Ruby script in the directory where 
-.BR testr (1) 
-is run.
+\fI.testr.rb\fP
+Optional Ruby script for configuring 
+.BR testr (1).
 .SH SEE ALSO
 .PP
 .BR testr (1), 
-.BR testr-driver (1), 
-.BR testr-master (1), 
-.BR testr-herald (1)
+.BR testr\-driver (1), 
+.BR testr\-master (1), 
+.BR testr\-herald (1)

data/man/man1/testr-herald.1

@@ -1,22 +1,22 @@
-.TH TESTR-HERALD 1 "2011-11-03" "14.1.0" "TestR User Manuals"
+.TH TESTR\-HERALD 1 "2011\-12\-07" "14.1.1"
 .SH NAME
 .PP
-testr-herald \- monitors current directory tree and reports modified files
+testr\-herald \- reports modified files
 .SH SYNOPSIS
 .PP
-\fBtestr-herald\fP [\fIOPTION\fP]...
+\fB\fCtestr-herald\fR [\fIOPTION\fP]...
 .SH DESCRIPTION
 .PP
 This program monitors the current working directory and prints relative paths
 of modified files, one per line, to the standard output stream.
 .SH OPTIONS
 .TP
-\fB-h\fP, \fB--help\fP
+\fB\fC-h\fR, \fB\fC--help\fR
 Display this help manual using 
 .BR man (1).
 .SH SEE ALSO
 .PP
 .BR testr (1), 
-.BR testr-driver (1), 
-.BR testr-master (1), 
-.BR testr-herald (1)
+.BR testr\-driver (1), 
+.BR testr\-master (1), 
+.BR testr\-herald (1)

data/man/man1/testr-master.1

@@ -1,21 +1,21 @@
-.TH TESTR-MASTER 1 "2011-11-03" "14.1.0" "TestR User Manuals"
+.TH TESTR\-MASTER 1 "2011\-12\-07" "14.1.1"
 .SH NAME
 .PP
-testr-master \- absorbs test execution overhead and forks to run your tests
+testr\-master \- absorbs overhead and runs tests
 .SH SYNOPSIS
 .PP
-\fBtestr-master\fP [\fIOPTION\fP]...
+\fB\fCtestr-master\fR [\fIOPTION\fP]...
 .SH DESCRIPTION
 .PP
-This program reads the following single-line commands (JSON arrays) from its
+This program reads the following single\-line commands (JSON arrays) from its
 standard input stream and performs the respective actions as described below.
 .TP
-\fB["load",\fP \fIpaths\fP\fB,\fP \fIfiles\fP\fB]\fP
+\fB\fC["load",\fR \fIpaths\fP\fB\fC,\fR \fIfiles\fP\fB\fC]\fR
 Adds the given array of \fIpaths\fP to Ruby's $LOAD_PATH, loads the given array
 of \fIfiles\fP after removing their ".rb" file extension if present, and prints
 the given command line to the standard output stream.
 .TP
-\fB["test",\fP \fItest_file\fP\fB,\fP \fItest_names\fP\fB]\fP
+\fB\fC["test",\fR \fItest_file\fP\fB\fC,\fR \fItest_names\fP\fB\fC]\fR
 Runs the given \fItest_file\fP in a forked child process while instructing your
 chosen unit testing framework (loaded by your test execution overhead) to
 only run those tests that are named in the given array of \fItest_names\fP.
@@ -23,34 +23,33 @@ only run those tests that are named in the given array of \fItest_names\fP.
 Prints the given command line to the standard output stream immediately
 after forking the child process.
 .IP
-Prints the given command line, modified with \fB"pass"\fP (if the test passed)
-or \fB"fail"\fP (if the test failed) in place of \fB"test"\fP, to the standard
+Prints the given command line, modified with \fB\fC"pass"\fR (if the test passed)
+or \fB\fC"fail"\fR (if the test failed) in place of \fB\fC"test"\fR, to the standard
 output stream after the forked child process finishes.
 .IP
 The standard output and error streams of the forked child process are
 redirected to a file whose path and name are the same as that of the test
 file being run by the forked child process but with ".log" appended.
 .TP
-\fB["stop"]\fP
+\fB\fC["stop"]\fR
 Stops all tests that are currently running and prints the given command line
 to the standard output stream.
 .TP
-\fB["quit"]\fP
+\fB\fC["quit"]\fR
 Stops all tests that are currently running and exits.
 .SH OPTIONS
 .TP
-\fB-h\fP, \fB--help\fP
+\fB\fC-h\fR, \fB\fC--help\fR
 Display this help manual using 
 .BR man (1).
 .SH FILES
 .TP
-\fB.testr.rb\fP
-Ruby script in the directory where 
-.BR testr (1) 
-is run.
+\fI.testr.rb\fP
+Optional Ruby script for configuring 
+.BR testr (1).
 .SH SEE ALSO
 .PP
 .BR testr (1), 
-.BR testr-driver (1), 
-.BR testr-master (1), 
-.BR testr-herald (1)
+.BR testr\-driver (1), 
+.BR testr\-master (1), 
+.BR testr\-herald (1)

data/man/man1/testr.1

@@ -1,40 +1,40 @@
-.TH TESTR 1 "2011-11-03" "14.1.0" "TestR User Manuals"
+.TH TESTR 1 "2011\-12\-07" "14.1.1"
 .SH NAME
 .PP
 testr \- Continuous testing tool for Ruby
 .SH SYNOPSIS
 .PP
-\fBtestr\fP [\fIOPTION\fP]...
+\fB\fCtestr\fR [\fIOPTION\fP]...
 .SH DESCRIPTION
 .PP
-This program is a simple command-line user interface for 
-.BR testr-driver (1).  
+This program is a simple command\-line user interface for 
+.BR testr\-driver (1).  
 It
 demonstrates how the components of TestR work together and also serves as an
 example of how you can create your own TestR user interface.
 .PP
-When run, it presents you with a menu of single-character commands that you
+When run, it presents you with a menu of single\-character commands that you
 can enter, loads the test execution overhead into 
-.BR testr-master (1), 
+.BR testr\-master (1), 
 and
 finally notifies you when the master is ready to run test files.
 .PP
 It also launches 
-.BR testr-herald (1) 
+.BR testr\-herald (1) 
 alongside 
-.BR testr-master (1).  
+.BR testr\-master (1).  
 When the herald
 reports a modified file that belongs to the test execution overhead, this
 program notifies you accordingly and then replaces the current master with a
 new one that will absorb the modified test execution overhead into itself.
 .SH OPTIONS
 .TP
-\fB-h\fP, \fB--help\fP
+\fB\fC-h\fR, \fB\fC--help\fR
 Display this help manual using 
 .BR man (1).
 .SH SEE ALSO
 .PP
 .BR testr (1), 
-.BR testr-driver (1), 
-.BR testr-master (1), 
-.BR testr-herald (1)
+.BR testr\-driver (1), 
+.BR testr\-master (1), 
+.BR testr\-herald (1)

data/testr.gemspec

@@ -1,6 +1,7 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "testr/version"
+require "binman/gemspec"
 
 Gem::Specification.new do |s|
   s.name        = "testr"
@@ -22,13 +23,4 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "json", ">= 1.6.1"
   s.add_runtime_dependency "guard", ">= 0.8.4"
   s.add_runtime_dependency "diff-lcs", ">= 1.1.2"
-
-  # add binman and all of its development dependencies
-  binman_gem = ['binman', '~> 1']
-  s.add_runtime_dependency(*binman_gem)
-  binman_vers = Gem::Dependency.new(*binman_gem)
-  binman_spec = Gem::SpecFetcher.fetcher.fetch(binman_vers).flatten.first
-  binman_spec.development_dependencies.unshift(binman_vers).each do |dep|
-    s.add_development_dependency dep.name, dep.requirements_list
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testr
 version: !ruby/object:Gem::Version
-  version: 14.1.0
+  version: 14.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,11 +13,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-04 00:00:00.000000000 Z
+date: 2011-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &23388540 !ruby/object:Gem::Requirement
+  requirement: &21787300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -25,10 +25,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *23388540
+  version_requirements: *21787300
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &23387820 !ruby/object:Gem::Requirement
+  requirement: &21786500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -36,10 +36,10 @@ dependencies:
         version: 0.8.4
   type: :runtime
   prerelease: false
-  version_requirements: *23387820
+  version_requirements: *21786500
 - !ruby/object:Gem::Dependency
   name: diff-lcs
-  requirement: &23386940 !ruby/object:Gem::Requirement
+  requirement: &21785620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -47,40 +47,40 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *23386940
+  version_requirements: *21785620
 - !ruby/object:Gem::Dependency
   name: binman
-  requirement: &23386420 !ruby/object:Gem::Requirement
+  requirement: &20910280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *23386420
+  version_requirements: *20910280
 - !ruby/object:Gem::Dependency
   name: binman
-  requirement: &25642060 !ruby/object:Gem::Requirement
+  requirement: &20996280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :development
   prerelease: false
-  version_requirements: *25642060
+  version_requirements: *20996280
 - !ruby/object:Gem::Dependency
-  name: redcarpet-manpage
-  requirement: &25641520 !ruby/object:Gem::Requirement
+  name: md2man
+  requirement: &20995240 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '1'
   type: :development
   prerelease: false
-  version_requirements: *25641520
+  version_requirements: *20995240
 description: ''
 email:
 - sunaku@gmail.com