kurko / smartest.vim Goto Github PK

Make your Vim smart when running your tests.

In your Rails project, it'll run the current test file the fastest way possible using either RSpec or Minitest:

• Runs current file with Spring gem if you have it running, or
• Runs current file with zeus if you have it running, or
• Runs bundle exec rspec $current_file if current test file has spec_helper, acceptance_spec_helper etc anywhere in the current file (which means it needs bundle exec), or
• uses pure RSpec (no bundle exec) other wise. This is useful for people like me that don't like running specs with Bundler when it's not needed.
• runs spring rake test $current_file in case of Minitest
• run a configurable command for specific file types (advanced)

In your Ruby project using minitest, it:

• when in the Rails project, you need to add the current framework (e.g actionview, activerecord) as dependency (e.g -Iactionview/lib), so if you in an actionview file, it'll run ruby -Iactionview/lib:actionview/test $current_file, or
• Runs ruby -Ilib $current_file
• runs rake TEST=$current_file when developing a gem with Minitest.

If you're testing Javascript, smartest:

• checks if it's a Konacha spec and runs it using Zeus or Bundler (whichever is available).
• checks if phantomjs can be used based on the presence of tests/runner.js. In case it's QUnit, it'll run only the current file.
• runs rake if it doesn't know what to do (e.g QUnit)

Case you're running Elixir code, smartest will:

• Run the test with Mix, case you used it's extension convention under a Mix project;
• Run the test with elixir, in which case you'll need to add ExUnit.start to the top of your test.

smartest.vim doesn't map any key, so these are the mappings I use and recommend:

map <leader>t :call RunTestFile()<cr>
map <leader>r :call RunNearestTest()<cr>

Here, <leader>t would run all tests in the current file, while <leader>r would run only the test under the cursor.

If your test file user_spec.rb and runs <leader>t (considering the mappings above), it'll run it. If you go to file user.rb (not a test file) and runs <leader>t again, it'll run the last test file run (idea by Gary Bernhardt).

This means you don't need to have your test file buffer opened to run it. You can just code and call the tests.

If you use RunNearestTest(), which is <leader>r for me, it'll run only the test under the cursor, even on Minitest.

If you need a specific command to be run, perhaps because you're using Docker and cannot run tests from your Vim, define a file called .smartest.#{type}.

For example, for a Ruby project, including Rails projects, create the file .smartest.ruby and write in it what you want Smartest to run. Ideally put it in .gitignore.

For example, if you're using Docker and is running the bash in a Tmux window (e.g 1), you could press <leader>r and have it run it on window 1. Define .smartest.ruby:

tmux send-keys -t 1 "time rspec --color --order random $filename" ENTER

or a more complex example, checking that the first window is actually in a test environment and selecting that window:

tmux send-keys -t 1 "[ \"\$RAILS_ENV\" == \"test\" ] && time rspec --color --order random $filename" ENTER; tmux select-window -t 1

These are the files you can use:

• .smartest.ruby
• .smartest.javascript
• .smartest.elixir
• .smartest.scala

These are the variables you can use:

• $filename: when RunTestFile() is run, it will be the filepath (e.g spec/models/user_spec.rb. When RunNearestTest() is run, however, then the test line number will be included (e.g spec/models/user_spec.rb:17).
• $command: this is the command that is generated by Smartest automatically based on the project configurations. For example, when a Rails project has a .zeus.sock file, $command will use zeus rspec instead of bundle exec.

MIT.

Alexandre de Oliveira, at http://github.com/kurko