Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeantessier/rails-event-store-test
A sample Rails app that shows how to use the `rails_event_store` gem.
https://github.com/jeantessier/rails-event-store-test
Last synced: about 1 month ago
JSON representation
A sample Rails app that shows how to use the `rails_event_store` gem.
- Host: GitHub
- URL: https://github.com/jeantessier/rails-event-store-test
- Owner: jeantessier
- Created: 2021-12-28T05:53:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-11T04:42:15.000Z (about 1 month ago)
- Last Synced: 2024-11-11T05:39:50.029Z (about 1 month ago)
- Language: Ruby
- Homepage:
- Size: 109 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rails Event Store Test
This sample app showcases the `rails_event_store` gem to do event-based
development in Ruby on Rails.
### Produce Events
Based on [the documentation](https://railseventstore.org/docs/v2/publish/).
```ruby
stream_name = 'book-reviews.users'
event = UserAddedEvent.new(data: {
id: SecureRandom.uuid,
name: 'Administrator',
email: '[email protected]',
password: 'abcd1234',
roles: %w(ROLE_ADMIN ROLE_USER),
})
Rails.configuration.event_store.publish(event, stream_name: stream_name)
```
You can persist events with `#publish`, which notifies listening handlers. The
`stream_name` parameter is optional.
You can persist them with `#append`, which does not notify the handlers. Again,
the `stream_name` parameter is optional.
You can add an event to a stream automatically within the call to either
`#publish` or `#append`. You can also use `#link` to add events to streams
independently. [The documentation](https://railseventstore.org/docs/v2/link/)
has an example where they use a handler to automatically link events to
additional streams when these events are published.
### Listen To Events
Handlers are called when events are published, based on which event types they
listen for. The streams to which the events participate has nothing to do with
how the events are handled.
In this app, we register handlers in an initializer.
For example, `NewUserNotifier` only listens to `UserAddedEvent`.
```ruby
event_store.subscribe(NewUserNotifier.new(Rails.logger), to: [UserAddedEvent])
```
In contrast, `EventLogger` listens to all events.
```ruby
event_store.subscribe_to_all_events(EventsLogger.new(Rails.logger))
```
### See All Events
```ruby
client = RailsEventStore::Client.new
client.read.count
client.read.each { |ev| puts ev.event_type }
client.read.each { |ev| puts ev.data[:email] }
```
Refer to [the documentation](https://railseventstore.org/docs/v2/read/) for
more.
### See Events On A Stream
```ruby
stream_name = 'book-reviews.users'
client = RailsEventStore::Client.new
client.read.stream(stream_name).count
client.read.stream(stream_name).each { |ev| puts ev.event_type }
client.read.stream(stream_name).each { |ev| puts ev.data[:email] }
```
Refer to [the documentation](https://railseventstore.org/docs/v2/read/) for
more.
### See Events In the Browser
Use the Rails Event Store Viewer at: http://localhost:3000/res
### See Events In the Database
```SQL
SELECT
eve.event_id,
eve.event_type,
eve.created_at,
GROUP_CONCAT(
eveis.stream
ORDER BY eveis.stream DESC
SEPARATOR ', '
) AS streams
FROM
event_store_events AS eve
LEFT OUTER JOIN event_store_events_in_streams AS eveis
ON eve.event_id = eveis.event_id
GROUP BY
eve.event_id
ORDER BY
eve.id
;
```