hub_kernel 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0aadeed46c5d7c19209c32b3fb4de077a80ebb2670d5f5545918fe3f9421e14
-  data.tar.gz: d3f57b2de645c719357101e13752b464b67c31ea38fa169281c7213c95c6f273
+  metadata.gz: 4b68695ef96166801769081d8d607907cc32e6d215f798b6404dc8b13a1faab2
+  data.tar.gz: 2fb12e7fa8b2cf1e8246eea5204ae7b38f61c6b41e668e07c753e7f55f899bf1
 SHA512:
-  metadata.gz: 2b78566e883135e653f2638c2986ba74e14153443b56fd923a14a6dae50eef107acbdc9ccf6c96774d8c96fce7802497a2643f66c316f3186ef976a5bb031a85
-  data.tar.gz: a939a5363771f77fedf2f4c647a5e67287a6bef22fac61665a5d818f5667ed6a066fda7227efbd8b8a115f17ddbd197e14a271b8d82005d559df2bd5a19d0fdc
+  metadata.gz: 4cecfcff2e7565d73b3c047ff191cc57a1f1f73056727a644a82bcc6f07517678d370c8876abb7c6c97e10197d663d2f0fa046a1430939e38583a5e89dda7f7f
+  data.tar.gz: 7a83ad99b5cc838650469b8e436d6a8a7f3d70e2ac37685206e1a1094f98c987dde0b29044b52dc5def44b2392e2b3eb045332819bbe160581c028c27ae7df36

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.4.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.4.0
 platform: ruby
 authors:
 - tylercschneider
@@ -44,8 +44,8 @@ files:
 - lib/hub_kernel/conformance/partial.rb
 - lib/hub_kernel/context.rb
 - 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

data/lib/hub_kernel/events.rb

@@ -1,36 +0,0 @@
-module HubKernel
-  class UndeclaredEventError < StandardError; end
-  class UnwiredEventError < StandardError; end
-
-  module Events
-    def declared_events
-      instance_methods(false)
-    end
-
-    def on(name, &handler)
-      raise UndeclaredEventError, "undeclared event :#{name}; declared events are #{declared_events}" unless declared_events.include?(name)
-
-      handlers[name] << handler
-    end
-
-    def emit(name, payload)
-      handlers[name].each { |handler| handler.call(payload) }
-    end
-
-    def verify_wired!
-      return if unwired_events.empty?
-
-      raise UnwiredEventError, "unwired events: #{unwired_events}"
-    end
-
-    private
-
-    def unwired_events
-      declared_events.reject { |name| handlers[name].any? }
-    end
-
-    def handlers
-      @handlers ||= Hash.new { |table, name| table[name] = [] }
-    end
-  end
-end