README.md in m-1.5.1 vs README.md in m-1.6.0
- old
+ new
@@ -1,30 +1,14 @@
M.RB
-----
-`m` stands for metal, a better test/unit test runner that can run tests by line number.
+[](https://rubygems.org/gems/m) [](https://codeclimate.com/github/qrush/m) [](https://travis-ci.org/qrush/m) [](https://coveralls.io/r/qrush/m)
- ________________________________________________________________________________
- _________________________/\\\\____________/\\\\_________________________________
- _________________________\/\\\\\\________/\\\\\\________________________________
- __________________________\/\\\//\\\____/\\\//\\\_______________________________
- ___________________________\/\\\\///\\\/\\\/_\/\\\______________________________
- ____________________________\/\\\__\///\\\/___\/\\\_____________________________
- _____________________________\/\\\____\///_____\/\\\____________________________
- ______________________________\/\\\_____________\/\\\___________________________
- _______________________________\/\\\_____________\/\\\__________________________
- ________________________________\///______________\///__________________________
- ________________________________________________________________________________
+----
- - [](https://rubygems.org/gems/m)
- - [](https://codeclimate.com/github/qrush/m)
- - [](https://travis-ci.org/qrush/m)
- - [](https://gemnasium.com/qrush/m)
- - [](https://coveralls.io/r/qrush/m)
+`m` stands for metal, a better test/unit and minitest test runner that can run tests by line number.
-
INSTALL
=======
Install via:
@@ -48,11 +32,11 @@
# ...
gem.add_development_dependency "m", "~> 1.5.0"
end
```
-m works on Ruby 2.0+ only.
+m works on Ruby 2.0+ only and support is only provided for [versions currently maintained by the community](https://www.ruby-lang.org/en/downloads/branches/).
USAGE
=====
@@ -124,38 +108,59 @@
Finished in 3.459902s, 45.0880 runs/s, 87.5747 assertions/s.
156 tests, 303 assertions, 0 failures, 0 errors, 13 skips
+If you need to pass some option down to the actual runner, that is also supported:
+ $ m test/models -- --seed 1234
+ Run options: --seed 1234
+
+ ..
+
+ Finished in 3.459902s, 45.0880 runs/s, 87.5747 assertions/s.
+
+ 156 tests, 303 assertions, 0 failures, 0 errors, 13 skips
+
+Ensure that you use the `--` before the options, otherwise you'll get an invalid option error. Also, these extra option should always be the last argument.
+
+
SUPPORT
=======
`m` works with a few Ruby test frameworks:
- Test::Unit
- ActiveSupport::TestCase
- MiniTest::Unit::TestCase
+ - Minitest
CONTRIBUTING
============
+## Setup
+
+This project uses [Appraisal](https://github.com/thoughtbot/appraisal) to test against different versions of dependencies.
+
+To install all scenarios (appraisals):
+
+ bundle install
+ bundle exec appraisal install
+
+## Testing
+
You can run all the tests with:
bundle exec rake tests
You can also run tests selectively. For minitest 4 run:
appraisal minitest4 rake test
and the ones for minitest 5 with:
- appraisal minitest5 rake test TEST=test/minitest_5_test.rb
-
-In the case of minitest 5, we have to specify the test to run, because running
-the whole suite will fail due to incompatibilities with ruby (at least until
-2.1.1).
+ appraisal minitest5 rake test
LICENSE
=======