ruby_event_store 2.1.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88203a9b943002241df25fa83c6f067e7944810e66d713eeb11e8cebf13271e2
-  data.tar.gz: 1b032e898517d787a2e6d0cb6b15775792591abc094e68d2483590f916e69c9e
+  metadata.gz: 21f9e0f89d5ab86baa4f840b70c2093d518e8077ee8380cce54144c0f123aaf0
+  data.tar.gz: 9927020649c8f492843ce48af29b020e7831efae54a949cb2e8078288254bed9
 SHA512:
-  metadata.gz: 780c9e0f6064311d45be29c0553c47e65e679a3967b91e6caca48a55ef9c34a06070e421b1413c1a35634c6e45c1452204ac29fae2aa706fe7a0e46d1dd99f40
-  data.tar.gz: 66b7a11ce2d3b58a5f9c2690a7f7f998fc9130c302343923cdd5a57a63d6a398ea258cced2d1b3161e07d9fb081d04bd7c4f305d6576cae59bd6e50f50ba6a92
+  metadata.gz: 4763bae7c34f07594ff9757f6482de78c84550bec861210e89930624438025ad0882bb7476eba0f1b511b02b2ff17c63c82a39b9ab065586dfc2704e6b21b6ba
+  data.tar.gz: 7ed29eadf34c3b9c3e22169250dfc5c9da81f2fa6f470c57c39313f79125c14ea57f2fd0a2c30715a915417ae84eb1b69bd8ec06a6b01de94e5bc000bea2f8ba

data/lib/ruby_event_store/batch_enumerator.rb

@@ -3,9 +3,9 @@
 module RubyEventStore
   class BatchEnumerator
     def initialize(batch_size, total_limit, reader)
-      @batch_size  = batch_size
+      @batch_size = batch_size
       @total_limit = total_limit
-      @reader      = reader
+      @reader = reader
     end
 
     def each
@@ -13,7 +13,7 @@ module RubyEventStore
 
       0.step(total_limit - 1, batch_size) do |batch_offset|
         batch_limit = [batch_size, total_limit - batch_offset].min
-        result      = reader.call(batch_offset, batch_limit)
+        result = reader.call(batch_offset, batch_limit)
 
         break if result.empty?
         yield result

data/lib/ruby_event_store/broker.rb

@@ -9,9 +9,7 @@ module RubyEventStore
 
     def call(event, record)
       subscribers = subscriptions.all_for(event.event_type)
-      subscribers.each do |subscriber|
-        dispatcher.call(subscriber, event, record)
-      end
+      subscribers.each { |subscriber| dispatcher.call(subscriber, event, record) }
     end
 
     def add_subscription(subscriber, event_types)
@@ -35,11 +33,14 @@ module RubyEventStore
     end
 
     private
+
     attr_reader :dispatcher, :subscriptions
 
     def verify_subscription(subscriber)
       raise SubscriberNotExist, "subscriber must be first argument or block" unless subscriber
-      raise InvalidHandler.new("Handler #{subscriber} is invalid for dispatcher #{dispatcher}") unless dispatcher.verify(subscriber)
+      unless dispatcher.verify(subscriber)
+        raise InvalidHandler.new("Handler #{subscriber} is invalid for dispatcher #{dispatcher}")
+      end
     end
   end
 end

data/lib/ruby_event_store/client.rb

@@ -1,27 +1,26 @@
 # frozen_string_literal: true
 
-require 'concurrent'
+require "concurrent"
 
 module RubyEventStore
   class Client
-    def initialize(repository:,
-                   mapper: Mappers::Default.new,
-                   subscriptions: Subscriptions.new,
-                   dispatcher: Dispatcher.new,
-                   clock: default_clock,
-                   correlation_id_generator: default_correlation_id_generator)
-
-
-      @repository     = repository
-      @mapper         = mapper
-      @subscriptions  = subscriptions
-      @broker         = Broker.new(subscriptions: subscriptions, dispatcher: dispatcher)
-      @clock          = clock
-      @metadata       = Concurrent::ThreadLocalVar.new
+    def initialize(
+      repository:,
+      mapper: Mappers::Default.new,
+      subscriptions: Subscriptions.new,
+      dispatcher: Dispatcher.new,
+      clock: default_clock,
+      correlation_id_generator: default_correlation_id_generator
+    )
+      @repository = repository
+      @mapper = mapper
+      @subscriptions = subscriptions
+      @broker = Broker.new(subscriptions: subscriptions, dispatcher: dispatcher)
+      @clock = clock
+      @metadata = Concurrent::ThreadLocalVar.new
       @correlation_id_generator = correlation_id_generator
     end
 
