synapse-core 0.5.5 → 0.5.6

data/lib/synapse/auditing/audit_logger.rb

@@ -10,7 +10,9 @@ module Synapse
       # @param [Object] return_value
       # @param [Array<EventMessage>] events
       # @return [undefined]
-      def on_success(command, return_value, events); end
+      def on_success(command, return_value, events)
+        raise NotImplementedError
+      end
 
       # Called when a command execution results in an exception being raised
       #
@@ -22,7 +24,9 @@ module Synapse
       # @param [Exception] exception
       # @param [Array<EventMessage>] events
       # @return [undefined]
-      def on_failure(command, exception, events); end
-    end
-  end
+      def on_failure(command, exception, events)
+        raise NotImplementedError
+      end
+    end # AuditLogger
+  end # Auditing
 end

data/lib/synapse/auditing/correlation_data_provider.rb

@@ -3,9 +3,12 @@ module Synapse
     # Implementation of an audit provider that attaches a command's identifier to each event
     # produced as a result of the execution of that command
     class CorrelationDataProvider < AuditDataProvider
+      # Key that will be used by default
+      DEFAULT_CORRELATION_KEY = :command_id
+
       # @param [Symbol] correlation_key
       # @return [undefined]
-      def initialize(correlation_key)
+      def initialize(correlation_key = DEFAULT_CORRELATION_KEY)
         @correlation_key = correlation_key
       end
 

data/lib/synapse/auditing/data_provider.rb

@@ -8,7 +8,9 @@ module Synapse
       # @abstract
       # @param [CommandMessage] command
       # @return [Hash]
-      def provide_data_for(command); end
+      def provide_data_for(command)
+        raise NotImplementedError
+      end
     end # AuditDataProvider
   end # Auditing
 end

data/lib/synapse/command/command_bus.rb

@@ -14,7 +14,9 @@ module Synapse
       # @abstract
       # @param [CommandMessage] command
       # @return [undefined]
-      def dispatch(command); end
+      def dispatch(command)
+        raise NotImplementedError
+      end
 
       # Dispatches the given command to the handler subscribed to its type and notifies the
       # given callback of the outcome of the dispatch
@@ -23,7 +25,9 @@ module Synapse
       # @param [CommandMessage] command
       # @param [CommandCallback] callback
       # @return [undefined]
-      def dispatch_with_callback(command, callback); end
+      def dispatch_with_callback(command, callback)
+        raise NotImplementedError
+      end
 
       # Subscribes the given handler to the given command type, replacing the currently subscribed
       # handler, if any.
@@ -31,7 +35,9 @@ module Synapse
       # @param [Class] command_type
       # @param [CommandHandler] handler
       # @return [undefined]
-      def subscribe(command_type, handler); end
+      def subscribe(command_type, handler)
+        raise NotImplementedError
+      end
 
       # Unsubscribes the given handler from the given command type, if it is currently subscribed
       # to the given command type.
@@ -39,7 +45,9 @@ module Synapse
       # @param [Class] command_type
       # @param [CommandHandler] handler
       # @return [undefined]
-      def unsubscribe(command_type, handler); end
-    end
-  end
+      def unsubscribe(command_type, handler)
+        raise NotImplementedError
+      end
+    end # CommandBus
+  end # Command
 end

data/lib/synapse/command/command_filter.rb

@@ -11,7 +11,9 @@ module Synapse
       # @abstract
       # @param [CommandMessage] command
       # @return [CommandMessage] The command to dispatch on the bus
-      def filter(command); end
-    end
-  end
+      def filter(command)
+        raise NotImplementedError
+      end
+    end # CommandFilter
+  end # Command
 end

data/lib/synapse/command/command_handler.rb

@@ -9,7 +9,9 @@ module Synapse
       # @param [CommandMessage] command
       # @param [UnitOfWork] current_unit Current unit of work
       # @return [Object] The result of handling the given command
-      def handle(command, current_unit); end
-    end
-  end
+      def handle(command, current_unit)
+        raise NotImplementedError
+      end
+    end # CommandHandler
+  end # Command
 end

