simple_event_sourcing 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 666d470eb4b8fadd4728c3bd093e216b6454272d23a3f2891fef63657855a270
-  data.tar.gz: 828c08776a5200bd236783f0d911b25ac4283ae87d628f102e61554d0c61089e
+  metadata.gz: 0611f1925717d9e7186c6afd3cb564ed9224969bffd3b681e20a503f6326749b
+  data.tar.gz: 8e9c67af00a6782f5097d4aad1892925bd9c20245d3c78e0ebebe28db44cdffc
 SHA512:
-  metadata.gz: d0b8fae3aac98197e3cbcf73f44ed374208239166cb631c952844196abdea07b81fcddbdb2cd03d604481f6d0859f4390384f359e0cc6cdf84df6c4c33df114f
-  data.tar.gz: 888f20ab00ebe27210b225760885cc35e8f654df4050068ad5979e33f4490e3451ed59325be12b6c64b96a774f840ac0634aa4d36dc9e9f07ce938a425bc1717
+  metadata.gz: 1f162f575634be6a4a5aaaa935afa736c7e9059507bd8b054489ff07e5d18fdd8900124287f6eedb6423c86bfd1b5fd27de41dbb28caf5de72a46834248f91f7
+  data.tar.gz: 0a7c0bcb4a586321420781093f3630d88f882d37b1d8d3b257c44f067838f1c3af55322b73e0faadd6d261afbde17d56d92ad7a6845b82ff1059beda96b86b3a

data/Gemfile.lock

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

data/README.md

@@ -9,9 +9,10 @@ This gem provides a simple way for add events sourcing related behaviour to your
 Base classes
 
 - AggregateRoot
+- UUID Id
 - Event
 - EventStream
-- EventPublisher
+- EventDispatcher
 
 ## Installation
 
@@ -63,7 +64,7 @@ class Employee
 
   def save
     # Persist the entity
-    publish_events { |event| SimpleEventSourcing::EventPublisher.publish(event) }
+    publish_events { |event| SimpleEventSourcing::Events::EventDispatcher.publish(event) }
   end
 
 end
@@ -78,7 +79,7 @@ First, you must add behaviour including the AggregateRoot module
 You must create your own domain events and a event stream
 
 ```ruby
-class EmployeeStreamEvents < SimpleEventSourcing::StreamEvents
+class EmployeeStreamEvents < SimpleEventSourcing::AggregateRoot::History
   def get_aggregate_class
     Employee
   end
@@ -109,14 +110,12 @@ on SalaryHasChangedEvent do |event|
 end
 ```
 
-
-
 Once you persist the entity you must publish all recorded events.
 
 ```ruby
   def save
     # Persist the entity
-    publish_events { |event| SimpleEventSourcing::EventPublisher.publish(event) }
+    publish_events { |event| SimpleEventSourcing::EventDispatcher.publish(event) }
   end
 ```
 

data/example/employee.rb

@@ -1,13 +1,13 @@
 require_relative '../lib/simple_event_sourcing'
 
-class EmployeeStreamEvents < SimpleEventSourcing::StreamEvents
+class EmployeeStreamEvents < SimpleEventSourcing::AggregateRoot::History
   def get_aggregate_class
     Employee
   end
 end
 
 
-class NewEmployeeIsHiredEvent < SimpleEventSourcing::Event
+class NewEmployeeIsHiredEvent < SimpleEventSourcing::Events::Event
   attr_reader :name, :title,:salary
 
   def initialize(aggregate_id, name, title, salary)
@@ -19,7 +19,7 @@ class NewEmployeeIsHiredEvent < SimpleEventSourcing::Event
   end
 end
 
-class SalaryHasChangedEvent < SimpleEventSourcing::Event
+class SalaryHasChangedEvent < SimpleEventSourcing::Events::Event
   attr_reader :aggregate_id, :new_salary
 
   def initialize(aggregate_id, new_salary)
@@ -29,7 +29,7 @@ class SalaryHasChangedEvent < SimpleEventSourcing::Event
   end
 end
 
-class CongratulateEmployeeSubscriber < SimpleEventSourcing::EventSubscriber
+class CongratulateEmployeeSubscriber < SimpleEventSourcing::Events::EventSubscriber
 
   def is_subscribet_to?(event)
     event.class == SalaryHasChangedEvent
@@ -44,7 +44,7 @@ end
 
 class Employee
 
