synapse-core 0.4.0 → 0.5.1

data/lib/synapse/event_bus/event_publisher.rb

@@ -0,0 +1,19 @@
+module Synapse
+  module EventBus
+    # Mixin for an object that wishes to easily be able to publish events to an event bus
+    module EventPublisher
+      # @return [EventBus]
+      attr_accessor :event_bus
+
+    protected
+
+      # Publishes the given event object or event message to the configured event bus
+      #
+      # @param [Object] event
+      # @return [undefined]
+      def publish_event(event)
+        @event_bus.publish(Domain::EventMessage.as_message(event))
+      end
+    end # EventPublisher
+  end # EventBus
+end

data/lib/synapse/event_bus/simple_event_bus.rb

@@ -8,62 +8,53 @@ module Synapse
         @logger = Logging.logger[self.class]
       end
 
+      # @api public
       # @param [EventMessage...] events
       # @return [undefined]
       def publish(*events)
-        if @listeners.empty?
-          return
-        end
+        return if @listeners.empty?
 
         events.flatten!
         events.each do |event|
           @listeners.each do |listener|
-            if @logger.debug?
-              listener_type = actual_type listener
-              @logger.debug 'Dispatching event [%s] to listener [%s]' %
-                [event.payload_type, listener_type]
-            end
+            @logger.debug 'Dispatching event [%s] to listener [%s]' %
+              [event.payload_type, listener.class]
 
             listener.notify event
           end
         end
       end
 
+      # Returns true if the given listener is subscribed to this event bus
+      #
+      # @api public
+      # @param [EventListener] listener
+      # @return [Boolean]
+      def subscribed?(listener)
+        @listeners.include? listener
+      end
+
+      # @api public
       # @param [EventListener] listener
       # @return [undefined]
       def subscribe(listener)
-        listener_type = actual_type listener
-
         if @listeners.add? listener
-          @logger.debug 'Event listener [%s] subscribed' % listener_type
+          @logger.debug 'Event listener [%s] subscribed' % listener.class
         else
-          @logger.info 'Event listener [%s] not added, was already subscribed' % listener_type
+          @logger.info 'Event listener [%s] not added, was already subscribed' % listener.class
         end
       end
 
+      # @api public
       # @param [EventListener] listener
       # @return [undefined]
       def unsubscribe(listener)
-        listener_type = actual_type listener
-
         if @listeners.delete? listener
-          @logger.debug 'Event listener [%s] unsubscribed' % listener_type
-        else
-          @logger.info 'Event listener [%s] not removed, was not subscribed' % listener_type
-        end
-      end
-
-    private
-
-      # @param [EventListener] listener
-      # @return [Class]
-      def actual_type(listener)
-        if listener.respond_to? :proxied_type
-          listener.proxied_type
+          @logger.debug 'Event listener [%s] unsubscribed' % listener.class
         else
-          listener.class
+          @logger.info 'Event listener [%s] not removed, was not subscribed' % listener.class
         end
       end
-    end
-  end
+    end # SimpleEventBus
+  end # EventBus
 end

data/lib/synapse/event_bus/wiring.rb

@@ -9,10 +9,11 @@ module Synapse
       # @param [EventMessage] event
       # @return [undefined]
       def notify(event)
-        wire = self.wire_registry.wire_for event.payload_type
-        if wire
-          invoke_wire event, wire
-        end
+        wire = wire_registry.wire_for event.payload_type
+
+        return unless wire
+
+        invoke_wire event, wire
       end
     end
   end

data/lib/synapse/event_bus.rb

@@ -1,5 +1,5 @@
 require 'synapse/event_bus/event_bus'
 require 'synapse/event_bus/event_listener'
-require 'synapse/event_bus/event_listener_proxy'
+require 'synapse/event_bus/event_publisher'
 require 'synapse/event_bus/simple_event_bus'
 require 'synapse/event_bus/wiring'

data/lib/synapse/event_sourcing/aggregate_root.rb

@@ -67,6 +67,7 @@ module Synapse
       # Creates an event with the given metadata and payload, publishes it using the event
       # container, and finally handles it locally and recursively down the aggregate.
       #
