ruby_event_store 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28fef13a18c820b5e2e67ffef0aa6ee04b171a427fe9f7a9a4323dbab9db61bb
-  data.tar.gz: 8aa4bcf65629ae5e1912651d08be52de870f0dc0c274bd046796400d6a50bf34
+  metadata.gz: 9170662f3f550d541b79d403aeacfdf734a41a2c48c90752a7a35218913c0ead
+  data.tar.gz: 3fa3e5b0e60d839391da9669a74228847aa921903c5d5a7db35363945af5b0f9
 SHA512:
-  metadata.gz: 2717723ff31551edb75469a884d88a5e64f97432f218a54c71fe84245bdd91ff770215bd54b90a2ee5dd56054a6bba29ed4ed766c551bb7d7c6f66806f23e207
-  data.tar.gz: 4f509c7e557271f414aad29db6dd04063aa9d29a45a49985fb12e89192e88d5bee5c8ad73a561faad3d196e04c4ff3ad2f1471ea3f67f0bd63f54060518cac27
+  metadata.gz: f753b40d9b216d372dba8692c69b855ac8bb382664f853be628e094557aa391fe1076c98a934f437158622b65a2cf6b5353e6672facadb408ae43441576f49ce
+  data.tar.gz: 7b909ee630098c28449eae7ca5dc0b018158ee3a8e240074a25bf71d602bb0529873487dd5d6f6f0ff495cd06b9b1ddfa3b1538fe42f91556fcd1a7cba666232

data/lib/ruby_event_store/client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'concurrent'
+require "concurrent"
 
 module RubyEventStore
   class Client
@@ -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:)
@@ -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(

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,26 +1,47 @@
 # 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 = 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
@@ -30,11 +51,12 @@ module RubyEventStore
       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
@@ -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)
@@ -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/encryption_mapper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'yaml'
+require "yaml"
 
 module RubyEventStore
   module Mappers

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

data/lib/ruby_event_store/mappers/in_memory_encryption_key_repository.rb

@@ -3,7 +3,7 @@
 module RubyEventStore
   module Mappers
     class InMemoryEncryptionKeyRepository
-      DEFAULT_CIPHER = 'aes-256-gcm'.freeze
+      DEFAULT_CIPHER = "aes-256-gcm".freeze
 
       def initialize
         @keys = {}

data/lib/ruby_event_store/mappers/transformation/domain_event.rb

@@ -21,11 +21,21 @@ module RubyEventStore
         def load(record)
           Object.const_get(record.event_type).new(
             event_id: record.event_id,
+            data:     record.data,
             metadata: record.metadata.merge(
               timestamp: record.timestamp,
-              valid_at: record.valid_at,
+              valid_at:  record.valid_at,
             ),
+          )
+        rescue NameError
+          Event.new(
+            event_id: record.event_id,
             data:     record.data,
+            metadata: record.metadata.merge(
+              timestamp:  record.timestamp,
+              valid_at:   record.valid_at,
+              event_type: record.event_type,
+            ),
           )
         end
       end

data/lib/ruby_event_store/metadata.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'date'
-require 'time'
-require 'forwardable'
+require "date"
+require "time"
+require "forwardable"
 
 module RubyEventStore
   class Metadata

data/lib/ruby_event_store/projection.rb

@@ -72,14 +72,14 @@ module RubyEventStore
     end
 
     def reduce_from_streams(event_store, start, count)
-      raise ArgumentError.new('Start must be an array with event ids') unless valid_starting_point?(start)
+      raise ArgumentError.new("Start must be an array with event ids") unless valid_starting_point?(start)
       streams.zip(start_events(start)).reduce(initial_state) do |state, (stream_name, start_event_id)|
         read_scope(event_store, stream_name, count, start_event_id).reduce(state, &method(:transition))
       end
     end
 
     def reduce_from_all_streams(event_store, start, count)
-      raise ArgumentError.new('Start must be valid event id') unless valid_starting_point?(start)
+      raise ArgumentError.new("Start must be valid event id") unless valid_starting_point?(start)
       read_scope(event_store, nil, count, start).reduce(initial_state, &method(:transition))
     end
 

data/lib/ruby_event_store/spec/broker_lint.rb

