sequent 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 814f54e9a769f6f73fc7c0cab26eebc4b9a191e1
-  data.tar.gz: c346224df919223cba73db9fe74097c235bacd32
+  metadata.gz: 0e8e35986af2a9dcdb19a2d66b291606e852b96c
+  data.tar.gz: a049cc85e36f391e22fd35ae3d45061f81eb7562
 SHA512:
-  metadata.gz: 4e39adc404ed14163bd5b54b4ebdc558a12d4d56be8b60ad54140ee1cbc9102d89e17359a08d7a37eeeb299b99788359777d9f6cf778362969cb45b3182d493a
-  data.tar.gz: 667ab8ca0e0b5255184f162210d33a6775b26e952e8868a42a6a8a8ef408b24cec46f118c6fa9400b71a01632a0fb32388e2e23a6ab9362301f2247c2730726a
+  metadata.gz: 319d6c1cb5397766edb05bb6239a083d51722490a85f7120c68a4973cda6d30d9a92a2efecaec0c0a0df42d864e80d4142ecc23ceea6255c344076f9703e45f1
+  data.tar.gz: e7768f63f1369006ed1a61397ce5d5195e35142a497113ffd6e03c34edffe56f49d20d3271b680b56b18752f3c32f91b8c72f4572fe01cafb4bf3fd16dc6e716

data/lib/sequent/core/aggregate_repository.rb

@@ -32,7 +32,6 @@ module Sequent
 
       def initialize(event_store)
         @event_store = event_store
-        clear
       end
 
       # Adds the given aggregate to the repository (or unit of work).
@@ -57,7 +56,7 @@ module Sequent
       # Loads aggregate by given id and class
       # Returns the one in the current Unit Of Work otherwise loads it from history.
       def load_aggregate(aggregate_id, clazz = nil)
-        result = aggregates.fetch(aggregate_id) do |aggregate_id|
+        result = aggregates.fetch(aggregate_id) do |_|
           stream, events = @event_store.load_events(aggregate_id)
           raise AggregateNotFound.new(aggregate_id) unless stream
           aggregate_class = Class.const_get(stream.aggregate_type)
@@ -69,6 +68,12 @@ module Sequent
         result
       end
 
+      ##
+      # Returns whether the event store has an aggregate with the given id
+      def contains_aggregate?(aggregate_id)
+        @event_store.stream_exists?(aggregate_id)
+      end
+
       # Gets all uncommitted_events from the 'registered' aggregates
       # and stores them in the event store.
       # The command is 'attached' for traceability purpose so we can see
@@ -77,7 +82,7 @@ module Sequent
       # This is all abstracted away if you use the Sequent::Core::CommandService
       #
       def commit(command)
-        updated_aggregates = aggregates.values.reject {|x| x.uncommitted_events.empty?}
+        updated_aggregates = aggregates.values.reject { |x| x.uncommitted_events.empty? }
         return if updated_aggregates.empty?
         streams_with_events = updated_aggregates.map do |aggregate|
           [ aggregate.event_stream, aggregate.uncommitted_events ]
@@ -88,13 +93,13 @@ module Sequent
 
       # Clears the Unit of Work.
       def clear
-        Thread.current[AGGREGATES_KEY] = {}
+        Thread.current[AGGREGATES_KEY] = nil
       end
 
       private
 
       def aggregates
-        Thread.current[AGGREGATES_KEY]
+        Thread.current[AGGREGATES_KEY] ||= {}
       end
 
       def store_events(command, streams_with_events)

data/lib/sequent/core/aggregate_root.rb

@@ -88,7 +88,7 @@ module Sequent
       protected
 
       def build_event(event, params = {})
-        event.new({aggregate_id: @id, sequence_number: @sequence_number}.merge(params))
+        event.new(params.merge({aggregate_id: @id, sequence_number: @sequence_number}))
       end
 
       # Provide subclasses nice DSL to 'apply' events via:
@@ -124,7 +124,7 @@ module Sequent
       protected
 
       def build_event(event, params = {})
-        super(event, {organization_id: @organization_id}.merge(params))
+        super(event, params.merge({organization_id: @organization_id}))
       end
     end
   end

data/lib/sequent/core/base_command_handler.rb

@@ -26,6 +26,10 @@ module Sequent
         @repository = repository
       end
 
