RSpectacles

RSpectacles is an in-browser visualizer and profiler for RSpec. It uses Server-Sent Events, Redis, and d3.js to render a partition of your specs in real time, so that you can tell at a glance where the time is spent in your test suite.

As a Sinatra app it can be run standalone, or else mounted on another Rack app.

Installation

gem install rspectacles

Or in your Gemfile:

group :test, :development do
  gem 'rspectacles'
end

Then add the formatter to your .rspec file:

--require rspectacles/formatter/redis
--format RSpectacles::Formatter::Redis

--format progress # or whatever other formatters you want to use

The formatter assumes you are using RSpec3. If you use RSpec 2:

--require rspectacles/formatter/legacy/redis
--format RSpectacles::Formatter::Legacy::Redis

Redis

RSpectacles depends on Redis for pubsub and persistence. You can quickly get an instance up and running by using your favorite package manager:

brew install redis
redis-server

Start the server and connect to it in your browser:

rspectacles

Then run your specs and watch the magic happen!

Web Server

The server can be run in standalone mode:

rspectacles

Or mounted directly on your app:

# routes.rb
mount RSpectacles::App => '/rspectacles'

Configuration

If you need to change any settings, the best method is to create a yaml file with your settings, and set the RSPECTACLES_CONFIG environment variable so that both the server and formatter can locate the file.

For instance:

export RSPECTACLES_CONFIG='/path/to/config/rspectacles.yml'

And in rspectacles.yml:

sinatra_port: 4567
redis_uri: 'redis://127.0.0.1:6379/'
pubsub_channel_name: 'redis-rspec-examples'
last_run_primary_key: 'redis-rspec-last-run'

Realtime Results

RSpectacles will attempt to stream spec results into the browser in realtime. This optional feature depends on EventMachine, and so will only work on servers with EM support. So if you mount RSpectacles on an app that uses thin or rainbows then you should be able to see the realtime results.

If you use a server that doesn't support EventMachine - no sweat. You'll still be able to see the visualization. You'll just need to refresh your browser from time to time.

Or you could always spin up an instance in standalone mode, which uses thin by default.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request