+      # @api public
       # @param [Object] payload
       # @param [Hash] metadata
       # @return [undefined]
@@ -76,10 +77,10 @@ module Synapse
           handle_recursively event
         else
           # This is a workaround for aggregates that set the aggregate identifier in an event handler
-          event = Domain::DomainEventMessage.build do |b|
-            b.metadata = metadata
-            b.payload = payload
-            b.sequence_number = 0
+          event = Domain::DomainEventMessage.build do |builder|
+            builder.metadata = metadata
+            builder.payload = payload
+            builder.sequence_number = 0
           end
 
           handle_recursively event
@@ -89,6 +90,7 @@ module Synapse
 
       # Handles the event locally and then cascades to any registered child entities
       #
+      # @api private
       # @param [DomainEventMessage] event
       # @return [undefined]
       def handle_recursively(event)

data/lib/synapse/process_manager/container_resource_injector.rb

@@ -0,0 +1,18 @@
+module Synapse
+  module ProcessManager
+    # Resource injector that uses the service container and dependency DSL to inject resources
+    class ContainerResourceInjector < ResourceInjector
+      # @param [Configuration::Container] container
+      # @return [undefined]
+      def initialize(container)
+        @container = container
+      end
+
+      # @param [Process] process
+      # @return [undefined]
+      def inject_resources(process)
+        @container.inject_into process
+      end
+    end # ContainerResourceInjector
+  end # ProcessManager
+end

data/lib/synapse/process_manager/pessimistic_lock_manager.rb

@@ -1,6 +1,6 @@
 module Synapse
   module ProcessManager
-    # Lock manager that does pessimistic locking for processes
+    # Lock manager that blocks until a lock can be obtained for a process
     class PessimisticLockManager
       def initialize
         @lock = IdentifierLock.new

data/lib/synapse/process_manager/process.rb

@@ -6,6 +6,8 @@ module Synapse
     # "maintain the state of the sequence and determine the next processing step based on
     # intermediate results" (Hohpe 279). Processes are also called sagas in some CQRS frameworks.
     #
+    # Consider using the implementation of a process that uses message wiring.
+    #
     # @abstract
     class Process
       # @return [String] The unique identifier of this process
@@ -47,6 +49,7 @@ module Synapse
 
       # Correlates this process instance with the given key and value
       #
+      # @api public
       # @param [Symbol] key
       # @param [String] value
       # @return [undefined]
@@ -56,6 +59,7 @@ module Synapse
 
       # Dissociates this process instance from the given key and value
       #
+      # @api public
       # @param [Symbol] key
       # @param [String] value
       # @return [undefined]

data/lib/synapse/process_manager/process_factory.rb

@@ -19,7 +19,7 @@ module Synapse
       # @param [Class] process_type
       # @return [Boolean]
       def supports(process_type); end
-    end
+    end # ProcessFactory
 
     # Generic implementation of a process factory that supports any process implementations that
     # have a no-argument constructor
@@ -47,6 +47,6 @@ module Synapse
         ctor = process_type.instance_method :initialize
         ctor.arity <= 0
       end
-    end
-  end
+    end # GenericProcessFactory
+  end # ProcessManager
 end

data/lib/synapse/process_manager/repository/in_memory.rb

@@ -59,5 +59,5 @@ module Synapse
         @managed_processes.count
       end
     end # InMemoryProcessRepository
-  end
+  end # ProcessManager
 end

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

@@ -15,13 +15,13 @@ module Synapse
       def handle(event)
         return unless @active
 
-        wire = self.wire_registry.wire_for event.payload_type
+        wire = wire_registry.wire_for event.payload_type
 
-        if wire
-          invoke_wire event, wire
-          finish if wire.options[:finish]
-        end
+        return unless wire
+
+        invoke_wire event, wire
+        finish if wire.options[:finish]
       end
     end # WiringProcess
-  end
+  end # ProcessManager
 end

data/lib/synapse/process_manager/wiring/process_manager.rb

@@ -1,7 +1,7 @@
 module Synapse
   module ProcessManager
     # Process manager that is aware of processes that use the wiring DSL
