krisleech / wisper-testing Goto Github PK

View Code? Open in Web Editor NEW

4.0 2.0 7.0 14 KB

Helpers for testing Wisper publisher/subscribers.

License: MIT License

Ruby 98.87% Shell 1.13%

wisper testing

wisper-testing's Introduction

Wisper::Testing

Helpers for testing Wisper publisher/subscribers.

Installation

gem 'wisper-testing'

Usage

Using fake! and fake prevents any events from being broadcast.

Instead each event is recorded and can be inspected.

Wisper::Testing.fake!

Wisper::Testing.fake do
  # ...
end

Wisper::Testing.events # => [...]

Inline

Using inline! and inline ensures all events are broadcast using the default broadcaster, meaning any subscribers which are subscribed with async: true will not be called asynchronously, but synchronously.

Wisper::Testing.inline!

Wisper::Testing.inline do
  # ...
end

Restore

Using restore! will turn off fake! and inline! and restore the original configuration.

It is not nessesary to call this if you are using the block variations fake and inline.

Wisper::Testing.restore!

Enabled

Wisper::Testing.enabled? # => true/false

Development

ls **/*.rb | entr -c bundle exec rspec

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/krisleech/wisper-testing.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

wisper-testing's People

Contributors

Stargazers

Watchers

Forkers

textgoeshere james2m zlw jfahrer merrington

wisper-testing's Issues

`fake` and friends don't work on existing subscriptions

Just following up on #6.

If the subscription already exists then its registration is already assigned a (real) listener. Calling fake only affects subsequent registrations. This is particularly a challenge where you are working with global listeners because you can't usually control their load order to get the fake in before the subscription.

Here's a failing spec that illustrates the issue: https://gist.github.com/14d09819e2c0ccb1bd23.

Assuming this isn't by design ;), do you like the idea of adding a step to walk over the existing registrations, memoize their broadcasters, and replace them with FakeBroadcaster? And reversing that on restore.

Setup Travis CI

Include Gemfiles for both Wisper v1 and v2.

Consider warning or raising if fake! or inline! called and testing is already enabled

Users should be doing restore! after or before every spec.

Disable global subscriptions during a block

Hey @krisleech,

First, thanks for the great work with the wisper gem.

I just started using it for one of my project and I am facing an issue I didn't find a solution to.

I am using a global subscriber that is in an initializer of a Rails project.
The thing is I would like most of my rspec test to not depend on this subscription. I could use Wisper.clear for that but then, I cannot run the full test suite properly because I need the subscriptions for my system tests.

I had a look at this gem, and tried to use the fake method.
Unfortunately the fake method doesn't work well with wisper-rspec meaning that in this case, the broadcast matcher won't work anymore (given how the matcher is implemented).

I think that in my case what I would like to do is disable the listeners for the duration of a block.
Currently I implemented a dirty hack that basically does this:

 registrations = Wisper::GlobalListeners.registrations.clone # save the global listeners
 Wisper.clear # clear the global listeners
 example.run
 Wisper::GlobalListeners.instance.instance_eval { @registrations = registrations } # restore the global listeners

Do you think such a feature could makes sense? Or am I taking this the wrong way and there is a better approach?

Thanks again for all this work!
Best

I'm getting Could not find gem 'wisper-testing' when I'm trying to use it.

Thanks.