synapse-core 0.1.2

data/lib/synapse.rb

@@ -0,0 +1,351 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'eventmachine'
+require 'logging'
+require 'set'
+
+require 'synapse/version'
+
+module Synapse
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload_at 'synapse/errors' do
+      autoload :SynapseError
+      autoload :ConfigurationError
+      autoload :NonTransientError
+      autoload :TransientError
+    end
+
+    autoload_at 'synapse/identifier' do
+      autoload :IdentifierFactory
+      autoload :GuidIdentifierFactory
+    end
+
+    autoload :Message
+    autoload :MessageBuilder
+
+    autoload_at 'synapse/duplication' do
+      autoload :DuplicationError
+      autoload :DuplicationRecorder
+    end
+  end
+
+  module Command
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload :CommandBus
+      autoload :SimpleCommandBus
+
+      autoload :CommandCallback
+      autoload :CommandFilter
+      autoload :CommandHandler
+
+      autoload_at 'synapse/command/message' do
+        autoload :CommandMessage
+        autoload :CommandMessageBuilder
+      end
+
+      autoload :CommandGateway, 'synapse/command/gateway'
+
+      autoload :DispatchInterceptor
+      autoload :InterceptorChain
+
+      autoload_at 'synapse/command/duplication' do
+        autoload :DuplicationFilter
+        autoload :DuplicationCleanupInterceptor
+      end
+
+      autoload_at 'synapse/command/errors' do
+        autoload :CommandExecutionError
+        autoload :CommandValidationError
+        autoload :NoHandlerError
+      end
+
+      autoload_at 'synapse/command/filters/validation' do
+        autoload :ActiveModelValidationFilter
+        autoload :ActiveModelValidationError
+      end
+
+      autoload_at 'synapse/command/interceptors/serialization' do
+        autoload :SerializationOptimizingInterceptor
+        autoload :SerializationOptimizingListener
+      end
+
+      autoload_at 'synapse/command/rollback_policy' do
+        autoload :RollbackPolicy
+        autoload :RollbackOnAnyExceptionPolicy
+      end
+
+      autoload :WiringCommandHandler, 'synapse/command/wiring'
+    end
+  end
+
+  module Domain
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload_at 'synapse/domain/aggregate_root' do
+        autoload :AggregateRoot
+        autoload :AggregateIdentifierNotInitializedError
+      end
+
+      autoload :EventContainer
+
+      autoload_at 'synapse/domain/message' do
+        autoload :EventMessage
+        autoload :DomainEventMessage
+      end
+
+      autoload_at 'synapse/domain/message_builder' do
+        autoload :EventMessageBuilder
+        autoload :DomainEventMessageBuilder
+      end
+
+      autoload_at 'synapse/domain/stream' do
+        autoload :DomainEventStream
+        autoload :EndOfStreamError
+        autoload :SimpleDomainEventStream
+      end
+    end
+  end
+
+  module EventBus
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload_at 'synapse/event_bus/event_bus' do
+        autoload :EventBus
+        autoload :SubscriptionFailedError
+      end
+
+      autoload :EventListener
+      autoload :EventListenerProxy
+      autoload :SimpleEventBus
+      autoload :WiringEventListener, 'synapse/event_bus/wiring'
+    end
+  end
+
+  module EventSourcing
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload_at 'synapse/event_sourcing/aggregate_factory' do
+        autoload :AggregateFactory
+        autoload :GenericAggregateFactory
+      end
+
+      autoload :AggregateRoot
+      autoload :Entity
+      autoload :Member
+
+      autoload :EventSourcingRepository, 'synapse/event_sourcing/repository'
+      autoload :EventSourcedStorageListener, 'synapse/event_sourcing/storage_listener'
+      autoload :EventStreamDecorator, 'synapse/event_sourcing/stream_decorator'
+
+      autoload_at 'synapse/event_sourcing/conflict_resolver' do
+        autoload :ConflictResolver
+        autoload :ConflictResolvingUnitOfWorkListener
+        autoload :CapturingEventStream
+      end
+
+      autoload_at 'synapse/event_sourcing/snapshot/taker' do
+        autoload :AggregateSnapshotTaker
+        autoload :DeferredSnapshotTaker
+        autoload :SnapshotTaker
+      end
+
+      autoload_at 'synapse/event_sourcing/snapshot/count_stream' do
+        autoload :CountingEventStream
+        autoload :TriggeringEventStream
+        autoload :SnapshotUnitOfWorkListener
+      end
+
+      autoload :EventCountSnapshotTrigger, 'synapse/event_sourcing/snapshot/count_trigger'
+    end
+  end
+
+  module EventStore
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload_at 'synapse/event_store/errors' do
+        autoload :EventStoreError
+        autoload :StreamNotFoundError
+      end
+
+      autoload_at 'synapse/event_store/event_store' do
+        autoload :EventStore
+        autoload :SnapshotEventStore
+      end
+    end
+
+    autoload :InMemoryEventStore, 'synapse/event_store/in_memory'
+
+    module Mongo
+      extend ActiveSupport::Autoload
+
+      autoload :CursorDomainEventStream, 'synapse/event_store/mongo/cursor_event_stream'
+      autoload :MongoEventStore, 'synapse/event_store/mongo/event_store'
+      autoload :DocumentPerEventStrategy, 'synapse/event_store/mongo/per_event_strategy'
+      autoload :DocumentPerCommitStrategy, 'synapse/event_store/mongo/per_commit_strategy'
+      autoload :StorageStrategy, 'synapse/event_store/mongo/storage_strategy'
+
+      autoload_at 'synapse/event_store/mongo/template' do
+        autoload :MongoTemplate
+        autoload :DefaultMongoTemplate
+      end
+    end
+  end
+
+  module ProcessManager
+    extend ActiveSupport::Autoload
+
+    autoload :Correlation
+    autoload :CorrelationResolver
+    autoload :CorrelationSet
+
+    autoload :Process
+  end
+
+  module Repository
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload_at 'synapse/repository/errors' do
+        autoload :AggregateNotFoundError
+        autoload :ConcurrencyError
+        autoload :ConflictingAggregateVersionError
+        autoload :ConflictingModificationError
+      end
+
+      autoload :LockManager
+      autoload :PessimisticLockManager
+
+      autoload_at 'synapse/repository/locking' do
+        autoload :LockingRepository
+        autoload :LockCleaningUnitOfWorkListener
+      end
+
+      autoload :Repository
+    end
+  end
+
+  module Serialization
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload :Converter
+      autoload :ConverterFactory,  'synapse/serialization/converter/factory'
+      autoload :IdentityConverter, 'synapse/serialization/converter/identity'
+
+      autoload_at 'synapse/serialization/errors' do
+        autoload :ConversionError
+        autoload :SerializationError
+        autoload :UnknownSerializedTypeError
+      end
+
+      autoload_at 'synapse/serialization/lazy_object' do
+        autoload :DeserializedObject
+        autoload :LazyObject
+      end
+
+      autoload_at 'synapse/serialization/revision_resolver' do
+        autoload :RevisionResolver
+        autoload :FixedRevisionResolver
+      end
+
+      autoload :SerializedDomainEventData, 'synapse/serialization/message/data'
+      autoload :MessageSerializer, 'synapse/serialization/message/serializer'
+      autoload :SerializedMetadata, 'synapse/serialization/message/metadata'
+      autoload :SerializationAware, 'synapse/serialization/message/serialization_aware'
+      autoload :SerializedObjectCache, 'synapse/serialization/message/serialized_object_cache'
+
+      autoload_at 'synapse/serialization/message/serialization_aware_message' do
+        autoload :SerializationAwareEventMessage
+        autoload :SerializationAwareDomainEventMessage
+      end
+
+      autoload_at 'synapse/serialization/message/serialized_message' do
+        autoload :SerializedMessage
+        autoload :SerializedEventMessage
+        autoload :SerializedDomainEventMessage
+      end
+
+      autoload_at 'synapse/serialization/message/serialized_message_builder' do
+        autoload :SerializedMessageBuilder
+        autoload :SerializedEventMessageBuilder
+        autoload :SerializedDomainEventMessageBuilder
+      end
+
+      autoload :Serializer
+      autoload :SerializedObject
+      autoload :SerializedType
+    end
+
+    autoload_at 'synapse/serialization/converter/json' do
+      autoload :JsonToObjectConverter
+      autoload :ObjectToJsonConverter
+    end
+
+    autoload_at 'synapse/serialization/converter/ox' do
+      autoload :XmlToOxDocumentConverter
+      autoload :OxDocumentToXmlConverter
+    end
+
+    autoload :OjSerializer, 'synapse/serialization/serializer/oj'
+    autoload :OxSerializer, 'synapse/serialization/serializer/ox'
+    autoload :MarshalSerializer, 'synapse/serialization/serializer/marshal'
+  end
+
+  module UnitOfWork
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload_at 'synapse/uow/nesting' do
+        autoload :NestableUnitOfWork
+        autoload :OuterCommitUnitOfWorkListener
+      end
+
+      autoload :StorageListener, 'synapse/uow/storage_listener'
+      autoload :TransactionManager, 'synapse/uow/transaction_manager'
+      autoload :UnitOfWork, 'synapse/uow/uow'
+      autoload :UnitOfWorkFactory, 'synapse/uow/factory'
+      autoload :UnitOfWorkListener, 'synapse/uow/listener'
+      autoload :UnitOfWorkListenerCollection, 'synapse/uow/listener_collection'
+      autoload :UnitOfWorkProvider, 'synapse/uow/provider'
+    end
+  end
+
+  module Upcasting
+    extend ActiveSupport::Autoload
+
+    autoload :SingleUpcaster
+    autoload :Upcaster
+    autoload :UpcasterChain, 'synapse/upcasting/chain'
+
+    autoload_at 'synapse/upcasting/context' do
+      autoload :UpcastingContext
+      autoload :SerializedDomainEventUpcastingContext
+    end
+
+    autoload :UpcastSerializedDomainEventData, 'synapse/upcasting/data'
+  end
+
+  module Wiring
+    extend ActiveSupport::Autoload
+
+    autoload :MessageWiring
+    autoload :Wire
+    autoload :WireRegistry
+  end
+
+  # TODO this is more of an application call
+  ActiveSupport::Autoload.eager_autoload!
+
+  # Setup the default identifier factory
+  ActiveSupport.on_load :identifier_factory  do
+    IdentifierFactory.instance = GuidIdentifierFactory.new
+  end
+end

