event_sourcery 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c501d64a75ded41a08829c20ccf9bf9368c9227b7381023d7d2fe0d502ee8003
-  data.tar.gz: 22eb6a9e837155b0315377873e7bb17cf6dadb75ef402c78a47ae9ae1c71e5ba
+  metadata.gz: 819d971e975a4fb5a0db2f5b6e7f7605af8d65448125b292ec62854fa0024162
+  data.tar.gz: 363d610db1c8c11d04bf815acae6447d7367a006f76cf03388f4cde2e6d76d32
 SHA512:
-  metadata.gz: a3251f8d9966e191485a24c582ab616c39d2383caa551ea0efcc988eacf08c52104cd0b7a1121c210dbde2975d3becc4f210b93a964bf08a3fc46accfbf0109f
-  data.tar.gz: c621abddc5fa626fbc0fa02d0be371d25f18ed97d78f4f43c29f9fc6ffa460e6f698f0eccf55f1b9d61a2e0dddb8ec2036905b8e67c876fc9fe7962dfc73783f
+  metadata.gz: e6c1d51e23d2d11efb4002e0350c5458fcefb3d8cc40a7e4a660d8b8064b7b887d68311615d4913f80af3a104560669f8769f4bfbca4a826e10f5b8fe1303d5d
+  data.tar.gz: c9c68fd9366316f52f4774f69aac877e0a69d92280e5f4c297eb6e31e07d5572e075624e0835bb6dedc5a89cfb08e9ac257964f30d2ab20d8627ba679815e306

data/CHANGELOG.md

