README.markdown in testr-14.1.3 vs README.markdown in testr-14.2.0

- old
+ new

@@ -26,33 +26,24 @@ * Logs the output from your tests into separate files: one log per test. The path of a log file is simply the path of its test file plus ".log". * 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? You can re-run any test file by simply saving it! When you do, TestR tries to @@ -83,11 +74,11 @@ As a Git clone: git clone git://github.com/sunaku/testr cd testr - bundle install + rake install ------------------------------------------------------------------------------ Invocation ------------------------------------------------------------------------------ @@ -97,10 +88,14 @@ 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' You can forcefully terminate TestR from another terminal: @@ -243,27 +238,27 @@ ------------------------------------------------------------------------------ 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 whenever you change an existing factory definition or create a new one. @@ -293,17 +288,22 @@ Otherwise, TestR will appear to ignore source-code changes in your 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 * cannot start a transaction within a transaction ------------------------------------------------------------------------------ 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