splot 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7239341b56f137cc8eb9e3ee90ad87f963c7be2
-  data.tar.gz: 1374d68cb52b2b77279b08e349a3ceae0de2402d
+  metadata.gz: 9a4dbbd8b1e8bf5f568d828642ee7f0481dfbad4
+  data.tar.gz: 6f351772ddfb8fedbd4467c73487da2b1d7e3b43
 SHA512:
-  metadata.gz: 34b95e19ee56c4350fb7817d3f584076700a6f0d19b6f69807a70f15e9d5682ed6009366d9f29ba42e753f55eac4e9309bc46008fa397f22c8c65fbf9dddc2f7
-  data.tar.gz: b15e8603ce6d104a9084523831bfad7adcd51826b344a04558aa22f195185b9189d63b961f07783a91ad465c3492e9970d42da97ec45503dcd5fea668434cbc6
+  metadata.gz: 57d5624e70eb25809a87cabdc7c10982e01e79b600839c1aa22f90c68ef94bf166a1145ef6f866d4bce48298a82e694d9b63c6f119c22f21291795ceadcfd9d7
+  data.tar.gz: be6812a2c2853dd81f6f7fa7f35bc56fb3dd47f10b566eb5193e60f392fdb09e77d5a246a252279761accf98ff596eebd0e3abcbf92c326ed25fbee1fcbe44cc

data/README.md

@@ -1,12 +1,12 @@
 # Splot
 
-TODO: Write a gem description
+Tired of having to reconfigure how you run tests for each project? Annoyed that Minitest::Unit doesn't let you supply a line number? Want to press a single button in your text editor of choice, and run the test most relevant to the file you're editing? If you answered yes to any of these, then `splot` is for you.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'splot'
+    gem 'splot', require: false
 
 And then execute:
 
@@ -18,7 +18,45 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First, play with `splot` on the command line. Jump into a project root directory. Want to run a test? Try this:
+
+    # splot -f test/models/foo_test.rb
+
+Do you use rspec? Nothing changes, except for the path to the file.
+
+    # splot -f spec/models/foo_spec.rb
+
+Want to run a test on a specific line? No problem:
+
+    # splot -f test/models/foo_test.rb -l 44
+    # splot -f spec/models/foo_spec.rb -l 44
+
+When using `Test::Unit`, `splot` will automatically figure out the name of the test corresponding to the line number you give.
+
+Now, you need a faster feedback loop, so you decide you want a preloader:
+
+    # splot -f test/models/foo_test.rb -p zeus
+
+That's about all there is to the command line!
+
+## Running relevant tests
+
+Editing `app/models/foo.rb`? `splot` can figure out which test to run:
+
+    # splot -f app/models/foo.rb
+
+In this case, it'll look for a test at `test/models/foo_test.rb` or `spec/models/foo_spec.rb`.
+
+## vim-dispatch integration
+
+I'm a huge fan of vim dispatch. Here's my `.vimrc` entries that bind `<F5>` to "run the test at the current cursor position" and `<F6>` to "run the whole test file," respectively:
+
+    map <f5> :w <cr> :execute "Dispatch splot -p spring -f % -l " . ( line(".") + 1 )<cr>
+    map <f6> :w <cr> :Dispatch splot -p spring -f %<cr>
+
+## Notes
+
+1. When invoking a `Test::Unit` test, `splot` defaults to using the `rake test`. This is to be compatible with preloaders like `spring` or `zeus`.
 
 ## Contributing
 

data/lib/splot/version.rb

@@ -1,3 +1,3 @@
 module Splot
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splot
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - ntl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-24 00:00:00.000000000 Z
+date: 2013-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler