event_engine-subscribers 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77ec2b6b5c9768d1968ead2a2d567e796a91747036be8d6c407137a36997c781
-  data.tar.gz: 4f97fd5b867ca07942c082c3e37a65e4a0bb452c6e7c4d59fd409561ccb9ea23
+  metadata.gz: eae67c45dcc6b8946ca569bbf90a1e9811b5c974a98ebdf27b1030aac9dfe948
+  data.tar.gz: 6fd89515d0fd50f6324a37f605343a2f63e347ce20400e6e166536c922125405
 SHA512:
-  metadata.gz: b806c0dbe05a8c57a1d3b1c0cd0fbe7937d015f5822d37c3f5feafd083d922a5f528b871564aaa8259866d8f0bd6ca4b90af63351788b8521f4baadf57346201
-  data.tar.gz: fcc63467dcf27dc0021304dd36821de214c30f9eff44efca1f3f2cd6a9b5a59cbe6f43693547f28e86bc4b0f7dfa949f8d912ee25c914bd1ff35328ba9aed617
+  metadata.gz: 4f0ac3aa8052389ef2b57646d586e07492346e9f1eb3a9abf4dcd5275687e4bebd11b4e023a5df14469971c32e6c74b32ddcde1ff494ff64331171efe3b294a8
+  data.tar.gz: 5567b5513c5524d4ab3c93a3db192def68a24ad5260805b8c2c3b861009f0c46d0cbffd257e6e6c7ee4fe4bdf84db318a2841c98db48f311bbce0e12df4749d9

data/README.md

@@ -100,27 +100,42 @@ 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.
 
-## Requiring every event to run inline
+## 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
 
 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:
+emit. A host that depends on that names the event packs whose events must run inline:
 
 ```ruby
 # config/application.rb
-config.after_initialize do
-  EventEngine::Subscribers.check_inline!(EventEngine::Subscribers.routes)
-end
+config.event_engine_subscribers.inline_packs = [:console]
 ```
 
-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.
+When the app starts, the gem then refuses to start when an event has no rule, when a
+rule names a processor nothing registered, or when an event in a named pack is routed to
+`background`. The last error names every such event. Events in other packs may still
+run in the background. With no packs named, which is the default, the gem runs no inline
+check.
 
 ## A working example app
 

data/lib/event_engine/subscribers/engine.rb

@@ -5,6 +5,15 @@ module EventEngine
     class Engine < ::Rails::Engine
       isolate_namespace EventEngine::Subscribers
 
+      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
           processor = Processor.new
@@ -18,6 +27,13 @@ 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?
+        end
+      end
+
       initializer "event_engine.subscribers.forget_unloaded_subscribers" do |app|
         app.reloader.before_class_unload { Registry.clear! }
       end
@@ -26,6 +42,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.3.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/event_engine/subscribers.rb

@@ -25,12 +25,20 @@ module EventEngine
       true
     end
 
-    def self.check_inline!(routes)
+    def self.check_inline!(routes, packs: nil)
       EventEngine.validate_rules!
       background = routes.reject { |_event_name, process_type| process_type == :inline }.keys
+      background = background.select { |event_name| packs.include?(pack_of(event_name)) } if packs
       raise BackgroundEventsError, background if background.any?
 
       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
 end

metadata

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