Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opal/opal-rspec-rails
bindings between `opal-rails` and `opal-rspec`
https://github.com/opal/opal-rspec-rails
browser javascript opal rails rspec ruby ruby-on-rails testing
Last synced: 3 months ago
JSON representation
bindings between `opal-rails` and `opal-rspec`
- Host: GitHub
- URL: https://github.com/opal/opal-rspec-rails
- Owner: opal
- License: mit
- Created: 2015-12-26T00:07:24.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-05T01:25:33.000Z (almost 8 years ago)
- Last Synced: 2024-03-25T21:16:46.244Z (10 months ago)
- Topics: browser, javascript, opal, rails, rspec, ruby, ruby-on-rails, testing
- Language: Ruby
- Size: 34.2 KB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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:
```ruby
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.
```ruby
# /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`._
```ruby
# /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`
```ruby
# /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)
```ruby
# 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](https://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](http://opensource.org/licenses/MIT).