Merge pull request #248 from envato/rubocop

orien · web-flow · commit e0d939ac6b94 · 2026-01-17T20:50:59.000+07:00
Resolve issues identified by RuboCop
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,4 +1,18 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
 inherit_from: .rubocop_todo.yml
+inherit_mode:
+  merge:
+    - Exclude
 
 AllCops:
   NewCops: disable
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -6,15 +6,6 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Configuration parameters: AllowedParentClasses.
-Lint/MissingSuper:
-  Exclude:
-    - 'lib/event_sourcery/errors.rb'
-
-Lint/RescueException:
-  Exclude:
-    - 'lib/event_sourcery/event_processing/esp_process.rb'
-
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
 # NotImplementedExceptions: NotImplementedError
@@ -33,7 +24,6 @@ Metrics/AbcSize:
 # AllowedMethods: refine
 Metrics/BlockLength:
   Exclude:
-    - '**/*.gemspec'
     - 'lib/event_sourcery/rspec/event_store_shared_examples.rb'
     - 'spec/event_sourcery/aggregate_root_spec.rb'
     - 'spec/event_sourcery/event_body_serializer_spec.rb'
@@ -80,36 +70,3 @@ Metrics/ParameterLists:
     - 'lib/event_sourcery/event.rb'
     - 'lib/event_sourcery/event_processing/esp_runner.rb'
     - 'lib/event_sourcery/event_store/subscription.rb'
-
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/event_sourcery.rb'
-    - 'lib/event_sourcery/aggregate_root.rb'
-    - 'lib/event_sourcery/config.rb'
-    - 'lib/event_sourcery/errors.rb'
-    - 'lib/event_sourcery/event_processing/error_handlers/error_handler.rb'
-    - 'lib/event_sourcery/event_processing/error_handlers/exponential_backoff_retry.rb'
-    - 'lib/event_sourcery/event_processing/error_handlers/no_retry.rb'
-    - 'lib/event_sourcery/event_processing/esp_process.rb'
-    - 'lib/event_sourcery/event_processing/event_stream_processor.rb'
-    - 'lib/event_sourcery/event_processing/event_stream_processor_registry.rb'
-    - 'lib/event_sourcery/event_store/each_by_range.rb'
-    - 'lib/event_sourcery/event_store/event_builder.rb'
-    - 'lib/event_sourcery/event_store/event_sink.rb'
-    - 'lib/event_sourcery/event_store/event_source.rb'
-    - 'lib/event_sourcery/event_store/event_type_serializers/underscored.rb'
-    - 'lib/event_sourcery/memory/config.rb'
-    - 'lib/event_sourcery/memory/projector.rb'
-
-Style/MultilineBlockChain:
-  Exclude:
-    - 'lib/event_sourcery/event_store/event_type_serializers/underscored.rb'
-
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: respond_to_missing?
-Style/OptionalBooleanParameter:
-  Exclude:
-    - 'lib/event_sourcery/event_store/event_type_serializers/underscored.rb'
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,16 @@ 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
 
diff --git a/event_sourcery.gemspec b/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}"
   }
 
diff --git a/lib/event_sourcery.rb b/lib/event_sourcery.rb
@@ -34,6 +34,7 @@
 require 'event_sourcery/memory/config'
 require 'event_sourcery/memory/projector'
 
+# Event sourcing framework for Ruby applications.
 module EventSourcery
   # Configure EventSourcery
   #
diff --git a/lib/event_sourcery/aggregate_root.rb b/lib/event_sourcery/aggregate_root.rb
@@ -64,6 +64,7 @@ def self.included(base)
       end
     end
 
+    # Class methods for aggregate root event handling configuration.
     module ClassMethods
       # Collection of event handlers for the events that this aggregate cares about
       #
diff --git a/lib/event_sourcery/config.rb b/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.
diff --git a/lib/event_sourcery/errors.rb b/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
diff --git a/lib/event_sourcery/event_processing/error_handlers/error_handler.rb b/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
         #
diff --git a/lib/event_sourcery/event_processing/error_handlers/exponential_backoff_retry.rb b/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
 
diff --git a/lib/event_sourcery/event_processing/error_handlers/no_retry.rb b/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:)
diff --git a/lib/event_sourcery/event_processing/esp_process.rb b/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 @@ def start
           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)
diff --git a/lib/event_sourcery/event_processing/event_stream_processor.rb b/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 @@ def self.included(base)
         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 @@ def process(event)
         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
diff --git a/lib/event_sourcery/event_processing/event_stream_processor_registry.rb b/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 = []
diff --git a/lib/event_sourcery/event_store/each_by_range.rb b/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
diff --git a/lib/event_sourcery/event_store/event_builder.rb b/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
diff --git a/lib/event_sourcery/event_store/event_sink.rb b/lib/event_sourcery/event_store/event_sink.rb
@@ -4,6 +4,7 @@
 
 module EventSourcery
   module EventStore
+    # Delegates event storage operations to the underlying event store.
     class EventSink
       def initialize(event_store)
         @event_store = event_store
diff --git a/lib/event_sourcery/event_store/event_source.rb b/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
diff --git a/lib/event_sourcery/event_store/event_type_serializers/underscored.rb b/lib/event_sourcery/event_store/event_type_serializers/underscored.rb
@@ -9,6 +9,7 @@ module EventTypeSerializers
       # 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 @@ def underscore(camel_cased_word)
             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
diff --git a/lib/event_sourcery/memory/config.rb b/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
diff --git a/lib/event_sourcery/memory/projector.rb b/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 @@ class << self
         end
       end
 
+      # Instance methods for in-memory projectors.
       module InstanceMethods
         def initialize(tracker: EventSourcery::Memory.config.event_tracker)
           @tracker = tracker
diff --git a/lib/event_sourcery/version.rb b/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

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@`
`34`	`34`	`require 'event_sourcery/memory/config'`
`35`	`35`	`require 'event_sourcery/memory/projector'`
`36`	`36`
	`37`	`+# Event sourcing framework for Ruby applications.`
`37`	`38`	`module EventSourcery`
`38`	`39`	`# Configure EventSourcery`
`39`	`40`	`#`
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,7 @@ def self.included(base)`
`64`	`64`	`end`
`65`	`65`	`end`
`66`	`66`
	`67`	`+ # Class methods for aggregate root event handling configuration.`
`67`	`68`	`module ClassMethods`
`68`	`69`	`# Collection of event handlers for the events that this aggregate cares about`
`69`	`70`	`#`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`module EventSourcery`
`4`	`4`	`module EventProcessing`
`5`	`5`	`module ErrorHandlers`
	`6`	`+ # Base module for error handling strategies in event processing.`
`6`	`7`	`module ErrorHandler`
`7`	`8`	`# The default with_error_handling method. Will always raise NotImplementedError`
`8`	`9`	`#`