Guard Teabag

Build Status Code Climate

Guard-Teabag allows you to run Teabag using Guard.

Teabag is a Javascript test runner built on top of Rails. It can run tests in the browser, or headlessly using PhantomJS or with Selenium WebDriver. We recommend you check out the installation steps for Teabag, and read about configuration.

With Guard-Teabag you can start up Guard, make changes to your tests or implementation files, and the specs will be run automatically using Teabag. It behaves very similarly to guard-rspec.

This project is still experimental...

Table of Contents

  1. Installation
  2. Usage
  3. Configuring Guard

Installation

Add it to your Gemfile. Like Teabag, in most cases you'll want to restrict it to the :asset, or :development, :test groups. You may also want to include one of the filesystem gems that Guard suggests, and in our example we included rb-fsevent.

group :assets do
  gem "teabag"
  gem "guard-teabag"
  gem "rb-fsevent" # used by guard
end

Install Teabag using the install generator.

rails generate teabag:install

Generate the Guardfile that includes the standard Guard-Teabag template.

bundle exec guard init teabag

Usage

Start Guard.

bundle exec guard start

Make changes to your javascript specs or implementation files and the appropriate tests will run.

Configuring Guard

In general this isn't very complicated, but if you have multiple suites setup in Teabag this can get a little complicated -- there's an expectation that you understand what you're doing in regards to using Guard.

The default Guardfile will watch for any file changes within your app/assets/javascripts path and will attempt to resolve those file to a spec. If you're using QUnit, you can change this to be _test instead of _spec, or use js.coffee or coffee for file extensions, and you can use a more advanced regexp for other needs.

Guardfile

guard :teabag do
  watch(%r{app/assets/javascripts/(.+).js}) { |m| "#{m[1]}_spec" }
  watch(%r{/spec/javascripts/(.*)})
end

Specifying Teabag Environment

Guard-Teabag takes several options, but worth calling out is the environment option. This option allows you to tell Teabag where it should look for it's environment file, and is useful if Teabag is unable to resolve it's environment.

Guardfile

guard :teabag, environment: "spec/dummy/spec/teabag_env.rb" do
end

Available Options

...document when this is better hammered out...

License

Licensed under the MIT License

Copyright 2012 Mode Set

Make Code Not War

crest