event_store_client 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9e8e4782cfd1b70376d4531ae7452d721e7af3078f23a2c6d345e654fed5d1d
-  data.tar.gz: b7de94d902e0ff87747b5f58f3740c580473514638901ed666fc07d98fc47b7f
+  metadata.gz: 82b73db66b7feef1d17e010f9e410476ab900bd6b137af03ee57106f2aefea6b
+  data.tar.gz: 926d40bfa51a581de7f9e7942d7092e4e0f0d7c23d1c932cb689946ef3a690f5
 SHA512:
-  metadata.gz: 03015ede0f74da75119247433579079ee2d71a9ab9f347d23a2f52915c5bc3441574f098a9509843325c5dd568c95c6c77681a7aaa81c364b90397e95181f929
-  data.tar.gz: 10f9a45843bc18f0e2e35294b9dee0c7e0c1f9a33e1e4c41881f407c82ee5df4714aaef6f6d4879b271f7ef6ea032e7e765d0f97ff23b99046a68ff2b230bffb
+  metadata.gz: 59dc478314bb1a15895dfe851248d6c1b62a381c26d03c8f7d1d18465a1407a28f007a959f2c655222b54dd310929df5430528125c3c97221393e3ce3b937256
+  data.tar.gz: bb92b9f60639f5d0552c69b493e0e6dbb8e6985e89d7f4f78de6df45c12e6098554e7de13f8880e45fd84a8ddc8528eec778a78715ebd591fcc5c331709bea4a

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,5 +1,3 @@
-# @title Configuration
-
 # Configuration
 
 Configuration options:
@@ -28,9 +26,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 +37,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 +137,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 +160,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/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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_store_client
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Sebastian Wilgosz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-05-17 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
@@ -226,6 +226,7 @@ files:
 - 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 +246,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