-    # @see [WiringProcess]
+    # @see WiringProcess
     class WiringProcessManager < ProcessManager
       # @raise [ArgumentError] If a process type is given that doesn't support the wiring DSL
       # @param [ProcessRepository] repository
@@ -44,11 +44,11 @@ module Synapse
       def extract_correlation(process_type, event)
         wire = process_type.wire_registry.wire_for event.payload_type
 
-        if wire
-          correlation_key = wire.options[:correlate]
-          if correlation_key
-            correlation_value event.payload, correlation_key
-          end
+        return unless wire
+
+        correlation_key = wire.options[:correlate]
+        if correlation_key
+          correlation_value event.payload, correlation_key
         end
       end
 
@@ -67,6 +67,6 @@ module Synapse
           Correlation.new correlation_key, value
         end
       end
-    end
-  end
+    end # WiringProcessManager
+  end # ProcessManager
 end

data/lib/synapse/process_manager.rb

@@ -8,6 +8,8 @@ require 'synapse/process_manager/process_factory'
 require 'synapse/process_manager/process_manager'
 require 'synapse/process_manager/process_repository'
 require 'synapse/process_manager/resource_injector'
+# Must be loaded after the resource injector
+require 'synapse/process_manager/container_resource_injector'
 require 'synapse/process_manager/simple_process_manager'
 
 require 'synapse/process_manager/wiring/process'

data/lib/synapse/repository/locking.rb

@@ -13,6 +13,7 @@ module Synapse
         @logger = Logging.logger[self.class]
       end
 
+      # @api public
       # @raise [AggregateNotFoundError]
       #   If the aggregate with the given identifier could not be found
       # @raise [ConflictingModificationError]
@@ -37,6 +38,7 @@ module Synapse
         end
       end
 
+      # @api public
       # @raise [ArgumentError] If the version of the aggregate is not null
       # @param [AggregateRoot] aggregate
       # @return [undefined]
@@ -69,7 +71,7 @@ module Synapse
       # @param [Integer] expected_version
       # @return [AggregateRoot]
       def perform_load(aggregate_id, expected_version); end
-    end
+    end # LockingRepository
 
     # Unit of work listener that releases the lock on an aggregate when the unit of work
     # is cleaning up
@@ -87,6 +89,6 @@ module Synapse
       def on_cleanup(unit)
         @lock_manager.release_lock @aggregate_id
       end
-    end
-  end
+    end # LockCleaningUnitOfWorkListener
+  end # Repository
 end

data/lib/synapse/repository/optimistic_lock_manager.rb

@@ -65,7 +65,7 @@ module Synapse
           end
         end
       end
-    end
+    end # OptimisticLockManager
 
     # Lock that keeps track of an aggregate's version
     # @api private
@@ -88,12 +88,7 @@ module Synapse
       def validate(aggregate)
         last_committed = aggregate.version
         if @version.nil? or @version.eql? last_committed
-          if last_committed.nil?
-            last_committed = 0
-          end
-
-          @version = last_committed + aggregate.uncommitted_event_count
-
+          @version = (last_committed or 0) + aggregate.uncommitted_event_count
           true
         else
           false

data/lib/synapse/repository/pessimistic_lock_manager.rb

@@ -1,6 +1,6 @@
 module Synapse
   module Repository
-    # Rough implementation of a pessimistic lock manager using local locks
+    # Implementation of a lock manager that blocks until a lock can be obtained
     class PessimisticLockManager < LockManager
       def initialize
         @aggregates = IdentifierLock.new
@@ -23,6 +23,6 @@ module Synapse
       def release_lock(aggregate_id)
         @aggregates.release_lock aggregate_id
       end
-    end
-  end
+    end # PessimisticLockManager
+  end # Repository
 end

data/lib/synapse/repository/repository.rb

@@ -104,6 +104,6 @@ module Synapse
       def current_unit
         @unit_provider.current
       end
-    end
-  end
+    end # Repository
+  end # Repository
 end

data/lib/synapse/repository/simple_repository.rb

