event_sourcery 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 851b272af6920686f8033e9d948e99281bd13886
-  data.tar.gz: 9f09be230953049d28e1e1686bb5a77f679105a9
+  metadata.gz: d676408ca476e668d70f08dd1c29ce1c93f25415
+  data.tar.gz: e34dfb803088dce3cff191f95b251af18470f659
 SHA512:
-  metadata.gz: f8653075d18913fc0bfdb3c69c607e28a47f71cf5dd76d1204fec159ae931c67343b67a3b12ff588385e79e3a06f2f1515c19e673623e2915e7bea4f079c32ca
-  data.tar.gz: 9f8562bb232db84fcf2d28973946385aacbbe98e712a396d2dd34cec0e7b0429943b530d6e5be3a671ed95b48c0920560055bcf3970281719d40907c41ff6a0d
+  metadata.gz: 6b9fa74a6699e135575a52e5edfe4f0c9cd32c9ee1ee6cc74ae32ca1a543f6090044d2aebc63c8ed9ee35481aeff9f5990d1d4911cf4cf1d15b3923abedbec14
+  data.tar.gz: e17b0c1cb636abfb81524d1197afe8bf4836f5ffdda50180bb1c7322c3a0e1ab66595d0e80ef1810b4d86496defe33c2edfe499367dec660939a4d74f13081f8

data/CHANGELOG.md

@@ -5,7 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
+## [0.17.0] - 2018-03-22
+### Added
+- Allow changing the event class using Event#with
+- Allow upcasting events using custom event classes
 
 ## [0.16.1] - 2018-01-17
 - Fixed bug with Sequel gem expecting processes_event_types to be an Array

data/lib/event_sourcery/event.rb

@@ -12,6 +12,31 @@ module EventSourcery
       end
     end
 
+    # Use this method to add "upcasting" to your events.
+    #
+    # To upcast your events override the `upcast` class method on your event.
+    # The `upcast` method will be passed the event allowing you to modify it
+    # before it is passed to your event processors.
+    #
+    # A good place to start is using the `Event#with` method that allows you to
+    # easily change attributes.
+    #
+    # @param Event
+    # @return Event
+    # @example
+    #     Foo = Class.new(EventSourcery::Event) do
+    #       def self.upcast(event)
+    #         body = event.body
+    #
+    #         body['bar'] ||= 'baz'
+    #
+    #         event.with(body: body)
+    #       end
+    #     end
+    def self.upcast(event)
+      event
+    end
+
     attr_reader :id, :uuid, :aggregate_id, :type, :body, :version, :created_at, :correlation_id, :causation_id
 
     # @!attribute [r] id
@@ -104,8 +129,18 @@ module EventSourcery
     #     # Of course, with can accept any number of event attributes:
     #
     #     new_event = old_event.with(id: 42, version: 77, body: { 'attr' => 'value' })
-    def with(**attributes)
-      self.class.new(**to_h.merge!(attributes))
+    #
+    #     # When using typed events you can also override the event class:
+    #
+    #     new_event = old_event.with(event_class: ItemRemoved)
+    #     new_event.type # => "item_removed"
+    #     new_event.class # => ItemRemoved
+    def with(event_class: self.class, **attributes)
+      if self.class != Event && !attributes[:type].nil? && attributes[:type] != type
+        raise Error, 'When using typed events change the type by changing the event class.'
+      end
+
+      event_class.new(**to_h.merge!(attributes))
     end
 
     # returns a hash of the event attributes

data/lib/event_sourcery/event_store/event_builder.rb

@@ -8,12 +8,16 @@ module EventSourcery
       def build(event_data)
         type = event_data.fetch(:type)
         klass = event_type_serializer.deserialize(type)
-        klass.new(event_data)
+        upcast(klass.new(event_data))
       end
 
       private
 
       attr_reader :event_type_serializer
+
+      def upcast(event)
+        event.class.upcast(event)
+      end
     end
   end
 end

data/lib/event_sourcery/version.rb

@@ -1,4 +1,4 @@
 module EventSourcery
   # Defines the version
-  VERSION = '0.16.1'.freeze
+  VERSION = '0.17.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_sourcery
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Envato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Event Sourcing Library