euston 1.0.1 → 1.1.0

data/Gemfile

@@ -1,3 +1,2 @@
 source :rubygems
 gemspec
-

data/euston.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'euston'
-  s.version     = '1.0.1'
-  s.date        = '2011-09-27'
+  s.version     = '1.1.0'
+  s.date        = '2011-10-03'
   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']
@@ -17,10 +17,16 @@ Gem::Specification.new do |s|
     lib/euston.rb
     lib/euston/aggregate_command_map.rb
     lib/euston/aggregate_root.rb
+    lib/euston/aggregate_root_dsl_methods.rb
+    lib/euston/aggregate_root_private_method_names.rb
+    lib/euston/command.rb
     lib/euston/command_bus.rb
     lib/euston/command_handler.rb
+    lib/euston/command_handler_private_method_names.rb
     lib/euston/command_headers.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/null_logger.rb
     lib/euston/repository.rb
@@ -35,10 +41,10 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 
+  s.add_dependency 'activemodel',         '~> 3.0.9'
   s.add_dependency 'activesupport',       '~> 3.0.9'
-  s.add_dependency 'euston-eventstore',   '~> 1.0.0'
-  s.add_dependency 'require_all',         '~> 1.2.0'
+
   s.add_development_dependency 'fuubar',  '~> 0.0.0'
   s.add_development_dependency 'rspec',   '~> 2.6.0'
   s.add_development_dependency 'uuid',    '~> 2.3.0'
-end
+end

data/lib/euston/aggregate_root.rb

@@ -1,50 +1,22 @@
 module Euston
   module AggregateRoot
     extend ActiveSupport::Concern
+    include Euston::AggregateRootPrivateMethodNames
+    include Euston::AggregateRootDslMethods
+    include Euston::EventHandler
 
     module ClassMethods
-      def applies event, version, &consumer
-        define_method "__consume__#{event}__v#{version}" do |*args| instance_exec *args, &consumer end
-      end
-
-      def consumes *arguments, &consumer #*args is an array of symbols plus an optional options hash at the end
-        commands, options = [], {}
-        while (arg = arguments.shift) do
-          commands << arg if arg.is_a?(Symbol)
-            options = arg if arg.is_a?(Hash)
-        end
-        commands.each do |command|
-          define_method "__consume__#{command}" do |*args| instance_exec *args, &consumer end
-
-          map_command :map_command_as_aggregate_method, self, command, options
-        end
-      end
-
-      def created_by command, options = {}, &consumer
-        define_method "__consume__#{command}" do |*args| instance_exec *args, &consumer end
-
-        map_command :map_command_as_aggregate_constructor, self, command, options
-      end
-
-      def hydrate(stream)
+      def hydrate stream, snapshot = nil
         instance = self.new
-        instance.send :reconstitute_from_history, stream
+        instance.send :apply_snapshot, snapshot unless snapshot.nil?
+        instance.send :apply_stream, stream
         instance
       end
-
-      private
-
-      def map_command(entry_point, type, command, opts)
-        id = opts.has_key?(:id) ? opts[:id] : :id
-        to_i = opts.key?(:to_i) ? opts[:to_i] : []
-
-        Euston::AggregateCommandMap.send entry_point, type, command, id, to_i
-      end
     end
 
     module InstanceMethods
       def initialize aggregate_id = nil
-        @aggregate_id = aggregate_id unless aggregate_id.nil?
+        @aggregate_id = aggregate_id
       end
 
       attr_reader :aggregate_id
@@ -76,6 +48,19 @@ module Euston
         self
       end
 
