event_sourcery 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 415c43691713e1a778ed869039f81ab0af0b3d65b86a1c96805414e46bde2111
-  data.tar.gz: 623adde0b5dd6f1b850567c8485bf8204cbc5c38691ead0f9b3f5f947faa6fc0
+  metadata.gz: 234ed8cdde83e87e565f51aa4dd25eb985e5ebf0f3f86997545a1b8cda3b45a1
+  data.tar.gz: 59e13d2ab9cba68104ad24567f54a5b7393939282e8112313094993fff2276ca
 SHA512:
-  metadata.gz: 6fdc34b508b5f3031eaabda5cce803d112e577e585f73716f0a29d3f7d6f5b3fb35f9fee4bd27e732ff5a05f7c0235313f3c08f6edc091a71ff0e253bb5f5f48
-  data.tar.gz: d3bd692067e4231ddbf4cbdc8a8de01dc4ce60963adc25166b052a3552e982563b76b4225606d1c18d7333e6c28dc97a9378faf9ae71a02da2f638c4012b7552
+  metadata.gz: d89cc4d55dd4609a6fd8b02f1fb062f25ee41132ab8ec3cff44fd11d319d8878f9a2bfdfc801100dbd2b257ab0fe58dde9eb8d9548b77012109ca7d2efa8554f
+  data.tar.gz: bb2ab3cfa3300db9f5a770cc4ffdb59ef878077d612bfe1b6dbde1359c9a8940bb9ac6d2af799ba93fd77c44b5d6a9cb85f3a3eaef491d38a33e4f76ccedb952

data/CHANGELOG.md