data/lib/synapse/command/command_bus.rb

@@ -0,0 +1,45 @@
+module Synapse
+  module Command
+    # Represents a mechanism for dispatching commands to their appropriate handlers
+    #
+    # Command handlers can subscribe and unsubscribe to different command types. Only a single
+    # handler can be subscribed for a command type at one time.
+    #
+    # Implementations can choose to dispatch commands in the calling thread or in another thread.
+    #
+    # @abstract
+    class CommandBus
+      # Dispatches the given command to the handler subscribed to its type
+      #
+      # @abstract
+      # @param [CommandMessage] command
+      # @return [undefined]
+      def dispatch(command); end
+
+      # Dispatches the given command to the handler subscribed to its type and notifies the
+      # given callback of the outcome of the dispatch
+      #
+      # @abstract
+      # @param [CommandMessage] command
+      # @param [CommandCallback] callback
+      # @return [undefined]
+      def dispatch_with_callback(command, callback); end
+
+      # Subscribes the given handler to the given command type, replacing the currently subscribed
+      # handler, if any.
+      #
+      # @param [Class] command_type
+      # @param [CommandHandler] handler
+      # @return [undefined]
+      def subscribe(command_type, handler); end
+
+      # Unsubscribes the given handler from the given command type, if it is currently subscribed
+      # to the given command type.
+      #
+      # @param [Class] command_type
+      # @param [CommandHandler] handler
+      # @return [undefined]
+      def unsubscribe(command_type, handler); end
+    end
+  end
+end

