simple_event_sourcing 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27655968339ee4735cea0e938d618b2892d0a85e276e279ad6651d44c89726c7
-  data.tar.gz: d192ef1f40ff278c102658df21d8b8160bc1c0b336b6b4f70111d21554b63647
+  metadata.gz: 8c8f96d29fae329c09e8001a2ce8ab34e725ba76095d61e7927acf42321be8c2
+  data.tar.gz: 69fc9bde337b95d771f4ca23a15f7eedc0b40d0e39df082b39272e96c4ecf88a
 SHA512:
-  metadata.gz: 97f34f53c14960df110797f2bc08ae9b7090ef57d55a500aee85dee982b31f9e174509b53c4f851e0a88b8bed54d7805bbc7540fef4c73778837c1cbcce59c15
-  data.tar.gz: 3090508f627ce2eb0ebae39f025876b0299c662744fe54cf549bd734299237c75a804c40d6ddb218cc89b77581db81a5d50e770192569bbc24056f9478d0455e
+  metadata.gz: 48671ba2bc1b7b37e7130622f87f7d519bafa91f9e38e1f26f3b346d14f60354b92e9cabfe1c8005f309cde15204ded274095867470f3800b7298e5ee7ff7104
+  data.tar.gz: ca37c5f86523fb2d3e28a6eedbe9f3f9ea9999940cba3d05daf616c18e7178e985e97df83f88a3860a6d019a42b778753a23252e6ac91bbc1ae3f0e0a2b37358

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_event_sourcing (0.1.0)
+    simple_event_sourcing (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,17 @@
 # EventSourcing
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/simple_event_sourcing`. To experiment with that code, run `bin/console` for an interactive prompt.
+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.
 
-TODO: Delete this and the text above, and describe your gem
+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
+
+- AggregateRoot
+- Event
+- EventStream
+- EventPublisher
 
 ## Installation
 
@@ -22,13 +31,86 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Here an example of use:
+
+```ruby
+class Employee
+
+  include SimpleEventSourcing::AggregateRoot
+
+  attr_reader :name, :title, :salary
+
+  def initialize(args = nil )
+    super
+    unless args.nil?
+      apply_record_event  NewEmployeeIsHiredEvent.new(@aggregate_id, args[:name], args[:title], args[:salary] )
+    end
+  end
+
+  def salary=(new_salary)
+    apply_record_event SalaryHasChangedEvent.new(@aggregate_id, new_salary)
+  end
+
+  def apply_new_employee_is_hired_event(event)
+    @name = event.name
+    @title = event.title
+    @salary = event.salary
+  end
+
+  def apply_salary_has_changed_event(event)
+    @salary = event.new_salary
+  end
+
+  def save
+    # Persist the entity
+    publish_events { |event| SimpleEventSourcing::EventPublisher.publish(event) }
+  end
+
+end
+```
+
+Firts you mus add behaviour including the AggregateRoot module
+
+```ruby
+  include SimpleEventSourcing::AggregateRoot
+```
+
+After that all domain event must be applied and recorded
+
+```ruby
+apply_record_event SalaryHasChangedEvent.new(@aggregate_id, new_salary)
+```
+
+You must create your own events and a event stream
 
-## Development
+```ruby
+class EmployeeStreamEvents < SimpleEventSourcing::StreamEvents
+  def get_aggregate_class
+    Employee
+  end
+end
+
+class SalaryHasChangedEvent < SimpleEventSourcing::Event
+  attr_reader :aggregate_id, :new_salary
+
+  def initialize(aggregate_id, new_salary)
+    @aggregate_id = aggregate_id
+    @new_salary = new_salary
+    super()
+  end
+end
+```
 
-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.
+Once you persist the entity you must publish all recorded events.
+
+```ruby
+  def save
+    # Persist the entity
+    publish_events { |event| SimpleEventSourcing::EventPublisher.publish(event) }
+  end
+```
 
-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](https://rubygems.org).
+Happy coding!
 
 ## Contributing
 

data/lib/simple_event_sourcing.rb

@@ -1,104 +1,9 @@
 require 'simple_event_sourcing/version'
-require 'securerandom'
-require 'facets'
 
-module SimpleEventSourcing
-  class Event
-    attr_reader :occurred_on
-
-    def initialize
-      @occurred_on ||= Time.new
-    end
-  end
-
-  class StreamEvents < Array
-    attr_reader :aggregate_id
-
-    def initialize(aggregate_id)
-      @aggregate_id = aggregate_id
-    end
-
-    def get_aggregate
-      aggregate = get_aggregate_class.create_from_agrregate_id @aggregate_id
-      each { |event| aggregate.apply_record_event event }
-      aggregate
-    end
-
-    def get_aggregate_class
-      raise StandardError('Method must be implemented')
-    end
-  end
-
-  module EventPublisher
-    @@subscribers = []
-
-    def self.add_subscriber(subscriber)
-      @@subscribers << subscriber
-    end
-
-    def self.delete_subscriber(subscriber)
-      @@subscribers.delete(subscriber)
-    end
-
-    def self.get_subscribers
-      @@subscribers
-    end
 
-    def self.publish(event)
-      @@subscribers.each { |subscriber| subscriber.handle(event) if subscriber.is_subscribet_to? event }
-    end
-  end
+require_relative 'simple_event_sourcing/aggregate_root/aggregate_root'
+require_relative 'simple_event_sourcing/events/events'
 
-  module AggregateRoot
-    def self.included(o)
-      o.extend(ClassMethods)
-    end
-
-    attr_accessor :aggregate_id
-    attr_reader :events
-
-    def initialize(_args = nil)
-      @events = []
-      @aggregate_id ||= SecureRandom.uuid
-    end
-
-    def have_changed?
-      (@events.count > 0)
-    end
-
-    def publish_events
-      @events.each do |event|
-        yield(event)
-      end
-      clear_events
-    end
-
-    def apply_record_event(event)
-      apply_event event
-      record_event event
-    end
-
-    private
-
-    def record_event(event)
-      @events << event
-    end
-
-    def clear_events
-      @events = []
-    end
-
-    def apply_event(event)
-      method = 'apply_' + event.class.name.snakecase
-      send(method, event)
-    end
+module SimpleEventSourcing
 
-    module ClassMethods
-      def create_from_agrregate_id(id)
-        aggregate = new
-        aggregate.aggregate_id = id
-        aggregate
-      end
-    end
-  end
 end

data/lib/simple_event_sourcing/aggregate_root/aggregate_root.rb

@@ -0,0 +1,59 @@
+require 'securerandom'
+require 'facets'
+
+module SimpleEventSourcing
+  module AggregateRoot
+
+    attr_accessor :aggregate_id
+    attr_reader :events
+
+    def initialize(_args = nil)
+      @events = []
+      @aggregate_id ||= SecureRandom.uuid
+    end
+
+    def have_changed?
+      (@events.count > 0)
+    end
+
+    def publish_events
+      @events.each do |event|
+        yield(event)
+      end
+      clear_events
+    end
+
+    def apply_record_event(event)
+      apply_event event
+      record_event event
+    end
+
+    def self.included(o)
+      o.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def create_from_agrregate_id(id)
+        aggregate = new
+        aggregate.aggregate_id = id
+        aggregate
+      end
+    end
+
+    private
+
+      def record_event(event)
+        @events << event
+      end
+
+      def clear_events
+        @events = []
+      end
+
+      def apply_event(event)
+        method = 'apply_' + event.class.name.snakecase
+        send(method, event)
+      end
+
+  end
+end

data/lib/simple_event_sourcing/events/events.rb

@@ -0,0 +1,48 @@
+module SimpleEventSourcing
+
+  class Event
+    attr_reader :occurred_on
+
+    def initialize
+      @occurred_on ||= Time.new
+    end
+  end
+
+  class StreamEvents < Array
+    attr_reader :aggregate_id
+
+    def initialize(aggregate_id)
+      @aggregate_id = aggregate_id
+    end
+
+    def get_aggregate
+      aggregate = get_aggregate_class.create_from_agrregate_id @aggregate_id
+      each { |event| aggregate.apply_record_event event }
+      aggregate
+    end
+
+    def get_aggregate_class
+      raise StandardError('Method must be implemented')
+    end
+  end
+
+  module EventPublisher
+    @@subscribers = []
+
+    def self.add_subscriber(subscriber)
+      @@subscribers << subscriber
+    end
+
+    def self.delete_subscriber(subscriber)
+      @@subscribers.delete(subscriber)
+    end
+
+    def self.get_subscribers
+      @@subscribers
+    end
+
+    def self.publish(event)
+      @@subscribers.each { |subscriber| subscriber.handle(event) if subscriber.is_subscribet_to? event }
+    end
+  end
+end

data/lib/simple_event_sourcing/version.rb

@@ -1,3 +1,3 @@
 module SimpleEventSourcing
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_event_sourcing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Manel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2018-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,8 @@ files:
 - example/employee_subscribers.rb
 - example/main.rb
 - lib/simple_event_sourcing.rb
+- lib/simple_event_sourcing/aggregate_root/aggregate_root.rb
+- lib/simple_event_sourcing/events/events.rb
 - lib/simple_event_sourcing/version.rb
 - run.sh
 - simple_event_sourcing.gemspec