@@ -1,5 +1,5 @@
 RSpec.shared_examples :broker do |broker_klass|
-  let(:event) { instance_double(::RubyEventStore::Event, event_type: 'EventType') }
+  let(:event) { instance_double(::RubyEventStore::Event, event_type: "EventType") }
   let(:record) { instance_double(::RubyEventStore::Record)  }
   let(:handler) { HandlerClass.new }
   let(:subscriptions) { ::RubyEventStore::Subscriptions.new }
@@ -7,38 +7,38 @@ RSpec.shared_examples :broker do |broker_klass|
   let(:broker) { broker_klass.new(subscriptions: subscriptions, dispatcher: dispatcher) }
 
   specify "no dispatch when no subscriptions" do
-    expect(subscriptions).to receive(:all_for).with('EventType').and_return([])
+    expect(subscriptions).to receive(:all_for).with("EventType").and_return([])
     expect(dispatcher).not_to receive(:call)
     broker.call(event, record)
   end
 
   specify "calls subscription" do
-    expect(subscriptions).to receive(:all_for).with('EventType').and_return([handler])
+    expect(subscriptions).to receive(:all_for).with("EventType").and_return([handler])
     expect(dispatcher).to receive(:call).with(handler, event, record)
     broker.call(event, record)
   end
 
   specify "calls subscribed class" do
-    expect(subscriptions).to receive(:all_for).with('EventType').and_return([HandlerClass])
+    expect(subscriptions).to receive(:all_for).with("EventType").and_return([HandlerClass])
     expect(dispatcher).to receive(:call).with(HandlerClass, event, record)
     broker.call(event, record)
   end
 
   specify "calls all subscriptions" do
-    expect(subscriptions).to receive(:all_for).with('EventType').and_return([handler, HandlerClass])
+    expect(subscriptions).to receive(:all_for).with("EventType").and_return([handler, HandlerClass])
     expect(dispatcher).to receive(:call).with(handler, event, record)
     expect(dispatcher).to receive(:call).with(HandlerClass, event, record)
     broker.call(event, record)
   end
 
-  specify 'raise error when no subscriber' do
+  specify "raise error when no subscriber" do
     expect { broker.add_subscription(nil, [])}.to raise_error(RubyEventStore::SubscriberNotExist, "subscriber must be first argument or block")
     expect { broker.add_global_subscription(nil)}.to raise_error(RubyEventStore::SubscriberNotExist), "subscriber must be first argument or block"
     expect { broker.add_thread_subscription(nil, []).call}.to raise_error(RubyEventStore::SubscriberNotExist), "subscriber must be first argument or block"
     expect { broker.add_thread_global_subscription(nil).call}.to raise_error(RubyEventStore::SubscriberNotExist), "subscriber must be first argument or block"
   end
 
-  specify 'raise error when wrong subscriber' do
+  specify "raise error when wrong subscriber" do
     allow(dispatcher).to receive(:verify).and_return(false)
     expect do
       broker.add_subscription(HandlerClass, [])
@@ -56,8 +56,8 @@ RSpec.shared_examples :broker do |broker_klass|
 
   specify "verify and add - local subscriptions" do
     expect(dispatcher).to receive(:verify).with(handler).and_return(true)
-    expect(subscriptions).to receive(:add_subscription).with(handler, ['EventType'])
-    broker.add_subscription(handler, ['EventType'])
+    expect(subscriptions).to receive(:add_subscription).with(handler, ["EventType"])
+    broker.add_subscription(handler, ["EventType"])
   end
 
   specify "verify and add - global subscriptions" do
@@ -68,8 +68,8 @@ RSpec.shared_examples :broker do |broker_klass|
 
   specify "verify and add - thread local subscriptions" do
     expect(dispatcher).to receive(:verify).with(handler).and_return(true)
-    expect(subscriptions).to receive(:add_thread_subscription).with(handler, ['EventType'])
-    broker.add_thread_subscription(handler, ['EventType'])
+    expect(subscriptions).to receive(:add_thread_subscription).with(handler, ["EventType"])
+    broker.add_thread_subscription(handler, ["EventType"])
   end
 
   specify "verify and add - thread global subscriptions" do