euston 1.2.3 → 1.2.4

data/euston.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'euston'
-  s.version     = '1.2.3'
-  s.date        = '2011-10-24'
+  s.version     = '1.2.4'
+  s.date        = '2011-11-29'
   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']
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
     spec/aggregate_command_map_spec.rb
     spec/aggregate_root_samples.rb
     spec/aggregate_root_spec.rb
+    spec/command_headers_spec.rb
     spec/spec_helper.rb
   ]
   # = MANIFEST =

data/lib/euston/aggregate_root.rb

@@ -161,10 +161,17 @@ module Euston
 
       def deliver_message headers, message, name_method, message_kind, expected_block_kind
         name = self.class.send(name_method, headers.type, headers.version).to_sym
-
         if respond_to? name
           @log.debug "Calling #{name} with: #{message.inspect}"
-          method(name).call OpenStruct.new(message).freeze
+          m = method(name)
+          case m.arity
+          when 2, -2
+            m.call OpenStruct.new(headers.to_hash).freeze, OpenStruct.new(message).freeze
+          when 1, -1
+            m.call OpenStruct.new(message).freeze
+          else
+            m.call
+          end
         else
           raise "Couldn't deliver #{message_kind} (#{headers.type} v#{headers.version}) to #{self.class}. Did you forget #{expected_block_kind}?"
         end

data/lib/euston/aggregate_root_dsl_methods.rb

@@ -40,8 +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
+        define_method name, &(block || method(:null_block))
       end
 
       def map_command(entry_point, type, command, opts)

data/lib/euston/command.rb

@@ -22,6 +22,14 @@ module Euston
       @headers[:id] = value
     end
 
+    def publishing_user_id
+      @headers[:user_id]
+    end
+
+    def publishing_user_id= value
+      @headers[:user_id] = value
+    end
+
     def read_attribute_for_validation key
       match = /^__(.*)/.match(key.to_s)
 

data/lib/euston/command_headers.rb

@@ -1,29 +1,58 @@
 module Euston
   class CommandHeaders
-    attr_reader :id, :type, :version, :log_completion
 
-    def initialize id, type, version, log_completion = false
-      @id = id
-      @type = type
-      @version = version
-      @log_completion = log_completion
+    BASE_KEYS = [:id, :type, :version]
+
+    def initialize hash
+      arg_errors = []
+      BASE_KEYS.each do |arg|
+        arg_errors << arg unless hash.has_key?(arg)
+      end
+      raise Errors::CommandHeadersArgumentError.new("Missing args: #{arg_errors.join(", ")}") if arg_errors.size > 0
+      @headers = {}.merge(hash)
+      @headers[:type] = @headers[:type].to_sym
+      @headers_keys = @headers.keys
+    end
+
+    def [] name
+      @headers[name.to_sym]
     end
 
+    # only use method missing for uncommon attributes
+    def id()      @headers[:id]; end
+    def type()    @headers[:type]; end
+    def version() @headers[:version]; end
+
     def to_hash
-      {
-        :id => id,
-        :type => type,
-        :version => version,
-        :log_completion => log_completion
-      }
+      @headers.dup
+    end
+
+    def ==(other)
+      @headers == other.to_hash
     end
 
     def self.from_hash hash
-      self.new hash[:id], hash[:type].to_sym, hash[:version], ( hash[:log_completion] || false )
+      self.new hash
     end
 
     def to_s
       "#{id} #{type} (v#{version})"
     end
+
+    def method_missing(name,*args,&block)
+      n = name.to_sym
+      is_dynamic_method?(n) ? @headers[n] : super
+    end
+
+    # >= 1.9.2
+    def respond_to_missing?(name, incl_private)
+      is_dynamic_method?(name.to_sym) || super
+    end
+
+    private
+
+    def is_dynamic_method? name
+      (@headers_keys - BASE_KEYS).include?(name)
+    end
   end
 end

data/lib/euston/errors.rb

@@ -2,5 +2,6 @@ module Euston
   module Errors
     class InvalidCommandError < StandardError; end
     class AggregateNotFoundError < StandardError; end
+    class CommandHeadersArgumentError < StandardError; end
   end
 end

data/lib/euston/event_handler.rb

@@ -8,7 +8,7 @@ module Euston
     end
 
     module ClassMethods
