testr 14.1.3 → 14.2.0

data/HISTORY.markdown

@@ -1,3 +1,19 @@
+------------------------------------------------------------------------------
+Version 14.2.0 (2012-01-16)
+------------------------------------------------------------------------------
+
+New features:
+
+  * Add ability to run `testr rails` without needing a `.testr.rb` file.
+
+  * testr(1) no longer shows command menu at startup.  Press ENTER to see it.
+
+  * testr(1) now notifies you before absorbing overhead at startup.
+
+Bug fixes:
+
+  * testr(1) now accepts death silently when Control-C is pressed.
+
 ------------------------------------------------------------------------------
 Version 14.1.3 (2012-01-13)
 ------------------------------------------------------------------------------

data/README.markdown

@@ -28,29 +28,20 @@ Features
 
   * Configurable through a Ruby script in your current working directory.
 
-  * Implemented in less than 380 lines (SLOC) of pure Ruby code! :-)
+  * Implemented in less than 400 lines (SLOC) of pure Ruby code! :-)
 
 ------------------------------------------------------------------------------
 Architecture
 ------------------------------------------------------------------------------
 
-Following UNIX philosophy, TestR is made of simple text-based programs:
+Following UNIX philosophy, TestR is made of simple text-based programs: thus
+you can build your own custom TestR user interface by wrapping `testr-driver`!
 
 * `testr` is an interactive command-line user interface (CLI) for driver
 * `testr-herald` monitors current directory tree and reports changed files
 * `testr-driver` tells master to run tests and keeps track of test results
 * `testr-master` absorbs test execution overhead and forks to run your tests
 
-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?
@@ -85,7 +76,7 @@ As a Git clone:
 
     git clone git://github.com/sunaku/testr
     cd testr
-    bundle install
+    rake install
 
 ------------------------------------------------------------------------------
 Invocation
@@ -99,6 +90,10 @@ If installed as a Git clone:
 
     bundle exec ruby -Ilib bin/testr
 
+You can test with built-in support for [Ruby on Rails]:
+
+    testr rails
+
 You can monitor your test processes in another terminal:
 
     watch 'ps xuw | sed -n "1p; /test[r]/p" | fgrep -v sed'
@@ -245,23 +240,23 @@ accelerates your test-driven development cycle and improves productivity!
 Configuration helpers
 ------------------------------------------------------------------------------
 
-The following libraries assist you with configuring TestR.  To use them,
-simply add the require() lines shown below to your configuration file.
+The following libraries assist you with configuring TestR. To use them,
+simply add the `require()` lines shown below to your configuration file
+*or* pass their basenames to the testr(1) command, also as shown below.
 
-### require 'testr/config/rails'
+### require 'testr/config/rails' # testr rails
 
-Support for the [Ruby on Rails](http://rubyonrails.org) web framework.
+Support for the [Ruby on Rails] web framework.
 
-### require 'testr/config/parallel_tests'
+### require 'testr/config/parallel_tests' # testr parallel_tests
 
-Support for the [parallel_tests](https://github.com/grosser/parallel_tests)
-library.
+Support for the [parallel_tests] library.
 
 ------------------------------------------------------------------------------
 Usage tips
 ------------------------------------------------------------------------------
 
-### [factory_girl](https://github.com/thoughtbot/factory_girl) factories
+### [factory_girl] factories
 
 Don't load your factories in master process (as part of your test execution
 overhead) because that would necessitate the reloading of said overhead
@@ -295,8 +290,8 @@ Known issues
     models, controllers, helpers, and other Ruby source files.
 
   * 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.
+    adapter for SQLite3][memory_test_fix] or use different database software
+    (such as MySQL) for your test environment.
 
     * SQLite3::BusyException: database is locked
 
@@ -307,3 +302,8 @@ License
 ------------------------------------------------------------------------------
 
 Released under the ISC license.  See the LICENSE file for details.
+
+[factory_girl]: https://github.com/thoughtbot/factory_girl
+[memory_test_fix]: https://github.com/mvz/memory_test_fix
+[parallel_tests]: https://github.com/grosser/parallel_tests
+[Ruby on Rails]: http://rubyonrails.org

data/bin/testr

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin
 
-TESTR 1 "2012-01-13" "14.1.3"
+TESTR 1 "2012-01-16" "14.2.0"
 =============================
 
 NAME
@@ -12,23 +12,16 @@ testr - Continuous testing tool for Ruby
 SYNOPSIS
 --------
 
-`testr` [*OPTION*]...
+`testr` [*OPTION*]... [*CONFIG*]...
 
 DESCRIPTION
 -----------
 
 This program is a simple command-line user interface for 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.