@@ -7,11 +7,37 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+[Unreleased]: https://github.com/envato/event_sourcery/compare/v1.0.2...HEAD
+
+## [1.0.2] - 2025-12-28
+
+### Changed
+
+- Minor fixups in gem metadata ([#240]).
+- Resolve issues as identified by RuboCop ([#241], [#244]).
+- Removed support for older Ruby versions: Ruby 2.6 or greater is now required ([#243]).
+
+[1.0.2]: https://github.com/envato/event_sourcery/compare/v1.0.1...v1.0.2
+[#240]: https://github.com/envato/event_sourcery/pull/240
+[#241]: https://github.com/envato/event_sourcery/pull/241
+[#243]: https://github.com/envato/event_sourcery/pull/243
+[#244]: https://github.com/envato/event_sourcery/pull/244
+
+## [1.0.1] - 2025-12-27
+
+### Changed
+
+- Support Ruby 4.0, make `logger` dependency explicit ([#239])
+
+[1.0.1]: https://github.com/envato/event_sourcery/compare/v1.0.0...v1.0.1
+[#239]: https://github.com/envato/event_sourcery/pull/239
+
 ## [1.0.0] - 2023-11-29
 
 ### Removed
 - Removed Event.persisted? as it was potentially misleading ([#235])
 
+[1.0.0]: https://github.com/envato/event_sourcery/compare/v0.24.0...v1.0.0
 [#235]: https://github.com/envato/event_sourcery/pull/235
 
 ## [0.24.0] - 2021-11-18
@@ -261,8 +287,6 @@ moving all Postgres related code into a separate gem.
 - EventSourcery no longer depends on Virtus.
 - `Command` and `CommandHandler` have been removed.
 
-[Unreleased]: https://github.com/envato/event_sourcery/compare/v0.24.0...HEAD
-[1.0.0]: https://github.com/envato/event_sourcery/compare/v0.24.0...v1.0.0
 [0.24.0]: https://github.com/envato/event_sourcery/compare/v0.23.1...v0.24.0
 [0.23.1]: https://github.com/envato/event_sourcery/compare/v0.23.0...v0.23.1
 [0.23.0]: https://github.com/envato/event_sourcery/compare/v0.22.0...v0.23.0

data/README.md

@@ -1,6 +1,6 @@
 # EventSourcery
 
-[![Build Status](https://github.com/envato/event_sourcery/workflows/tests/badge.svg?branch=main)](https://github.com/envato/event_sourcery/actions?query=workflow%3Atests+branch%3Amain)
+[![Build Status](https://github.com/envato/event_sourcery/actions/workflows/test.yml/badge.svg)](https://github.com/envato/event_sourcery/actions/workflows/test.yml)
 
 A framework for building event sourced, CQRS applications.
 
@@ -34,7 +34,7 @@ A framework for building event sourced, CQRS applications.
 
 ## Development Status
 
-[![Build Status](https://github.com/envato/event_sourcery/workflows/tests/badge.svg?branch=main)](https://github.com/envato/event_sourcery/actions?query=branch%3Amain)
+[![Build Status](https://github.com/envato/event_sourcery/actions/workflows/test.yml/badge.svg)](https://github.com/envato/event_sourcery/actions/workflows/test.yml)
 
 Event Sourcery is in production use at [Envato](http://envato.com).
 

data/event_sourcery.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'event_sourcery/version'
 
@@ -12,22 +11,30 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Event Sourcing Library'
   spec.description   = ''
   spec.homepage      = 'https://github.com/envato/event_sourcery'
+  spec.license       = 'MIT'
   spec.metadata      = {
-                         'bug_tracker_uri' => 'https://github.com/envato/event_sourcery/issues',
-                         'changelog_uri'   => 'https://github.com/envato/event_sourcery/blob/HEAD/CHANGELOG.md',
-                         'source_code_uri' => 'https://github.com/envato/event_sourcery',
-                       }
+    '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}",
+    'source_code_uri' => "#{spec.homepage}/tree/v#{spec.version}"
+  }
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(\.|Gemfile|Rakefile|bin/|script/|spec/)}) }
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(\.|Gemfile|Rakefile|bin/|script/|spec/)})
+  end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.required_ruby_version = '>= 2.6.0'
 
+  spec.add_runtime_dependency 'logger'
+
+  spec.add_development_dependency 'benchmark-ips'
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 13'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'rubocop', '~> 1'
 end

data/lib/event_sourcery/aggregate_root.rb

@@ -3,7 +3,9 @@ module EventSourcery
   # EventSourcery::AggregateRoot provides a foundation for writing your own aggregate root classes.
   # You can use it by including it in your classes, as show in the example code.
   #
-  # Excerpt from {https://github.com/envato/event_sourcery/blob/HEAD/docs/core-concepts.md EventSourcery Core Concepts} on Aggregates follows:
+  # Excerpt from {https://github.com/envato/event_sourcery/blob/HEAD/docs/core-concepts.md EventSourcery Core Concepts}
+  # on Aggregates follows:
+  #
   # === Aggregates and Command Handling
   #
   #   An aggregate is a cluster of domain objects that can be treated as a single unit.
@@ -18,7 +20,8 @@ module EventSourcery
   # A typical EventSourcery application will have one or more aggregate roots with multiple commands.
   #
   # The following partial example is taken from the EventSourceryTodoApp.
-  # Refer a more complete example {https://github.com/envato/event_sourcery_todo_app/blob/HEAD/app/aggregates/todo.rb here}.
+  # Refer a more complete example
+  # {https://github.com/envato/event_sourcery_todo_app/blob/HEAD/app/aggregates/todo.rb here}.
   #
   # @example
   #   module EventSourceryTodoApp
@@ -85,7 +88,9 @@ module EventSourcery
     #
     # @param id [String] ID (a UUID represented as a string) of the aggregate instance to be loaded
     # @param events [Array] Events from which the aggregate's current state will be formed
-    # @param on_unknown_event [Proc] Optional. The proc to be run if an unknown event type (for which no event handler is registered using {ClassMethods#apply}) is to be loaded.
+    # @param on_unknown_event [Proc] Optional. The proc to be run if an unknown
+    #   event type (for which no event handler is registered using
+    #   {ClassMethods#apply}) is to be loaded.
     def initialize(id, events, on_unknown_event: EventSourcery.config.on_unknown_event)
       @id = id.to_str
       @version = 0

data/lib/event_sourcery/config.rb

@@ -76,7 +76,9 @@ module EventSourcery
     # ({EventStore::EventBuilder}). By default {EventBodySerializer} will be used.
     # Provide a custom serializer here to change how the event body is serialized.
     def event_body_serializer
-      @event_body_serializer ||= EventBodySerializer.new
+      @event_body_serializer ||=
+        EventBodySerializer
+        .new
         .add(Hash, EventBodySerializer::HashSerializer)
         .add(Array, EventBodySerializer::ArraySerializer)
         .add(Time, &:iso8601)

data/lib/event_sourcery/event.rb

@@ -7,9 +7,9 @@ module EventSourcery
     #
     # Will return `nil` if called on an instance of {EventSourcery::Event}.
     def self.type
-      unless self == Event
-        EventSourcery.config.event_type_serializer.serialize(self)
-      end
+      return if self == Event
+
+      EventSourcery.config.event_type_serializer.serialize(self)
     end
 
     # Use this method to add "upcasting" to your events.
@@ -61,19 +61,35 @@ module EventSourcery
     # @return [Time] Created at timestamp (in UTC) for the event.
 
     # @!attribute [r] correlation_id
-    # @return [String] UUID attached to the event that allows reference to a particular transaction or event chain. This value is often supplied as part of a command issued by clients.
+    # @return [String] UUID attached to the event that allows reference to a
+    #   particular transaction or event chain. This value is often supplied as
+    #   part of a command issued by clients.
 
     # @!attribute [r] causation_id
     # @return [String] UUID of the event that caused this event.
 
     #
-    # @param id [Integer] Optional. Unique identifier at the persistent layer. By default this will be set by the underlying persistence layer when persisting the event.
-    # @param uuid [String] UUID as a string. Optional. Unique identifier for this event. A random UUID will be generated by default.
-    # @param aggregate_id [String] UUID as a string. Aggregate instance UUID to which this event belongs to.
+    # @param id [Integer] Optional. Unique identifier at the persistent layer.
+    #   By default this will be set by the underlying persistence layer when
+    #   persisting the event.
+    #
+    # @param uuid [String] UUID as a string. Optional. Unique identifier for
+    #   this event. A random UUID will be generated by default.
+    #
+    # @param aggregate_id [String] UUID as a string. Aggregate instance UUID to
+    #   which this event belongs to.
+    #
     # @param type [Class] Optional. Event type. {Event.type} will be used by default.
-    # @param version [String] Optional. Event's aggregate version. Used by some event stores to guard against concurrency errors.
+    #
+    # @param version [String] Optional. Event's aggregate version. Used by some
+    #   event stores to guard against concurrency errors.
+    #
     # @param created_at [Time] Optional. Created at timestamp (in UTC) for the event.
-    # @param correlation_id [String] Optional. UUID attached to the event that allows reference to a particular transaction or event chain. This value is often supplied as part of a command issued by clients.
+    #
+    # @param correlation_id [String] Optional. UUID attached to the event that
+    #   allows reference to a particular transaction or event chain. This value
+    #   is often supplied as part of a command issued by clients.
+    #
     # @param causation_id [String] Optional. UUID of the event that caused this event.
     def initialize(id: nil,
                    uuid: SecureRandom.uuid,
@@ -143,15 +159,15 @@ module EventSourcery
     # @return Hash
     def to_h
       {
-        id:             id,
-        uuid:           uuid,
-        aggregate_id:   aggregate_id,
-        type:           type,
-        body:           body,
-        version:        version,
-        created_at:     created_at,
+        id: id,
+        uuid: uuid,
+        aggregate_id: aggregate_id,
+        type: type,
+        body: body,
+        version: version,
+        created_at: created_at,
         correlation_id: correlation_id,
-        causation_id:   causation_id,
+        causation_id: causation_id
       }
     end
   end

data/lib/event_sourcery/event_body_serializer.rb

@@ -4,7 +4,9 @@ module EventSourcery
     # Serialize the given event body, with the default or the provided, serializer
     #
     # @param event_body event body to be serialized
-    # @param serializer Optional. Serializer to be used. By default {Config#event_body_serializer EventSourcery.config.event_body_serializer} will be used.
+    # @param serializer Optional. Serializer to be used. By default
+    #   {Config#event_body_serializer EventSourcery.config.event_body_serializer}
+    #   will be used.
     def self.serialize(event_body,
                        serializer: EventSourcery.config.event_body_serializer)
       serializer.serialize(event_body)

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

@@ -9,7 +9,7 @@ module EventSourcery
         #
         # @api private
         DEFAULT_RETRY_INTERVAL = 1
-        
+
         def initialize(processor_name:)
           @processor_name = processor_name
           @retry_interval = DEFAULT_RETRY_INTERVAL
@@ -18,8 +18,8 @@ module EventSourcery
         # Will yield the block and attempt to retry after a defined retry interval {DEFAULT_RETRY_INTERVAL}.
         def with_error_handling
           yield
-        rescue => error
-          report_error(error)
+        rescue StandardError => e
+          report_error(e)
           sleep(@retry_interval)
 
           retry

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

@@ -23,11 +23,13 @@ module EventSourcery
         # Will yield the block and attempt to retry in an exponential backoff.
         def with_error_handling
           yield
-        rescue => error
-          report_error(error)
-          update_retry_interval(error)
+        rescue StandardError => e
+          report_error(e)
+          update_retry_interval(e)
           sleep(@retry_interval)
-          EventSourcery.logger.info { "Retrying #{@processor_name} with error: #{error.message} at interval=#{@retry_interval}" }
+          EventSourcery.logger.info do
+            "Retrying #{@processor_name} with error: #{e.message} at interval=#{@retry_interval}"
+          end
           retry
         end
 

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

@@ -10,8 +10,8 @@ module EventSourcery
         # Will yield the block and exit the process if an error is raised.
         def with_error_handling
           yield
-        rescue => error
-          report_error(error)
+        rescue StandardError => e
+          report_error(e)
           Process.exit(false)
         end
       end

data/lib/event_sourcery/event_processing/esp_process.rb

@@ -1,7 +1,7 @@
 module EventSourcery
   module EventProcessing
     class ESPProcess
-      DEFAULT_AFTER_FORK = -> (event_processor) { }
+      DEFAULT_AFTER_FORK = ->(event_processor) {}
 
       def initialize(event_processor:,
                      event_source:,

data/lib/event_sourcery/event_processing/esp_runner.rb

@@ -30,9 +30,7 @@ module EventSourcery
             record_terminated_processes
           end
           terminate_remaining_processes
-          until all_processes_terminated? || waited_long_enough?
-            record_terminated_processes
-          end
+          record_terminated_processes until all_processes_terminated? || waited_long_enough?
           kill_remaining_processes
           record_terminated_processes until all_processes_terminated?
         end
@@ -43,7 +41,7 @@ module EventSourcery
         process = ESPProcess.new(
           event_processor: event_processor,
           event_source: @event_source,
-          after_fork: @after_fork,
+          after_fork: @after_fork
         )
         pid = Process.fork { process.start }
         @pids[pid] = event_processor
@@ -72,7 +70,7 @@ module EventSourcery
       end
 
       def listen_for_shutdown_signals
-        %i(TERM INT).each do |signal|
+        %i[TERM INT].each do |signal|
           Signal.trap(signal) { shutdown }
         end
       end
@@ -81,6 +79,7 @@ module EventSourcery
         loop do
           yield
           break if shutdown_requested?
+
           sleep(1)
         end
       end
@@ -109,6 +108,7 @@ module EventSourcery
           logger.info("ESPRunner: Process #{event_processor&.processor_name || pid} " \
                       "terminated with exit status: #{status.exitstatus.inspect}")
           next unless event_processor
+
           @exit_status &&= !!status.success?
           @after_subprocess_termination&.call(processor: event_processor, runner: self, exit_status: status.exitstatus)
         end

data/lib/event_sourcery/event_processing/event_stream_processor.rb

@@ -31,13 +31,12 @@ module EventSourcery
             instance_exec(event, &handler)
           end
           @_event = nil
-        rescue
+        rescue StandardError
           raise EventProcessingError.new(event: event, processor: self)
         end
       end
 
       module ClassMethods
-
         # @attr_reader processes_event_types [Array] Process Event Types
         # @attr_reader event_handlers [Hash] Hash of handler blocks keyed by event
         # @attr_reader all_event_handler [Proc] An event handler
@@ -75,9 +74,9 @@ module EventSourcery
           if event_classes.empty?
             if @all_event_handler
               raise MultipleCatchAllHandlersDefined, 'Attemping to define multiple catch all event handlers.'
-            else
-              @all_event_handler = block
             end
+
+            @all_event_handler = block
           else
             @processes_event_types ||= []
             event_classes.each do |event_class|
@@ -127,8 +126,8 @@ module EventSourcery
       def subscribe_to(event_source, subscription_master: EventStore::SignalHandlingSubscriptionMaster.new)
         setup
         event_source.subscribe(from_id: last_processed_event_id + 1,
-                              event_types: processes_event_types,
-                              subscription_master: subscription_master) do |events|
+                               event_types: processes_event_types,
+                               subscription_master: subscription_master) do |events|
           process_events(events, subscription_master)
         end
       end

data/lib/event_sourcery/event_store/each_by_range.rb

@@ -15,9 +15,7 @@ module EventSourcery
               break
             end
           end
-          unless no_events_left
-            event_id = events.last.id + 1
-          end
+          event_id = events.last.id + 1 unless no_events_left
         end while !caught_up && !no_events_left
       end
     end

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

@@ -4,11 +4,11 @@ module EventSourcery
       # To support legacy implementations.  Type is provided when initializing
       # the event, not derived from the class constant
       class Legacy
-        def serialize(event_class)
+        def serialize(_event_class)
           nil
         end
 
-        def deserialize(event_type)
+        def deserialize(_event_type)
           Event
         end
       end

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

@@ -13,32 +13,35 @@ module EventSourcery
           def underscore(camel_cased_word)
             word = camel_cased_word.to_s.dup
             word.gsub!(/::/, '/')
-            word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-            word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-            word.tr!("-", "_")
+            word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+            word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+            word.tr!('-', '_')
             word.downcase!
             word
           end
 
           def camelize(term, uppercase_first_letter = true)
             string = term.to_s
-            if uppercase_first_letter
-              string = string.sub(/^[a-z\d]*/) { capitalize($&) }
-            else
-              string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { $&.downcase }
-            end
-            string.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{capitalize($2)}" }.gsub('/', '::')
+            string =
+              if uppercase_first_letter
+                string.sub(/^[a-z\d]*/) { capitalize(::Regexp.last_match(0)) }
+              else
+                string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { ::Regexp.last_match(0).downcase }
+              end
+            string.gsub(%r{(?:_|(/))([a-z\d]*)}i) do
+              "#{::Regexp.last_match(1)}#{capitalize(::Regexp.last_match(2))}"
+            end.gsub('/', '::')
           end
 
           private
 
           def capitalize(lower_case_and_underscored_word)
             result = lower_case_and_underscored_word.to_s.dup
-            result.gsub!(/_id$/, "")
+            result.gsub!(/_id$/, '')
             result.gsub!(/_/, ' ')
-            result.gsub(/([a-z\d]*)/i) { |match|
+            result.gsub(/([a-z\d]*)/i) do |match|
               "#{match.downcase}"
-            }.gsub(/^\w/) { $&.upcase }
+            end.gsub(/^\w/) { ::Regexp.last_match(0).upcase }
           end
         end
 

data/lib/event_sourcery/event_store/poll_waiter.rb

@@ -1,7 +1,8 @@
 module EventSourcery
   module EventStore
-
-    # This class provides a basic poll waiter implementation that calls the provided block and sleeps for the specified interval, to be used by a {Subscription}.
+    # This class provides a basic poll waiter implementation that calls the
+    # provided block and sleeps for the specified interval, to be used by a
+    # {Subscription}.
     class PollWaiter
       #
       # @param interval [Float] Optional. Will default to `0.5`
@@ -9,7 +10,8 @@ module EventSourcery
         @interval = interval
       end
 
-      # Start polling. Call the provided block and sleep. Repeat until `:stop` is thrown (usually via a subscription master).
+      # Start polling. Call the provided block and sleep. Repeat until `:stop`
+      # is thrown (usually via a subscription master).
       #
       # @param block [Proc] code block to be called when polling
       #

data/lib/event_sourcery/event_store/signal_handling_subscription_master.rb

@@ -20,7 +20,7 @@ module EventSourcery
       private
 
       def setup_graceful_shutdown
-        %i(TERM INT).each do |signal|
+        %i[TERM INT].each do |signal|
           Signal.trap(signal) do
             @shutdown_requested = true
             wakeup_main_thread

data/lib/event_sourcery/event_store/subscription.rb

@@ -1,6 +1,5 @@
 module EventSourcery
   module EventStore
-
     # This allows Event Stream Processors (ESPs) to subscribe to an event store, and be notified when new events are
     # added.
     class Subscription
@@ -10,14 +9,16 @@ module EventSourcery
       # @param from_event_id [Integer] Start reading events from this event ID
       # @param event_types [Array] Optional. If specified, only subscribe to given event types.
       # @param on_new_events [Proc] Code block to be executed when new events are received
-      # @param subscription_master A subscription master instance (such as {EventStore::SignalHandlingSubscriptionMaster}) which orchestrates a graceful shutdown of the subscription, if one is requested.
+      # @param subscription_master A subscription master instance (such as
+      #   {EventStore::SignalHandlingSubscriptionMaster}) which orchestrates a
+      #   graceful shutdown of the subscription, if one is requested.
       # @param events_table_name [Symbol] Optional. Defaults to `:events`
       def initialize(event_store:,
                      poll_waiter:,
                      from_event_id:,
-                     event_types: nil,
                      on_new_events:,
                      subscription_master:,
+                     event_types: nil,
                      events_table_name: :events,
                      batch_size: EventSourcery.config.subscription_batch_size)
         @event_store = event_store
@@ -51,6 +52,7 @@ module EventSourcery
           @subscription_master.shutdown_if_requested
           events = @event_store.get_next_from(@current_event_id + 1, event_types: @event_types, limit: batch_size)
           break if events.empty?
+
           EventSourcery.logger.debug { "New events in subscription: #{events.inspect}" }
           @on_new_events.call(events)
           @current_event_id = events.last.id

data/lib/event_sourcery/memory/config.rb

@@ -19,7 +19,6 @@ module EventSourcery
       def event_sink
         @event_sink ||= ::EventSourcery::EventStore::EventSink.new(event_store)
       end
-
     end
 
     def self.configure
@@ -29,6 +28,5 @@ module EventSourcery
     def self.config
       @config ||= Config.new
     end
-
   end
 end

data/lib/event_sourcery/memory/event_store.rb

@@ -18,16 +18,17 @@ module EventSourcery
       # Store given events to the in-memory store
       #
       # @param event_or_events Event(s) to be stored
-      # @param expected_version [Optional] Expected version for the aggregate. This is the version the caller of this method expect the aggregate to be in. If it's different from the expected version a {EventSourcery::ConcurrencyError} will be raised. Defaults to nil.
+      # @param expected_version [Optional] Expected version for the aggregate.
+      #   This is the version the caller of this method expect the aggregate to
+      #   be in. If it's different from the expected version a
+      #   {EventSourcery::ConcurrencyError} will be raised. Defaults to nil.
       # @raise EventSourcery::ConcurrencyError
       # @return Boolean
       def sink(event_or_events, expected_version: nil)
         events = Array(event_or_events)
         ensure_one_aggregate(events)
 
-        if expected_version && version_for(events.first.aggregate_id) != expected_version
-          raise ConcurrencyError
-        end
+        raise ConcurrencyError if expected_version && version_for(events.first.aggregate_id) != expected_version
 
         events.each do |event|
           @events << @event_builder.build(
@@ -39,7 +40,7 @@ module EventSourcery
             created_at: event.created_at || Time.now.utc,
             uuid: event.uuid,
             correlation_id: event.correlation_id,
-            causation_id: event.causation_id,
+            causation_id: event.causation_id
           )
         end
 
@@ -55,11 +56,12 @@ module EventSourcery
       # @param limit [Integer] Optional. Number of events to retrieve (starting from the given event ID).
       # @return Array
       def get_next_from(id, event_types: nil, limit: 1000)
-        events = if event_types.nil?
-          @events
-        else
-          @events.select { |e| event_types.include?(e.type) }
-        end
+        events =
+          if event_types.nil?
+            @events
+          else
+            @events.select { |e| event_types.include?(e.type) }
+          end
 
         events.select { |event| event.id >= id }.first(limit)
       end
@@ -69,11 +71,12 @@ module EventSourcery
       # @param event_types [Array] Optional. If supplied, only retrieve events of given type(s).
       # @return Integer
       def latest_event_id(event_types: nil)
-        events = if event_types.nil?
-          @events
-        else
-          @events.select { |e| event_types.include?(e.type) }
-        end
+        events =
+          if event_types.nil?
+            @events
+          else
+            @events.select { |e| event_types.include?(e.type) }
+          end
 
         events.empty? ? 0 : events.last.id
       end
@@ -108,9 +111,9 @@ module EventSourcery
       # @param events [Array] Collection of events
       # @raise AtomicWriteToMultipleAggregatesNotSupported
       def ensure_one_aggregate(events)
-        unless events.map(&:aggregate_id).uniq.one?
-          raise AtomicWriteToMultipleAggregatesNotSupported
-        end
+        return if events.map(&:aggregate_id).uniq.one?
+
+        raise AtomicWriteToMultipleAggregatesNotSupported
       end
 
       # Adds a listener or listeners to the memory store.

data/lib/event_sourcery/memory/projector.rb

@@ -1,7 +1,6 @@
 module EventSourcery
   module Memory
     module Projector
-
       def self.included(base)
         base.include(EventSourcery::EventProcessing::EventStreamProcessor)
         base.include(InstanceMethods)

data/lib/event_sourcery/memory/tracker.rb

@@ -26,7 +26,7 @@ module EventSourcery
         @state[processor_name.to_s] = event_id
       end
 
-      alias :reset_last_processed_event_id :setup
+      alias reset_last_processed_event_id setup
 
       # Find the last processed event id for a given processor name.
       #

data/lib/event_sourcery/rspec/event_store_shared_examples.rb

@@ -51,22 +51,22 @@ RSpec.shared_examples 'an event store' do
     end
 
     it 'writes multiple events' do
-      event_store.sink([ItemAdded.new(aggregate_id: aggregate_id, body: {e: 1}),
-                        ItemAdded.new(aggregate_id: aggregate_id, body: {e: 2}),
-                        ItemAdded.new(aggregate_id: aggregate_id, body: {e: 3})])
+      event_store.sink([ItemAdded.new(aggregate_id: aggregate_id, body: { e: 1 }),
+                        ItemAdded.new(aggregate_id: aggregate_id, body: { e: 2 }),
+                        ItemAdded.new(aggregate_id: aggregate_id, body: { e: 3 })])
       events = event_store.get_next_from(1)
       expect(events.count).to eq 3
       expect(events.map(&:id)).to eq [1, 2, 3]
-      expect(events.map(&:body)).to eq [{'e' => 1}, {'e' => 2}, {'e' => 3}]
+      expect(events.map(&:body)).to eq [{ 'e' => 1 }, { 'e' => 2 }, { 'e' => 3 }]
       expect(events.map(&:version)).to eq [1, 2, 3]
     end
 
     it 'sets the correct aggregates version' do
-      event_store.sink([ItemAdded.new(aggregate_id: aggregate_id, body: {e: 1}),
-                        ItemAdded.new(aggregate_id: aggregate_id, body: {e: 2})])
+      event_store.sink([ItemAdded.new(aggregate_id: aggregate_id, body: { e: 1 }),
+                        ItemAdded.new(aggregate_id: aggregate_id, body: { e: 2 })])
       # this will throw a unique constrain error if the aggregate version was not set correctly ^
-      event_store.sink([ItemAdded.new(aggregate_id: aggregate_id, body: {e: 1}),
-                        ItemAdded.new(aggregate_id: aggregate_id, body: {e: 2})])
+      event_store.sink([ItemAdded.new(aggregate_id: aggregate_id, body: { e: 1 }),
+                        ItemAdded.new(aggregate_id: aggregate_id, body: { e: 2 })])
       events = event_store.get_next_from(1)
       expect(events.count).to eq 4
       expect(events.map(&:id)).to eq [1, 2, 3, 4]
@@ -104,16 +104,17 @@ RSpec.shared_examples 'an event store' do
 
     it 'correctly inserts created at times when inserting multiple events atomically' do
       time = Time.parse('2016-10-14T00:00:00.646191Z')
-      event_store.sink([ItemAdded.new(aggregate_id: aggregate_id, created_at: nil), ItemAdded.new(aggregate_id: aggregate_id, created_at: time)])
+      event_store.sink([ItemAdded.new(aggregate_id: aggregate_id, created_at: nil),
+                        ItemAdded.new(aggregate_id: aggregate_id, created_at: time)])
       created_ats = event_store.get_next_from(0).map(&:created_at)
       expect(created_ats.map(&:class)).to eq [Time, Time]
       expect(created_ats.last).to eq time
     end
 
     it 'raises an error if the events given are for more than one aggregate' do
-      expect {
+      expect do
         event_store.sink([ItemAdded.new(aggregate_id: aggregate_id), ItemAdded.new(aggregate_id: SecureRandom.uuid)])
-      }.to raise_error(EventSourcery::AtomicWriteToMultipleAggregatesNotSupported)
+      end.to raise_error(EventSourcery::AtomicWriteToMultipleAggregatesNotSupported)
     end
   end
 
@@ -168,7 +169,7 @@ RSpec.shared_examples 'an event store' do
 
         expect(event_store.latest_event_id(event_types: ['type1'])).to eq 2
         expect(event_store.latest_event_id(event_types: ['type2'])).to eq 3
-        expect(event_store.latest_event_id(event_types: ['type1', 'type2'])).to eq 3
+        expect(event_store.latest_event_id(event_types: %w[type1 type2])).to eq 3
       end
     end
   end
@@ -207,7 +208,7 @@ RSpec.shared_examples 'an event store' do
 
   describe '#each_by_range' do
     before do
-      (1..21).each do |i|
+      21.times do
         event_store.sink(ItemAdded.new(aggregate_id: aggregate_id, body: {}))
       end
     end
@@ -255,7 +256,7 @@ RSpec.shared_examples 'an event store' do
   def save_event(expected_version: nil)
     event_store.sink(
       BillingDetailsProvided.new(aggregate_id: aggregate_id, body: { my_event: 'data' }),
-      expected_version: expected_version,
+      expected_version: expected_version
     )
   end
 
@@ -278,9 +279,8 @@ RSpec.shared_examples 'an event store' do
 
       context 'and the expected version is incorrect - 1' do
         it 'raises a ConcurrencyError' do
-          expect {
-            save_event(expected_version: 1)
-          }.to raise_error(EventSourcery::ConcurrencyError)
+          expect { save_event(expected_version: 1) }
+            .to raise_error(EventSourcery::ConcurrencyError)
         end
       end
 
@@ -299,9 +299,8 @@ RSpec.shared_examples 'an event store' do
 
       context 'with an incorrect expected version - 0' do
         it 'raises a ConcurrencyError' do
-          expect {
-            save_event(expected_version: 0)
-          }.to raise_error(EventSourcery::ConcurrencyError)
+          expect { save_event(expected_version: 0) }
+            .to raise_error(EventSourcery::ConcurrencyError)
         end
       end
 

data/lib/event_sourcery/version.rb

@@ -1,4 +1,4 @@
 module EventSourcery
-  # Defines the version
-  VERSION = '1.0.0'.freeze
+  # The version of the EventSourcery gem
+  VERSION = '1.0.2'.freeze
 end

metadata

@@ -1,23 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: event_sourcery
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Envato
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,21 +24,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +66,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +93,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 description: ''
 email:
 - rubygems@envato.com
@@ -124,12 +151,14 @@ files:
 - lib/event_sourcery/rspec/event_store_shared_examples.rb
 - lib/event_sourcery/version.rb
 homepage: https://github.com/envato/event_sourcery
-licenses: []
+licenses:
+- MIT
 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
-  source_code_uri: https://github.com/envato/event_sourcery
-post_install_message:
+  documentation_uri: https://www.rubydoc.info/gems/event_sourcery/1.0.2
+  source_code_uri: https://github.com/envato/event_sourcery/tree/v1.0.2
 rdoc_options: []
 require_paths:
 - lib
@@ -137,15 +166,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Event Sourcing Library
 test_files: []