-  include SimpleEventSourcing::AggregateRoot
+  include SimpleEventSourcing::AggregateRoot::Base
 
   attr_reader :name, :title, :salary
 
@@ -71,7 +71,7 @@ class Employee
 
   def save
     # Persist the entity
-    publish_events { |event| SimpleEventSourcing::EventPublisher.publish(event) }
+    publish_events { |event| SimpleEventSourcing::Events::EventDispatcher.publish(event) }
   end
 
 end

data/example/main.rb

@@ -1,7 +1,12 @@
+
+unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)+'/../lib'))
+  $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)+'/../lib'))
+end
+
 require 'simple_event_sourcing'
-require_relative 'employee'
+require_relative './employee'
 
-SimpleEventSourcing::EventPublisher.add_subscriber(CongratulateEmployeeSubscriber.new)
+SimpleEventSourcing::Events::EventDispatcher.add_subscriber(CongratulateEmployeeSubscriber.new)
 
 fred = Employee.new(name: "Fred Flintstone", title: "Crane Operator", salary: 30000.0)
 fred.salary=35000.0

data/lib/simple_event_sourcing/aggregate_root/base.rb

@@ -0,0 +1,75 @@
+module SimpleEventSourcing
+  module AggregateRoot
+
+    module Base
+
+      attr_accessor :aggregate_id
+      attr_reader :events
+
+      def initialize(_args = nil)
+        @events = []
+        @aggregate_id ||= SimpleEventSourcing::Id::UUIDId.generate
+      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)
+        handle_message(event)
+        record_event event
+      end
+
+      def handle_message(message)
+        handler = self.class.message_mapping[message.class]
+        self.instance_exec(message, &handler) if handler
+      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
+        def on(*message_classes, &block)
+          message_classes.each { |message_class| message_mapping[message_class] = block }
+        end
+
+        def message_mapping
+          @message_mapping ||= {}
+        end
+
+        def handles_message?(message)
+          message_mapping.keys.include? message.class
+        end
+      end
+
+      private
+
+        def record_event(event)
+          @events << event
+        end
+
+        def clear_events
+          @events = []
+        end
+
+        def apply_event(event)
+          handle_message(event)
+          #method = 'apply_' + event.class.name.snakecase
+          #send(method, event)
+        end
+    end
+  end
+end

data/lib/simple_event_sourcing/aggregate_root/history.rb

@@ -0,0 +1,21 @@
+module SimpleEventSourcing
+  module AggregateRoot
+    class History < 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
+  end
+end

data/lib/simple_event_sourcing/aggregate_root/id.rb

@@ -0,0 +1,54 @@
+require 'securerandom'
+
+module SimpleEventSourcing
+
+  module Id
+
+    class BaseId
+      def initialize(value)
+        @value = value
+      end
+
+      def id
+        @value
+      end
+
+      def to_s
+        @value
+      end
+
+      def ==(other_id)
+        self.class == other_id.class && @value == other_id.id
+      end
+
+      alias eql? ==
+
+    end
+
+    class UUIDId < BaseId
+      def initialize(value)
+        raise UUIDValidationError unless valid? value
+        super(value)
+      end
+
+      def self.generate
+        new SecureRandom.uuid
+      end
+
+      private
+
+        def valid?(uuid)
+          uuid_regex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
+          return true if uuid_regex =~ uuid.to_s.downcase
+          return false
+        end
+    end
+
+    class UUIDValidationError < StandardError
+      def initialize(msg="Value is not a valid UUID")
+        super
+      end
+    end
+
+  end
+end

data/lib/simple_event_sourcing/events/events.rb

@@ -1,60 +1,56 @@
 module SimpleEventSourcing
+  module Events
 
-  class Event
-    attr_reader :occurred_on
+    class Event
+      attr_reader :occured_on
 
-    def initialize
-      @occurred_on ||= Time.new
+      def initialize
+        @occured_on ||= Time.new
+      end
     end
-  end
 
-  class StreamEvents < Array
-    attr_reader :aggregate_id
+    class EventSubscriber
 
-    def initialize(aggregate_id)
-      @aggregate_id = aggregate_id
-    end
+      def is_subscribet_to?(event)
+        raise StandardError "Method not implemented"
+      end
 
-    def get_aggregate
-      aggregate = get_aggregate_class.create_from_agrregate_id @aggregate_id
-      each { |event| aggregate.apply_record_event event }
-      aggregate
-    end
+      def check(event)
+        raise EventIsNotAllowedToBeHandled unless is_subscribet_to? event
+      end
 
