ruby_event_store 2.0.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3c88fc2b8bb6cc690ca8518b0d05e81e648969f21047aaa630c122b3d62d039
-  data.tar.gz: 62de2a86056dfe64d42bcdb58b37054152bda5cec7e8614239ffab7ea06b14a8
+  metadata.gz: 9170662f3f550d541b79d403aeacfdf734a41a2c48c90752a7a35218913c0ead
+  data.tar.gz: 3fa3e5b0e60d839391da9669a74228847aa921903c5d5a7db35363945af5b0f9
 SHA512:
-  metadata.gz: 5cd0b9296fdf313dd30ee7d5dc4ce3d09f83b10675da8cf735dbbab8043ee1725e13d3c29e574d3bc16f0e57b7059dc5856f2a406b444cdbb514f511b35bad32
-  data.tar.gz: 40624c5a6101794364f0c952e78b74e127924b6aade3b53e028d7715d72b198ca58bf4a0fe2bc001220e1c4a5f580221ff686ec40994edff2abb6b4bd42b7620
+  metadata.gz: f753b40d9b216d372dba8692c69b855ac8bb382664f853be628e094557aa391fe1076c98a934f437158622b65a2cf6b5353e6672facadb408ae43441576f49ce
+  data.tar.gz: 7b909ee630098c28449eae7ca5dc0b018158ee3a8e240074a25bf71d602bb0529873487dd5d6f6f0ff495cd06b9b1ddfa3b1538fe42f91556fcd1a7cba666232

data/README.md

@@ -1,3 +1,5 @@
 # RubyEventStore
 
-A Ruby implementation of an EventStore. It is an integral part of `rails_event_store` gem.
+Ruby implementation of an event store. Ships with in-memory event repository, generic instrumentation and dispatches events synchronously.
+
+Find out more at [https://railseventstore.org](https://railseventstore.org/)

data/lib/ruby_event_store/client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'concurrent'
+require "concurrent"
 
 module RubyEventStore
   class Client
@@ -13,7 +13,7 @@ module RubyEventStore
 
 
       @repository     = repository
-      @mapper         = Mappers::DeprecatedWrapper.new(mapper)
+      @mapper         = mapper
       @subscriptions  = subscriptions
       @broker         = Broker.new(subscriptions: subscriptions, dispatcher: dispatcher)
       @clock          = clock
@@ -64,7 +64,7 @@ module RubyEventStore
     # @param expected_version (see #publish)
     # @return [self]
     def link(event_ids, stream_name:, expected_version: :any)
-      repository.link_to_stream(event_ids, Stream.new(stream_name), ExpectedVersion.new(expected_version))
+      repository.link_to_stream(Array(event_ids), Stream.new(stream_name), ExpectedVersion.new(expected_version))
       self
     end
 
@@ -94,6 +94,33 @@ 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
+
     # Subscribes a handler (subscriber) that will be invoked for published events of provided type.
     #
     # @overload subscribe(subscriber, to:)
@@ -131,8 +158,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.to_s)
+    def subscribers_for(event_class)
+      subscriptions.all_for(event_type_resolver.call(event_class))
     end
 
     # Builder object for collecting temporary handlers (subscribers)
@@ -239,7 +266,7 @@ 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
+        (m[:timestamp] || Time.parse(m.fetch("timestamp"))).iso8601
       end
 
       mapper.record_to_event(
@@ -328,6 +355,10 @@ module RubyEventStore
 
     protected
 
+    def event_type_resolver
+      subscriptions.event_type_resolver
+    end
+
     def metadata=(value)
       @metadata.value = value
     end

data/lib/ruby_event_store/errors.rb

@@ -12,6 +12,7 @@ module RubyEventStore
   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,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module RubyEventStore
 
@@ -31,7 +31,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 +50,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)
     #
@@ -59,6 +60,7 @@ module RubyEventStore
     # @return [TrueClass, FalseClass]
     def ==(other_event)
       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
@@ -80,6 +82,7 @@ module RubyEventStore
       # We don't use metadata because == does not use metadata
       [
         self.class,
+        event_type,
         event_id,
         data
       ].hash ^ BIG_VALUE

data/lib/ruby_event_store/in_memory_repository.rb

@@ -1,40 +1,62 @@
 # frozen_string_literal: true
 
-require 'ostruct'
+require "ostruct"
 module RubyEventStore
   class InMemoryRepository
+    class UnsupportedVersionAnyUsage < StandardError
+      def initialize
+        super <<~EOS
+        Mixing expected version :any and specific position (or :auto) is unsupported.
+
+        Read more about expected versions here:
+        https://railseventstore.org/docs/v2/expected_version/
+        EOS
+      end
+    end
+
+    class EventInStream
+      def initialize(event_id, position)
+        @event_id = event_id
+        @position = position
+      end
+
+      attr_reader :event_id, :position
+    end
 