+      def handles_message?(command)
+        self.class.message_mapping.keys.include? command.class
+      end
+
       protected
       def do_with_aggregate(command, clazz, aggregate_id = nil)
         aggregate = @repository.load_aggregate(aggregate_id.nil? ? command.aggregate_id : aggregate_id, clazz)

data/lib/sequent/core/base_event_handler.rb

@@ -47,5 +47,8 @@ module Sequent
                      :find_records, :last_record
 
     end
+
+    # Alias the above class
+    Projector = BaseEventHandler
   end
 end

data/lib/sequent/core/command_service.rb

@@ -15,13 +15,14 @@ module Sequent
     class CommandService
       attr_accessor :configuration
 
-      # +DefaultCommandServiceConfiguration+ Configuration class for the CommandService containing:
+      # Create a command service with the given configuration.
       #
       #   +event_store+ The Sequent::Core::EventStore
-      #   +command_handler_classes+ Array of BaseCommandHandler classes that need to handle commands
-      #   +transaction_provider+ How to do transaction management. Defaults to Sequent::Core::Transactions::NoTransactions
-      #   +filters+ List of filter that respond_to :execute(command). Can be useful to do extra checks (security and such).
-      def initialize(configuration = CommandServiceConfiguration.new)
+      #   +aggregate_repository+ The Sequent::Core::AggregateRepository
+      #   +transaction_provider+ How to do transaction management.
+      #   +command_handlers+ List of command handlers that need to handle commands
+      #   +command_filters+ List of filter that respond_to :execute(command). Can be useful to do extra checks (security and such).
+      def initialize(configuration)
         self.configuration = configuration
       end
 

data/lib/sequent/core/core.rb

@@ -15,3 +15,4 @@ require_relative 'tenant_event_store'
 require_relative 'event_record'
 require_relative 'command_record'
 require_relative 'aggregate_snapshotter'
+require_relative 'workflow'

data/lib/sequent/core/event_store.rb

@@ -33,7 +33,8 @@ module Sequent
       # Returns all events for the aggregate ordered by sequence_number
       #
       def load_events(aggregate_id)
