event_engine-subscribers 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9911cefcbfa87b20178f615e68e88cef8f57da763ad42fcdf10a3f7f1b9d7be9
-  data.tar.gz: 1aa83bfbbea17ba4b3d2555f08509545f487e94d38abc52409de1a97bfa52109
+  metadata.gz: bbee4f2589c558f24ee153965000570ecdafd07fc131a60c123b444943a69a2e
+  data.tar.gz: 2f314b0b83c6cc107f9367ea8dd43afc82c7cf1fd1007a92795964f21865a4cd
 SHA512:
-  metadata.gz: 64e5c8652616821523641c4ffa5e17afb165e052847cde405c42f9ba2e852ed90a5c77add76ba3d6315e4fe230b97c280ff6213db5671c18a94e41757d957f82
-  data.tar.gz: 6b420c78274b70abf4cda7d544074e692e400409dac035937204b2270a0a2605b9a3f63198d46b0c9201c49cd3406aab5a6d1f789de28defe4c69aaf4f6fd88c
+  metadata.gz: 4f0b5988077c604629273013de16dfda42f4dbcb568e57d744e688d0b0107c94c90d60b66cecd0d2fdcfdcb156fbdd69036b8f030888bd787a0df9d0dc8daabb
+  data.tar.gz: 116c77921a190211c785c866dc97a81def005dfc8e0bb47ada93c3e6f5c9ecaf7cdb24c2063748fbc7bf7d4401a49ab4d08a003116277afba9810eb107688d12

data/README.md

@@ -100,9 +100,26 @@ EventEngine::Subscribers::UnsubscribedEventsError: These events are routed to
   subscribers but have none: hay_baled
 ```
 
-The check runs once the app has started, after every class in `app/subscribers` is
-registered. A subscriber anywhere else registers only once Rails has loaded its class,
-so keep subscribers in `app/subscribers`.
+The check runs once the app has started, after every class in `app/subscribers` and in
+the folders named in `subscriber_folders` is registered. A subscriber anywhere else
+registers only once Rails has loaded its class, so keep subscribers in `app/subscribers`
+or in a folder you name there.
+
+## Keeping subscribers in other folders
+
+A host that keeps subscribers outside `app/subscribers` names those folders, relative to
+the app's root:
+
+```ruby
+# config/application.rb
+config.event_engine_subscribers.subscriber_folders = ["hubs/*/app/subscribers"]
+```
+
+Each entry is a folder or a pattern that matches several folders. The gem adds every
+folder it matches to the app's eager load paths, then loads and registers its subscribers
+when the app starts and again after each code reload, the same as `app/subscribers`. A
+folder or pattern that matches nothing is skipped. It names no folders by default, so
+only `app/subscribers` is loaded.
 
 ## Requiring a pack's events to run inline
 

data/lib/event_engine/subscribers/engine.rb

@@ -7,6 +7,12 @@ module EventEngine
 
       config.event_engine_subscribers = ActiveSupport::OrderedOptions.new
       config.event_engine_subscribers.inline_packs = []
+      config.event_engine_subscribers.subscriber_folders = []
+
+      initializer "event_engine.subscribers.autoload_subscriber_folders", before: :set_autoload_paths do |app|
+        folders = Subscribers.folders_matching(app.root, app.config.event_engine_subscribers.subscriber_folders)
+        app.config.eager_load_paths += folders.map(&:to_s)
+      end
 
       initializer "event_engine.subscribers.register_processor" do
         config.after_initialize do
@@ -21,10 +27,14 @@ module EventEngine
         config.after_initialize { Subscribers.check!(Subscribers.routes) }
       end
 
-      initializer "event_engine.subscribers.check_inline_packs", after: "event_engine.subscribers.register_processor" do |app|
-        config.after_initialize do
-          packs = app.config.event_engine_subscribers.inline_packs
-          Subscribers.check_inline!(Subscribers.routes, packs: packs) if packs.any?
+      initializer "event_engine.subscribers.check_inline_packs" do |app|
+        config.to_prepare do
+          next if app.initialized?
+
+          app.config.after_initialize do
+            packs = app.config.event_engine_subscribers.inline_packs
+            Subscribers.check_inline!(Subscribers.routes, packs: packs) if packs.any?
+          end
         end
       end
 
@@ -36,6 +46,9 @@ module EventEngine
         config.to_prepare do
           subscribers = app.root.join("app/subscribers")
           Rails.autoloaders.main.eager_load_dir(subscribers) if subscribers.directory?
+          Subscribers.folders_matching(app.root, app.config.event_engine_subscribers.subscriber_folders).each do |folder|
+            Rails.autoloaders.main.eager_load_dir(folder)
+          end
         end
       end
     end

data/lib/event_engine/subscribers/version.rb

@@ -1,5 +1,5 @@
 module EventEngine
   module Subscribers
-    VERSION = "0.4.0"
+    VERSION = "0.5.1"
   end
 end

data/lib/event_engine/subscribers.rb

@@ -34,6 +34,10 @@ module EventEngine
       true
     end
 
+    def self.folders_matching(root, patterns)
+      patterns.flat_map { |pattern| Dir[root.join(pattern).to_s] }.map { |folder| Pathname.new(folder) }.select(&:directory?)
+    end
+
     def self.pack_of(event_name) = EventEngine.schema_registry.latest_for(event_name).domain
     private_class_method :pack_of
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_engine-subscribers
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - tylercschneider