-    def initialize(serializer: NULL)
+    def initialize(serializer: NULL, ensure_supported_any_usage: false)
       @serializer = serializer
       @streams = Hash.new { |h, k| h[k] = Array.new }
       @mutex   = Mutex.new
       @storage = Hash.new
+      @ensure_supported_any_usage = ensure_supported_any_usage
     end
 
     def append_to_stream(records, stream, expected_version)
-      serialized_records = Array(records).map{ |record| record.serialize(serializer) }
+      serialized_records = records.map { |record| record.serialize(serializer) }
 
       with_synchronize(expected_version, stream) do |resolved_version|
-        raise WrongExpectedEventVersion unless last_stream_version(stream).equal?(resolved_version)
+        ensure_supported_any_usage(resolved_version, stream)
+        raise WrongExpectedEventVersion unless resolved_version.nil? || last_stream_version(stream).equal?(resolved_version)
 
-        serialized_records.each do |serialized_record|
+        serialized_records.each_with_index do |serialized_record, index|
           raise EventDuplicatedInStream if has_event?(serialized_record.event_id)
           storage[serialized_record.event_id] = serialized_record
-          streams[stream.name] << serialized_record.event_id
+          add_to_stream(stream, serialized_record, resolved_version, index)
         end
       end
       self
     end
 
     def link_to_stream(event_ids, stream, expected_version)
-      serialized_records = Array(event_ids).map { |id| read_event(id) }
+      serialized_records = event_ids.map { |id| read_event(id) }
 
       with_synchronize(expected_version, stream) do |resolved_version|
-        raise WrongExpectedEventVersion unless last_stream_version(stream).equal?(resolved_version)
+        ensure_supported_any_usage(resolved_version, stream)
+        raise WrongExpectedEventVersion unless resolved_version.nil? || last_stream_version(stream).equal?(resolved_version)
 
-        serialized_records.each do |serialized_record|
+        serialized_records.each_with_index do |serialized_record, index|
           raise EventDuplicatedInStream if has_event_in_stream?(serialized_record.event_id, stream.name)
-          streams[stream.name] << serialized_record.event_id
+          add_to_stream(stream, serialized_record, resolved_version, index)
         end
       end
       self
@@ -60,7 +82,7 @@ module RubyEventStore
           serialized_records
             .drop(offset)
             .take(limit)
-            .map{|serialized_record| serialized_record.deserialize(serializer) }
+            .map { |serialized_record| serialized_record.deserialize(serializer) }
         end
         BatchEnumerator.new(spec.batch_size, serialized_records.size, batch_reader).each
       elsif spec.first?
@@ -102,6 +124,16 @@ module RubyEventStore
         .map    { |name,| Stream.new(name) }
     end
 
+    def position_in_stream(event_id, stream)
+      event_in_stream = streams[stream.name].find {|event_in_stream| event_in_stream.event_id.eql?(event_id) }
+      raise EventNotFoundInStream if event_in_stream.nil?
+      event_in_stream.position
+    end
+
+    def global_position(event_id)
+      storage.keys.index(event_id) or raise EventNotFound.new(event_id)
+    end
+
     private
     def read_scope(spec)
       serialized_records = serialized_records_of_stream(spec.stream)
@@ -124,7 +156,7 @@ module RubyEventStore
     end
 
     def event_ids_of_stream(stream)
-      streams.fetch(stream.name, Array.new)
+      streams.fetch(stream.name, Array.new).map(&:event_id)
     end
 
     def serialized_records_of_stream(stream)
@@ -143,7 +175,7 @@ module RubyEventStore
     end
 
     def last_stream_version(stream)
-      event_ids_of_stream(stream).size - 1
+      streams.fetch(stream.name, Array.new).size - 1
     end
 
     def with_synchronize(expected_version, stream, &block)
@@ -158,19 +190,39 @@ module RubyEventStore
       # not for the whole read+write algorithm.
       Thread.pass
       mutex.synchronize do
-        resolved_version = last_stream_version(stream) if expected_version.any?
         block.call(resolved_version)
       end
     end
 
     def has_event_in_stream?(event_id, stream_name)
-      streams.fetch(stream_name, Array.new).any? { |id| id.eql?(event_id) }
+      streams.fetch(stream_name, Array.new).any? { |event_in_stream| event_in_stream.event_id.eql?(event_id) }
     end
 
     def index_of(source, event_id)
       source.index {|item| item.event_id.eql?(event_id)}
     end
 
