pubsub_on_rails 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 610b5e8d1415af6aa00766ef49444e4a3889aa6e1d79c0da2a74a58a09726d0c
-  data.tar.gz: 57ac3717989db60def406d8f6a85aa4139bdffef3ee3d05b5d7dcae70823f6dc
+  metadata.gz: 665f27ae9c49ccdd0f1b87c8f5b788a558ebee2a22848f3ab04e272528df7e17
+  data.tar.gz: c7107b6d788c1ac9a0069b104b6e4db211a692ef4a6345c613a62fcbcd306859
 SHA512:
-  metadata.gz: 43d05d52a2f8dfbc52c9cca47a731acb8c98d2b36d2d490aef3f08cf9a902bf29e9dd394f441fcd914d74fcf53230ccaaf011c0ef64e5c1be546947e6a5ca7d1
-  data.tar.gz: 8c4fc34fc4404ff3476bef408760b10af12113720aadad1428566ab34e8350d902375022621148bf7e3016ae1cdc8ee682cdeacece0f95438d4a177a400bceec
+  metadata.gz: 4a0f58bbe6dd2ff109934781c580c3ac5b1a711db532a4f0a61f2a005b3b6fee0d4c89391cf53f6d33c0dc65972ccddb34843e551121053641781499fb7d0d7e
+  data.tar.gz: c1895dffa35a785cd78ff6ab62e2e5c5fb10c4937d96b81f7d44cfe63908d101eb30073054ef1dfd17829ebfa72a47f9ee8275e1df813c89ad1d40a7a29c6fb2

data/README.md

@@ -16,8 +16,50 @@ This is especially true for applications covering many side effects, integration
 ```ruby
 # Gemfile
 
+gem 'pubsub_on_rails', '~> 1.1.0'
+
+# config/initializers/pub_sub.rb
+
+require 'pub_sub/subscriptions_list'
+
+Rails.configuration.to_prepare do
+  Rails.configuration.event_store = event_store = RailsEventStore::Client.new(
+    repository: RailsEventStoreActiveRecord::EventRepository.new(serializer: RubyEventStore::NULL)
+  )
+
+  PubSub::SubscriptionsList.config_path =
+    Rails.root.join('config/subscriptions.yml')
+  PubSub::SubscriptionsList.load!(event_store)
+end
+```
+
+## Migrating from 0.0.7 to 1.0.0
+
+1. Update gem to version `1.0.0`
+
+```ruby
+# Gemfile
+
 gem 'pubsub_on_rails', '~> 1.0.0'
+```
+
+2. Run Rails Event Store migrations
+
+**MySQL**
+```
+bin/rails generate rails_event_store_active_record:migration
+bin/rails db:migrate
+```
 
+**PostgreSQL**
+```
+bin/rails generate rails_event_store_active_record:migration --data-type=jsonb
+bin/rails db:migrate
+```
+
+3. Update initializer to use Rails Event Store Client
+
+```ruby
 # config/initializers/pub_sub.rb
 
 require 'pub_sub/subscriptions_list'
@@ -33,6 +75,31 @@ Rails.configuration.to_prepare do
 end
 ```
 
