Wisper::Sequel
A Sequel plugin for broadcasting model hooks as Wisper events.
Installation
Add this line to your application's Gemfile:
gem 'wisper-sequel', github: 'munshkr/wisper-sequel'
And then execute:
$ bundle
Or install it yourself as:
$ gem install wisper-sequel
Usage
Please refer to the Wisper README for full details about subscribing.
Some of the events which are automatically broadcast are
create_<model_name>_{successful,failed}
update_<model_name>_{successful,failed}
destroy_<model_name>_{successful,failed}
There is also an event per each model hook available. The complete list is:
before_validation
after_validation
before_save
after_save
before_create
after_create
before_update
after_update
before_destroy
after_destroy
after_commit
after_rollback
after_destroy_commit
after_destroy_rollback
Please refer to Sequel Model Hooks document for full details about model hooks.
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run
rake rspec
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/munshkr/wisper-sequel. 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.