data/lib/synapse/command/dispatch_interceptor.rb

@@ -10,7 +10,9 @@ module Synapse
       # @param [UnitOfWork] unit The current unit of work for this command dispatch
       # @param [InterceptorChain] chain
       # @return [Object] The result of the execution of the command
-      def intercept(command, unit, chain); end
-    end
-  end
+      def intercept(command, unit, chain)
+        raise NotImplementedError
+      end
+    end # DispatchInterceptor
+  end # Command
 end

data/lib/synapse/command/duplication.rb

@@ -14,7 +14,7 @@ module Synapse
         @recorder.record command
         command
       end
-    end
+    end # DuplicationFilter
 
     # Interceptor that removes commands from the duplication recorder if their execution results
     # in a transient error (like concurrency error) being raised. This way, the same command can
@@ -38,6 +38,6 @@ module Synapse
           raise
         end
       end
-    end
-  end
+    end # DuplicationCleanupInterceptor
+  end # Command
 end

data/lib/synapse/command/mapping.rb

@@ -44,7 +44,7 @@ module Synapse
           raise ArgumentError, 'Not capable of handling [%s] commands' % command.payload_type
         end
 
-        mapping.invoke self, command.payload
+        mapping.invoke self, command.payload, command, current_unit
       end
 
       # Subscribes this handler to the given command bus for any types that have been mapped

data/lib/synapse/command/rollback_policy.rb

@@ -7,8 +7,10 @@ module Synapse
       #
       # @param [Exception] exception
       # @return [Boolean]
-      def should_rollback(exception); end
-    end
+      def should_rollback(exception)
+        raise NotImplementedError
+      end
+    end # RollbackPolicy
 
     # Implementation of a rollback policy that performs a rollback on any exception
     class RollbackOnAnyExceptionPolicy < RollbackPolicy
@@ -17,6 +19,6 @@ module Synapse
       def should_rollback(exception)
         true
       end
-    end
-  end
+    end # RollbackOnAnyExceptionPolicy
+  end # Command
 end

data/lib/synapse/domain/simple_stream.rb

@@ -2,6 +2,8 @@ module Synapse
   module Domain
     # Implementation of a domain event stream that holds a stream of events in memory
     class SimpleDomainEventStream < DomainEventStream
+      # @param [EventMessage...] events
+      # @return [undefined]
       def initialize(*events)
         @events = events.flatten
         @next_index = 0

data/lib/synapse/domain/stream.rb

@@ -21,20 +21,24 @@ module Synapse
       # @abstract
       # @return [Boolean]
       def end?
-        true
+        raise NotImplementedError
       end
 
       # Returns the next event in the stream and moves the stream's pointer forward
       #
       # @abstract
       # @return [DomainEventMessage]
-      def next_event; end
+      def next_event
+        raise NotImplementedError
+      end
 
       # Returns the next event in the stream without moving the stream's pointer forward
       #
       # @abstract
       # @return [DomainEventMessage]
-      def peek; end
+      def peek
+        raise NotImplementedError
+      end
 
       # Yields the next domain events in the stream until the end of the stream has been reached
       #
@@ -59,10 +63,10 @@ module Synapse
 
     protected
 
+      # @raise [EndOfStreamError] If at the end of the stream
+      # @return [undefined]
       def assert_valid
-        if end?
-          raise EndOfStreamError
-        end
+        raise EndOfStreamError if end?
       end
     end # DomainEventStream
   end # Domain

data/lib/synapse/event_bus/clustering/cluster.rb

@@ -0,0 +1,10 @@
+module Synapse
+  module EventBus
+    # Represents a group of event listeners
+    #
+    # Clusters allow attributes and behaviors to be applied across an entire group of listeners,
+    # such as asynchronous processing, event replay, transaction management and distribution.
+    class Cluster
+    end # Cluster
+  end # EventBus
+end

data/lib/synapse/event_bus/clustering/event_bus.rb

