euston 1.1.0 → 1.2.0

data/euston.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'euston'
-  s.version     = '1.1.0'
-  s.date        = '2011-10-03'
+  s.version     = '1.2.0'
+  s.date        = '2011-10-12'
   s.platform    = RUBY_PLATFORM.to_s == 'java' ? 'java' : Gem::Platform::RUBY
   s.authors     = ['Lee Henson', 'Guy Boertje']
   s.email       = ['lee.m.henson@gmail.com', 'guyboertje@gmail.com']
@@ -24,10 +24,12 @@ Gem::Specification.new do |s|
     lib/euston/command_handler.rb
     lib/euston/command_handler_private_method_names.rb
     lib/euston/command_headers.rb
+    lib/euston/errors.rb
     lib/euston/event.rb
     lib/euston/event_handler.rb
     lib/euston/event_handler_private_method_names.rb
     lib/euston/event_headers.rb
+    lib/euston/idempotence.rb
     lib/euston/null_logger.rb
     lib/euston/repository.rb
     lib/euston/version.rb

data/lib/euston/aggregate_command_map.rb

@@ -60,7 +60,7 @@ module Euston
         aggregate_entry[:mappings].push_if_unique(mapping, command)
       end
 
-      def deliver_command(headers, command)
+      def deliver_command(headers, command, logger = Euston::NullLogger.instance)
         args = [headers, command]
         query = {:kind => :construct, :type => headers.type}
         if (entry = @map.find_entry_with_mapping_match( query ))
@@ -71,6 +71,7 @@ module Euston
           return unless entry
           aggregate = load_aggregate(entry, *args)
         end
+        aggregate.log = logger
         aggregate.consume_command( headers, command )
       end
 

data/lib/euston/aggregate_root.rb

@@ -6,8 +6,9 @@ module Euston
     include Euston::EventHandler
 
     module ClassMethods
-      def hydrate stream, snapshot = nil
+      def hydrate stream, snapshot = nil, log = nil
         instance = self.new
+        instance.log = log unless log.nil?
         instance.send :apply_snapshot, snapshot unless snapshot.nil?
         instance.send :apply_stream, stream
         instance
@@ -17,8 +18,10 @@ module Euston
     module InstanceMethods
       def initialize aggregate_id = nil
         @aggregate_id = aggregate_id
+        @log = Euston::NullLogger.instance
       end
 
+      attr_accessor :log
       attr_reader :aggregate_id
 
       def initial_version
@@ -29,23 +32,34 @@ module Euston
         !uncommitted_events.empty?
       end
 
-      def committed_commands
-        @committed_commands ||= []
+      def committed_messages
+        @committed_messages ||= Set.new
+      end
+
+      def uncommitted_commands
+        @uncommitted_commands ||= []
       end
 
       def uncommitted_events
         @uncommitted_events ||= []
       end
 
-      def consume_command(headers, command)
-        headers = Euston::CommandHeaders.from_hash(headers) if headers.is_a?(Hash)
-        return if committed_commands.include? headers.id
+      def consume_command headers, command
+        consume_message headers, command, :command, Euston::CommandHeaders, :send_command_to_method
+      end
 
-        @current_headers = headers
-        @current_command = command
+      def consume_event_subscription headers, event
+        consume_message headers, event, :event_subscription, Euston::EventHeaders, :send_event_subscription_to_method
+      end
 
-        handle_command headers, command
-        self
+      def replay_event headers, event
+        headers = Euston::EventHeaders.from_hash(headers) if headers.is_a?(Hash)
+
+        source_message = headers.source_message
+        committed_messages << source_message[:headers][:id] unless source_message.nil?
+
+        send_event_to_method headers, event
+        @initial_version = initial_version + 1
       end
 
       def take_snapshot
@@ -61,15 +75,6 @@ module Euston
         { :version => version, :payload => send(name) }
       end
 