@@ -7,16 +7,25 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/envato/event_sourcery/compare/v1.0.3...HEAD
+[Unreleased]: https://github.com/envato/event_sourcery/compare/v1.0.4...HEAD
+
+## [1.0.4] - 2026-01-17
+
+### Changed
+
+- Resolve issues as identified by RuboCop ([#248]).
+
+[1.0.4]: https://github.com/envato/event_sourcery/compare/v1.0.3...v1.0.4
+[#248]: https://github.com/envato/event_sourcery/pull/248
 
 ## [1.0.3] - 2025-12-29
 
 ### Changed
 
-- Resolve issues as identified by RuboCop ([#245]).
+- Resolve issues as identified by RuboCop ([#246]).
 
 [1.0.3]: https://github.com/envato/event_sourcery/compare/v1.0.2...v1.0.3
-[#245]: https://github.com/envato/event_sourcery/pull/245
+[#246]: https://github.com/envato/event_sourcery/pull/246
 
 ## [1.0.2] - 2025-12-28
 

data/event_sourcery.gemspec

@@ -12,13 +12,13 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Event Sourcing Library'
   spec.description   = ''
-  spec.homepage      = 'https://github.com/envato/event_sourcery'
+  spec.homepage      = "https://github.com/envato/#{spec.name}"
   spec.license       = 'MIT'
   spec.metadata      = {
     'allowed_push_host' => 'https://rubygems.org',
     'bug_tracker_uri' => "#{spec.homepage}/issues",
     'changelog_uri' => "#{spec.homepage}/blob/HEAD/CHANGELOG.md",
-    'documentation_uri' => "https://www.rubydoc.info/gems/event_sourcery/#{spec.version}",
+    'documentation_uri' => "https://www.rubydoc.info/gems/#{spec.name}/#{spec.version}",
     'source_code_uri' => "#{spec.homepage}/tree/v#{spec.version}"
   }
 

data/lib/event_sourcery/aggregate_root.rb

@@ -64,6 +64,7 @@ module EventSourcery
       end
     end
 
+    # Class methods for aggregate root event handling configuration.
     module ClassMethods
       # Collection of event handlers for the events that this aggregate cares about
       #

data/lib/event_sourcery/config.rb

@@ -3,6 +3,7 @@
 require 'logger'
 
 module EventSourcery
+  # Configuration settings for EventSourcery.
   class Config
     # The default Proc to be run when an aggregate loads an event type that
     # it doesn't know how to handle.

data/lib/event_sourcery/errors.rb

@@ -7,10 +7,12 @@ module EventSourcery
   AtomicWriteToMultipleAggregatesNotSupported = Class.new(Error)
   MultipleCatchAllHandlersDefined = Class.new(Error)
 
+  # Error raised when event processing fails with contextual information.
   class EventProcessingError < Error
     attr_reader :event, :processor
 
     def initialize(event:, processor:)
+      super()
       @event = event
       @processor = processor
     end

data/lib/event_sourcery/event_processing/error_handlers/error_handler.rb

@@ -3,6 +3,7 @@
 module EventSourcery
   module EventProcessing
     module ErrorHandlers
+      # Base module for error handling strategies in event processing.
       module ErrorHandler
         # The default with_error_handling method. Will always raise NotImplementedError
         #

data/lib/event_sourcery/event_processing/error_handlers/exponential_backoff_retry.rb

@@ -3,6 +3,7 @@
 module EventSourcery
   module EventProcessing
     module ErrorHandlers
+      # Error handler that retries with exponentially increasing delays.
       class ExponentialBackoffRetry
         include EventSourcery::EventProcessing::ErrorHandlers::ErrorHandler
 

data/lib/event_sourcery/event_processing/error_handlers/no_retry.rb

@@ -3,6 +3,7 @@
 module EventSourcery
   module EventProcessing
     module ErrorHandlers
+      # Error handler that exits the process on error without retrying.
       class NoRetry
         include EventSourcery::EventProcessing::ErrorHandlers::ErrorHandler
         def initialize(processor_name:)

data/lib/event_sourcery/event_processing/esp_process.rb

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module EventProcessing
+    # Manages the lifecycle of an event stream processor in a dedicated process.
     class ESPProcess
       DEFAULT_AFTER_FORK = ->(event_processor) {}
 
@@ -25,7 +26,7 @@ module EventSourcery
           subscribe_to_event_stream
           EventSourcery.logger.info("Stopping #{processor_name}")
         end
-      rescue Exception => e
+      rescue Exception => e # rubocop:disable Lint/RescueException
         EventSourcery.logger.fatal("An unhandled exception occurred in #{processor_name}")
         EventSourcery.logger.fatal(e)
         EventSourcery.config.on_event_processor_critical_error.call(e, processor_name)

data/lib/event_sourcery/event_processing/event_stream_processor.rb

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module EventProcessing
+    # Module for processing streams of events with customisable handlers.
     module EventStreamProcessor
       def self.included(base)
         base.extend(ClassMethods)
@@ -14,12 +15,14 @@ module EventSourcery
         end
       end
 
+      # Instance methods for event stream processors.
       module InstanceMethods
         def initialize(tracker:)
           @tracker = tracker
         end
       end
 
+      # Handles the processing of individual events with error handling.
       module ProcessHandler
         # Handler that processes the given event.
         #
@@ -38,6 +41,7 @@ module EventSourcery
         end
       end
 
+      # Class methods for configuring event stream processors.
       module ClassMethods
         # @attr_reader processes_event_types [Array] Process Event Types
         # @attr_reader event_handlers [Hash] Hash of handler blocks keyed by event

data/lib/event_sourcery/event_processing/event_stream_processor_registry.rb

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module EventProcessing
+    # Registry for managing event stream processor classes.
     class EventStreamProcessorRegistry
       def initialize
         @processors = []

data/lib/event_sourcery/event_store/each_by_range.rb

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module EventStore
+    # Provides iteration over events within a specified range.
     module EachByRange
       def each_by_range(from_event_id, to_event_id, event_types: nil)
         caught_up = false

data/lib/event_sourcery/event_store/event_builder.rb

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module EventStore
+    # Builds event objects from serialised event data.
     class EventBuilder
       def initialize(event_type_serializer:)
         @event_type_serializer = event_type_serializer

data/lib/event_sourcery/event_store/event_sink.rb

@@ -4,6 +4,7 @@ require 'forwardable'
 
 module EventSourcery
   module EventStore
+    # Delegates event storage operations to the underlying event store.
     class EventSink
       def initialize(event_store)
         @event_store = event_store

data/lib/event_sourcery/event_store/event_source.rb

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module EventStore
+    # Delegates event retrieval operations to the underlying event store.
     class EventSource
       def initialize(event_store)
         @event_store = event_store

data/lib/event_sourcery/event_store/event_type_serializers/underscored.rb

@@ -9,6 +9,7 @@ module EventSourcery
       # Replace inflector with ActiveSupport like this:
       # EventSourcery::EventStore::EventTypeSerializers::Underscored.inflector = ActiveSupport::Inflector
       class Underscored
+        # Provides string inflection methods for converting between formats.
         class Inflector
           # Inflection methods are taken from active support 3.2
           # https://github.com/rails/rails/blob/3-2-stable/activesupport/lib/active_support/inflector/methods.rb
@@ -22,7 +23,7 @@ module EventSourcery
             word
           end
 
-          def camelize(term, uppercase_first_letter = true)
+          def camelize(term, uppercase_first_letter = true) # rubocop:disable Style/OptionalBooleanParameter
             string = term.to_s
             string =
               if uppercase_first_letter

data/lib/event_sourcery/memory/config.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module EventSourcery
+  # In-memory implementation for testing and development.
   module Memory
+    # Configuration for in-memory event sourcing components.
     class Config
       attr_accessor :event_tracker
       attr_writer :event_store, :event_source, :event_sink

data/lib/event_sourcery/memory/projector.rb

@@ -2,6 +2,7 @@
 
 module EventSourcery
   module Memory
+    # Provides projection functionality for in-memory event processing.
     module Projector
       def self.included(base)
         base.include(EventSourcery::EventProcessing::EventStreamProcessor)
@@ -15,6 +16,7 @@ module EventSourcery
         end
       end
 
+      # Instance methods for in-memory projectors.
       module InstanceMethods
         def initialize(tracker: EventSourcery::Memory.config.event_tracker)
           @tracker = tracker

data/lib/event_sourcery/version.rb

@@ -2,5 +2,5 @@
 
 module EventSourcery
   # The version of the EventSourcery gem
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/lib/event_sourcery.rb

@@ -34,6 +34,7 @@ require 'event_sourcery/memory/event_store'
 require 'event_sourcery/memory/config'
 require 'event_sourcery/memory/projector'
 
+# Event sourcing framework for Ruby applications.
 module EventSourcery
   # Configure EventSourcery
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_sourcery
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Envato
@@ -157,8 +157,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/envato/event_sourcery/issues
   changelog_uri: https://github.com/envato/event_sourcery/blob/HEAD/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/event_sourcery/1.0.3
-  source_code_uri: https://github.com/envato/event_sourcery/tree/v1.0.3
+  documentation_uri: https://www.rubydoc.info/gems/event_sourcery/1.0.4
+  source_code_uri: https://github.com/envato/event_sourcery/tree/v1.0.4
 rdoc_options: []
 require_paths:
 - lib
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.4
 specification_version: 4
 summary: Event Sourcing Library
 test_files: []