@@ -0,0 +1,55 @@
+module Synapse
+  module EventBus
+    class ClusteringEventBus
+      # @param [ClusterSelector] cluster_selector
+      # @return [undefined]
+      def initialize(cluster_selector)
+        @cluster_selector = cluster_selector
+        @clusters = Set.new
+      end
+
+      # @api public
+      # @param [EventMessage...] events
+      # @return [undefined]
+      def publish(*events)
+        events.flatten!
+
+        @clusters.each do |cluster|
+          cluster.publish events
+        end
+      end
+
+      # @api public
+      # @raise [SubscriptionFailedError] If subscription of an event listener failed
+      # @param [EventListener] listener
+      # @return [undefined]
+      def subscribe(listener)
+        select_cluster(listener).subscribe(listener)
+      end
+
+      # @api public
+      # @param [EventListener] listener
+      # @return [undefined]
+      def unsubscribe(listener)
+        select_cluster(listener).unsubscribe(listener)
+      end
+
+    private
+
+      # @raise [SubscriptionFailedError] If no suitable cluster for listener
+      # @param [EventListener] listener
+      # @return [Cluster]
+      def select_cluster(listener)
+        cluster = @cluster_selector.select_cluster listener
+
+        unless cluster
+          raise SubscriptionFailedError, 'Unable to find suitable cluster for [%s]' % listener.class
+        end
+
+        @clusters.add cluster
+
+        cluster
+      end
+    end # ClusteringEventBus
+  end # EventBus
+end

data/lib/synapse/event_bus/clustering/selector.rb

@@ -0,0 +1,14 @@
+module Synapse
+  module EventBus
+    # Represents a mechanism for assigning event listeners to clusters
+    # @abstract
+    class ClusterSelector
+      # Selects and returns a suitable cluster for the given event listener
+      #
+      # @abstract
+      # @param [EventListener] listener
+      # @return [Cluster] Returns nil if no suitable cluster
+      def select_cluster(listener); end
+    end # ClusterSelector
+  end # EventBus
+end

data/lib/synapse/event_bus/event_bus.rb

@@ -15,7 +15,9 @@ module Synapse
       # @abstract
       # @param [EventMessage...] events
       # @return [undefined]
-      def publish(*events); end
+      def publish(*events)
+        raise NotImplementedError
+      end
 
       # Subscribes the given listener to this event bus
       #
@@ -23,14 +25,18 @@ module Synapse
       # @raise [SubscriptionFailedError] If subscription of an event listener failed
       # @param [EventListener] listener
       # @return [undefined]
-      def subscribe(listener); end
+      def subscribe(listener)
+        raise NotImplementedError
+      end
 
       # Unsubscribes the given listener from this event bus
       #
       # @abstract
       # @param [EventListener] listener
       # @return [undefined]
-      def unsubscribe(listener); end
+      def unsubscribe(listener)
+        raise NotImplementedError
+      end
     end
 
     # Raised when the subscription of an event listener has not succeeded. Generally, this means that

data/lib/synapse/event_bus/event_listener.rb

@@ -12,7 +12,9 @@ module Synapse
       # @abstract
       # @param [EventMessage] event
       # @return [undefined]
-      def notify(event); end
-    end
-  end
+      def notify(event)
+        raise NotImplementedError
+      end
+    end # EventListener
+  end # EventBus
 end

data/lib/synapse/event_bus/mapping.rb

@@ -10,6 +10,10 @@ module Synapse
     #       # ...
     #     end
     #
+    #     map_event UserProfileUpdated do |event, message|
+    #       # ...
+    #     end
+    #
     #     map_event UserBanned, :to => :on_banned
     #   end
     module MappingEventListener
@@ -37,10 +41,9 @@ module Synapse
       # @return [undefined]
       def notify(event)
         mapping = event_mapper.mapping_for event.payload_type
-
-        return unless mapping
-
-        mapping.invoke self, event.payload
+        if mapping
+          mapping.invoke self, event.payload, event
+        end
       end
     end # MappingEventListener
   end # EventBus