@@ -0,0 +1,69 @@
+module Synapse
+  module Repository
+    # Simple repository that works with all sorts of different object mappers, including:
+    #
+    # - ActiveRecord
+    # - DataMapper
+    # - Mongoid
+    # - MongoMapper
+    #
+    # The only requirement of the model is that it properly increment the version field upon save
+    class SimpleRepository < LockingRepository
+      # @param [LockManager] lock_manager
+      # @param [Class] aggregate_type
+      # @return [undefined]
+      def initialize(lock_manager, aggregate_type)
+        super lock_manager
+
+        @aggregate_type = aggregate_type
+        @storage_listener = SimpleStorageListener.new
+      end
+
+    protected
+
+      # @raise [AggregateNotFoundError]
+      #   If the aggregate with the given identifier could not be found
+      # @raise [ConflictingModificationError]
+      #   If the expected version doesn't match the aggregate's actual version
+      # @param [Object] aggregate_id
+      # @param [Integer] expected_version
+      # @return [AggregateRoot]
+      def perform_load(aggregate_id, expected_version)
+        # Most ORMs that I can think of use #find like this -- no need for orm_adapter or anything 
+        # crazy like that
+        aggregate = @aggregate_type.find aggregate_id
+        aggregate.tap do
+          unless aggregate
+            raise AggregateNotFoundError
+          end
+
+          assert_version_expected aggregate, expected_version
+        end
+      end
+
+      # @return [Class]
+      def aggregate_type
+        @aggregate_type
+      end
+
+      # @return [StorageListener]
+      def storage_listener
+        @storage_listener
+      end
+    end # SimpleRepository
+
+    # Storage listener that simply calls #save on the aggregate, unless it has been marked for 
+    # deletion. In that case, then the #destroy method is called instead.
+    class SimpleStorageListener < UnitOfWork::StorageListener
+      # @param [AggregateRoot] aggregate
+      # @return [undefined]
+      def store(aggregate)
+        if aggregate.deleted?
+          aggregate.destroy
+        else
+          aggregate.save
+        end
+      end
+    end # SimpleStorageListener
+  end # Repository
+end

data/lib/synapse/repository.rb

@@ -6,3 +6,4 @@ require 'synapse/repository/pessimistic_lock_manager'
 
 require 'synapse/repository/repository'
 require 'synapse/repository/locking'
+require 'synapse/repository/simple_repository'

data/lib/synapse/serialization/converter/chain.rb

@@ -40,6 +40,6 @@ module Synapse
         end
         intermediate
       end
-    end
-  end
+    end # ConverterChain
+  end # Serialization
 end

data/lib/synapse/serialization/converter_factory.rb

@@ -63,6 +63,6 @@ module Synapse
           converter.source_type == source_type && converter.target_type == target_type
         end
       end
-    end
-  end
+    end # ConverterFactory
+  end # Serialization
 end

data/lib/synapse/serialization/lazy_object.rb

@@ -56,6 +56,6 @@ module Synapse
       def deserialized?
         true
       end
-    end
-  end
+    end # LazyObject
+  end # Serialization
 end

data/lib/synapse/serialization/message/serialization_aware_message.rb

@@ -55,12 +55,12 @@ module Synapse
 
       # Delegators for message attribute readers
       def_delegators :@message, :id, :metadata, :payload, :payload_type, :timestamp
-    end
+    end # SerializationAwareEventMessage
 
     # Decorator for a domain event message that adds serialization awareness
     class SerializationAwareDomainEventMessage < SerializationAwareEventMessage
       # Delegators for domain event specific attribute readers
       def_delegators :@message, :aggregate_id, :sequence_number
-    end
-  end
+    end # SerializationAwareDomainEventMessage
+  end # Serialization
 end

data/lib/synapse/serialization/message/serialized_message.rb

@@ -44,9 +44,7 @@ module Synapse
       # @param [Hash] additional_metadata
       # @return [SerializedMessage]
       def and_metadata(additional_metadata)
-        if additional_metadata.empty?
-          return self
-        end
+        return self if additional_metadata.empty?
 
         self.class.build do |builder|
           build_duplicate builder, metadata.merge(additional_metadata)
@@ -59,9 +57,7 @@ module Synapse
       # @param [Hash] replacement_metadata
       # @return [SerializedMessage]
       def with_metadata(replacement_metadata)
