0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
This provides a simple implementation of an event bus. It makes easy to use the abstractionwithout needing dedicated components, like RabbitMQ. Using this will however make it easyto rewrite your code to use more solid foundations for the future.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.11
~> 10.0
~> 3.0
 Project Readme

EventTrain

Build Status Code Climate Test Coverage Issue Count

EventTrain is a really simple implementation of an EventTrain in Ruby. It enables you to start implementing your application using an event bus pattern without relying on some specific pub/sub service or component (like Redis, RabbitMQ). This will enable to move to such future-proof implementation just by using the same interface, thus reducing the need for refactoring or rewrites!

Installation

Add this line to your application's Gemfile:

gem "event_train"

And then execute:

$ bundle

Or install it yourself as:

$ gem install event_train

Usage

# Subscribe and publish to the :global channel
EventTrain.subscribe do |event_name:, event_data:|
  puts "Received event named #{event_name} with data #{event_data}"
end
EventTrain.publish(event_name: :my_first_event, event_data: true)
# => "Received event named my_first_event with data true"

# To subscribe / publish to a specific channel, just add the :channel_name parameter:
EventTrain.publish(channel_name: :my_first_channel, ...)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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/rchampourlier/event_train. 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.