+      def take_snapshot
+        methods = self.class.instance_methods
+        regex = self.class.take_snapshot_regexp
+        methods = methods.map { |m| regex.match m }.compact
+
+        raise "You tried to take a snapshot of #{self.class.name} but no snapshot method was found." if methods.empty?
+
+        version = methods.map { |m| m[1].to_i }.sort.last
+        name = self.class.take_snapshot_method_name version
+
+        { :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
@@ -92,7 +77,7 @@ module Euston
       protected
 
       def apply_event(type, version, body = {})
-        event = Euston::EventStore::EventMessage.new(body.is_a?(Hash) ? body : body.marshal_dump)
+        event = Euston::Event.new(body.is_a?(OpenStruct) ? body.marshal_dump : body)
         event.headers.merge! :id => Euston.uuid.generate,
                              :type => type,
                              :version => version,
@@ -106,32 +91,48 @@ module Euston
         uncommitted_events << event
       end
 
-      def handle_command(headers, command)
-        name = "__consume__#{headers.type}"
-        method(name).call OpenStruct.new(command).freeze
-      end
+      def apply_snapshot snapshot
+        if !snapshot.nil?
+          version = snapshot.headers[:version]
+          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)
 
-      def handle_event(headers, event)
-        name = "__consume__#{headers.type}__v#{headers.version}"
-        if respond_to? name.to_sym
-          method(name).call OpenStruct.new(event).freeze
-        else
-          raise "Couldn't find an event handler for #{headers.type} (v#{headers.version}) on #{self.class}. Did you forget an 'applies' block?"
+          name = self.class.load_snapshot_method_name version
+          self.send name, snapshot.payload
         end
       end
 
-      def reconstitute_from_history(stream)
+      def apply_stream stream
+        @aggregate_id = stream.stream_id
+
         events = stream.committed_events
         return if events.empty?
 
         raise "This aggregate cannot apply a historical event stream because it is not empty." unless uncommitted_events.empty? && initial_version == 0
 
-        @aggregate_id = stream.stream_id
-
         events.each_with_index do |event, i|
           replay_event Euston::EventHeaders.from_hash(event.headers), event.body
         end
       end
+
+      def handle_command headers, command
+        deliver_message headers, command, :consumes_method_name, 'a command', "a 'consumes' block"
+      end
+
+      def handle_event headers, event
+        deliver_message headers, event, :applies_method_name, 'an event', "an 'applies' block"
+      end
+
+      private
+
+      def deliver_message headers, message, name_method, message_kind, expected_block_kind
+        name = self.class.send name_method, headers.type, headers.version
+
+        if respond_to? name.to_sym
+          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}?"
+        end
+      end
     end
   end
 end

data/lib/euston/aggregate_root_dsl_methods.rb

@@ -0,0 +1,54 @@
+module Euston
+  module AggregateRootDslMethods
+    extend ActiveSupport::Concern
+    include Euston::AggregateRootPrivateMethodNames
+
+    module ClassMethods
+      def applies event, version = 1, &block
+        define_private_method applies_method_name(event, version), &block
+      end
+
+      def consumes *arguments, &block #*args is an array of symbols plus an optional options hash at the end
+        commands, options = [], {}
+
+        while (arg = arguments.shift) do
+          commands << { :name => arg, :version => 1 } if arg.is_a?(Symbol)
+          commands.last[:version] = arg if arg.is_a?(Integer)
+          options = arg if arg.is_a?(Hash)
+        end
+
+        commands.each do |command|
+          define_private_method consumes_method_name(command[:name], command[:version]), &block
+          map_command :map_command_as_aggregate_method, self, command[:name], options
+        end
+      end
+
+      def created_by command, version = 1, options = {}, &block
+        define_method consumes_method_name(command, version), &block
+
+        map_command :map_command_as_aggregate_constructor, self, command, options
+      end
+
+      def load_snapshot version, &block
+        define_private_method load_snapshot_method_name(version), &block
+      end
+
+      def take_snapshot version, &block
+        define_private_method take_snapshot_method_name(version), &block
+      end
+
+      private
+
+      def define_private_method name, &block
+        define_method name do |*args| instance_exec *args, &block end
+      end
+
+      def map_command(entry_point, type, command, opts)
+        id = opts.has_key?(:id) ? opts[:id] : :id
+        to_i = opts.key?(:to_i) ? opts[:to_i] : []
+
+        Euston::AggregateCommandMap.send entry_point, type, command, id, to_i
+      end
+    end
+  end
+end

