hub_kernel 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0aadeed46c5d7c19209c32b3fb4de077a80ebb2670d5f5545918fe3f9421e14
-  data.tar.gz: d3f57b2de645c719357101e13752b464b67c31ea38fa169281c7213c95c6f273
+  metadata.gz: 2e21318b337715e24c66ec08ab39f65b4a11aa4eb43783a05bf6f7548dd7f8fc
+  data.tar.gz: 36790eed17097fefd6b6c2eaa1a6c42b712b7b1cc9df510ad1b0b8f2e4136a3c
 SHA512:
-  metadata.gz: 2b78566e883135e653f2638c2986ba74e14153443b56fd923a14a6dae50eef107acbdc9ccf6c96774d8c96fce7802497a2643f66c316f3186ef976a5bb031a85
-  data.tar.gz: a939a5363771f77fedf2f4c647a5e67287a6bef22fac61665a5d818f5667ed6a066fda7227efbd8b8a115f17ddbd197e14a271b8d82005d559df2bd5a19d0fdc
+  metadata.gz: 776e13a1c4fb5be4f499fe4a2647d845fb5bf9b972bd7e045b5fa4c754130bb633a0841230f2aeee684d017fc8d23be144db551915e84eb240a9458c5c8bc78d
+  data.tar.gz: 238d3e0722eb7c89ed1a32237a1d7edcf68933034aa98df541001ac8bbaccaaf81ee0d96d90029e4fed3cb523d4c80510ccbb72c9b3ae2d3948257e0a1e9f448

data/README.md

@@ -28,6 +28,22 @@ returns its answer. An error it raises reaches the caller unchanged. Calling a p
 app left unfilled raises `HubKernel::UnwiredPortError`, such as "Supplies' spend
 recorder is not wired".
 
+### The start check
+Every hub that declares a port is on `HubKernel::Hubs.list`. Call
+`HubKernel::Hubs.check!` after the app fills its ports, and the app refuses to start
+while any port is unfilled:
+
+```ruby
+Rails.application.config.to_prepare do
+  Supplies.spend_recorder = Finance.method(:record_spend)
+  HubKernel::Hubs.check!
+end
+```
+
+It raises `HubKernel::UnwiredPortError` naming every unfilled port with its hub, one per
+line. Running it inside `to_prepare` checks again after every code reload, and a hub
+declared again on a reload stays on the list once.
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/hub_kernel/hubs.rb

@@ -0,0 +1,15 @@
+module HubKernel
+  module Hubs
+    def self.add(hub)
+      list.reject! { |listed| listed.name == hub.name }
+      list << hub
+    end
+
+    def self.list = @list ||= []
+
+    def self.check!
+      unwired = list.flat_map(&:unwired_ports)
+      raise UnwiredPortError, unwired.join("\n") if unwired.any?
+    end
+  end
+end

data/lib/hub_kernel/ports.rb

@@ -1,21 +1,32 @@
 require "active_support/core_ext/string/inflections"
+require "hub_kernel/hubs"
 
 module HubKernel
   class UnwiredPortError < StandardError; end
 
   module Ports
     def port(name, as:)
+      Hubs.add(self)
+      declared_ports << name
       singleton_class.attr_writer name
       define_singleton_method(name) { instance_variable_get(:"@#{name}") || unwired(name) }
       define_singleton_method(as) { |*args, **options| public_send(name).call(*args, **options) }
     end
 
+    def unwired_ports
+      declared_ports.reject { |name| instance_variable_get(:"@#{name}") }.map { |name| unwired_message(name) }
+    end
+
     private
 
+    def declared_ports = @declared_ports ||= []
+
     def unwired(name)
-      ->(*, **) { raise UnwiredPortError, "#{hub_name} #{name.to_s.tr("_", " ")} is not wired" }
+      ->(*, **) { raise UnwiredPortError, unwired_message(name) }
     end
 
+    def unwired_message(name) = "#{hub_name} #{name.to_s.tr("_", " ")} is not wired"
+
     def hub_name = self.name.demodulize.then { |hub| hub.end_with?("s") ? "#{hub}'" : "#{hub}'s" }
   end
 end

data/lib/hub_kernel/version.rb

@@ -1,3 +1,3 @@
 module HubKernel
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - tylercschneider
@@ -46,6 +46,7 @@ files:
 - lib/hub_kernel/engine.rb
 - lib/hub_kernel/events.rb
 - lib/hub_kernel/follow_up.rb
+- lib/hub_kernel/hubs.rb
 - lib/hub_kernel/markup.rb
 - lib/hub_kernel/ports.rb
 - lib/hub_kernel/version.rb