-    def get_aggregate_class
-      raise StandardError('Method must be implemented')
-    end
-  end
+      def handle_event(event)
+        raise StandardError "Method not implemented"
+      end
 
-  class EventSubscriber
+      def handle(event)
+        check event
+        handle_event event
+      end
 
-    def is_subscribet_to?(event)
-      raise StandardError "Method not implemented"
     end
 
-    def handle(event)
-      raise StandardError "Method not implemented"
-    end
-  end
+    class EventIsNotAllowedToBeHandled < StandardError; end
 
+    module EventDispatcher
+      @@subscribers = []
 
-  module EventPublisher
-    @@subscribers = []
+      def self.add_subscriber(subscriber)
+        @@subscribers << subscriber
+      end
 
-    def self.add_subscriber(subscriber)
-      @@subscribers << subscriber
-    end
+      def self.delete_subscriber(subscriber)
+        @@subscribers.delete(subscriber)
+      end
 
-    def self.delete_subscriber(subscriber)
-      @@subscribers.delete(subscriber)
-    end
+      def self.get_subscribers
+        @@subscribers
+      end
 
-    def self.get_subscribers
-      @@subscribers
+      def self.publish(event)
+        @@subscribers.each { |subscriber| subscriber.handle(event) if subscriber.is_subscribet_to? event }
+      end
     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.3.0"
+  VERSION = "0.4.0"
 end

data/lib/simple_event_sourcing.rb

@@ -1,8 +1,6 @@
 require 'simple_event_sourcing/version'
 
-require_relative 'simple_event_sourcing/aggregate_root/aggregate_root'
-require_relative 'simple_event_sourcing/events/events'
-
-module SimpleEventSourcing
-
-end
+require 'simple_event_sourcing/aggregate_root/id'
+require 'simple_event_sourcing/aggregate_root/base'
+require 'simple_event_sourcing/aggregate_root/history'
+require 'simple_event_sourcing/events/events'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_event_sourcing
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Manuel López Torrent
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-22 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,8 +105,9 @@ files:
 - example/employee.rb
 - example/main.rb
 - lib/simple_event_sourcing.rb
-- lib/simple_event_sourcing/aggregate_root/aggregate_root.rb
-- lib/simple_event_sourcing/aggregate_root/self_applier.rb
+- lib/simple_event_sourcing/aggregate_root/base.rb
+- lib/simple_event_sourcing/aggregate_root/history.rb
+- lib/simple_event_sourcing/aggregate_root/id.rb
 - lib/simple_event_sourcing/events/events.rb
 - lib/simple_event_sourcing/version.rb
 - run.sh
@@ -131,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: This gem provides a simple way for add events sourcing related behaviour

data/lib/simple_event_sourcing/aggregate_root/aggregate_root.rb

@@ -1,62 +0,0 @@
-require 'securerandom'
-require 'facets'
-
-require_relative 'self_applier'
-
-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)
-      handle_message(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)
-        handle_message(event)
-        #method = 'apply_' + event.class.name.snakecase
-        #send(method, event)
-      end
-
-  end
-end

data/lib/simple_event_sourcing/aggregate_root/self_applier.rb

@@ -1,41 +0,0 @@
-module SimpleEventSourcing
-  module AggregateRoot
-    ##
-    # Creates ability to use DSL like:
-    # class MyEventHandler < Sequent::Core::BaseEventHandler
-    #
-    #   on MyEvent do |event|
-    #     do_some_logic
-    #   end
-    # end
-    #
-    # You typically do not need to include this module in your classes. If you extend from
-    # Sequent::Core::AggregateRoot, Sequent::Core::Projector, Sequent::Core::Workflow or Sequent::Core::BaseCommandHandler
-    # you will get this functionality for free.
-    #
-
-      module ClassMethods
-        def on(*message_classes, &block)
-          message_classes.each { |message_class| message_mapping[message_class] = block }
-        end
-
-        def message_mapping
-          @message_mapping ||= {}
-        end
-
-        def handles_message?(message)
-          message_mapping.keys.include? message.class
-        end
-      end
-
-      def self.included(host_class)
-        host_class.extend(ClassMethods)
-      end
-
-      def handle_message(message)
-        handler = self.class.message_mapping[message.class]
-        self.instance_exec(message, &handler) if handler
-      end
-    end
-  
-end