hub_kernel 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b68695ef96166801769081d8d607907cc32e6d215f798b6404dc8b13a1faab2
-  data.tar.gz: 2fb12e7fa8b2cf1e8246eea5204ae7b38f61c6b41e668e07c753e7f55f899bf1
+  metadata.gz: 04f59c358a3f035fa56669fe9c6da01ceb7a8e513493ad6ca29b108758510d9c
+  data.tar.gz: 47a75f20985cf4ce0291e61e389d421245c93e90a3e04255ed69af769dc18469
 SHA512:
-  metadata.gz: 4cecfcff2e7565d73b3c047ff191cc57a1f1f73056727a644a82bcc6f07517678d370c8876abb7c6c97e10197d663d2f0fa046a1430939e38583a5e89dda7f7f
-  data.tar.gz: 7a83ad99b5cc838650469b8e436d6a8a7f3d70e2ac37685206e1a1094f98c987dde0b29044b52dc5def44b2392e2b3eb045332819bbe160581c028c27ae7df36
+  metadata.gz: 4cbcfba750818bdf25789490618b5959effc5af6a7aaca97daf17a7571162c25c35f452a2b26291ad62b7affaf74fc52a195ba65fbb00129fe09bed16e51f12f
+  data.tar.gz: 84909e946aac47038945054c3f8548170417388d4af2f96cef7826460385a49e57dc1bf587df6051d5acec6ab57d7355e91b400f9cba29c0306f1d5dcc988dad

data/README.md

@@ -44,6 +44,39 @@ It raises `HubKernel::UnwiredPortError` naming every unfilled port with its hub,
 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.
 
+### The hub check
+A hub's own test can check that the app filled every one of its ports, so a missing
+fill shows in the suite rather than on the next start:
+
+```ruby
+require "hub_kernel/conformance/hub"
+
+class SuppliesHubTest < ActiveSupport::TestCase
+  include HubKernel::Conformance::Hub
+
+  hub { Supplies }
+end
+```
+
+The test fails and names each port the app left unfilled, and each port filled with
+something that cannot be called.
+
+### The exposed list
+A hub names each method outside callers may reach, the values it takes, and whether it
+writes. A layer such as a JSON endpoint looks a method up by name and serves only what
+the hub exposes:
+
+```ruby
+module Supplies
+  extend HubKernel::Exposes
+
+  exposes :record_purchase, takes: %i[supplier_id bought_on lines], writes: true
+end
+
+Supplies.exposed("record_purchase").takes # => [:supplier_id, :bought_on, :lines]
+Supplies.exposed("delete_everything")     # => nil
+```
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/hub_kernel/conformance/hub.rb

@@ -0,0 +1,22 @@
+require "active_support/concern"
+
+module HubKernel
+  module Conformance
+    module Hub
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def hub(&block)
+          define_method(:the_hub, &block)
+        end
+      end
+
+      included do
+        test "every port of the hub is filled with something that can be called" do
+          problems = the_hub.unwired_ports + the_hub.uncallable_ports
+          flunk problems.join("\n") if problems.any?
+        end
+      end
+    end
+  end
+end

data/lib/hub_kernel/exposes.rb

@@ -0,0 +1,15 @@
+module HubKernel
+  module Exposes
+    Exposed = Data.define(:name, :takes, :writes)
+
+    def exposes(name, takes:, writes:)
+      exposed_methods[name.to_s] = Exposed.new(name: name, takes: takes, writes: writes)
+    end
+
+    def exposed(name) = exposed_methods[name.to_s]
+
+    private
+
+    def exposed_methods = @exposed_methods ||= {}
+  end
+end

data/lib/hub_kernel/ports.rb

@@ -17,6 +17,11 @@ module HubKernel
       declared_ports.reject { |name| instance_variable_get(:"@#{name}") }.map { |name| unwired_message(name) }
     end
 
+    def uncallable_ports
+      declared_ports.select { |name| instance_variable_get(:"@#{name}")&.respond_to?(:call) == false }
+        .map { |name| "#{hub_name} #{name.to_s.tr("_", " ")} is filled with something that cannot be called" }
+    end
+
     private
 
     def declared_ports = @declared_ports ||= []

data/lib/hub_kernel/version.rb

@@ -1,3 +1,3 @@
 module HubKernel
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

data/lib/hub_kernel.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - tylercschneider
@@ -41,9 +41,11 @@ files:
 - lib/hub_kernel/answer.rb
 - lib/hub_kernel/authz.rb
 - lib/hub_kernel/conformance/action.rb
+- lib/hub_kernel/conformance/hub.rb
 - lib/hub_kernel/conformance/partial.rb
 - lib/hub_kernel/context.rb
 - lib/hub_kernel/engine.rb
+- lib/hub_kernel/exposes.rb
 - lib/hub_kernel/follow_up.rb
 - lib/hub_kernel/hubs.rb
 - lib/hub_kernel/markup.rb