-        if @serialized_metadata.deserialized == replacement_metadata
-          return self
-        end
+        return self if @serialized_metadata.deserialized == replacement_metadata
 
         self.class.build do |builder|
           build_duplicate builder, replacement_metadata
@@ -126,7 +122,7 @@ module Synapse
           serializer.serialize object.deserialized, expected_type
         end
       end
-    end
+    end # SerializedMessage
 
     # Serialized representation of an event message
     class SerializedEventMessage < SerializedMessage
@@ -157,7 +153,7 @@ module Synapse
         super
         builder.timestamp = @timestamp
       end
-    end
+    end # SerializedEventMessage
 
     # Serialized representation of a domain event message
     class SerializedDomainEventMessage < SerializedEventMessage
@@ -196,6 +192,6 @@ module Synapse
         builder.aggregate_id = @aggregate_id
         builder.sequence_number = @sequence_number
       end
-    end
-  end
+    end # SerializedDomainEventMessage
+  end # Serialization
 end

data/lib/synapse/serialization/message/serialized_message_builder.rb

@@ -22,7 +22,7 @@ module Synapse
       def build
         SerializedMessage.new @id, @metadata, @payload
       end
-    end
+    end # SerializedMessageBuilder
 
     # Message builder capable of producing SerializedEventMessage instances
     class SerializedEventMessageBuilder < SerializedMessageBuilder
@@ -33,7 +33,7 @@ module Synapse
       def build
         SerializedEventMessage.new @id, @metadata, @payload, @timestamp
       end
-    end
+    end # SerializedEventMessageBuilder
 
     # Message builder capable of producing SerializedDomainEventMessage instances
     class SerializedDomainEventMessageBuilder < SerializedEventMessageBuilder
@@ -59,6 +59,6 @@ module Synapse
       def build
         SerializedDomainEventMessage.new @id, @metadata, @payload, @timestamp, @aggregate_id, @sequence_number
       end
-    end
-  end
+    end # SerializedDomainEventMessageBuilder
+  end # Serialization
 end

data/lib/synapse/serialization/message/serialized_object_cache.rb

@@ -45,6 +45,6 @@ module Synapse
           end
         end
       end
-    end
-  end
+    end # SerializedObjectCache
+  end # Serialization
 end

data/lib/synapse/serialization/message/serializer.rb

@@ -42,6 +42,6 @@ module Synapse
       # Delegators for regular serializer methods
       def_delegators :@serializer, :converter_factory, :serialize, :deserialize,
         :can_serialize_to?, :class_for, :type_for
-    end
-  end
+    end # MessageSerializer
+  end # Serialization
 end

data/lib/synapse/serialization/revision_resolver.rb

@@ -9,7 +9,7 @@ module Synapse
       # @param [Class] payload_type
       # @return [String] The revision of the given payload type
       def revision_of(payload_type); end
-    end
+    end # RevisionResolver
 
     # Implementation of a revision resolver that returns a fixed value. This could be an
     # application version number, for example
@@ -25,6 +25,6 @@ module Synapse
       def revision_of(payload_type)
         @revision.to_s
       end
-    end
-  end
+    end # FixedRevisionResolver
+  end # Serialization
 end

data/lib/synapse/serialization/serialized_object.rb

@@ -32,6 +32,6 @@ module Synapse
       def hash
         @content.hash ^ @content_type.hash ^ @type.hash
       end
-    end
-  end
+    end # SerializedObject
+  end # Serialization
 end

data/lib/synapse/serialization/serialized_type.rb

@@ -26,6 +26,6 @@ module Synapse
       def hash
         @name.hash ^ @revision.hash
       end
-    end
-  end
+    end # SerializedType
+  end # Serialization
 end

data/lib/synapse/serialization/serializer/attribute.rb

@@ -43,6 +43,6 @@ module Synapse
       def native_content_type
         Hash
       end
-    end
-  end
+    end # AttributeSerializer
+  end # Serialization
 end

data/lib/synapse/serialization/serializer/marshal.rb

@@ -27,6 +27,6 @@ module Synapse
       def native_content_type
         String
       end
-    end
-  end
+    end # MarshalSerializer
+  end # Serialization
 end