-      def replay_event(headers, event)
-        headers = Euston::EventHeaders.from_hash(headers) if headers.is_a?(Hash)
-        command = headers.command
-        committed_commands << command[:id] unless command.nil? || committed_commands.include?(command[:id])
-
-        handle_event headers, event
-        @initial_version = initial_version + 1
-      end
-
       def version
         initial_version + uncommitted_events.length
       end
@@ -83,11 +88,12 @@ module Euston
                              :version => version,
                              :timestamp => Time.now.to_f
 
-        unless @current_headers.nil?
-          event.headers.merge! :command => @current_headers.to_hash.merge(:body => @current_command)
+        unless @current_message_headers.nil?
+          event.headers[@current_message_type] = { :headers  => @current_message_headers.to_hash,
+                                                   :body     => @current_message_body }
         end
 
-        handle_event Euston::EventHeaders.from_hash(event.headers), event.body
+        send_event_to_method Euston::EventHeaders.from_hash(event.headers), event.body
         uncommitted_events << event
       end
 
@@ -97,6 +103,8 @@ module Euston
           raise "Trying to load a snapshot of aggregate #{self.class.name} but it does not have a load_snapshot method for version #{version}!" unless respond_to? self.class.load_snapshot_method_name(version)
 
           name = self.class.load_snapshot_method_name version
+
+          @log.debug "Applying snapshot: #{snapshot.inspect}"
           self.send name, snapshot.payload
         end
       end
@@ -110,24 +118,52 @@ module Euston
         raise "This aggregate cannot apply a historical event stream because it is not empty." unless uncommitted_events.empty? && initial_version == 0
 
         events.each_with_index do |event, i|
-          replay_event Euston::EventHeaders.from_hash(event.headers), event.body
+          replay_event event.headers, event.body
         end
       end
 
-      def handle_command headers, command
+      def publish_command command, dispatch_at = Time.now.to_f
+        raise ArgumentError, 'Commands must subclass Euston::Command' unless command.is_a? Euston::Command
+        raise Euston::Errors::InvalidCommandError, "An attempt was made to publish an invalid command from an aggregate root.\n\nAggregate id: #{@aggregate_id}\nAggregate type: #{self.class.name}\nCommand: #{command.to_hash}\nErrors: #{command.errors}" unless command.valid?
+
+        command.headers[:dispatch_at] = dispatch_at
+
+        uncommitted_commands << command
+      end
+
+      def send_command_to_method headers, command
         deliver_message headers, command, :consumes_method_name, 'a command', "a 'consumes' block"
       end
 
-      def handle_event headers, event
+      def send_event_to_method headers, event
         deliver_message headers, event, :applies_method_name, 'an event', "an 'applies' block"
       end
 
+      def send_event_subscription_to_method headers, event
+        deliver_message headers, event, :event_handler_method_name, 'an event', "a 'subscribes' block"
+      end
+
       private
 
+      def consume_message headers, body, message_type, headers_type, send_method
+        headers = headers_type.from_hash(headers) if headers.is_a?(Hash)
+
+        unless committed_messages.include? headers.id
+          @current_message_type     = message_type
+          @current_message_headers  = headers
+          @current_message_body     = body
+
+          self.send send_method, headers, body
+        end
+
+        self
+      end
+
       def deliver_message headers, message, name_method, message_kind, expected_block_kind
-        name = self.class.send name_method, headers.type, headers.version
+        name = self.class.send(name_method, headers.type, headers.version).to_sym
 
-        if respond_to? name.to_sym
+        if respond_to? name
+          @log.debug "Calling #{name} with: #{message.inspect}"
           method(name).call OpenStruct.new(message).freeze
         else
           raise "Couldn't deliver #{message_kind} (#{headers.type} v#{headers.version}) to #{self.class}. Did you forget #{expected_block_kind}?"

data/lib/euston/aggregate_root_dsl_methods.rb

@@ -40,6 +40,7 @@ module Euston
       private
 
       def define_private_method name, &block