-
     # Persists events and notifies subscribed handlers about them
     #
     # @param events [Array<Event>, Event] event(s)
@@ -30,13 +29,10 @@ module RubyEventStore
     # @return [self]
     def publish(events, stream_name: GLOBAL_STREAM, expected_version: :any)
       enriched_events = enrich_events_metadata(events)
-      records         = transform(enriched_events)
+      records = transform(enriched_events)
       append_records_to_stream(records, stream_name: stream_name, expected_version: expected_version)
       enriched_events.zip(records) do |event, record|
-        with_metadata(
-          correlation_id: event.metadata.fetch(:correlation_id),
-          causation_id:   event.event_id,
-        ) do
+        with_metadata(correlation_id: event.metadata.fetch(:correlation_id), causation_id: event.event_id) do
           broker.(event, record)
         end
       end
@@ -94,6 +90,43 @@ module RubyEventStore
       repository.streams_of(event_id)
     end
 
+    # Gets position of the event in given stream
+    #
+    # The position is always nonnegative.
+    # Returns nil if the event has no specific position in stream.
+    # Raise error if event is not present in stream.
+    #
+    # @param event_id [String]
+    # @param stream_name [String]
+    # @return [Integer] nonnegative integer position of event in stream
+    # @raise [EventNotInStream]
+    def position_in_stream(event_id, stream_name)
+      repository.position_in_stream(event_id, Stream.new(stream_name))
+    end
+
+    # Gets position of the event in global stream
+    #
+    # The position is always nonnegative.
+    # Global position may have gaps, meaning, there may be event at
+    # position 40, but no event at position 39.
+    #
+    # @param event_id [String]
+    # @raise [EventNotFound]
+    # @return [Integer] nonnegno ative integer position of event in global stream
+    def global_position(event_id)
+      repository.global_position(event_id)
+    end
+
+    # Checks whether event is linked in given stream
+    #
+    # @param event_id [String]
+    # @param stream_name [String]
+    # @return [Boolean] true if event is linked to given stream, false otherwise
+    def event_in_stream?(event_id, stream_name)
+      stream = Stream.new(stream_name)
+      stream.global? ? repository.has_event?(event_id) : repository.event_in_stream?(event_id, stream)
+    end
+
     # Subscribes a handler (subscriber) that will be invoked for published events of provided type.
     #
     # @overload subscribe(subscriber, to:)
@@ -131,8 +164,8 @@ module RubyEventStore
     #
     # @param to [Class, String] type of events to get list of sybscribed handlers
     # @return [Array<Object, Class>]
-    def subscribers_for(event_type)
-      subscriptions.all_for(event_type)
+    def subscribers_for(event_class)
+      subscriptions.all_for(event_type_resolver.call(event_class))
     end
 
     # Builder object for collecting temporary handlers (subscribers)
@@ -143,7 +176,7 @@ module RubyEventStore
         @block = block
         @broker = broker
         @global_subscribers = []
-        @subscribers = Hash.new {[]}
+        @subscribers = Hash.new { [] }
       end
 
       # Subscribes temporary handlers that
@@ -175,7 +208,7 @@ module RubyEventStore
       #   @param to [Array<Class>] types of events to subscribe
       #   @param handler [Proc] handler passed as proc
       #   @return [self]
-      def subscribe(handler=nil, to:, &handler2)
+      def subscribe(handler = nil, to:, &handler2)
         raise ArgumentError if handler && handler2
         @subscribers[handler || handler2] += Array(to)
         self
@@ -187,7 +220,7 @@ module RubyEventStore
       #
       # @return [Object] value returned by the invoked block of code
       def call
-        unsubs  = add_thread_global_subscribers
+        unsubs = add_thread_global_subscribers
         unsubs += add_thread_subscribers
         @block.call
       ensure
@@ -197,15 +230,11 @@ module RubyEventStore
       private
 
       def add_thread_subscribers
-        @subscribers.map do |subscriber, types|
-          @broker.add_thread_subscription(subscriber, types)
-        end
+        @subscribers.map { |subscriber, types| @broker.add_thread_subscription(subscriber, types) }
       end
 
       def add_thread_global_subscribers
-        @global_subscribers.map do |subscriber|
-          @broker.add_thread_global_subscription(subscriber)
-        end
+        @global_subscribers.map { |subscriber| @broker.add_thread_global_subscription(subscriber) }
       end
     end
 
