rails_event_store 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05020e834d5c97cc237417e4a7be9faaa390e6dd
-  data.tar.gz: d4a5b24df71b0ab5bc7db11e7b70c9fc44453f32
+  metadata.gz: 2d9826553e1956e364b65709bd8e29e713869a6b
+  data.tar.gz: 2f30ed66122ba0a9a30b5bd3053f03652eaf94ab
 SHA512:
-  metadata.gz: 332ca9bb7abad5c530e016cc3798947077cd94940aafc058cff89ad0fec911a1bedb86ffa76dfbd3efbebd7fa6fe8c4a5d80a7d7ad490116e0863af3eaf64825
-  data.tar.gz: 4ee55442c067e05d362d358da1cb4d954d488bfed9751e7e34d778067cd990580b1453a5e319a241b0026d6ef0019513d4fe0dfc23798708417783b388a9e537
+  metadata.gz: 5b2e74bd009c8369d43507147d7c0c64748787e3a6207f2482b8c14b1671853d003b9aa1647276f404400e0bebe2a201dee8e39b5d26c9c0c44ccf931c6783bb
+  data.tar.gz: 1200e2ab68017a246835588778bee2b0a577af0aec61935b1f27c008f19274508b7f56b5a215788ddf5ec24ccd99251eff63d5d8dc4e045c139ca5f032e96cfd

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ### HEAD
 
+### 0.3.0 (03.03.2016)
+
+* Update to ruby_event_store 0.3.0 - see ruby_event_store changelog for more details
+* Implement reading forward & backward (aliasold methods to read forward)
+* Implement paging when reading from all streams
+
 ### 0.2.2 (25.02.2016)
 
 * Restore AggregateRoot in RES, but this time as a dependency on aggregate_root gem

data/README.md

@@ -38,16 +38,18 @@ Firstly you have to define own event model extending `RailsEventStore::Event` cl
 ```ruby
 class OrderCreated < RailsEventStore::Event
 end
+
+# or
+
+OrderCreated = Class.new(RailsEventStore::Event)
 ```
 
 ```ruby
 stream_name = "order_1"
-event_data = {
-               data: { data: "sample" },
-               event_id: "b2d506fd-409d-4ec7-b02f-c6d2295c7edd"
-             }
-event = OrderCreated.new(event_data)
-
+event = OrderCreated.new(
+          data: "sample",
+          event_id: "b2d506fd-409d-4ec7-b02f-c6d2295c7edd"
+        )
 #publishing event for specific stream
 client.publish_event(event, stream_name)
 
@@ -64,39 +66,97 @@ end
 
 ```ruby
 stream_name = "order_1"
-event_data = {
-               data: { data: "sample" },
-               event_id: "b2d506fd-409d-4ec7-b02f-c6d2295c7edd"
-             }
-event = OrderCreated.new(event_data)
+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
+#### Reading stream's events forward in batch - starting from first event
 
 ```ruby
 stream_name = "order_1"
-start = "850c347f-423a-4158-a5ce-b885396c5b73"
 count = 40
-client.read_all_events(stream_name, start, count)
+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_all_events(stream_name)
+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
+client.read_all_streams_backward
 ```
 
 #### Deleting stream

data/lib/rails_event_store/client.rb

@@ -1,30 +1,38 @@
 module RailsEventStore
   class Client
 
-    def initialize(repository = Repositories::EventRepository.new)
+    def initialize(repository = Repositories::EventRepository.new, page_size = PAGE_SIZE)
       @repository = repository
+      @page_size = page_size
     end
-    attr_reader :repository
+    attr_reader :repository, :page_size
 
-    def publish_event(event_data, stream_name = GLOBAL_STREAM, expected_version = nil)
-      event_store.publish_event(event_data, stream_name, expected_version)
+    def publish_event(event, stream_name = GLOBAL_STREAM, expected_version = nil)
+      event_store.publish_event(event, stream_name, expected_version)
+    end
+
+    def appent_to_stream(event, stream_name = GLOBAL_STREAM, expected_version = nil)
+      event_store.appent_to_stream(stream_name, event, expected_version)
     end
 
     def delete_stream(stream_name)
       event_store.delete_stream(stream_name)
     end
 
-    def read_events(stream_name, start, count)
-      event_store.read_events(stream_name, start, count)
+    def read_events_forward(stream_name, start = :head, count = page_size)
+      event_store.read_events_forward(stream_name, start, count)
     end
+    alias :read_events :read_events_forward
 
-    def read_all_events(stream_name)
-      event_store.read_all_events(stream_name)
+    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_all_streams
-      event_store.read_all_streams
+    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 subscribe(subscriber, event_types)
       event_store.subscribe(subscriber, event_types)

data/lib/rails_event_store/constants.rb

@@ -1,3 +1,4 @@
 module RailsEventStore
   GLOBAL_STREAM = 'all'.freeze
+  PAGE_SIZE     = 100.freeze
 end

data/lib/rails_event_store/event.rb

@@ -1,19 +1,3 @@
 module RailsEventStore
-  class Event < RubyEventStore::Event
-    def initialize(**args)
-      attributes = args.except(:event_type, :event_id, :metadata)
-      singleton_class = (class << self; self; end)
-      attributes.each do |key, value|
-        singleton_class.send(:define_method, key) { value }
-      end
-
-      event_data = {
-        event_type: args[:event_type] || self.class.name,
-        data:       attributes,
-      }
-      event_data[:event_id] = args[:event_id] if args.key?(:event_id)
-      event_data[:metadata] = args[:metadata] if args.key?(:metadata)
-      super(event_data)
-    end
-  end
+  Event = RubyEventStore::Event
 end