+        block = method(:null_block) if block.nil?
         define_method name do |*args| instance_exec *args, &block end
       end
 
@@ -49,6 +50,10 @@ module Euston
 
         Euston::AggregateCommandMap.send entry_point, type, command, id, to_i
       end
+
+      def null_block *args
+        # block-less definitions get pointed here
+      end
     end
   end
 end

data/lib/euston/aggregate_root_private_method_names.rb

@@ -11,6 +11,10 @@ module Euston
         "__consume__#{command}__v#{version}__"
       end
 
+      def consumes_regex
+        /__consume__(\w+)__v(\d+)__/
+      end
+
       def id_from_event_method_name type, version
         "__id_from_event_#{type}__v#{version}__"
       end

data/lib/euston/command.rb

@@ -2,10 +2,20 @@ module Euston
   class Command
     include ActiveModel::Validations
 
-    def initialize body
+    def initialize body, dispatch_at = nil
       @headers = { :id => Uuid.generate,
                    :type => self.class.to_s.split('::').pop.underscore.to_sym }
+
       @body = body
+      @headers[:dispatch_at] = dispatch_at unless dispatch_at.nil?
+    end
+
+    def headers
+      @headers.merge :version => version
+    end
+
+    def id
+      @headers[:id]
     end
 
     def read_attribute_for_validation key
@@ -13,15 +23,13 @@ module Euston
     end
 
     def to_hash
-      { :headers => @headers.merge(:version => version), :body => @body }
-    end
-
-    def id
-      @headers[:id]
+      { :headers => headers, :body => @body }
     end
 
     def version
       1
     end
+
+    attr_reader :body
   end
 end

data/lib/euston/command_bus.rb

@@ -1,10 +1,10 @@
 module Euston
   module CommandBus
-    def self.publish headers, command
-      aggregate = AggregateCommandMap.deliver_command headers, command
+    def self.publish headers, command, logger = Euston::NullLogger.instance
+      aggregate = AggregateCommandMap.deliver_command headers, command, logger
       raise "No aggregate found to handle command: #{headers} #{command}" if aggregate.nil?
 
       Repository.save aggregate
     end
   end
-end
+end

data/lib/euston/errors.rb

@@ -0,0 +1,5 @@
+module Euston
+  module Errors
+    class InvalidCommandError < StandardError; end
+  end
+end

data/lib/euston/event_handler.rb

@@ -3,6 +3,10 @@ module Euston
     extend ActiveSupport::Concern
     include Euston::EventHandlerPrivateMethodNames
 
+    included do
+      attr_accessor :log unless public_method_defined? :log=
+    end
+
     module ClassMethods
       def subscribes type, version = 1, opts = nil, &consumer
         if self.include? Euston::AggregateRoot

data/lib/euston/event_headers.rb

@@ -1,17 +1,37 @@
 module Euston
   class EventHeaders
-    attr_reader :id, :type, :version, :timestamp, :command
+    attr_reader :id, :type, :version, :timestamp, :source_message, :source_message_type
 
-    def initialize id, type, version, timestamp = Time.now, command = nil
+    def initialize id, type, version, timestamp = Time.now, source_message = nil, source_message_type = nil
       @id = id
       @type = type
       @version = version
       @timestamp = Time.at(timestamp).utc
-      @command = command
+      @source_message = source_message
+      @source_message_type = source_message_type
+    end
+
+    def to_hash
+      Hash[@source_message_type, @source_message].merge :id => id,
+                                                        :type => type,
+                                                        :version => version,
+                                                        :timestamp => timestamp
     end
 
     def self.from_hash hash