-        stream = stream_record_class.where(aggregate_id: aggregate_id).first!
+        stream = stream_record_class.where(aggregate_id: aggregate_id).first
+        return nil unless stream
         events = event_record_class.connection.select_all(%Q{
 SELECT event_type, event_json
   FROM #{quote_table_name event_record_class.table_name}
@@ -49,6 +50,10 @@ SELECT event_type, event_json
         [stream.event_stream, events]
       end
 
+      def stream_exists?(aggregate_id)
+        stream_record_class.exists?(aggregate_id: aggregate_id)
+      end
+
       ##
       # Replays all events in the event store to the registered event_handlers.
       #

data/lib/sequent/core/helpers/attribute_support.rb

@@ -122,6 +122,10 @@ EOS
           hash
         end
 
+        def update(changes)
+          self.class.new(attributes.merge(changes))
+        end
+
         def validation_errors(prefix = nil)
           result = errors.to_hash
           self.class.types.each do |field|

data/lib/sequent/core/helpers/self_applier.rb

@@ -11,7 +11,7 @@ module Sequent
       # end
       #
       # You typically do not need to include this module in your classes. If you extend from
-      # Sequent::Core::AggregateRoot, Sequent::Core::BaseEventHandler or Sequent::Core::BaseCommandHandler
+      # Sequent::Core::AggregateRoot, Sequent::Core::Projector, Sequent::Core::Workflow or Sequent::Core::BaseCommandHandler
       # you will get this functionality for free.
       #
       module SelfApplier

data/lib/sequent/core/record_sessions/replay_events_session.rb

@@ -18,7 +18,7 @@ module Sequent
       #
       # Example:
       #
-      #   class InvoiceEventHandler < Sequent::Core::BaseEventHandler
+      #   class InvoiceEventHandler < Sequent::Core::Projector
       #     on RecipientMovedEvent do |event|
       #       update_all_records InvoiceRecord, recipient_id: event.recipient.aggregate_id do |record|
       #         record.recipient_street = record.recipient.street

data/lib/sequent/core/workflow.rb

@@ -0,0 +1,13 @@
+require_relative 'helpers/self_applier'
+
+module Sequent
+  module Core
+    class Workflow
+      include Helpers::SelfApplier
+
+      def execute_commands(*commands)
+        Sequent.configuration.command_service.execute_commands(*commands)
+      end
+    end
+  end
+end

data/lib/sequent/sequent.rb

@@ -1,6 +1,5 @@
 require_relative 'core/core'
 require_relative 'migrations/migrations'
-require_relative 'test/test'
 require_relative 'configuration'
 
 require 'logger'

data/lib/sequent/test.rb

@@ -0,0 +1,4 @@
+require_relative 'sequent'
+require_relative 'test/command_handler_helpers'
+require_relative 'test/event_stream_helpers'
+require_relative 'test/event_handler_helpers'

data/lib/sequent/test/command_handler_helpers.rb

@@ -33,6 +33,11 @@ module Sequent
     #     then_events InvoicePaidEvent(args)
     #   end
     #
+    #   it "rejects coupon when does not exist" do
+    #     given_events CartCreatedEvent.new(args)
+    #     when_command ApplyDiscountCouponCommand(args)
+    #     then_fails_with CouponDoesNotExist
+    #   end
     # end
     module CommandHandlerHelpers
 
@@ -72,6 +77,10 @@ module Sequent
           @stored_events = []
         end
 
+        def stream_exists?(aggregate_id)
+          @event_streams.has_key?(aggregate_id)
+        end
+
         private
 
         def to_event_streams(events)
@@ -107,23 +116,32 @@ module Sequent
             Class.const_get(type).deserialize_from_json(Sequent::Core::Oj.strict_load(json))
           end
         end
-
       end
 
       def given_events *events
-        @event_store.given_events(events)
+        @event_store.given_events(events.flatten(1))
       end
 
       def when_command command
         raise "@command_handler is mandatory when using the #{self.class}" unless @command_handler
         raise "Command handler #{@command_handler} cannot handle command #{command}, please configure the command type (forgot an include in the command class?)" unless @command_handler.handles_message?(command)
-        @command_handler.handle_message(command)
+        begin
+          @command_handler.handle_message(command)
+        rescue => e
+          @unhandled_error = e
+        end
         @repository.commit(command)
+        @repository.clear
+      end
+
+      def then_fails_with clazz
+        expect(@unhandled_error).to be_kind_of(clazz)
+        @unhandled_error = nil
       end
 
       def then_events *events
-        expect(@event_store.stored_events.map(&:class)).to eq(events.map(&:class))
-        @event_store.stored_events.zip(events).each do |actual, expected|
+        expect(@event_store.stored_events.map(&:class)).to eq(events.flatten(1).map(&:class))
+        @event_store.stored_events.zip(events.flatten(1)).each do |actual, expected|
           expect(Sequent::Core::Oj.strict_load(Sequent::Core::Oj.dump(actual.payload))).to eq(Sequent::Core::Oj.strict_load(Sequent::Core::Oj.dump(expected.payload))) if expected
         end
       end
@@ -132,7 +150,11 @@ module Sequent
         then_events
       end
 
+      def self.included(spec)
+        spec.after do
+          raise @unhandled_error if @unhandled_error
+        end
+      end
     end
-
   end
 end

data/lib/sequent/test/event_handler_helpers.rb

@@ -0,0 +1,71 @@
+module Sequent
+  module Test
+    ##
+    # Use in tests
+    #
+    # This provides a nice DSL for testing your event handlers.
+    # E.g.
+    #
+    # when_event UserWasRegistered.new(args)
+    # then_commands SendWelcomeEmail.new(args)
+    #
+    # Example for Rspec config
+    #
+    # RSpec.configure do |config|
+    #   config.include Sequent::Test::WorkflowHelpers
+    # end
+    #
+    # Then in a spec
+    #
+    # describe SendWelcomeMailWorkflow do
+    #   let(:workflow) { SendWelcomeMailWorkflow.new }
+    #
+    #   it "sends a welcome mail" do
+    #     when_event UserWasRegistered.new(args)
+    #     then_commands SendWelcomeEmail.new(args)
+    #   end
+    # end
+    module WorkflowHelpers
+
+      class FakeCommandService
+        attr_reader :recorded_commands
+
+        def initialize
+          @recorded_commands = []
+        end
+
+        def execute_commands(*commands)
+          @recorded_commands += commands
+        end
+      end
+
+      def then_events *events
+        expect(@event_store.stored_events.map(&:class)).to eq(events.flatten(1).map(&:class))
+        @event_store.stored_events.zip(events.flatten(1)).each do |actual, expected|
+          expect(Sequent::Core::Oj.strict_load(Sequent::Core::Oj.dump(actual.payload))).to eq(Sequent::Core::Oj.strict_load(Sequent::Core::Oj.dump(expected.payload))) if expected
+        end
+      end
+
+      def then_no_events
+        then_events
+      end
+
+      def when_event(event)
+        workflow.handle_message event
+      end
+
+      def then_commands(*commands)
+        recorded = fake_command_service.recorded_commands
+        expect(recorded.map(&:class)).to eq(commands.flatten(1).map(&:class))
+        expect(fake_command_service.recorded_commands).to eq(commands.flatten(1))
+      end
+
+      def self.included(spec)
+        spec.let(:fake_command_service) { FakeCommandService.new }
+        spec.before do
+          Sequent.configure { |c| c.command_service = fake_command_service }
+        end
+      end
+    end
+  end
+end

data/lib/sequent/test/event_stream_helpers.rb

@@ -0,0 +1,78 @@
+module Sequent
+  module Test
+    ##
+    # Use in tests
+    #
+    # This provides a nice DSL for generating streams of events. FactoryGirl is required when using this helper.
+    #
+    # Example for Rspec config
+    #
+    # RSpec.configure do |config|
+    #   config.include Sequent::Test::EventStreamHelpers
+    # end
+    #
+    # Then in a spec
+    #
+    # given_stream_for(aggregate_id: 'X') do |s|
+    #   s.group_created owner_aggregate_id: 'Y'
+    #   s.group_opened
+    #   s.owner_joined_group owner_aggregate_id: 'Y'
+    # end
+    #
+    # Methods on `s` will be FactoryGirl factories. All arguments will be passed on to FactoryGirl's build method.
+    # Aggregate ids and sequence numbers will be set automatically.
+    #
+    # The example above can also be written as follows:
+    #
+    # events = event_stream(aggregate_id: 'X') do |s|
+    #   s.group_created owner_aggregate_id: 'Y'
+    #   s.group_opened
+    #   s.owner_joined_group owner_aggregate_id: 'Y'
+    # end
+    #
+    # given_events(events)
+    #
+    module EventStreamHelpers
+      class Builder
+        attr_reader :events
+
+        def initialize(aggregate_id)
+          @aggregate_id = aggregate_id
+          @events = []
+        end
+
+        def method_missing(name, *args, &block)
+          args = prepare_arguments(args)
+          @events << FactoryGirl.build(name, *args, &block)
+        end
+
+      private
+
+        def prepare_arguments(args)
+          options = args.last.is_a?(Hash) ? args.pop : {}
+          args << options.merge(aggregate_id: @aggregate_id, sequence_number: next_sequence_number)
+        end
+
+        def next_sequence_number
+          @events.count + 1
+        end
+      end
+
+      def event_stream(aggregate_id:, &block)
+        builder = Builder.new(aggregate_id)
+        block.call(builder)
+        builder.events
+      end
+
+      def given_stream_for(aggregate_id:, &block)
+        given_events(*event_stream(aggregate_id: aggregate_id, &block))
+      end
+
+      def self.included(spec)
+        require 'factory_girl'
+      rescue LoadError
+        raise ArgumentError, "Factory girl is required to use the event stream helpers"
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Sequent
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequent
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Lars Vonk
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2015-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -205,11 +205,14 @@ files:
 - lib/sequent/core/transactions/no_transactions.rb
 - lib/sequent/core/transactions/transactions.rb
 - lib/sequent/core/value_object.rb
+- lib/sequent/core/workflow.rb
 - lib/sequent/migrations/migrate_events.rb
 - lib/sequent/migrations/migrations.rb
 - lib/sequent/sequent.rb
+- lib/sequent/test.rb
 - lib/sequent/test/command_handler_helpers.rb
-- lib/sequent/test/test.rb
+- lib/sequent/test/event_handler_helpers.rb
+- lib/sequent/test/event_stream_helpers.rb
 - lib/version.rb
 homepage: https://github.com/zilverline/sequent
 licenses:
@@ -231,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Event sourcing framework for Ruby

data/lib/sequent/test/test.rb

@@ -1 +0,0 @@
-require_relative 'command_handler_helpers'