lib/event_sourcery.rb in event_sourcery-0.14.0 vs lib/event_sourcery.rb in event_sourcery-0.15.0

@@ -27,23 +27,51 @@
 require 'event_sourcery/event_body_serializer'
 require 'event_sourcery/aggregate_root'
 require 'event_sourcery/repository'
 require 'event_sourcery/memory/tracker'
 require 'event_sourcery/memory/event_store'
+require 'event_sourcery/memory/config'
+require 'event_sourcery/memory/projector'
 
 module EventSourcery
+  # Configure EventSourcery
+  #
+  # @example
+  #   EventSourcery.configure do |config|
+  #     # Add custom reporting of errors occurring during event processing.
+  #     # One might set up an error reporting service like Rollbar here.
+  #     config.on_event_processor_error = proc { |exception, processor_name| … }
+  #
+  #     # Enable Event Sourcery logging.
+  #     config.logger = Logger.new('logs/my_event_sourcery_app.log')
+  #
+  #     # Customize how event body attributes are serialized
+  #     config.event_body_serializer
+  #       .add(BigDecimal) { |decimal| decimal.to_s('F') }
+  #
+  #     # Config how you want to handle event processing errors
+  #     config.error_handler_class = EventSourcery::EventProcessing::ErrorHandlers::ExponentialBackoffRetry
+  #   end
+  #
+  # @see Config
   def self.configure
     yield config
   end
 
   def self.config
     @config ||= Config.new
   end
 
+  # Logger object used by EventSourcery. Set via `configure`.
+  #
+  # @see Config.logger
   def self.logger
     config.logger
   end
 
+  # Registry of all Event Stream Processors
+  #
+  # @return EventProcessing::EventStreamProcessorRegistry
   def self.event_stream_processor_registry
     @event_stream_processor_registry ||= EventProcessing::EventStreamProcessorRegistry.new
   end
 end