data/lib/rails_event_store/repositories/event_repository.rb

@@ -7,35 +7,82 @@ module RailsEventStore
       end
       attr_reader :adapter
 
-      def find(condition)
-        build_event_entity(adapter.where(condition).first)
+      def create(event, stream_name)
+        data = event.to_h.merge!(stream: stream_name)
+        adapter.create(data)
+        event
       end
 
-      def create(data)
-        build_event_entity(adapter.create(data))
-      rescue ActiveRecord::RecordNotUnique
-        raise EventCannotBeSaved
-      end
-
-      def delete(condition)
+      def delete_stream(stream_name)
+        condition = {stream: stream_name}
         adapter.destroy_all condition
         nil
       end
 
-      def get_all_events
-        adapter.order('id ASC').order('stream').all.map(&method(:build_event_entity))
+      def has_event?(event_id)
+        adapter.exists?(event_id: event_id)
       end
 
       def last_stream_event(stream_name)
         build_event_entity(adapter.where(stream: stream_name).last)
       end
 
-      def load_all_events_forward(stream_name)
-        adapter.where(stream: stream_name).order('id ASC').map(&method(:build_event_entity))
+      def get_all_events
+        adapter.order('id ASC').order('stream').all.map(&method(:build_event_entity))
+      end
+
+      def read_events_forward(stream_name, start_event_id, count)
+        stream = adapter.where(stream: stream_name)
+        unless start_event_id.equal?(:head)
+          starting_event = adapter.find_by(event_id: start_event_id)
+          stream = stream.where('id > ?', starting_event.id)
+        end
+
+        stream.order('id ASC').limit(count)
+          .map(&method(:build_event_entity))
+      end
+
+      def read_events_backward(stream_name, start_event_id, count)
+        stream = adapter.where(stream: stream_name)
+        unless start_event_id.equal?(:head)
+          starting_event = adapter.find_by(event_id: start_event_id)
+          stream = stream.where('id < ?', starting_event.id)
+        end
+
+        stream.order('id DESC').limit(count)
+          .map(&method(:build_event_entity))
+      end
+
+      def read_stream_events_forward(stream_name)
+        adapter.where(stream: stream_name).order('id ASC')
+          .map(&method(:build_event_entity))
+      end
+
+      def read_stream_events_backward(stream_name)
+        adapter.where(stream: stream_name).order('id DESC')
+          .map(&method(:build_event_entity))
       end
 
-      def load_events_batch(stream_name, start_point, count)
-        adapter.where('id >= ? AND stream = ?', start_point, stream_name).limit(count).map(&method(:build_event_entity))
+      def read_all_streams_forward(start_event_id, count)
+        stream = adapter
+        unless start_event_id.equal?(:head)
+          starting_event = adapter.find_by(event_id: start_event_id)
+          stream = stream.where('id > ?', starting_event.id)
+        end
+
+        stream.order('id ASC').limit(count)
+          .map(&method(:build_event_entity))
+      end
+
+      def read_all_streams_backward(start_event_id, count)
+        stream = adapter
+        unless start_event_id.equal?(:head)
+          starting_event = adapter.find_by(event_id: start_event_id)
+          stream = stream.where('id < ?', starting_event.id)
+        end
+
+        stream.order('id DESC').limit(count)
+          .map(&method(:build_event_entity))
       end
 
       private
@@ -45,7 +92,6 @@ module RailsEventStore
         ::RailsEventStore::Event.new(record.data.merge(
           event_type: record.event_type,
           event_id:   record.event_id,
-          stream:     record.stream,
           metadata:   record.metadata))
       end
 

data/lib/rails_event_store/version.rb

@@ -1,3 +1,3 @@
 module RailsEventStore
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/rails_event_store.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ['rybex', 'mpraglowski']
   spec.email         = ['tomek.rybka@gmail.com', 'm@praglowski.com']
 
-  spec.summary       = %q{Implementation of Event Store in Ruby}
+  spec.summary       = %q{Event Store in Ruby}
   spec.description   = %q{Implementation of Event Store in Ruby}
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/arkency/rails_event_store'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
@@ -20,14 +20,14 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.9'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rails', '~> 4.2.1'
-  spec.add_development_dependency 'webmock', '~> 1.21.0'
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 0'
+  spec.add_development_dependency 'rails', '~> 4.2'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'sqlite3', '~> 0'
 
-  spec.add_dependency 'ruby_event_store', '>= 0.2.0'
-  spec.add_dependency 'aggregate_root', '>= 0.1.0'
+  spec.add_dependency 'ruby_event_store', '~> 0.3'
+  spec.add_dependency 'aggregate_root', '~> 0'
   spec.add_dependency 'activesupport', '>= 3.0'
   spec.add_dependency 'activemodel', '>= 3.0'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_event_store
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - rybex
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,28 +43,28 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -73,70 +73,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby_event_store
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: aggregate_root
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +192,7 @@ files:
 - lib/rails_event_store/repositories/event_repository.rb
 - lib/rails_event_store/version.rb
 - rails_event_store.gemspec
-homepage: ''
+homepage: https://github.com/arkency/rails_event_store
 licenses: []
 metadata: {}
 post_install_message: 
@@ -211,8 +211,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
-summary: Implementation of Event Store in Ruby
+summary: Event Store in Ruby
 test_files: []