Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pdabrowski6/cable-ready-testing
Cable Ready testing utils
https://github.com/pdabrowski6/cable-ready-testing
cableready rails rspec testing
Last synced: about 1 month ago
JSON representation
Cable Ready testing utils
- Host: GitHub
- URL: https://github.com/pdabrowski6/cable-ready-testing
- Owner: pdabrowski6
- License: mit
- Created: 2020-07-23T16:11:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-07-31T13:26:13.000Z (over 4 years ago)
- Last Synced: 2024-10-01T14:53:33.548Z (about 1 month ago)
- Topics: cableready, rails, rspec, testing
- Language: Ruby
- Homepage:
- Size: 10.7 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
> CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby.
This gem makes the testing of your broadcast classes easier by providing custom matchers that will verify that the expected message was broadcasted to the expected channel.
## 📚 Docs
- [Cable Ready official Documentation](https://cableready.stimulusreflex.com)
- [Instruction how to install Cable Ready on a Rails application](https://pdabrowski.com/articles/cable-ready-with-action-cable)
## 🚀 Install
Open `Gemfile` and add the following line to the `test` group:
```sh
group :test do
gem 'cable-ready-testing'
end
```
now load the library for RSpec by editing the file `spec/rails_helper.rb` and loading the gem after initializing the environment with the following line:
```ruby
require 'cable_ready/testing/rspec'
```
you are now ready to use the matchers inside your RSpec tests.
## 🎲 Usage
Let's consider the following usage of Cable Ready:
```ruby
class Broadcaster
include CableReady::Broadcaster
def call(channel_name, selector)
cable_ready[channel_name].outer_html(
selector: selector,
html: 'html'
)
cable_ready.broadcast
end
end
```
without custom matchers you may end-up with the following test:
```ruby
RSpec.describe Broadcaster do
subject { described_class.new }
describe '#call' do
it 'broadcasts the html' do
cable_ready = double(outer_html: double)
expect(CableReady::Channels.instance)
.to receive(:[])
.with('custom_channel')
.and_return(cable_ready)
expect(cable_ready)
.to receive(:outer_html)
.with(selector: '#some-div', html: 'html')
expect(CableReady::Channels.instance)
.to receive(:broadcast).once
subject.call('custom_channel', '#some-div')
end
end
end
```
after using `cable-ready-testing` gem:
```ruby
RSpec.describe Broadcaster do
subject { described_class.new }
describe '#call' do
it 'broadcasts the html' do
expect {
subject.call('custom_channel', '#some-div')
}.to mutated_element('#some-div')
.on_channel('custom_channel')
.with(:outer_html, { 'html' => 'html' })
end
end
end
```
## 📝 Documentation
The following matchers are available:
* `mudated_element`
* `mutated_attribute`
* `mutated_css_class`
* `mutated_dataset`
* `mutated_style`
* `mutated_element`
Mentioned above matchers work the same way, you should choose the right one depending on the context. If you are calling `cable_ready["MyChannel"].set_dataset_property` then use `mutated_dataset` matcher, etc. Always chain them with `.on_channel` and `.with`.
## 📝 License
CableReady testing lib is released under the [MIT License](LICENSE.txt).