+    def compute_position(resolved_version, index)
+      unless resolved_version.nil?
+        resolved_version + index + 1
+      end
+    end
+
+    def add_to_stream(stream, serialized_record, resolved_version, index)
+      streams[stream.name] << EventInStream.new(serialized_record.event_id, compute_position(resolved_version, index))
+    end
+
+    def ensure_supported_any_usage(resolved_version, stream)
+      if @ensure_supported_any_usage
+        stream_positions = streams.fetch(stream.name, Array.new).map(&:position)
+        if resolved_version.nil?
+          raise UnsupportedVersionAnyUsage if !stream_positions.compact.empty?
+        else
+          raise UnsupportedVersionAnyUsage if stream_positions.include?(nil)
+        end
+      end
+    end
+
     attr_reader :streams, :mutex, :storage, :serializer
   end
 end

data/lib/ruby_event_store/instrumented_dispatcher.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "ruby2_keywords"
+
 module RubyEventStore
   class InstrumentedDispatcher
     def initialize(dispatcher, instrumentation)
@@ -13,8 +15,16 @@ module RubyEventStore
       end
     end
 
-    def verify(subscriber)
-      dispatcher.verify(subscriber)
+    ruby2_keywords def method_missing(method_name, *arguments, &block)
+      if respond_to?(method_name)
+        dispatcher.public_send(method_name, *arguments, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, _include_private)
+      dispatcher.respond_to?(method_name)
     end
 
     private

data/lib/ruby_event_store/instrumented_repository.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "ruby2_keywords"
+
 module RubyEventStore
   class InstrumentedRepository
     def initialize(repository, instrumentation)
@@ -7,9 +9,9 @@ module RubyEventStore
       @instrumentation = instrumentation
     end
 
-    def append_to_stream(events, stream, expected_version)
-      instrumentation.instrument("append_to_stream.repository.rails_event_store", events: events, stream: stream) do
-        repository.append_to_stream(events, stream, expected_version)
+    def append_to_stream(records, stream, expected_version)
+      instrumentation.instrument("append_to_stream.repository.rails_event_store", events: records, stream: stream) do
+        repository.append_to_stream(records, stream, expected_version)
       end
     end
 
@@ -25,14 +27,6 @@ module RubyEventStore
       end
     end
 
-    def has_event?(event_id)
-      repository.has_event?(event_id)
-    end
-
-    def last_stream_event(stream)
-      repository.last_stream_event(stream)
-    end
-
     def read(specification)
       instrumentation.instrument("read.repository.rails_event_store", specification: specification) do
         repository.read(specification)
@@ -57,6 +51,18 @@ module RubyEventStore
       end
     end
 
+    ruby2_keywords def method_missing(method_name, *arguments, &block)
+      if respond_to?(method_name)
+        repository.public_send(method_name, *arguments, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, _include_private)
+      repository.respond_to?(method_name)
+    end
+
     private
     attr_reader :repository, :instrumentation
   end

data/lib/ruby_event_store/mappers/default.rb

@@ -1,36 +1,9 @@
 # frozen_string_literal: true
 
-require 'yaml'
-
 module RubyEventStore
   module Mappers
     class Default < PipelineMapper
-      UNSET = Object.new.freeze
-
-      attr_reader :serializer
-
-      def initialize(serializer: UNSET, events_class_remapping: {})
-        case serializer
-        when UNSET
-          @serializer = YAML
-        else
-          warn <<~EOW
-            Passing serializer: to #{self.class} has been deprecated.
-
-            Pass it directly to the repository and the scheduler. For example:
-
-            Rails.configuration.event_store = RailsEventStore::Client.new(
-              mapper:     RubyEventStore::Mappers::Default.new,
-              repository: RailsEventStoreActiveRecord::EventRepository.new(serializer: #{serializer}),
-              dispatcher: RubyEventStore::ComposedDispatcher.new(
-                RailsEventStore::AfterCommitAsyncDispatcher.new(scheduler: RailsEventStore::ActiveJobScheduler.new(serializer: #{serializer}),
-                RubyEventStore::Dispatcher.new
-              )
-            )
-          EOW
-          @serializer = serializer
-        end
-
+      def initialize(events_class_remapping: {})
         super(Pipeline.new(
           Transformation::EventClassRemapper.new(events_class_remapping),
           Transformation::SymbolizeMetadataKeys.new,

data/lib/ruby_event_store/mappers/encryption_mapper.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "yaml"
+
 module RubyEventStore
   module Mappers
     class EncryptionMapper < PipelineMapper

data/lib/ruby_event_store/mappers/forgotten_data.rb

@@ -3,7 +3,7 @@
 module RubyEventStore
   module Mappers
     class ForgottenData
-      FORGOTTEN_DATA = 'FORGOTTEN_DATA'.freeze
+      FORGOTTEN_DATA = "FORGOTTEN_DATA".freeze
 
       def initialize(string = FORGOTTEN_DATA)
         @string = string