event_store_client 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9e8e4782cfd1b70376d4531ae7452d721e7af3078f23a2c6d345e654fed5d1d
-  data.tar.gz: b7de94d902e0ff87747b5f58f3740c580473514638901ed666fc07d98fc47b7f
+  metadata.gz: 3d4a4dc809c49fb6d9ab52ea68c6bfcb58217cb463d64e7591d5de7e0e5c80af
+  data.tar.gz: 29c38f7e04dd6b4b73a61966353ec51246037dfb6ffd25d38a8ebfc06c9faa8a
 SHA512:
-  metadata.gz: 03015ede0f74da75119247433579079ee2d71a9ab9f347d23a2f52915c5bc3441574f098a9509843325c5dd568c95c6c77681a7aaa81c364b90397e95181f929
-  data.tar.gz: 10f9a45843bc18f0e2e35294b9dee0c7e0c1f9a33e1e4c41881f407c82ee5df4714aaef6f6d4879b271f7ef6ea032e7e765d0f97ff23b99046a68ff2b230bffb
+  metadata.gz: 4c15bb242df2456c57fbddd4dbe553113e803d26062081e1261ba134b64db2e445ae0f6a56a218555f3007e858c030212285749765aa941152fc6e395325acf6
+  data.tar.gz: 04654757ca1d4ed722255ac16d53cfa6415a7dc098ded62fbc91479fef681ed66f80ecd61e408f7a2f8bdafbf724cc4e1b9766c39f015cd79a799b327f15a3b3

data/README.md

