event_engine-subscribers 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34965b10a7789582de233120f7e16c220292225c732605797c7dd2759f84d070
-  data.tar.gz: 3936714ca836690e78228fdfe66c5be51b5c7a7826264ea5f745ea696c16a277
+  metadata.gz: 77ec2b6b5c9768d1968ead2a2d567e796a91747036be8d6c407137a36997c781
+  data.tar.gz: 4f97fd5b867ca07942c082c3e37a65e4a0bb452c6e7c4d59fd409561ccb9ea23
 SHA512:
-  metadata.gz: '08c34c7ddcdef975a9c8af1f2289e55bf13bcaa7426e18544bb92bebe80f3acd1f927a9f207d05b130a4481b4aed632506f0e8e24c7fe3384e3cefbf62821088'
-  data.tar.gz: a750d52e0fc9a50cde6feded5f5ac782a027f9618ce4104a7fc2c231bdc403f8e6e607f8e9326297796e6fc4aab740f4912a3e458536acd65ea85d04fc808a1f
+  metadata.gz: b806c0dbe05a8c57a1d3b1c0cd0fbe7937d015f5822d37c3f5feafd083d922a5f528b871564aaa8259866d8f0bd6ca4b90af63351788b8521f4baadf57346201
+  data.tar.gz: fcc63467dcf27dc0021304dd36821de214c30f9eff44efca1f3f2cd6a9b5a59cbe6f43693547f28e86bc4b0f7dfa949f8d912ee25c914bd1ff35328ba9aed617

data/README.md

@@ -104,6 +104,24 @@ The check runs once the app has started, after every class in `app/subscribers`
 registered. A subscriber anywhere else registers only once Rails has loaded its class,
 so keep subscribers in `app/subscribers`.
 
+## Requiring every event to run inline
+
+A subscriber that refuses a change can only undo it when it runs inline, during the
+emit. A host that depends on that calls the event start check once the subscriber
+processors are registered:
+
+```ruby
+# config/application.rb
+config.after_initialize do
+  EventEngine::Subscribers.check_inline!(EventEngine::Subscribers.routes)
+end
+```
+
+The app then refuses to start when an event has no rule, when a rule names a processor
+nothing registered, or when any event is routed to `background`. The last error names
+every such event. A host that does not call it can route events to `background` as
+before.
+
 ## A working example app
 
 [**DYB-Development/event_engine_example**](https://github.com/DYB-Development/event_engine_example)

data/lib/event_engine/subscribers/background_events_error.rb

@@ -0,0 +1,9 @@
+module EventEngine
+  module Subscribers
+    class BackgroundEventsError < StandardError
+      def initialize(event_names)
+        super("These events are routed to run in the background, where a refusal cannot undo the change: #{event_names.join(", ")}")
+      end
+    end
+  end
+end

data/lib/event_engine/subscribers/version.rb

@@ -1,5 +1,5 @@
 module EventEngine
   module Subscribers
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/event_engine/subscribers.rb

@@ -4,6 +4,7 @@ require "event_engine/subscribers/registry"
 require "event_engine/subscribers/base"
 require "event_engine/subscribers/processor"
 require "event_engine/subscribers/unsubscribed_events_error"
+require "event_engine/subscribers/background_events_error"
 
 module EventEngine
   module Subscribers
@@ -23,5 +24,13 @@ module EventEngine
 
       true
     end
+
+    def self.check_inline!(routes)
+      EventEngine.validate_rules!
+      background = routes.reject { |_event_name, process_type| process_type == :inline }.keys
+      raise BackgroundEventsError, background if background.any?
+
+      true
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_engine-subscribers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - tylercschneider
@@ -81,6 +81,7 @@ files:
 - app/jobs/event_engine/subscribers/dispatch_subscribers_job.rb
 - app/views/layouts/event_engine/subscribers/application.html.erb
 - lib/event_engine/subscribers.rb
+- lib/event_engine/subscribers/background_events_error.rb
 - lib/event_engine/subscribers/base.rb
 - lib/event_engine/subscribers/engine.rb
 - lib/event_engine/subscribers/processor.rb