@@ -238,19 +267,19 @@ module RubyEventStore
     #
     # @return [Event] deserialized event
     def deserialize(serializer:, event_type:, event_id:, data:, metadata:, timestamp: nil, valid_at: nil)
-      extract_timestamp = lambda do |m|
-        (m[:timestamp] || Time.parse(m.fetch('timestamp'))).iso8601
-      end
+      extract_timestamp = lambda { |m| (m[:timestamp] || Time.parse(m.fetch("timestamp"))).iso8601 }
 
       mapper.record_to_event(
-        SerializedRecord.new(
-          event_type: event_type,
-          event_id:   event_id,
-          data:       data,
-          metadata:   metadata,
-          timestamp:  timestamp || timestamp_ = extract_timestamp[serializer.load(metadata)],
-          valid_at:   valid_at  || timestamp_,
-        ).deserialize(serializer)
+        SerializedRecord
+          .new(
+            event_type: event_type,
+            event_id: event_id,
+            data: data,
+            metadata: metadata,
+            timestamp: timestamp || timestamp_ = extract_timestamp[serializer.load(metadata)],
+            valid_at: valid_at || timestamp_
+          )
+          .deserialize(serializer)
       )
     end
 
@@ -311,14 +340,14 @@ module RubyEventStore
 
     def enrich_events_metadata(events)
       events = Array(events)
-      events.each{|event| enrich_event_metadata(event) }
+      events.each { |event| enrich_event_metadata(event) }
       events
     end
 
     def enrich_event_metadata(event)
       metadata.each { |key, value| event.metadata[key] ||= value }
-      event.metadata[:timestamp]      ||= clock.call
-      event.metadata[:valid_at]       ||= event.metadata.fetch(:timestamp)
+      event.metadata[:timestamp] ||= clock.call
+      event.metadata[:valid_at] ||= event.metadata.fetch(:timestamp)
       event.metadata[:correlation_id] ||= correlation_id_generator.call
     end
 
@@ -328,16 +357,20 @@ module RubyEventStore
 
     protected
 
+    def event_type_resolver
+      subscriptions.event_type_resolver
+    end
+
     def metadata=(value)
       @metadata.value = value
     end
 
     def default_clock
-      ->{ Time.now.utc.round(TIMESTAMP_PRECISION) }
+      -> { Time.now.utc.round(TIMESTAMP_PRECISION) }
     end
 
     def default_correlation_id_generator
-      ->{ SecureRandom.uuid }
+      -> { SecureRandom.uuid }
     end
 
     attr_reader :repository, :mapper, :subscriptions, :broker, :clock, :correlation_id_generator

data/lib/ruby_event_store/composed_dispatcher.rb

@@ -16,9 +16,7 @@ module RubyEventStore
     end
 
     def verify(subscriber)
-      @dispatchers.any? do |dispatcher|
-        dispatcher.verify(subscriber)
-      end
+      @dispatchers.any? { |dispatcher| dispatcher.verify(subscriber) }
     end
   end
 end

data/lib/ruby_event_store/correlated_commands.rb

@@ -2,7 +2,6 @@
 
 module RubyEventStore
   class CorrelatedCommands
-
     def initialize(event_store, command_bus)
       @event_store = event_store
       @command_bus = command_bus
@@ -13,23 +12,13 @@ module RubyEventStore
 
     def call(command)
       correlation_id = event_store.metadata[:correlation_id]
-      causation_id   = event_store.metadata[:causation_id]
+      causation_id = event_store.metadata[:causation_id]
 
       if correlation_id && causation_id
-        command.correlate_with(MiniEvent.new(
-          correlation_id,
-          causation_id,
-        )) if command.respond_to?(:correlate_with)
-        event_store.with_metadata(
-          causation_id: command.message_id,
-        ) do
-          command_bus.call(command)
-        end
+        command.correlate_with(MiniEvent.new(correlation_id, causation_id)) if command.respond_to?(:correlate_with)
+        event_store.with_metadata(causation_id: command.message_id) { command_bus.call(command) }
       else
-        event_store.with_metadata(
-          correlation_id: command.message_id,
-          causation_id: command.message_id,
-        ) do
+        event_store.with_metadata(correlation_id: command.message_id, causation_id: command.message_id) do
           command_bus.call(command)
         end
       end

data/lib/ruby_event_store/errors.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
 module RubyEventStore