+4. Override `EventWorker` or override `EventHandlerBuilder` if needed
+
+For example when you want to have different workers for different events:
+
+```ruby
+# config/initializers/pub_sub.rb
+
+PubSub::EventHandlerBuilder.class_eval do
+  def call(event)
+    if async?
+      if class_name.to_s.include?('MyType')
+        SingleThreadEventWorker.perform_in(2.seconds, class_name.to_s, event.event_id)
+      else
+        EventWorker.perform_in(2.seconds, class_name.to_s, event.event_id)
+      end
+    else
+      class_name.new(event).call!
+    end
+  end
+end
+```
+
+5. Add event objects for Rails Event Store streams. Check [Event](README.md#Event) section.
+6. Update test cases to use new matchers. Check [Testing](README.md#Testing) section.
+
 ## Entities
 
 There are five entities that are core to PubSub on Rails: domains, events, event publishers, event handlers and subscriptions.
@@ -69,13 +136,17 @@ Event example:
 ```ruby
 # app/events/ordering/order_created_event.rb
 
-module Ordering
-  class OrderCreatedEvent < PubSub::DomainEvent
-    attribute :order_id, Types::Strict::Integer
-    attribute :customer_id, Types::Strict::Integer
-    attribute :line_items, Types::Strict::Array
-    attribute :total_amount, Types::Strict::Float
-    attribute :comment, Types::Strict::String.optional
+module PubSub
+  module Ordering
+    class OrderCreatedEvent < PubSub::EventWithType
+      schema do
+        attribute :order_id, Types::Strict::Integer
+        attribute :customer_id, Types::Strict::Integer
+        attribute :line_items, Types::Strict::Array
+        attribute :total_amount, Types::Strict::Float
+        attribute :comment, Types::Strict::String.optional
+      end
+    end
   end
 end
 ```
@@ -351,15 +422,19 @@ logging:
 
 ## Payload verification
 
-Every time event is emitted, its payload is supplied to corresponding event class and is verified.
+Every time event is emitted, its payload is supplied to corresponding `Dry::Struct` event class and is verified.
 This ensures that whenever we emit event we can be sure its payload is matching specification.
 
 Example:
 
 ```ruby
-module Accounts
-  class PersonCreatedEvent < PubSub::DomainEvent
-    attribute :person_id, Types::Strict::Integer
+module PubSub
+  module Accounts
+    class PersonCreatedEvent < PubSub::EventWithType
+      schema do
+        attribute :person_id, Types::Strict::Integer
+      end
+    end
   end
 end
 ```

data/lib/pub_sub/event_emission.rb

@@ -48,22 +48,18 @@ module PubSub
       end
     end
 
-    def dry_struct_event_class
-      @dry_struct_event_class ||= event_class.name.remove('PubSub').constantize
-    end
-
     # rubocop:disable Metrics/MethodLength
     def full_payload
-      dry_struct_event_class.attribute_names.each_with_object({}) do |attribute_name, result|
+      attribute_names.each_with_object({}) do |attribute_name, result|
         result[attribute_name] = PayloadAttribute.new(
           attribute_name, explicit_payload, context
         ).get
       rescue PayloadAttribute::CannotEvaluate => e
-        next if dry_struct_event_class.schema.key(attribute_name).default?
+        next if schema.key(attribute_name).default?
 
         raise(
           EventPayloadArgumentMissing,
-          "Event [#{dry_struct_event_class.name}] expects [#{attribute_name}] " \
+          "Event [#{event_class.name}] expects [#{attribute_name}] " \
           "payload attribute to be either exposed as [#{e.message}] method in emitting object " \
           'or provided as argument'
         )
@@ -71,6 +67,14 @@ module PubSub
     end
     # rubocop:enable Metrics/MethodLength
 
+    def attribute_names
+      (abstract_event_class || event_class.instance_variable_get(:@schema_validator)).attribute_names
+    end
+
+    def schema
+      (abstract_event_class || event_class.instance_variable_get(:@schema_validator)).schema
+    end
+
     def event_store
       Rails.configuration.event_store
     end

data/lib/pub_sub/event_with_type.rb

@@ -4,7 +4,7 @@ module PubSub
       super(
         event_id:,
         metadata:,
-        data: self.class.name.remove('PubSub').constantize.new(
+        data: self.class.instance_variable_get(:@schema_validator).new(
           data.deep_symbolize_keys
         ).attributes
       )
@@ -13,5 +13,9 @@ module PubSub
     def stream_names
       []
     end
+
+    def self.schema(&block)
+      instance_variable_set(:@schema_validator, Class.new(Dry::Struct, &block))
+    end
   end
 end

data/lib/pub_sub/version.rb

@@ -1,3 +1,3 @@
 module PubSub
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubsub_on_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Stevo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-02 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -96,6 +96,7 @@ files:
 - lib/pub_sub/version.rb
 - lib/pubsub_on_rails.rb
 - pubsub_on_rails-0.0.7.gem
+- pubsub_on_rails-1.0.0.gem
 - pubsub_on_rails.gemspec
 homepage: https://github.com/Selleo/pubsub_on_rails
 licenses: