Opal::RSpec::Rails

Provides bindings between opal-rails and opal-rspec. Supports in browser specs as well as a rake task.

Installation

Add this line to your Rails application's Gemfile:

gem 'opal-rspec-rails', github: 'opal/opal-rspec-rails'

And then execute:

$ bundle

Usage

Let's say you have a library named MyLib in your Opal app.

# /app/assets/javascripts/my_lib.js.rb
class MyLib
  def does_something
    "running"
  end
end

Setup code can be put in a spec_helper as usual in the spec-opal folder:

BEWARE: Rails style autoload doesn't work here, so you have to require my_lib.

# /spec-opal/spec_helper.js.rb
require 'my_lib'
require 'support/some_spec_helper'

RSpec.configure do |config|
  config.before(:all) { puts "before all hook"}
  config.include SomeSpecHelper
end

Specs go into /spec-opal

# /spec-opal/my_lib_spec.js.rb
require 'spec_helper'

describe MyLib do
  it 'does something' do
    MyLib.new.does_something.should =~ /run/
  end
end

You can now run your specs by visiting http://localhost:3000/spec-opal on your app (rails server) or using the command line with rake opal:spec.

Configuration (Rails side)

# Enable or disable opal-rspec support, usually it's disabled in production.
config.opal_rspec.enable = ::Rails.env.development? || ::Rails.env.test?

# The path at which the embedded spec runner is mounted in your application.
config.opal_rspec.routing_path = '/spec-opal'

# The spec dir on the file system, relative from `Rails.root`.
config.opal_rspec.spec_location = 'spec-opal'

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rake to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/opal/opal-rspec-rails.

License

The gem is available as open source under the terms of the MIT License.