data/lib/synapse/event_sourcing/aggregate_factory.rb

@@ -16,11 +16,15 @@ module Synapse
 
       # @abstract
       # @return [Class] Type of aggregate being created by this factory
-      def aggregate_type; end
+      def aggregate_type
+        raise NotImplementedError
+      end
 
       # @abstract
       # @return [String] Type identifier used to store the aggregate in the event store
-      def type_identifier; end
+      def type_identifier
+        raise NotImplementedError
+      end
     end # AggregateFactory
 
     # Aggregate factory that uses a convention to create instances of aggregates

data/lib/synapse/event_sourcing/conflict_resolver.rb

@@ -10,6 +10,17 @@ module Synapse
       # an exception. Otherwise, the changes will be applied.
       #
       # @abstract
+      # @raise [ConflictingModificationException] If any conflicts were detected
+      # @param [Array] applied_changes List of changes applied to the aggregate
+      # @param [Array] committed_changes List of events that were unexpected by the command handler
+      # @return [undefined]
+      def resolve_conflicts(applied_changes, committed_changes)
+        raise NotImplementedError
+      end
+    end
+
+    # Conflict resolver that accepts any unseen changes to an aggregate
+    class AcceptAllConflictResolver < ConflictResolver
       # @raise [ConflictingModificationException] If any conflicts were detected
       # @param [Array] applied_changes List of changes applied to the aggregate
       # @param [Array] committed_changes List of events that were unexpected by the command handler

data/lib/synapse/event_sourcing/member.rb

@@ -77,7 +77,7 @@ module Synapse
       def handle_event(event)
         mapping = self.event_mapper.mapping_for event.payload_type
         if mapping
-          mapping.invoke self, event.payload
+          mapping.invoke self, event.payload, event
         end
       end
 

data/lib/synapse/event_sourcing/snapshot/policy.rb

@@ -6,7 +6,9 @@ module Synapse
       #
       # @param [AggregateRoot] aggregate
       # @return [Boolean]
-      def should_snapshot?(aggregate); end
+      def should_snapshot?(aggregate)
+        raise NotImplementedError
+      end
     end # SnapshotPolicy
 
     # Snapshot policy that takes a snapshot if the number of events committed in an aggregate since

data/lib/synapse/event_sourcing/snapshot/taker.rb

@@ -43,7 +43,9 @@ module Synapse
       # @param [Object] aggregate_id
       # @param [DomainEventStream] stream
       # @return [DomainEventMessage]
-      def create_snapshot(type_identifier, aggregate_id, stream); end
+      def create_snapshot(type_identifier, aggregate_id, stream)
+        raise NotImplementedError
+      end
     end # SnapshotTaker
   end # EventSourcing
 end

data/lib/synapse/event_store/event_store.rb

@@ -15,7 +15,9 @@ module Synapse
       # @param [String] type_identifier Type descriptor of the aggregate to retrieve
       # @param [Object] aggregate_id
       # @return [DomainEventStream]
-      def read_events(type_identifier, aggregate_id); end
+      def read_events(type_identifier, aggregate_id)
+        raise NotImplementedError
+      end
 
       # Appends the domain events in the given stream to the event store
       #
@@ -24,8 +26,10 @@ module Synapse
       # @param [String] type_identifier Type descriptor of the aggregate to append to
       # @param [DomainEventStream] stream
       # @return [undefined]
-      def append_events(type_identifier, stream); end
-    end
+      def append_events(type_identifier, stream)
+        raise NotImplementedError
+      end
+    end # EventStore
 
     # Represents an event store with the capability to manage aggregate snapshots
     # @abstract
@@ -37,7 +41,9 @@ module Synapse
       # @param [String] type_identifier Type descriptor of the aggregate to append to
       # @param [DomainEventMessage] snapshot_event
       # @return [undefined]
