rails_event_store 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fcb48b25744c5f50cde8d3a00322ab3cd4a86cd
-  data.tar.gz: e2604f6b1b50c0634052a641ac96864c87d58637
+  metadata.gz: 69cc1d3ee940054aa247a3effcbc4590a9c87305
+  data.tar.gz: 40e656548799d5bcf0c1921bbf914d75d07d389f
 SHA512:
-  metadata.gz: 88296f59b7700f534ba5d36e48732fd1b6598a047c9f652361e744c8981c3bec0ae22ba35cc8ea5530cebaccacb69ff2145a29c1ace1ea54ec5c033fcc8b07d2
-  data.tar.gz: b68122fb0239b1e5a02afdb392810775bd4a3bab9cc005bb8e8e8876c48402c9cbe88514a43c89df6128b8959a4d230296e52d471754f9fc3888c6c82f762aa5
+  metadata.gz: 0637153e87843e2e23cc1705b5e09a2dd997af2116419c5ae4990ce1c5e04bbc95dd4e98a5afbb95756a57cabf43e8ac686861fed714d4e492b5817791e549a7
+  data.tar.gz: f4741353b9109b2a981c24d900d5e32f2f34ce8d2817265b1577c7bdf7c5be7fb6f937f9e971433664c9c832eb2ed6c09533e9369471e23a3c0c709d604ce1a2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.6.1 (25.05.2016)
+
+* Allow to read events backward PR #32 (bugfix)
+
 ### 0.6.0 (11.04.2016)
 
 * Change: EventRepository moved to separate gem [rails_event_store_active_record](http://github.com/arkency/rails_event_store_active_record)

data/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing to RailsEventStore
+
+Any kind of contribution is welcomed. Here is a few guidelines that we need contributors to follow.
+
+## Found a bug? Have a question?
+
+* [Create a new issue](https://github.com/arkency/rails_event_store/issues/new), assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce when it is a bug.
+  * If possible provide a Pull Request with failing test case.
+
+## Getting Started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free).
+* [Fork the repository](https://help.github.com/articles/fork-a-repo/) on GitHub.
+
+## Making Changes
+
+* Create a feature branch from where you want to base your work.
+* Do your work. Please try to keep your commits small and focussed.
+* Make sure you have added the necessary tests for your changes.
+* Push your changes to a feature branch in your fork of the repository.
+* Submit a pull request to the RailsEventStore repository.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/README.md

@@ -9,206 +9,13 @@
 A Ruby implementation of an EventStore.
 Default storage is events repository based on Active Record (provided by separate gem: [rails_event_store_active_record](http://github.com/arkency/rails_event_store_active_record)).
 
-## Installation
+# Documentation
 
-* Add following line to your application's Gemfile:
+All documentation and sample codes are available at [http://railseventstore.arkency.com](http://railseventstore.arkency.com)
 
-```ruby
-gem 'rails_event_store'
-```
+# Contributing
 
-* Use provided task to generate a table to store events in you DB.
-
-```ruby
-rails generate rails_event_store_active_record:migration
-rake db:migrate
-```
-
-## Usage
-
-To communicate with ES you have to create instance of `RailsEventStore::Client` class.
-
-```ruby
-client = RailsEventStore::Client.new
-```
-
-#### Creating new event
-
-Firstly you have to define own event model extending `RailsEventStore::Event` class.
-
-```ruby
-class OrderCreated < RailsEventStore::Event
-end
-
-# or
-
-OrderCreated = Class.new(RailsEventStore::Event)
-```
-
-```ruby
-stream_name = "order_1"
-event = OrderCreated.new(
-          data: "sample",
-          event_id: "b2d506fd-409d-4ec7-b02f-c6d2295c7edd"
-        )
-#publishing event for specific stream
-client.publish_event(event, stream_name)
-
-#publishing global event. In this case stream_name is 'all'.
-client.publish_event(event)
-```
-
-#### Creating new event with optimistic locking:
-
-```ruby
-class OrderCreated < RailsEventStore::Event
-end
-```
-
-```ruby
-stream_name = "order_1"
-event = OrderCreated.new(
-          data: "sample",
-          event_id: "b2d506fd-409d-4ec7-b02f-c6d2295c7edd"
-        )
-expected_version = "850c347f-423a-4158-a5ce-b885396c5b73" #last event_id
-client.publish_event(event, stream_name, expected_version)
-```
-
-#### Reading stream's events forward in batch - starting from first event
-
-```ruby
-stream_name = "order_1"
-count = 40
-client.read_events_forward(stream_name, :head, count)
-```
-
-In this case `:head` means first event of the stream.
-
-#### Reading stream's events forward in batch - staring from given event
-
-```ruby
-# last_read_event is any domain event read or published by rails_event_store
-
-stream_name = "order_1"
-start = last_read_event.event_id
-count = 40
-client.read_events_forward(stream_name, start, count)
-```
-
-#### Reading stream's events backward in batch
-
-As in examples above, just use `read_events_backward` instead of `read_events_forward`.
-In this case `:head` means last event of the stream.
-
-#### Reading all events from stream forward
-
-This method allows us to load all stream's events ascending.
-
-```ruby
-stream_name = "order_1"
-client.read_stream_events_forward(stream_name)
-```
-
-#### Reading all events from stream forward
-
-This method allows us to load all stream's events descending.
-
-```ruby
-stream_name = "order_1"
-client.read_stream_events_backward(stream_name)
-```
-
-#### Reading all events forward
-
-This method allows us to load all stored events ascending.
-
-This will read first 100 domain events stored in event store.
-
-```ruby
-client.read_all_streams_forward(:head, 100)
-```
-
-When not specified it reads events starting from `:head` (first domain event
-stored in event store) and reads up to `RailsEventStore::PAGE_SIZE`
-domain events.
-
-```ruby
-client.read_all_streams_forward
-```
-
-You could also read batch of domain events starting from any read or published event.
-
-```ruby
-client.read_all_streams_forward(last_read_event.event_id, 100)
-```
-
-#### Reading all events backward
-
-This method allows us to load all stored events descending.
-
-This will read last 100 domain events stored in event store.
-```ruby
-client.read_all_streams_backward(:head, 100)
-```
-
-When not specified it reads events starting from `:head` (last domain event
-stored in event store) and reads up to `RailsEventStore::PAGE_SIZE`
-domain events.
-
-```ruby
-client.read_all_streams_backward
-```
-
-#### Deleting stream
-
-You can permanently delete all events from a specific stream. Use this wisely.
-
-```ruby
-stream_name = "product_1"
-client.delete_stream(stream_name)
-```
-
-#### Subscribing to events
-
-To listen on specific events synchronously you have to create subscriber representation. The only requirement is that subscriber class has to implement the 'handle_event(event)' method.
-
-```ruby
-class InvoiceReadModel
-  def handle_event(event)
-    #we deal here with event's data
-  end
-end
-```
-
-* You can subscribe on specific set of events
-
-```ruby
-invoice = InvoiceReadModel.new
-client.subscribe(invoice, [PriceChanged, ProductAdded])
-```
-
-* You can also listen on all incoming events
-
-```ruby
-invoice = InvoiceReadModel.new
-client.subscribe_to_all_events(invoice)
-```
-
-#### Building an event sourced application with RailsEventStore gem
-
-ArrgegateRoot module & AggregateReporitory have been extracted from RailsEventStore to separate gem.
-See [aggregate_root](https://github.com/arkency/aggregate_root) gem readme to find help how to start.
-Also [this example](https://github.com/mpraglowski/cqrs-es-sample-with-res) might be useful.
-
-#### Resources
-
-There're already few blogposts about Rails EventStore. Check them out:
-
-* [Why use Event Sourcing](http://blog.arkency.com/2015/03/why-use-event-sourcing/)
-* [The Event Store for Rails developers](http://blog.arkency.com/2015/04/the-event-store-for-rails-developers/)
-* [Fast introduction to Event Sourcing for Ruby programmers](http://blog.arkency.com/2015/03/fast-introduction-to-event-sourcing-for-ruby-programmers/)
-* [Why I want to introduce mutation testing to the rails_event_store gem](http://blog.arkency.com/2015/04/why-i-want-to-introduce-mutation-testing-to-the-rails-event-store-gem/)
+Check the contribution guide on [CONTRIBUTING.md](https://github.com/arkency/rails_event_store/blob/master/CONTRIBUTING.md)
 
 ## About
 

data/lib/rails_event_store/client.rb

@@ -26,16 +26,28 @@ module RailsEventStore
     end
     alias :read_events :read_events_forward
 
+    def read_events_backward(stream_name, start = :head, count = page_size)
+      event_store.read_events_backward(stream_name, start, count)
+    end
+
     def read_stream_events_forward(stream_name)
       event_store.read_stream_events_forward(stream_name)
     end
     alias :read_all_events :read_stream_events_forward
 
+    def read_stream_events_backward(stream_name)
+      event_store.read_stream_events_backward(stream_name)
+    end
+
     def read_all_streams_forward(start = :head, count = page_size)
       event_store.read_all_streams_forward(start, count)
     end
     alias :read_all_streams :read_all_streams_forward
 
+    def read_all_streams_backward(start = :head, count = page_size)
+      event_store.read_all_streams_backward(start, count)
+    end
+
     def subscribe(subscriber, event_types)
       event_store.subscribe(subscriber, event_types)
     end

data/lib/rails_event_store/version.rb

@@ -1,3 +1,3 @@
 module RailsEventStore
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_event_store
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - rybex
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-11 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -190,6 +190,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md