data/lib/euston/aggregate_root_private_method_names.rb

@@ -0,0 +1,31 @@
+module Euston
+  module AggregateRootPrivateMethodNames
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def applies_method_name event, version
+        "__apply__#{event}__v#{version}__"
+      end
+
+      def consumes_method_name command, version
+        "__consume__#{command}__v#{version}__"
+      end
+
+      def id_from_event_method_name type, version
+        "__id_from_event_#{type}__v#{version}__"
+      end
+
+      def load_snapshot_method_name version
+        "__load_snapshot__v#{version}__"
+      end
+
+      def take_snapshot_method_name version
+        "__take_snapshot__v#{version}__"
+      end
+
+      def take_snapshot_regexp
+        /__take_snapshot__v(\d+)__/
+      end
+    end
+  end
+end

data/lib/euston/command.rb

@@ -0,0 +1,27 @@
+module Euston
+  class Command
+    include ActiveModel::Validations
+
+    def initialize body
+      @headers = { :id => Uuid.generate,
+                   :type => self.class.to_s.split('::').pop.underscore.to_sym }
+      @body = body
+    end
+
+    def read_attribute_for_validation key
+      @body[key]
+    end
+
+    def to_hash
+      { :headers => @headers.merge(:version => version), :body => @body }
+    end
+
+    def id
+      @headers[:id]
+    end
+
+    def version
+      1
+    end
+  end
+end

data/lib/euston/command_handler.rb

@@ -1,10 +1,11 @@
 module Euston
   module CommandHandler
     extend ActiveSupport::Concern
+    include Euston::CommandHandlerPrivateMethodNames
 
     module ClassMethods
       def version number, &consumer
-        define_method "__version__#{number}" do |*args|
+        define_method command_handler_method_name(number) do |*args|
           if block_given?
             instance_exec *args, &consumer
           else
@@ -22,4 +23,4 @@ module Euston
       end
     end
   end
-end
+end

data/lib/euston/command_handler_private_method_names.rb

@@ -0,0 +1,11 @@
+module Euston
+  module CommandHandlerPrivateMethodNames
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def command_handler_method_name version
+        "__version__#{version}"
+      end
+    end
+  end
+end

data/lib/euston/command_headers.rb

@@ -21,5 +21,9 @@ module Euston
     def self.from_hash hash
       self.new hash[:id], hash[:type].to_sym, hash[:version], ( hash[:log_completion] || false )
     end
+
+    def to_s
+      "#{id} #{type} (v#{version})"
+    end
   end
 end

data/lib/euston/event.rb

@@ -0,0 +1,18 @@
+module Euston
+  class Event
+    def initialize data = {}
+      if (data.keys & ['body', 'headers']).size == 2
+        @body, @headers = data.values_at 'body', 'headers'
+      else
+        @headers = {}
+        @body = data
+      end
+    end
+
+    attr_reader :headers, :body
+
+    def to_hash
+      { :headers => @headers, :body => @body }
+    end
+  end
+end

data/lib/euston/event_handler.rb

@@ -1,13 +1,26 @@
 module Euston
   module EventHandler
     extend ActiveSupport::Concern
+    include Euston::EventHandlerPrivateMethodNames
 
     module ClassMethods
-      def consumes type, version, &consumer
-        define_method "__event_handler__#{type}__#{version}" do |*args|
+      def subscribes type, version = 1, opts = nil, &consumer
+        if self.include? Euston::AggregateRoot
+          opts = opts || { :id => :id }
+
+          self.class.send :define_method, id_from_event_method_name(type, version) do |event|
+            if opts[:id].respond_to? :call
+              opts[:id].call event
+            else
+              event[opts[:id]]
+            end
+          end
+        end
+
+        define_method event_handler_method_name(type, version) do |*args|
           instance_exec *args, &consumer
         end
       end
     end
   end