-
-When run, it presents you with a menu of single-character commands that you
-can enter, loads the test execution overhead into testr-master(1), and
-finally notifies you when the master is ready to run test files.
-
-It also launches testr-herald(1) alongside 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.
+loads the given *CONFIG* files (which are either paths to actual files or
+names of helper libraries in the testr/config/ namespace of Ruby's load path)
+and then waits for you to supply interactive commands on its stdin.  You may
+press the ENTER key (supplying no command) to see a menu of accepted commands.
 
 OPTIONS
 -------
@@ -49,8 +42,15 @@ require 'binman'
 BinMan.help
 
 require 'json'
+ENV['TESTR_CONFIGS'] = JSON.dump(ARGV)
+
+#-----------------------------------------------------------------------------
+# backend
+#-----------------------------------------------------------------------------
+
 require 'testr/client'
 
+warn 'testr: Absorbing test execution overhead...'
 @driver = TestR::Client::Transceiver.new('testr-driver') do |line|
   evstr, *details = JSON.load(line)
   event = evstr.to_sym
@@ -73,6 +73,10 @@ require 'testr/client'
   end
 end
 
+#-----------------------------------------------------------------------------
+# frontend
+#-----------------------------------------------------------------------------
+
 COMMANDS = {
   'r' => :run_all_test_files,
   's' => :stop_running_test_files,
@@ -82,25 +86,23 @@ COMMANDS = {
   'q' => :quit,
 }
 
-def COMMANDS.show
-  each do |key, cmd|
-    warn "testr: Type #{key} then ENTER to #{cmd.to_s.tr('_', ' ')}."
-  end
-end
-
-COMMANDS.show # instruct newbies
-
-while key = STDIN.gets.chomp
-  if command = COMMANDS[key]
-    if command == :quit
-      @driver.quit
-      break
+begin
+  while key = STDIN.gets.chomp
+    if command = COMMANDS[key]
+      if command == :quit
+        @driver.quit
+        break
+      else
+        @driver.send [command]
+      end
     else
-      @driver.send [command]
+      COMMANDS.each do |key, cmd|
+        warn "testr: Type #{key} then ENTER to #{cmd.to_s.tr('_', ' ')}."
+      end
     end
-  else
-    COMMANDS.show
   end
+rescue Interrupt
+  # forced quit
 end
 
 Process.waitall

data/bin/testr-driver

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin
 
-TESTR-DRIVER 1 "2012-01-13" "14.1.3"
+TESTR-DRIVER 1 "2012-01-16" "14.2.0"
 ====================================
 
 NAME
@@ -21,6 +21,10 @@ 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 testr-master(1) into its own.
 
+When testr-herald(1) reports that a file belonging to the test execution
+overhead has been modified, this program replaces testr-master(1) with a new
+instance, which then absorbs the modified test execution overhead into itself.
+
 `["run_all_test_files"]`
   Runs all test files found within and beneath the current working directory.
 
@@ -49,6 +53,14 @@ FILES
 *.testr.rb*
   Optional Ruby script for configuring testr(1).
 
+ENVIRONMENT
+-----------
+
+`TESTR_CONFIGS`
+  A single-line JSON array containing paths to actual files or names of
+  helper libraries in the testr/config/ namespace of Ruby's load path.
+  These configuration files are loaded just before *.testr.rb* is loaded.
+
 SEE ALSO
 --------
 

data/bin/testr-herald

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin
 
-TESTR-HERALD 1 "2012-01-13" "14.1.3"
+TESTR-HERALD 1 "2012-01-16" "14.2.0"
 ====================================
 
 NAME

data/bin/testr-master

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin
 
-TESTR-MASTER 1 "2012-01-13" "14.1.3"
+TESTR-MASTER 1 "2012-01-16" "14.2.0"
 ====================================
 
 NAME
@@ -60,6 +60,14 @@ FILES
 *.testr.rb*
   Optional Ruby script for configuring testr(1).
 
+ENVIRONMENT
+-----------
+
+`TESTR_CONFIGS`
+  A single-line JSON array containing paths to actual files or names of
+  helper libraries in the testr/config/ namespace of Ruby's load path.
+  These configuration files are loaded just before *.testr.rb* is loaded.
+
 SEE ALSO
 --------
 

data/lib/testr/config.rb

@@ -5,6 +5,10 @@ module TestR
 
   Config = OpenStruct.new
 
+  #---------------------------------------------------------------------------
+  # defaults
+  #---------------------------------------------------------------------------
+
   Config.max_forked_workers = [
     # http://stackoverflow.com/questions/891537#6420817
     'fgrep -c processor /proc/cpuinfo', # Linux
@@ -61,5 +65,19 @@ module TestR
     end
   ]
 
+  #---------------------------------------------------------------------------
+  # overrides
+  #---------------------------------------------------------------------------
+
+  if ENV.key? 'TESTR_CONFIGS'
+    JSON.load(ENV['TESTR_CONFIGS']).each do |config|
+      if File.exist? config
+        load File.expand_path(config)
+      else
+        require "testr/config/#{config}"
+      end
+    end
+  end
+
   load _user_config_file if File.exist? _user_config_file
 end

data/lib/testr/server.rb

@@ -26,6 +26,8 @@ module Server
         end
       end
     end
+  rescue Interrupt
+    # forced quit
   end
 
   def self.extended server

data/lib/testr/version.rb

@@ -1,3 +1,3 @@
 module TestR
-  VERSION = "14.1.3"
+  VERSION = "14.2.0"
 end

data/man/man1/testr-driver.1

@@ -1,4 +1,4 @@
-.TH TESTR\-DRIVER 1 "2012\-01\-13" "14.1.3"
+.TH TESTR\-DRIVER 1 "2012\-01\-16" "14.2.0"
 .SH NAME
 .PP
 testr\-driver \- drives 
@@ -14,6 +14,14 @@ standard input stream and performs the respective actions as described below.
 It also funnels the standard output stream of 
 .BR testr\-master (1) 
 into its own.
+.PP
+When 
+.BR testr\-herald (1) 
+reports that a file belonging to the test execution
+overhead has been modified, this program replaces 
+.BR testr\-master (1) 
+with a new
+instance, which then absorbs the modified test execution overhead into itself.
 .TP
 \fB\fC["run_all_test_files"]\fR
 Runs all test files found within and beneath the current working directory.
@@ -40,6 +48,12 @@ Display this help manual using
 \fI.testr.rb\fP
 Optional Ruby script for configuring 
 .BR testr (1).
+.SH ENVIRONMENT
+.TP
+\fB\fCTESTR_CONFIGS\fR
+A single\-line JSON array containing paths to actual files or names of
+helper libraries in the testr/config/ namespace of Ruby's load path.
+These configuration files are loaded just before \fI.testr.rb\fP is loaded.
 .SH SEE ALSO
 .PP
 .BR testr (1), 

data/man/man1/testr-herald.1

@@ -1,4 +1,4 @@
-.TH TESTR\-HERALD 1 "2012\-01\-13" "14.1.3"
+.TH TESTR\-HERALD 1 "2012\-01\-16" "14.2.0"
 .SH NAME
 .PP
 testr\-herald \- reports modified files

data/man/man1/testr-master.1

@@ -1,4 +1,4 @@
-.TH TESTR\-MASTER 1 "2012\-01\-13" "14.1.3"
+.TH TESTR\-MASTER 1 "2012\-01\-16" "14.2.0"
 .SH NAME
 .PP
 testr\-master \- absorbs overhead and runs tests
@@ -47,6 +47,12 @@ Display this help manual using
 \fI.testr.rb\fP
 Optional Ruby script for configuring 
 .BR testr (1).
+.SH ENVIRONMENT
+.TP
+\fB\fCTESTR_CONFIGS\fR
+A single\-line JSON array containing paths to actual files or names of
+helper libraries in the testr/config/ namespace of Ruby's load path.
+These configuration files are loaded just before \fI.testr.rb\fP is loaded.
 .SH SEE ALSO
 .PP
 .BR testr (1), 

data/man/man1/testr.1

@@ -1,32 +1,19 @@
-.TH TESTR 1 "2012\-01\-13" "14.1.3"
+.TH TESTR 1 "2012\-01\-16" "14.2.0"
 .SH NAME
 .PP
 testr \- Continuous testing tool for Ruby
 .SH SYNOPSIS
 .PP
-\fB\fCtestr\fR [\fIOPTION\fP]...
+\fB\fCtestr\fR [\fIOPTION\fP]... [\fICONFIG\fP]...
 .SH DESCRIPTION
 .PP
 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
-can enter, loads the test execution overhead into 
-.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) 
-alongside 
-.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.
+loads the given \fICONFIG\fP files (which are either paths to actual files or
+names of helper libraries in the testr/config/ namespace of Ruby's load path)
+and then waits for you to supply interactive commands on its stdin.  You may
+press the ENTER key (supplying no command) to see a menu of accepted commands.
 .SH OPTIONS
 .TP
 \fB\fC-h\fR, \fB\fC--help\fR

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testr
 version: !ruby/object:Gem::Version
-  version: 14.1.3
+  version: 14.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,11 +13,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-14 00:00:00.000000000 Z
+date: 2012-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binman
-  requirement: &24250900 !ruby/object:Gem::Requirement
+  requirement: &9134380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -25,10 +25,10 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *24250900
+  version_requirements: *9134380
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &24250380 !ruby/object:Gem::Requirement
+  requirement: &9133860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -39,10 +39,10 @@ dependencies:
         version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *24250380
+  version_requirements: *9133860
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &24249640 !ruby/object:Gem::Requirement
+  requirement: &9133120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,10 +53,10 @@ dependencies:
         version: '1'
   type: :runtime
   prerelease: false
-  version_requirements: *24249640
+  version_requirements: *9133120
 - !ruby/object:Gem::Dependency
   name: diff-lcs
-  requirement: &24248900 !ruby/object:Gem::Requirement
+  requirement: &9132380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,7 +67,7 @@ dependencies:
         version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *24248900
+  version_requirements: *9132380
 description: ''
 email:
 - sunaku@gmail.com