data/lib/synapse/command/command_callback.rb

@@ -0,0 +1,18 @@
+module Synapse
+  module Command
+    # Callback that is notified of the outcome of the dispatch of a command
+    class CommandCallback
+      # Called when a dispatch is successful
+      #
+      # @param [Object] result The result from the command handler
+      # @return [undefined]
+      def on_success(result); end
+
+      # Called when a dispatch fails due to an exception
+      #
+      # @param [Exception] exception The cause of the failure
+      # @return [undefined]
+      def on_failure(exception); end
+    end
+  end
+end

data/lib/synapse/command/command_filter.rb

@@ -0,0 +1,17 @@
+module Synapse
+  module Command
+    # Represents a mechanism for validating or modifying commands before they are dispatched on
+    # the command bus. This filtering is done very early in the dispatch process, before a unit of
+    # work is created for the dispatch.
+    #
+    # @abstract
+    class CommandFilter
+      # Called when a command is preparing to be dispatched on the command bus
+      #
+      # @abstract
+      # @param [CommandMessage] command
+      # @return [CommandMessage] The command to dispatch on the bus
+      def filter(command); end
+    end
+  end
+end

data/lib/synapse/command/command_handler.rb

@@ -0,0 +1,13 @@
+module Synapse
+  module Command
+    # Mixin for an object capable of handling commands
+    module CommandHandler
+      # Handles the given command
+      #
+      # @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
+end

data/lib/synapse/command/dispatch_interceptor.rb

@@ -0,0 +1,16 @@
+module Synapse
+  module Command
+    # Interceptor wrapping a command dispatch that can add custom behavior before or after a
+    # command is dispatched to a command handler
+    #
+    # @abstract
+    class DispatchInterceptor
+      # @abstract
+      # @param [CommandMessage] command
+      # @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
+end