hub_kernel 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e433f46a0cd33d7236e9f57f150a4c8e59b778a320c4dcf1252093a405fbcce
-  data.tar.gz: c8898bc61f4c65dd72a0008ca1dd75e36508102089636964c68da9ec4863115a
+  metadata.gz: 2e21318b337715e24c66ec08ab39f65b4a11aa4eb43783a05bf6f7548dd7f8fc
+  data.tar.gz: 36790eed17097fefd6b6c2eaa1a6c42b712b7b1cc9df510ad1b0b8f2e4136a3c
 SHA512:
-  metadata.gz: a453b3e41b68ba7f7b9c06b31546fb92ec0d840e6f949657a5a5ec6a8d4b4708d88c3fd21963bd37fe9ebb224362a69e4d287d20f65c24eb275d557dacdee923
-  data.tar.gz: 1eb7d7a09b26da2997ebee5145d148c5f98111fe8372b868e3bdb1290bc2decb401aa406fe6405844d9b0aa00527ef03101939482c970f0f7e3de35ad40da4d1
+  metadata.gz: 776e13a1c4fb5be4f499fe4a2647d845fb5bf9b972bd7e045b5fa4c754130bb633a0841230f2aeee684d017fc8d23be144db551915e84eb240a9458c5c8bc78d
+  data.tar.gz: 238d3e0722eb7c89ed1a32237a1d7edcf68933034aa98df541001ac8bbaccaaf81ee0d96d90029e4fed3cb523d4c80510ccbb72c9b3ae2d3948257e0a1e9f448

data/README.md

@@ -1,8 +1,48 @@
 # HubKernel
-Short description and motivation.
+Gives every hub in a Rails app one way to declare what it needs from another hub.
 
 ## Usage
-How to use my plugin.
+
+### Ports
+A port is something a hub needs from outside itself. The hub declares it by name,
+with the method its own code calls:
+
+```ruby
+module Supplies
+  extend HubKernel::Ports
+
+  port :spend_recorder, as: :record_spend
+end
+```
+
+The app fills each port with any callable, usually another hub's method:
+
+```ruby
+Rails.application.config.to_prepare do
+  Supplies.spend_recorder = Finance.method(:record_spend)
+end
+```
+
+`Supplies.record_spend(amount: 5)` then calls what the app filled the port with and
+returns its answer. An error it raises reaches the caller unchanged. Calling a port the
+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

@@ -0,0 +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, 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.1.0"
+  VERSION = "0.3.0"
 end

data/lib/hub_kernel.rb

@@ -4,6 +4,7 @@ require "hub_kernel/action"
 require "hub_kernel/answer"
 require "hub_kernel/follow_up"
 require "hub_kernel/markup"
+require "hub_kernel/ports"
 
 module HubKernel
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - tylercschneider
@@ -46,7 +46,9 @@ 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
 homepage: https://github.com/tylercschneider/hub_kernel
 licenses: