ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Test​RSpec

by astrauka ST2/ST3

RSpec plugin for Sublime Text 3

Labels ruby, testing, rspec, spec

Details

Installs

  • Total 1K
  • Win 125
  • OS X 876
  • Linux 297
Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6
Windows 0 0 0 0 0 0 0 0 0 1 0 1 3 0 0 0 0 0 1 0 0 1 0 1 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 1 0 1 1 2 0 0
OS X 2 3 2 0 2 2 5 1 1 0 2 3 5 0 2 0 2 1 1 0 1 0 0 2 1 1 3 2 1 0 1 0 3 1 1 0 1 1 1 3 2 3 1 0 3 5
Linux 0 1 0 1 0 1 4 1 0 0 1 1 0 1 0 1 1 0 2 1 0 3 0 1 1 0 2 3 0 0 0 1 2 3 1 0 0 1 0 0 0 0 0 1 1 1

Readme

Source
raw.​githubusercontent.​com

Sublime TestRSpec

RSpec plugin for Sublime Text 3

Run, navigate and create specs from Sublime editor.

Features

Motivation

I have used RubyTest plugin for some time and was not happy with it.

So I decided to create a simple to understand and develop plugin targeting only rspec.

Installation

With Package Control:

  1. Run “Package Control: Install Package” command, find and install Test Rspec plugin.
  2. Restart SublimeText editor

Manually:

  1. Clone this git repository into your packages folder (in SublimeText, Preferences -> Browse Packages to open this folder)
  2. Restart SublimeText editor

Output

Executed using sublime build tools exec command.

When preconditions are not satisfied outputs to panel.

Configuration

Read this if you want to know how Sublime package settings work.

Find settings in “Preferences -> Package Settings -> TestRSpec”

Default settings

Key bindings

Find bindings in “Preferences -> Package Settings -> TestRSpec”

Default bindings

Features

Run rspec

Executes Sublime command to run rspec. Displays output in panel.

Launch rspec for: * current line * current file * run previous spec

Command generation

# output example
# /home/user/.rbenv/bin/rbenv exec bundle exec spring rspec /home/user/dev/project/spec/models/user_spec.rb:2
#
# ProjectRoot
#   project root by ../spec
#
# SpecTarget
#   file + line
#
# Rspec
#   Environment variables
#     take from configuration
#
#   (BinRspec || RubyRspec) + SpecTarget
#
#   BinRspec
#     find /bin/rspec from project root
#
#   on ./bin/rspec not found
#     RubyRspec : (Rbenv || Rvm || SystemRuby) + Bundle + Spring
#       Rbenv on configuration
#         find $HOME/.rbenv/bin/rbenv exec
#
#       Bundle on configuration
#         check if Gemfile is present
#         bundle exec
#
#       Spring on configuration
#         check if Gemfile contains spring
#         spring

Switch between code and test

Returns all matches by file name.

Prioritizes matches by path as they are more likely the right ones such that in most cases you pick the first match.

Create spec file

Creates spec file when launched in source file.

Uses code snippet defined in settings.

Ignore binding.pry in the spec run

You add binding.pry to the code, then run the rspec and process stucks on pry debugger.

You can disable the debugger modifying the rspec command environment:

"rspec_add_to_path": "DISABLE_PRY=true",

Thanks @werdlerk for the tip!

Troubleshooting

Ruby not found

Example error:

/usr/bin/env: ruby: No such file or directory

Update package settings with path to ruby, for rbenv that's:

"rspec_add_to_path": "$HOME/.rbenv/shims",

Acknowledgments

Inspired by https://github.com/maltize/sublime-text-2-ruby-tests

Parts that are taken: * test console theme * key bindings * idea of how to switch between code and test * idea of how to run spec

Contribution

Help is always welcome. Create an issue if you need help.

Sublime Text plugin development links

Copyright and license

Copyright © 2016 @astrauka

Licensed under the MIT license.