-      def append_snapshot_event(type_identifier, snapshot_event); end
-    end
-  end
+      def append_snapshot_event(type_identifier, snapshot_event)
+        raise NotImplementedError
+      end
+    end # SnapshotEventStore
+  end # EventStore
 end

data/lib/synapse/event_store/in_memory.rb

@@ -54,6 +54,6 @@ module Synapse
 
         @streams.store aggregate_id, Array.new
       end
-    end
-  end
+    end # InMemoryEventStore
+  end # EventStore
 end

data/lib/synapse/mapping/mapping.rb

@@ -29,9 +29,15 @@ module Synapse
       # @return [Object] The result of the handler invocation
       def invoke(target, *args)
         if @handler.is_a? Symbol
-          target.send(@handler, *args)
+          method = target.method @handler
+
+          if method.arity > args.size || method.arity == 0
+            raise ArgumentError, 'Method signature is invalid'
+          end
+
+          method.call(*args.slice(0, method.arity))
         else
-          target.instance_exec(*args, &@handler)
+          target.instance_exec *args, &@handler
         end
       end
 

data/lib/synapse/process_manager/correlation.rb

@@ -27,6 +27,6 @@ module Synapse
       def hash
         @key.hash ^ @value.hash
       end
-    end
-  end
+    end # Correlation
+  end # ProcessManager
 end

data/lib/synapse/process_manager/correlation_resolver.rb

@@ -8,7 +8,9 @@ module Synapse
       # @abstract
       # @param [EventMessage] event
       # @return [Correlation]
-      def resolve(event); end
-    end
-  end
+      def resolve(event)
+        raise NotImplementedError
+      end
+    end # CorrelationResolver
+  end # ProcessManager
 end

data/lib/synapse/process_manager/mapping/process.rb

@@ -33,11 +33,10 @@ module Synapse
         return unless @active
 
         mapping = event_mapper.mapping_for event.payload_type
-
-        return unless mapping
-
-        mapping.invoke self, event.payload
-        finish if mapping.options[:finish]
+        if mapping
+          mapping.invoke self, event.payload, event
+          finish if mapping.options[:finish]
+        end
       end
     end # MappingProcess
   end # ProcessManager

data/lib/synapse/process_manager/pessimistic_lock_manager.rb

@@ -18,6 +18,6 @@ module Synapse
       def release_lock(process_id)
         @lock.release_lock process_id
       end
-    end
-  end
+    end # PessimisticLockManager
+  end # ProcessManager
 end

data/lib/synapse/process_manager/process.rb

@@ -43,7 +43,9 @@ module Synapse
       # @abstract
       # @param [EventMessage] event
       # @return [undefined]
-      def handle(event); end
+      def handle(event)
+        raise NotImplementedError
+      end
 
     protected
 

data/lib/synapse/process_manager/process_factory.rb

@@ -11,14 +11,18 @@ module Synapse
       # @abstract
       # @param [Class] process_type
       # @return [Process]
-      def create(process_type); end
+      def create(process_type)
+        raise NotImplementedError
+      end
 
       # Returns true if processes of the given type can be created by this factory
       #
       # @abstract
       # @param [Class] process_type
       # @return [Boolean]
-      def supports(process_type); end
+      def supports(process_type)
+        raise NotImplementedError
+      end
     end # ProcessFactory
 
     # Generic implementation of a process factory that supports any process implementations that

data/lib/synapse/process_manager/process_manager.rb

@@ -52,13 +52,17 @@ module Synapse
       # @param [Class] process_type
       # @param [EventMessage] event
       # @return [Symbol]
-      def creation_policy_for(process_type, event); end
+      def creation_policy_for(process_type, event)
+        raise NotImplementedError
+      end
 
       # @abstract
       # @param [Class] process_type
       # @param [EventMessage] event
       # @return [Correlation] Returns nil if no correlation could be extracted
-      def extract_correlation(process_type, event); end
+      def extract_correlation(process_type, event)
+        raise NotImplementedError
+      end
 
       # Determines whether or not a new process should be started, based off of existing processes
       # and the creation policy for the event and process