simple_event_sourcing 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0af077c1f7192128bfc81d95dd245712d44fa647465dd4dddc3cd0cc3849044
-  data.tar.gz: c34c2358c240f4235be395afbc42373336278fc85bfbd0ba8b768e479f842c3b
+  metadata.gz: ae87508c0ddc3384c7f2011ea0b8ed3700620cadc889164ae06776cdaa79cb4d
+  data.tar.gz: e5a91b0012ee57ccb2451a229c38a0c45f10fe27c400ba7d8f53e616b4da794c
 SHA512:
-  metadata.gz: a6a6dd3da4a2b9e489309d718371726fd00b841ab55fd5a9502b4ed3e1c0e69a38e11b0d21d25a11a7109adc98017376403e2a2e0ce59a8d5e1c6adccc3dc395
-  data.tar.gz: 8316de28bec9dee0efe27e8f1e7a3089f594900e63b83b56dca9752396fbe159a622be9e40c96257aac7be6da6b0f0144fea5c30ff2d5ad2460b37a5f5df9568
+  metadata.gz: 42d2a999148a1211598af7b5e9a8361c5bd769e9e73529cb06a7c5ff94d6a3e3f16d896f39e6416c84dae67e49b02f223c1afd5e5d7742ade56d6e92f62db8a5
+  data.tar.gz: ef5175ce65a340e3008bd9b6bbb676a6f027073c0eb8cdd79d212092730f89ca3596b74f388bd65328e6d75c27e083fda7c941cad8d2ff3bf0ea25dd03c174bd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_event_sourcing (0.7.0)
+    simple_event_sourcing (0.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -11,6 +11,7 @@ GEM
     facets (3.1.0)
     json (2.1.0)
     rake (10.5.0)
+    redis (4.0.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -29,6 +30,7 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    timecop (0.9.1)
 
 PLATFORMS
   ruby
@@ -37,9 +39,11 @@ DEPENDENCIES
   bundler (~> 1.16)
   facets
   rake (~> 10.0)
+  redis
   rspec (~> 3.0)
   simple_event_sourcing!
   simplecov
+  timecop
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -5,20 +5,22 @@ DISCLAIMER
 
 This gem is under development. DO NOT USE IN PRODUCTION ENVIRONMENT!!!!
 
+>The fundamental idea of Event Sourcing is that of ensuring every change to the state of an application is captured in an event object, and that these event objects are themselves stored in the sequence they were applied for the same lifetime as the application state itself.
+>
+>Martin Fowler , [https://martinfowler.com/eaaDev/EventSourcing.html](https://martinfowler.com/eaaDev/EventSourcing.html)
 
-The fundamental idea of Event Sourcing is that of ensuring every change to the state of an application is captured in an event object, and that these event objects are themselves stored in the sequence they were applied for the same lifetime as the application state itself.
+This gem provides a simple way of adding event sourcing behaviour to your models class.
 
-Martin Fowler , https://martinfowler.com/eaaDev/EventSourcing.html
-
-This gem provides a simple way for add events sourcing related behaviour to your models class.
-
-Base classes
+You could find this base classes:
 
 - AggregateRoot
-- UUID Id
+- Id
+- History
 - Event
-- EventStream
 - EventDispatcher
+- EventSubscriber
+- StoredEvent
+- RedisEventStore
 
 ## Installation
 
@@ -38,7 +40,7 @@ Or install it yourself as:
 
 ## Usage
 
-Here an example of use:
+Firts of all, you must add "event sourcing" behaviour to your model including the AggregateRoot Base Module
 
 ```ruby
 class Employee
@@ -58,6 +60,10 @@ class Employee
     apply_record_event SalaryHasChangedEvent , new_salary: new_salary
   end
 
+  def id
+    aggregate_id.to_s
+  end
+
   on NewEmployeeIsHiredEvent do |event|
     @name = event.name
     @title = event.title
@@ -68,76 +74,69 @@ class Employee
     @salary = event.new_salary
   end
 
-  def save
-    # Persist the entity
-    publish_events { |event| SimpleEventSourcing::Events::EventDispatcher.publish(event) }
-  end
-
 end
 
 ```
 
-First, you must add behaviour including the AggregateRoot module
-
-```ruby
-  include SimpleEventSourcing::AggregateRoot::Base
-```
-
-You must create your own domain events and a event stream
+You must create your own domain events
 
 ```ruby
-class EmployeeStreamEvents < SimpleEventSourcing::AggregateRoot::History
-  def get_aggregate_class
-    Employee
-  end
-end
-
-
-class NewEmployeeIsHiredEvent < SimpleEventSourcing::Events::Event
-  attr_reader :name, :title,:salary
-
-  def initialize(args)
-    @name = args[:name]
-    @title = args[:title]
-    @salary = args[:salary]
-    super(args)
-  end
-end
 
-class SalaryHasChangedEvent < SimpleEventSourcing::Events::Event
+class SalaryHasChangedEvent  < SimpleEventSourcing::Events::Event
   attr_reader  :new_salary
 
   def initialize(args)
     @new_salary = args[:new_salary]
     super(args)
   end
+
+  def serialize
+    super.merge("new_salary" => new_salary)
+  end
+
 end
+
 ```
 
-After that all domain event must be applied and recorded
+After that, we must provide a handle in the out model for all domain event. SimpleEventSourcing provides a DSL to handle the applied events. You must provide a handler for each event
 
 ```ruby
-apply_record_event SalaryHasChangedEvent , new_salary: new_salary
+  on SalaryHasChangedEvent do |event|
+    @salary = event.new_salary
+  end
 ```
 
-SimpleEventSourcing provides a DSL to handle the applied events. You must provide a handler for each event
+Now you could apply and record events.
 
 ```ruby
-on SalaryHasChangedEvent do |event|
-  @salary = event.new_salary
-end
+apply_record_event SalaryHasChangedEvent , new_salary: new_salary
 ```
 
-Once you persist the entity you must publish all recorded events.
-
+Once you persist the entity you must store and publish all recorded events.
 ```ruby
-  def save
-    # Persist the entity
-    publish_events { |event| SimpleEventSourcing::EventDispatcher.publish(event) }
+class EmployeeRepository
+  def initialize(event_store)
+    @event_store = event_store
   end
+
+  def save(employee)
+    employee.events.each do |event|
+      @event_store.commit event
+      SimpleEventSourcing::Events::EventDispatcher.publish(event)
+    end
+  end
+
+  def findById(id)
+    history = @event_store.get_history id
+    return Employee.create_from_history history
+  end
+end
+
 ```
 
-You could see this example in https://github.com/malotor/simple_event_sourcing_example
+This gem provides a Redis Event Store or if you want, you could create your own usign "EventStoreBase" interface.
+
+You could see this example running in  https://github.com/malotor/simple_event_sourcing_example
 
 Happy coding!
 

data/lib/simple_event_sourcing/aggregate_root/base.rb

@@ -16,10 +16,9 @@ module SimpleEventSourcing
       end
 
       def publish_events
-        @events.each do |event|
-          yield(event)
-        end
+        published_events = @events
         clear_events
+        published_events
       end
 
       def handle_message(message)

data/lib/simple_event_sourcing/events/event.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module SimpleEventSourcing
   module Events
 
@@ -6,7 +8,15 @@ module SimpleEventSourcing
 
       def initialize(args)
         @aggregate_id = args[:aggregate_id]
-        @occurred_on ||= Time.new
+        @occurred_on ||= Time.now.getlocal("+02:00").to_i
+      end
+
+      def serialize
+        {"aggregate_id" => aggregate_id.to_s, "occurred_on" => occurred_on }
+      end
+
+      def to_json(*a)
+        serialize.to_json(*a)
       end
     end
   end

data/lib/simple_event_sourcing/events/event_store/redis/redis_client.rb

@@ -0,0 +1,66 @@
+require 'redis'
+
+module SimpleEventSourcing
+  module Events
+    module EventStore
+    
+      module RedisClient
+        class << self
+          attr_writer :configuration
+        end
+
+        def self.configuration
+          @configuration ||= Configuration.new
+        end
+
+        def self.reset
+          @configuration = Configuration.new
+        end
+
+        def self.configure
+          yield(configuration)
+        end
+
+        class Configuration
+          attr_accessor :host,:port,:mock
+
+          def initialize
+            @host ='localhost'
+            @port = 6379
+            @mock = false
+          end
+        end
+
+
+        def self.get_client
+          if @configuration.mock
+            return RedisClientMock.new
+          else
+            return Redis.new(
+              host: @configuration.host,
+              port: @configuration.port
+            )
+          end
+        end
+
+      end
+
+      class RedisClientMock
+        attr_reader :entries
+
+        def initialize
+          @entries = Hash.new()
+        end
+        def rpush(key, value)
+          @entries[key] ||= []
+          @entries[key] << value
+        end
+        def lrange(key,inf,max)
+          @entries[key] ||= []
+          return @entries[key]
+        end
+      end
+
+    end
+  end
+end

data/lib/simple_event_sourcing/events/event_store/redis/redis_event_store.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+module SimpleEventSourcing
+  module Events
+    module EventStore
+      class RedisEventStore < SimpleEventSourcing::Events::EventStore::EventStoreBase
+
+        def initialize(client)
+          @redis = client
+        end
+
+        def commit(event)
+
+          stored_event = SimpleEventSourcing::Events::StoredEvent.new(
+            aggregate_id: event.aggregate_id.to_s,
+            occurred_on: Time.now.getlocal("+02:00").to_i,
+            event_type: event.class.name,
+            event_data: event.to_json
+          )
+
+          @redis.rpush(event.aggregate_id.to_s, stored_event.to_json )
+
+        end
+
+        def get_history(aggregate_id)
+          stored_events_json = @redis.lrange( aggregate_id, 0, -1 )
+          history = SimpleEventSourcing::AggregateRoot::History.new(aggregate_id)
+          stored_events_json.each do |stored_event_json|
+            stored_event =  SimpleEventSourcing::Events::StoredEvent.create_from_json stored_event_json
+            event = Object.const_get(stored_event.event_type)
+            args = JSON.parse(stored_event.event_data)
+            args.keys.each do |key|
+              args[(key.to_sym rescue key) || key] = args.delete(key)
+            end
+            recovered_event = event.new(args)
+            history << recovered_event
+          end
+          history
+        end
+      end
+    end
+  end
+end

data/lib/simple_event_sourcing/events/event_store.rb

@@ -1,15 +1,16 @@
 module SimpleEventSourcing
   module Events
-    class EventStore
+    module EventStore
+      class EventStoreBase
 
-      def commit(event)
-        raise StandardError "This methid must be implemented"
-      end
+        def commit(event)
+          raise StandardError "This methid must be implemented"
+        end
 
-      def get_history(aggregate_id)
-        raise StandardError "This methid must be implemented"
+        def get_history(aggregate_id)
+          raise StandardError "This methid must be implemented"
+        end
       end
     end
-
   end
 end

data/lib/simple_event_sourcing/events/stored_event.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module SimpleEventSourcing
   module Events
 

data/lib/simple_event_sourcing/version.rb

@@ -1,3 +1,3 @@
 module SimpleEventSourcing
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/simple_event_sourcing.rb

@@ -9,3 +9,5 @@ require 'simple_event_sourcing/events/event_dispatcher'
 require 'simple_event_sourcing/events/event_subscriber'
 require 'simple_event_sourcing/events/stored_event'
 require 'simple_event_sourcing/events/event_store'
+require 'simple_event_sourcing/events/event_store/redis/redis_client'
+require 'simple_event_sourcing/events/event_store/redis/redis_event_store'

data/simple_event_sourcing.gemspec

@@ -35,5 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "facets"
   spec.add_development_dependency "simplecov"
-
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "redis"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_event_sourcing
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Manuel López Torrent
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2018-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: redis
+  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'
 description: This gem provides a simple way for add events sourcing related behaviour
   to your models class
 email:
@@ -109,6 +137,8 @@ files:
 - lib/simple_event_sourcing/events/event.rb
 - lib/simple_event_sourcing/events/event_dispatcher.rb
 - lib/simple_event_sourcing/events/event_store.rb
+- lib/simple_event_sourcing/events/event_store/redis/redis_client.rb
+- lib/simple_event_sourcing/events/event_store/redis/redis_event_store.rb
 - lib/simple_event_sourcing/events/event_subscriber.rb
 - lib/simple_event_sourcing/events/stored_event.rb
 - lib/simple_event_sourcing/version.rb