-  Error                     = Class.new(StandardError)
+  Error = Class.new(StandardError)
   WrongExpectedEventVersion = Class.new(Error)
-  InvalidExpectedVersion    = Class.new(Error)
-  IncorrectStreamData       = Class.new(Error)
-  SubscriberNotExist        = Class.new(Error)
-  InvalidPageStart          = Class.new(Error)
-  InvalidPageStop           = Class.new(Error)
-  InvalidPageSize           = Class.new(Error)
-  EventDuplicatedInStream   = Class.new(Error)
-  ReservedInternalName      = Class.new(Error)
-  InvalidHandler            = Class.new(Error)
+  InvalidExpectedVersion = Class.new(Error)
+  IncorrectStreamData = Class.new(Error)
+  SubscriberNotExist = Class.new(Error)
+  InvalidPageStart = Class.new(Error)
+  InvalidPageStop = Class.new(Error)
+  InvalidPageSize = Class.new(Error)
+  EventDuplicatedInStream = Class.new(Error)
+  ReservedInternalName = Class.new(Error)
+  InvalidHandler = Class.new(Error)
+  EventNotFoundInStream = Class.new(Error)
 
   class EventNotFound < Error
     attr_reader :event_id

data/lib/ruby_event_store/event.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module RubyEventStore
-
   # Data structure representing an event
   class Event
     # Instantiates a new event
@@ -17,7 +16,7 @@ module RubyEventStore
     def initialize(event_id: SecureRandom.uuid, metadata: nil, data: {})
       @event_id = event_id.to_s
       @metadata = Metadata.new(metadata.to_h)
-      @data     = data
+      @data = data
     end
 
     attr_reader :event_id, :metadata, :data
@@ -31,7 +30,7 @@ module RubyEventStore
     # Type of event. Used when matching with subscribed handlers.
     # @return [String]
     def event_type
-      self.class.name
+      metadata[:event_type] || self.class.name
     end
 
     # Timestamp from metadata
@@ -50,6 +49,7 @@ module RubyEventStore
 
     # Two events are equal if:
     # * they are of the same class
+    # * have identical event type
     # * have identical event id
     # * have identical data (verified with eql? method)
     #
@@ -58,9 +58,8 @@ module RubyEventStore
     # Event equality ignores metadata!
     # @return [TrueClass, FalseClass]
     def ==(other_event)
-      other_event.instance_of?(self.class) &&
-        other_event.event_id.eql?(event_id) &&
-        other_event.data.eql?(data)
+      other_event.instance_of?(self.class) && other_event.event_type.eql?(event_type) &&
+        other_event.event_id.eql?(event_id) && other_event.data.eql?(data)
     end
 
     # @private
@@ -78,11 +77,7 @@ module RubyEventStore
     # * data
     def hash
       # We don't use metadata because == does not use metadata
-      [
-        self.class,
-        event_id,
-        data
-      ].hash ^ BIG_VALUE
+      [self.class, event_type, event_id, data].hash ^ BIG_VALUE
     end
 
     # Reads correlation_id from metadata.
@@ -116,7 +111,7 @@ module RubyEventStore
     # @param val [String]
     # @return [String]
     def causation_id=(val)
-      metadata[:causation_id]= val
+      metadata[:causation_id] = val
     end
 
     # Sets correlation_id and causation_id in metadata based
@@ -127,7 +122,7 @@ module RubyEventStore
     # @return [String] set causation_id
     def correlate_with(other_message)
       self.correlation_id = other_message.correlation_id || other_message.message_id
-      self.causation_id   = other_message.message_id
+      self.causation_id = other_message.message_id
       self
     end
 

data/lib/ruby_event_store/expected_version.rb

@@ -21,7 +21,7 @@ module RubyEventStore
 
     def initialize(version)
       @version = version
-      invalid_version! unless [Integer, :any, :none, :auto].any? {|i| i === version}
+      invalid_version! unless [Integer, :any, :none, :auto].any? { |i| i === version }
     end
 
     def any?
@@ -53,15 +53,11 @@ module RubyEventStore
     private_constant :BIG_VALUE
 
     def hash
-      [
-        self.class,
-        version
-      ].hash ^ BIG_VALUE
+      [self.class, version].hash ^ BIG_VALUE
     end
 
     def ==(other_expected_version)
-      other_expected_version.instance_of?(self.class) &&
-        other_expected_version.version.equal?(version)
+      other_expected_version.instance_of?(self.class) && other_expected_version.version.equal?(version)
     end
 
     alias_method :eql?, :==