-end
+end

data/lib/euston/event_handler_private_method_names.rb

@@ -0,0 +1,15 @@
+module Euston
+  module EventHandlerPrivateMethodNames
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def id_from_event_method_name type, version
+        "__id_from_event_#{type}__v#{version}__"
+      end
+
+      def event_handler_method_name type, version
+        "__event_handler__#{type}__#{version}"
+      end
+    end
+  end
+end

data/lib/euston/repository.rb

@@ -3,18 +3,8 @@ module Euston
     class << self
       attr_accessor :event_store
 
-      def find type, id
-        stream = event_store.open_stream :stream_id => id
-        return nil if stream.committed_events.empty?
-
-        type.hydrate stream
-      end
-
-      def save aggregate
-        stream = event_store.open_stream :stream_id => aggregate.aggregate_id
-        aggregate.uncommitted_events.each { |e| stream << e }
-        stream.commit_changes Euston.uuid.generate
-      end
+      # def find(type, id)  mixed in by event store implementation
+      # def save(aggregate) mixed in by event store implementation
     end
   end
-end
+end

data/lib/euston/version.rb

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

data/lib/euston.rb

@@ -1,5 +1,5 @@
 require 'active_support/concern'
-require 'require_all'
+require 'active_model'
 require 'ostruct'
 
 module Euston
@@ -21,5 +21,18 @@ end
 
 Euston.uuid = Uuid
 
-require 'euston-eventstore'
-require_rel 'euston'
+require 'euston/aggregate_command_map'
+require 'euston/aggregate_root_private_method_names'
+require 'euston/aggregate_root_dsl_methods'
+require 'euston/command'
+require 'euston/command_bus'
+require 'euston/command_handler_private_method_names'
+require 'euston/command_handler'
+require 'euston/command_headers'
+require 'euston/event'
+require 'euston/event_handler_private_method_names'
+require 'euston/event_handler'
+require 'euston/event_headers'
+require 'euston/null_logger'
+require 'euston/aggregate_root'
+require 'euston/repository'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: euston
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-27 00:00:00.000000000 Z
+date: 2011-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &72535020 !ruby/object:Gem::Requirement
+  name: activemodel
+  requirement: &80875570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,32 +22,21 @@ dependencies:
         version: 3.0.9
   type: :runtime
   prerelease: false
-  version_requirements: *72535020
-- !ruby/object:Gem::Dependency
-  name: euston-eventstore
-  requirement: &72534700 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *72534700
+  version_requirements: *80875570
 - !ruby/object:Gem::Dependency
-  name: require_all
-  requirement: &72534290 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: &80874680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 3.0.9
   type: :runtime
   prerelease: false
-  version_requirements: *72534290
+  version_requirements: *80874680
 - !ruby/object:Gem::Dependency
   name: fuubar
-  requirement: &72534050 !ruby/object:Gem::Requirement
+  requirement: &80874230 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +44,10 @@ dependencies:
         version: 0.0.0
   type: :development
   prerelease: false
-  version_requirements: *72534050
+  version_requirements: *80874230
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &72533780 !ruby/object:Gem::Requirement
+  requirement: &80873750 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +55,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *72533780
+  version_requirements: *80873750
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &72533470 !ruby/object:Gem::Requirement
+  requirement: &80873120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,7 +66,7 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *72533470
+  version_requirements: *80873120
 description: ''
 email:
 - lee.m.henson@gmail.com
@@ -92,10 +81,16 @@ files:
 - lib/euston.rb
 - lib/euston/aggregate_command_map.rb
 - lib/euston/aggregate_root.rb
+- lib/euston/aggregate_root_dsl_methods.rb
+- lib/euston/aggregate_root_private_method_names.rb
+- lib/euston/command.rb
 - lib/euston/command_bus.rb
 - lib/euston/command_handler.rb
+- lib/euston/command_handler_private_method_names.rb
 - lib/euston/command_headers.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/null_logger.rb
 - lib/euston/repository.rb