-      self.new hash[:id], hash[:type].to_sym, hash[:version], hash[:timestamp], hash[:command]
+      if hash.has_key? :command
+        source_message = hash[:command]
+        source_message_type = :command
+      elsif hash.has_key? :event_subscription
+        source_message = hash[:event_subscription]
+        source_message_type = :event_subscription
+      end
+
+      self.new hash[:id], hash[:type].to_sym, hash[:version], hash[:timestamp], source_message, source_message_type
+    end
+
+    def to_s
+      "#{id} #{type} (v#{version})"
     end
   end
 end

data/lib/euston/idempotence.rb

@@ -0,0 +1,27 @@
+module Euston
+  module Idempotence
+    extend ActiveSupport::Concern
+
+    module InstanceMethods
+      def if_unhandled obj, headers
+        return if obj._history.include? headers.id
+
+        obj._history << headers.id
+
+        unless headers.source_message.nil? || obj._history.include?(headers.source_message[:headers][:id])
+          obj._history << headers.source_message[:headers][:id]
+        end
+
+        yield
+      end
+
+      def if_exists_and_unhandled document_type, id, headers
+        document = document_type.find id
+
+        if_unhandled document, headers do
+          yield document
+        end
+      end
+    end
+  end
+end

data/lib/euston/version.rb

@@ -1,3 +1,3 @@
 module Euston
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/euston.rb

@@ -1,6 +1,7 @@
 require 'active_support/concern'
 require 'active_model'
 require 'ostruct'
+require 'set'
 
 module Euston
   class << self
@@ -21,6 +22,7 @@ end
 
 Euston.uuid = Uuid
 
+require 'euston/errors'
 require 'euston/aggregate_command_map'
 require 'euston/aggregate_root_private_method_names'
 require 'euston/aggregate_root_dsl_methods'
@@ -33,6 +35,7 @@ require 'euston/event'
 require 'euston/event_handler_private_method_names'
 require 'euston/event_handler'
 require 'euston/event_headers'
+require 'euston/idempotence'
 require 'euston/null_logger'
 require 'euston/aggregate_root'
 require 'euston/repository'

data/spec/aggregate_command_map_spec.rb

@@ -25,8 +25,8 @@ module Euston
 
       it "then side effects are seen" do
 
-        aggregate.committed_commands.should have(0).items
-        aggregate2.committed_commands.should have(0).items
+        aggregate.committed_messages.should have(0).items
+        aggregate2.committed_messages.should have(0).items
 
         Sample::Widget.new( Euston.uuid.generate )
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: euston
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-03 00:00:00.000000000 Z
+date: 2011-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &80875570 !ruby/object:Gem::Requirement
+  requirement: &83067690 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 3.0.9
   type: :runtime
   prerelease: false
-  version_requirements: *80875570
+  version_requirements: *83067690
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &80874680 !ruby/object:Gem::Requirement
+  requirement: &83067260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 3.0.9
   type: :runtime
   prerelease: false
-  version_requirements: *80874680
+  version_requirements: *83067260
 - !ruby/object:Gem::Dependency
   name: fuubar
-  requirement: &80874230 !ruby/object:Gem::Requirement
+  requirement: &83066570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 0.0.0
   type: :development
   prerelease: false
-  version_requirements: *80874230
+  version_requirements: *83066570
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &80873750 !ruby/object:Gem::Requirement
+  requirement: &83065520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *80873750
+  version_requirements: *83065520
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &80873120 !ruby/object:Gem::Requirement
+  requirement: &83064720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,7 +66,7 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *80873120
+  version_requirements: *83064720
 description: ''
 email:
 - lee.m.henson@gmail.com
@@ -88,10 +88,12 @@ files:
 - lib/euston/command_handler.rb
 - lib/euston/command_handler_private_method_names.rb
 - lib/euston/command_headers.rb
+- lib/euston/errors.rb
 - lib/euston/event.rb
 - lib/euston/event_handler.rb
 - lib/euston/event_handler_private_method_names.rb
 - lib/euston/event_headers.rb
+- lib/euston/idempotence.rb
 - lib/euston/null_logger.rb
 - lib/euston/repository.rb
 - lib/euston/version.rb