@@ -9,7 +9,7 @@ An easy-to use GRPC API client for connecting ruby applications with [EventStore
 
 `event_store_client` gem requires:
 
-- ruby 2.7 or newer.
+- ruby 3.0 or newer.
 - EventstoreDB version `>= "20.*"`.
 
 ## Installation

data/docs/appending_events.md

@@ -1,6 +1,4 @@
-# @title Appending events
-
-# Append your first event
+# Appending Events
 
 ## Append your first event
 
@@ -15,10 +13,10 @@ event = SomethingHappened.new(
 )
 
 begin
-  EventStoreClient.client.append_to_stream('some-stream', event) 
+  EventStoreClient.client.append_to_stream('some-stream', event)
   # => EventStore::Client::Streams::AppendResp
 rescue EventStoreClient::WrongExpectedVersionError => e
-  puts e.message  
+  puts e.message
 end
 ```
 
@@ -38,7 +36,7 @@ event2 = SomethingHappened.new(
 )
 
 begin
-  EventStoreClient.client.append_to_stream('some-stream', [event1, event2]) 
+  EventStoreClient.client.append_to_stream('some-stream', [event1, event2])
   # => Array<EventStore::Client::Streams::AppendResp>
 rescue EventStoreClient::WrongExpectedVersionError => e
   puts e.message

data/docs/catch_up_subscriptions.md

@@ -1,6 +1,4 @@
-# @title Catch-up subscriptions
-
-# Catch-up subscriptions
+# Catch-up Subscriptions
 
 Subscriptions allow you to subscribe to a stream and receive notifications about new events added to the stream.
 
@@ -111,7 +109,7 @@ An application, which hosts the subscription, can go offline for a period of tim
 checkpoint = :start
 handler = proc do |event|
   handle_event(event)
-  checkpoint = event.stream_revision  
+  checkpoint = event.stream_revision
 end
 
 EventStoreClient.client.subscribe_to_stream('some-stream', handler: handler, options: { from_revision: checkpoint })

data/docs/configuration.md

@@ -1,19 +1,18 @@
-# @title Configuration
-
 # Configuration
 
 Configuration options:
 
-| name                 | value                                                                                | default value                                                                                                                     | description                                                                                                                                                                                                                                           |
-|----------------------|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| eventstore_url      | String                                                                               | `'esdb://localhost:2113'`                                                                                                         | Connection string. See description of possible values below.                                                                                                                                                                                          |
-| per_page             | Integer                                                                              | `20`                                                                                                                              | Number of events to return in one response.                                                                                                                                                                                                           |
-| mapper               | `EventStoreClient::Mapper::Default.new` or `EventStoreClient::Mapper::Encrypted.new` | `EventStoreClient::Mapper::Default.new`                                                                                           | An object that is responsible for serialization / deserialization and encryption / decryption of events.                                                                                                                                              |
-| default_event_class  | `DeserializedEvent` or any class, inherited from it                                  | `DeserializedEvent`                                                                                                               | This class will be used during the deserialization process when deserializer fails to resolve an event's class from response.                                                                                                                         |
-| logger               | `Logger`                                                                             | `nil`                                                                                                                             | A logger that would log messages from `event_store_client` and `grpc` gems.                                                                                                                                                                           |
-| skip_deserialization | Boolean                                                                              | `false`                                                                                                                           | Whether to skip event deserialization using the given `mapper` setting. If you set it to `true` decryption will be skipped as well. It is useful when you want to defer deserialization and handle it later by yourself.                              |
-| skip_decryption      | Boolean                                                                              | `false`                                                                                                                           | Whether to skip decrypting encrypted event payloads.                                                                                                                                                                                                  |
-| channel_args      | Hash                                                                                 | `{ 'grpc.min_reconnect_backoff_ms' => 100, 'grpc.max_reconnect_backoff_ms' => 100, 'grpc.initial_reconnect_backoff_ms' => 100 }` | GRPC-specific connection options. This hash will be passed into the `:channel_args` argument of a Stub class of your request. More GRPC options can be found [here](https://github.com/grpc/grpc/blob/master/include/grpc/impl/codegen/grpc_types.h). |
+| name                 | value                                                                                | default value                                                                                                                    | description                                                                                                                                                                                                                                         |
+|----------------------|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| eventstore_url       | String                                                                               | `'esdb://localhost:2113'`                                                                                                        | Connection string. See description of possible values below.                                                                                                                                                                                        |
+| per_page             | Integer                                                                              | `20`                                                                                                                             | Number of events to return in one response.                                                                                                                                                                                                         |
+| mapper               | `EventStoreClient::Mapper::Default.new` or `EventStoreClient::Mapper::Encrypted.new` | `EventStoreClient::Mapper::Default.new`                                                                                          | An object that is responsible for serialization / deserialization and encryption / decryption of events.                                                                                                                                            |
+| default_event_class  | `DeserializedEvent` or any class, inherited from it                                  | `EventStoreClient::DeserializedEvent`                                                                                            | This class will be used during the deserialization process when deserializer fails to resolve an event's class from response.                                                                                                                       |
+| event_class_resolver | `Proc`                                                                               | `nil`                                                                                                                            | A Proc that accepts a string and returns event class.                                                                                                                                                                                               |
+| logger               | `Logger`                                                                             | `nil`                                                                                                                            | A logger that would log messages from `event_store_client` and `grpc` gems.                                                                                                                                                                         |
+| skip_deserialization | Boolean                                                                              | `false`                                                                                                                          | Whether to skip event deserialization using the given `mapper` setting. If you set it to `true` decryption will be skipped as well. It is useful when you want to defer deserialization and handle it later by yourself.                            |
+| skip_decryption      | Boolean                                                                              | `false`                                                                                                                          | Whether to skip decrypting encrypted event payloads.                                                                                                                                                                                                |
+| channel_args         | Hash                                                                                 | `{ 'grpc.min_reconnect_backoff_ms' => 100, 'grpc.max_reconnect_backoff_ms' => 100, 'grpc.initial_reconnect_backoff_ms' => 100 }` | GRPC-specific connection options. This hash will be passed into the `:channel_args` argument of a Stub class of your request. More GRPC options can be found [here](https://github.com/grpc/grpc/blob/v1.55.1/include/grpc/impl/grpc_types.h#L141). |
 
 ## A note about channel_args option
 
@@ -28,9 +27,9 @@ end
 the resulting `channel_args` value will be
 
 ```ruby
-{ 
-  "grpc.min_reconnect_backoff_ms" => 200, 
-  "grpc.max_reconnect_backoff_ms" => 100, 
+{
+  "grpc.min_reconnect_backoff_ms" => 200,
+  "grpc.max_reconnect_backoff_ms" => 100,
   "grpc.initial_reconnect_backoff_ms" => 100
 }
 ```
@@ -39,7 +38,7 @@ This behaviour is intentional. So, if you want to override them all - you should
 
 ```ruby
 EventStoreClient.configure do |config|
-  config.channel_args = { 
+  config.channel_args = {
     'grpc.min_reconnect_backoff_ms' => 500,
     'grpc.max_reconnect_backoff_ms' => 500,
     'grpc.initial_reconnect_backoff_ms' => 500
@@ -139,7 +138,7 @@ EventStoreClient.configure(name: :es_db_1) do |config|
 end
 EventStoreClient.configure(name: :es_db_2) do |config|
   # adjust your second config here
-  config.eventstore_url = 'esdb://localhost:2114' 
+  config.eventstore_url = 'esdb://localhost:2114'
 end
 ```
 
@@ -162,7 +161,7 @@ Setup your default config:
 ```ruby
 EventStoreClient.configure do |config|
   # config goes here
-  config.eventstore_url = 'esdb://localhost:2113' 
+  config.eventstore_url = 'esdb://localhost:2113'
 end
 ```
 

data/docs/deleting_streams.md

@@ -1,6 +1,4 @@
-# @title Deleting streams
-
-# Deleting streams
+# Deleting Streams
 
 ## Soft deleting streams
 

data/docs/encrypting_events.md

@@ -1,6 +1,4 @@
-# @title Encrypting events
-
-# Encrypting events
+# Encrypting Events
 
 To encrypt/decrypt events payload, you can use an encrypted mapper.
 

data/docs/linking_events.md

@@ -1,6 +1,4 @@
-# @title Linking events
-
-# Linking events
+# Linking Events
 
 ## Linking single event
 
@@ -20,7 +18,7 @@ EventStoreClient.client.append_to_stream(stream_name_1, event)
 # Get persisted event
 event = EventStoreClient.client.read(stream_name_1).first
 # Link event from first stream into second stream
-EventStoreClient.client.link_to(stream_name_2, event) 
+EventStoreClient.client.link_to(stream_name_2, event)
 # => EventStore::Client::Streams::AppendResp
 ```
 
@@ -55,7 +53,7 @@ end
 # Get persisted events
 events = EventStoreClient.client.read(stream_name_1)
 # Link events from first stream into second stream one by one
-EventStoreClient.client.link_to(stream_name_2, events) 
+EventStoreClient.client.link_to(stream_name_2, events)
 # => Array<EventStore::Client::Streams::AppendResp>
 ```
 
@@ -86,7 +84,7 @@ events = EventStoreClient.client.read(stream_name_1)
 begin
   EventStoreClient.client.link_to(stream_name_2, events, options: { expected_revision: :no_stream })
 rescue EventStoreClient::WrongExpectedVersionError => e
-  puts e.message  
+  puts e.message
 end
 ```
 

data/docs/reading_events.md

@@ -1,6 +1,4 @@
-# @title Reading events
-
-# Reading events
+# Reading Events
 
 ## Reading from a stream
 
@@ -63,7 +61,7 @@ In case a stream with given name does not exist - `EventStoreClient::StreamNotFo
 
 ```ruby
 begin
-  EventStoreClient.client.read('non-existing-stream')  
+  EventStoreClient.client.read('non-existing-stream')
 rescue EventStoreClient::StreamNotFoundError => e
   puts e.message # => Stream "non-existing-stream" does not exist.
   puts e.stream_name # => "non-existing-stream"

data/lib/event_store_client/config.rb

@@ -23,6 +23,7 @@ module EventStoreClient
     # https://github.com/grpc/grpc/blob/master/include/grpc/impl/codegen/grpc_types.h
     option(:channel_args) # Hash
     option(:name) { :default }
+    option(:event_class_resolver) # Proc that excepts a string and returns a class
 
     def eventstore_url=(value)
       @eventstore_url =

data/lib/event_store_client/errors.rb

@@ -48,28 +48,43 @@ module EventStoreClient
 
     # @return [String]
     def user_friendly_message
-      if wrong_expected_version.expected_stream_exists
-        return "Expected stream to exist, but it doesn't."
-      end
-      if wrong_expected_version.expected_no_stream
-        return "Expected stream to be absent, but it actually exists."
-      end
-      if wrong_expected_version.current_no_stream
-        return <<~TEXT.strip
-          Stream revision #{wrong_expected_version.expected_revision.inspect} is expected, but \
-          stream does not exist.
-        TEXT
-      end
+      return expected_stream_exists if wrong_expected_version.expected_stream_exists
+      return expected_no_stream if wrong_expected_version.expected_no_stream
+      return current_no_stream if wrong_expected_version.current_no_stream
       unless wrong_expected_version.expected_revision == wrong_expected_version.current_revision
-        return <<~TEXT.strip
-          Stream revision #{wrong_expected_version.expected_revision.inspect} is expected, but \
-          actual stream revision is #{wrong_expected_version.current_revision.inspect}.
-        TEXT
+        return unmatched_stream_revision
       end
+
       # Unhandled case. Could happen if something else would be added to proto and I don't add it
       # here.
       self.class.to_s
     end
+
+    # @return [String]
+    def expected_stream_exists
+      "Expected stream to exist, but it doesn't."
+    end
+
+    # @return [String]
+    def expected_no_stream
+      "Expected stream to be absent, but it actually exists."
+    end
+
+    # @return [String]
+    def current_no_stream
+      <<~TEXT.strip
+        Stream revision #{wrong_expected_version.expected_revision.inspect} is expected, but \
+        stream does not exist.
+      TEXT
+    end
+
+    # @return [String]
+    def unmatched_stream_revision
+      <<~TEXT.strip
+        Stream revision #{wrong_expected_version.expected_revision.inspect} is expected, but \
+        actual stream revision is #{wrong_expected_version.current_revision.inspect}.
+      TEXT
+    end
   end
 
   class StreamDeletionError < Error

data/lib/event_store_client/event_class_resolver.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module EventStoreClient
+  class EventClassResolver
+    attr_reader :config
+    private :config
+
+    # @param config [EventStoreClient::Config]
+    def initialize(config)
+      @config = config
+    end
+
+    # @param event_type [String, nil]
+    # @return [Class<EventStoreClient::DeserializedEvent>]
+    def resolve(event_type)
+      return config.event_class_resolver.(event_type) || config.default_event_class if config.event_class_resolver
+
+      Object.const_get(event_type)
+    rescue NameError, TypeError
+      config.logger&.debug(<<~TEXT.strip)
+        Unable to resolve class by `#{event_type}' event type. \
+        Picking default `#{config.default_event_class}' event class to instantiate the event.
+      TEXT
+      config.default_event_class
+    end
+  end
+end

data/lib/event_store_client/rspec/has_option_matcher.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# This matcher is defined to test options which are defined by using
+# EventStoreClient::Extensions::OptionsExtension option. Example:
+# Let's say you have next class
+# class SomeClass
+#   include EventStoreClient::Extensions::OptionsExtension
+#
+#   option(:some_opt) { '1' }
+# end
+#
+# To test that its instance has the proper option with the proper default value you can use this
+# matcher:
+# RSpec.describe SomeClass do
+#   subject { described_class.new }
+#
+#   # Check that :some_opt is present
+#   it { is_expected.to have_option(:some_opt) }
+#   # Check that :some_opt is present and has the correct default value
+#   it { is_expected.to have_option(:some_opt).with_default_value('1') }
+# end
+#
+# If you have more complex implementation of default value of your option - you should handle it
+# customly. For example:
+# class SomeClass
+#   include EventStoreClient::Extensions::OptionsExtension
+#
+#   option(:some_opt) { calc_value }
+# end
+# You could test it like so:
+# RSpec.described SomeClass do
+#   let(:instance) { described_class.new }
+#
+#   describe ':some_opt default value' do
+#     subject { instance.some_opt }
+#
+#     let(:value) { 'some val' }
+#
+#     before do
+#       allow(instance).to receive(:calc_value).and_return(value)
+#     end
+#
+#     it { is_expected.to eq(value) }
+#   end
+# end
+RSpec::Matchers.define :has_option do |option_name|
+  match do |obj|
+    option_presence = obj.class.respond_to?(:options) && obj.class.options.include?(option_name)
+    if @default_value
+      option_presence && obj.class.allocate.public_send(option_name) == @default_value
+    else
+      option_presence
+    end
+  end
+
+  failure_message do |obj|
+    option_presence = obj.class.respond_to?(:options) && obj.class.options.include?(option_name)
+    if option_presence && @default_value
+      msg = "Expected #{obj.class} to have `#{option_name.inspect}' option with #{@default_value.inspect}"
+      msg += ' default value, but default value is'
+      msg += " #{obj.class.allocate.public_send(option_name).inspect}"
+    else
+      msg = "Expected #{obj} to have `#{option_name.inspect}' option."
+    end
+
+    msg
+  end
+
+  description do
+    expected_list = RSpec::Matchers::EnglishPhrasing.list(expected)
+    sentences =
+      @chained_method_clauses.map do |(method_name, method_args)|
+        next '' if method_name == :required_kwargs
+
+        english_name = RSpec::Matchers::EnglishPhrasing.split_words(method_name)
+        arg_list = RSpec::Matchers::EnglishPhrasing.list(method_args)
+        " #{english_name}#{arg_list}"
+      end.join
+
+    "have#{expected_list} option#{sentences}"
+  end
+
+  chain :with_default_value do |val|
+    @default_value = val
+  end
+end
+
+RSpec::Matchers.alias_matcher :have_option, :has_option

data/lib/event_store_client/serializer/event_deserializer.rb

@@ -32,7 +32,8 @@ module EventStoreClient
         custom_metadata = serializer.deserialize(normalize_serialized(raw_event.custom_metadata))
         metadata = raw_event.metadata.to_h
 
-        event_class(metadata['type']).new(
+        event_class = EventStoreClient::EventClassResolver.new(config).resolve(metadata['type'])
+        event_class.new(
           skip_validation: true,
           id: raw_event.id.string,
           title: "#{raw_event.stream_revision}@#{raw_event.stream_identifier.stream_name}",
@@ -49,18 +50,6 @@ module EventStoreClient
 
       private
 
-      # @param event_type [String]
-      # @return [Class<EventStoreClient::DeserializedEvent>]
-      def event_class(event_type)
-        Object.const_get(event_type)
-      rescue NameError, TypeError
-        config.logger&.debug(<<~TEXT.strip)
-          Unable to resolve class by `#{event_type}' event type. \
-          Picking default `#{config.default_event_class}' event class to instantiate the event.
-        TEXT
-        config.default_event_class
-      end
-
       # @param raw_data [String]
       # @return [String]
       def normalize_serialized(raw_data)

data/lib/event_store_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EventStoreClient
-  VERSION = '3.0.0'
+  VERSION = '3.2.0'
 end

data/lib/event_store_client.rb

@@ -17,6 +17,7 @@ require 'event_store_client/connection/url'
 require 'event_store_client/connection/url_parser'
 require 'event_store_client/deserialized_event'
 require 'event_store_client/serialized_event'
+require 'event_store_client/event_class_resolver'
 require 'event_store_client/config'
 
 require 'event_store_client/mapper'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_store_client
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Sebastian Wilgosz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -222,10 +222,12 @@ files:
 - lib/event_store_client/deserialized_event.rb
 - lib/event_store_client/encryption_metadata.rb
 - lib/event_store_client/errors.rb
+- lib/event_store_client/event_class_resolver.rb
 - lib/event_store_client/extensions/options_extension.rb
 - lib/event_store_client/mapper.rb
 - lib/event_store_client/mapper/default.rb
 - lib/event_store_client/mapper/encrypted.rb
+- lib/event_store_client/rspec/has_option_matcher.rb
 - lib/event_store_client/serialized_event.rb
 - lib/event_store_client/serializer/event_deserializer.rb
 - lib/event_store_client/serializer/event_serializer.rb
@@ -245,14 +247,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Ruby integration for https://eventstore.org