-      def subscribes type, version = 1, opts = nil, &consumer
+      def subscribes type, version = 1, opts = {}, &consumer
         if self.include? Euston::AggregateRoot
           o = { :id => :id }.merge opts
 
@@ -21,8 +21,12 @@ module Euston
           end
         end
 
-        define_method event_handler_method_name(type, version) do |*args|
-          instance_exec *args, &consumer
+        method_name = event_handler_method_name type, version
+        define_method method_name, &consumer
+        new_method = instance_method method_name
+
+        define_method method_name do |*args|
+          new_method.bind(self).call *args
         end
       end
     end

data/lib/euston/version.rb

@@ -1,3 +1,3 @@
 module Euston
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

data/spec/aggregate_command_map_spec.rb

@@ -6,17 +6,17 @@ module Euston
     let(:guid1) {Euston.uuid.generate}
     let(:guid2) {Euston.uuid.generate}
 
-    let(:command_cw) { { :headers => CommandHeaders.new(Euston.uuid.generate, :create_widget, 1),
+    let(:command_cw) { { :headers => CommandHeaders.new(id: Euston.uuid.generate, type: 'create_widget', version: 1),
                       :body => { :id => guid1} } }
-    let(:command_iw) { { :headers => CommandHeaders.new(Euston.uuid.generate, :import_widget, 1),
+    let(:command_iw) { { :headers => CommandHeaders.new(id: Euston.uuid.generate, type: 'import_widget', version: 1),
                       :body => { :id => guid1, :imported_count => 5 } } }
-    let(:command_aw) { { :headers => CommandHeaders.new(Euston.uuid.generate, :log_access_to_widget, 1),
+    let(:command_aw) { { :headers => CommandHeaders.new(id: Euston.uuid.generate, type: 'log_access_to_widget', version: 1),
                       :body => { :widget_id => guid1 } } }
-    let(:command_cp) { { :headers => CommandHeaders.new(Euston.uuid.generate, :create_product, 1),
+    let(:command_cp) { { :headers => CommandHeaders.new(id: Euston.uuid.generate, type: 'create_product', version: 1),
                       :body => { :id => guid2} } }
-    let(:command_ip) { { :headers => CommandHeaders.new(Euston.uuid.generate, :import_product, 1),
+    let(:command_ip) { { :headers => CommandHeaders.new(id: Euston.uuid.generate, type: 'import_product', version: 1),
                       :body => { :id => guid2, :imported_count => 5 } } }
-    let(:command_ap) { { :headers => CommandHeaders.new(Euston.uuid.generate, :log_access_to_product, 1),
+    let(:command_ap) { { :headers => CommandHeaders.new(id: Euston.uuid.generate, type: 'log_access_to_product', version: 1),
                       :body => { :product_id => guid2 } } }
 
     describe "when creating new Aggregates" do

data/spec/aggregate_root_samples.rb

@@ -3,20 +3,20 @@ module Euston
     class Widget
       include Euston::AggregateRoot
 
-      created_by :create_widget do |command|
+      created_by :create_widget do |header, command|
         apply_event :widget_created, 1, command
       end
 
-      created_by :import_widget do |command|
+      created_by :import_widget do |header, command|
         apply_event :widget_imported, 1, :access_count => (@access_count || 0) + command.imported_count
       end
 
-      consumes :log_access_to_widget, :id => :widget_id do |command|
+      consumes :log_access_to_widget, :id => :widget_id do |header, command|
         apply_event :widget_access_logged, 1, :widget_id => command.widget_id,
                                        :access_count => @access_count + 1
       end
 
-      applies :widget_created, 1 do |event|
+      applies :widget_created, 1 do
         @access_count = 0
       end
 
@@ -32,11 +32,11 @@ module Euston
     class Product
       include Euston::AggregateRoot
 
-      created_by :create_product do |command|
+      created_by :create_product do |header, command|
         apply_event :product_created, 1, command
       end
 
-      created_by :import_product do |command|
+      created_by :import_product do |header, command|
         apply_event :product_imported, 1, :access_count => command.imported_count
       end
 

data/spec/aggregate_root_spec.rb

@@ -5,7 +5,7 @@ module Euston
     context 'duplicate command consumption' do
       let(:aggregate) { Sample::Widget.new }
       let(:aggregate2) { Sample::Widget.new }
-      let(:command) { { :headers => CommandHeaders.new(Euston.uuid.generate, :create_widget, 1),
+      let(:command) { { :headers => CommandHeaders.new(id: Euston.uuid.generate, type: 'create_widget', version: 1),
                         :body => { :id => Euston.uuid.generate } } }
 
       it 'does not handle the same command twice' do

data/spec/command_headers_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+module Euston
+  describe 'command_headers' do
+    let(:header) { CommandHeaders.new(parameters) }
+    context 'a new command headers object' do
+      it 'traps incorrect construction' do
+        expect { CommandHeaders.new({}) }.to raise_error(Errors::CommandHeadersArgumentError)
+        expect { CommandHeaders.new(id: 'foo', type: 'bah') }.to raise_error(Errors::CommandHeadersArgumentError,/version/)
+        expect { CommandHeaders.new(type: 'bah', version: 3) }.to raise_error(Errors::CommandHeadersArgumentError,/id/)
+        expect { CommandHeaders.new(id: 'foo', version: 2) }.to raise_error(Errors::CommandHeadersArgumentError,/type/)
+      end
+      let(:parameters) {{ id: 'foo', type: 'bah', version: 3 }}
+      it 'creates one from a hash' do
+        CommandHeaders.from_hash(parameters).should == header
+      end
+    end
+    context 'accessors' do
+      let(:parameters) {{ id: 'foo', type: 'bah', version: 3 }}
+      it 'converts type to a symbol' do
+        header.type.should == :bah
+      end
+      it 'has various accessor methods' do
+        header.id.should == 'foo'
+        header.version.should == 3
+        header[:id].should == 'foo'
+        header[:type].should == :bah
+        header['version'].should == 3
+      end
+      it 'treats respond_to correctly' do
+        header.respond_to?(:type).should be_true
+        header.respond_to?(:user_id).should be_false
+      end
+    end
+    context 'with more than the basic attributes' do
+      let(:parameters) {{ id: 'foo', type: 'bah', version: 3, user_id: 'bobby123' }}
+      it 'allows access to the extra attributes' do
+        header.respond_to?(:user_id).should be_true
+        header.user_id.should == 'bobby123'
+        header[:user_id].should == 'bobby123'
+      end
+    end
+    context 'auxilliary methods' do
+      let(:parameters) {{ id: 'foo', type: 'bah', version: 3, user_id: 'bobby123' }}
+      it 'has methods' do
+        header.to_hash.should == {id: 'foo', type: :bah, version: 3, user_id: 'bobby123'}
+        header.to_s.should == 'foo bah (v3)'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,8 @@
 require 'euston'
 require 'aggregate_root_samples'
+
+def apr(what, header='')
+  puts '', "== #{header} =="
+  puts what.inspect
+  puts ("="*(header.size + 6)), ''
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: euston
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-24 00:00:00.000000000 Z
+date: 2011-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70270530479600 !ruby/object:Gem::Requirement
+  requirement: &70222602188740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 3.0.10
   type: :runtime
   prerelease: false
-  version_requirements: *70270530479600
+  version_requirements: *70222602188740
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70270530478760 !ruby/object:Gem::Requirement
+  requirement: &70222602187880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 3.0.10
   type: :runtime
   prerelease: false
-  version_requirements: *70270530478760
+  version_requirements: *70222602187880
 - !ruby/object:Gem::Dependency
   name: fuubar
-  requirement: &70270530478060 !ruby/object:Gem::Requirement
+  requirement: &70222602187200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 0.0.0
   type: :development
   prerelease: false
-  version_requirements: *70270530478060
+  version_requirements: *70222602187200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70270530477300 !ruby/object:Gem::Requirement
+  requirement: &70222602186600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70270530477300
+  version_requirements: *70222602186600
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &70270530476640 !ruby/object:Gem::Requirement
+  requirement: &70222602186040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,7 +66,7 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70270530476640
+  version_requirements: *70222602186040
 description: ''
 email:
 - lee.m.henson@gmail.com
@@ -99,6 +99,7 @@ files:
 - spec/aggregate_command_map_spec.rb
 - spec/aggregate_root_samples.rb
 - spec/aggregate_root_spec.rb
+- spec/command_headers_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/leemhenson/euston
 licenses: []
@@ -128,4 +129,5 @@ test_files:
 - spec/aggregate_command_map_spec.rb
 - spec/aggregate_root_samples.rb
 - spec/aggregate_root_spec.rb
+- spec/command_headers_spec.rb
 - spec/spec_helper.rb