Permalink
Browse files

Add README info

  • Loading branch information...
1 parent 1ff587e commit 1a83a1e4a5d8629bcfc6bc88ff852523951c8c1c @quirkey committed Mar 28, 2011
Showing with 40 additions and 3 deletions.
  1. +39 −1 README.rdoc
  2. +0 −1 TODO
  3. +1 −1 lib/minitest/display.rb
View
40 README.rdoc
@@ -1,6 +1,44 @@
= minitest-display
-Description goes here.
+MiniTest::Display is a module that monkey patches a lot of the MiniTest::Unit interals to allow for configurable display options.
+You want color?! You want Suite name printouts?!?! You want fried eggs?! Too bad.
+
+I was messing with leftright (https://github.com/jordi/leftright - which is awesome btw) and trying to get it to work well with 1.9 but its all tied up in Test::Unit.
+MiniTest is much much simpler, and its patch points are easy to override and much less scary. Beyond that, MiniTest is also faster and has some neat benefits over test/unit (like benchmark assertions, etc). So, off we went.
+
+The goal is to be as configurable as possible with some nice defaults. My problem with most test enhancers is that they monkey patch blindly with very little openness and room for configuration. MiniTest::Display should allow for an infinite number (evenutally) of test display enhancements.
+
+Needless to say, it's a work in progress.
+
+== Requirements
+
+Requires Ruby 1.9 and the gem version of minitest >= 2.0.2
+
+== Usage
+
+Install minitest and minitest display:
+
+ gem install minitest minitest-display
+
+In your test suite/test_helper, require and configure mini test/display:
+
+ require 'minitest/autorun'
+ require 'minitest/display'
+
+ MiniTest::Display.options = {
+ suite_names: true,
+ color: true,
+ print: {
+ success: "OK\n",
+ failure: "EPIC FAIL\n"
+ error: "ERRRRRRR\n"
+ }
+ }
+
+That suite will look pretty funny.
+
+For all current available options see the code:
+https://github.com/quirkey/minitest-display/blob/master/lib/minitest/display.rb#L25
== Contributing to minitest-display
View
1 TODO
@@ -1,5 +1,4 @@
- Configurable error puking
-- MOAR COLORZ
- YAML based configuration
- Per-User YAML configuration
- Easy reset to default settings
View
2 lib/minitest/display.rb
@@ -18,7 +18,7 @@ def deep_merge(other_hash)
module MiniTest
module Display
- VERSION = '0.0.1'
+ VERSION = '0.0.2'
class << self
def options

0 comments on commit 1a83a1e

Please sign in to comment.