hub_kernel-interface 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37c5ea275a8aaacc15d056ff35580688737ef2210a22e22846276404cf7b052b
-  data.tar.gz: 8ca84328489427f9d5616ad4d93b620219bbb6bc550a5ec63ac0f7e54ec3e569
+  metadata.gz: b0fa91bb8d315c37de4f4d2aadb2c12e924b092b763b2d932eecf0a0adb161d8
+  data.tar.gz: bccf1208493a973a64cb76df47226cd638d375aa38e3dfa34f18e801a4fba94f
 SHA512:
-  metadata.gz: ef4ee5d46d58f791c724fbaa24402cc3db861c05b1193a4a13d60a413aae415bdab29400cbf10c4fe5ae7580be660c6e3740012ad5c9cbe0a93733674f1b2c32
-  data.tar.gz: 2410f02d15351de8a053741bd66c14a162d34ce4f60a910acaa13f2002cc63742716f2029ed02ff042d4aee2323123cb9fc9dff2ec1f07498fee4f9c166c634c
+  metadata.gz: 2114bad113c0a16a3f6a85b59a01f887928980fa69f334e32dcdb19f5ca7ac1397c234d67779d8c5ba275c794254cbb673a6fc3db5f5b2fb6c0d35858acc587c
+  data.tar.gz: 90e57ae0a730030c16c895f94d6011c99d371bb7443668e935c681b95f1a58b0de8440bc0bf011f6b5110583b173100bfae214241215afe5f9ad0b3783b75d7a

data/README.md

@@ -55,6 +55,23 @@ HubKernel::Interface.served           # => { "supplies" => Supplies, "money" =>
 The permission check is still asked about a hub served under a chosen name by its own name,
 such as `ledger:record_spend`.
 
+An interface gem's boot check runs `HubKernel::Interface.check!`, which raises
+`HubKernel::Interface::UnservableHubError` naming every problem in the served list at once:
+an entry that exposes no methods, two entries that answer at the same name, and each
+problem in a served hub's exposed list.
+
+An interface gem checks a call's values before calling, and describes a record the call
+named that does not exist, so every interface gives the same reasons:
+
+```ruby
+HubKernel::Interface::CallReasons.refuse_unlisted_values(Supplies, "price_of", values: values, person: person, account: account)
+HubKernel::Interface::CallReasons.missing_record(error) # => "No consumable has the id 7"
+```
+
+`refuse_unlisted_values` raises `HubKernel::NotAllowed` when the permission check refuses the
+call, whatever values it sends, and otherwise raises `HubKernel::Refused` naming the method and
+every value it is not listed with. `missing_record` reads the error's `model` and `id`.
+
 `Supplies.exposure_problems` names each exposed method the hub has no method for, or lists
 with values it does not take. `HubKernel::Interface::ExposingHubs.list` holds every hub that
 declares an exposed method.

data/lib/hub_kernel/interface/call_reasons.rb

@@ -0,0 +1,16 @@
+require "hub_kernel/exposes"
+
+module HubKernel
+  module Interface
+    module CallReasons
+      def self.refuse_unlisted_values(hub, name, values:, person:, account:)
+        raise HubKernel::NotAllowed, "#{hub.name.demodulize} #{name}" unless hub.exposures_for(person: person, account: account).any? { |exposure| exposure.name.to_s == name.to_s }
+
+        unlisted = values.keys - hub.exposed(name).takes
+        raise HubKernel::Refused, "#{name} does not take #{unlisted.join(", ")}" if unlisted.any?
+      end
+
+      def self.missing_record(missing) = "No #{missing.model.demodulize.underscore.humanize(capitalize: false)} has the id #{missing.id}"
+    end
+  end
+end

data/lib/hub_kernel/interface/version.rb

@@ -1,5 +1,5 @@
 module HubKernel
   module Interface
-    VERSION = "0.3.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/hub_kernel/interface.rb

@@ -1,14 +1,35 @@
 require "hub_kernel/interface/version"
 require "hub_kernel/exposes"
+require "hub_kernel/interface/call_reasons"
 
 module HubKernel
   module Interface
+    class UnservableHubError < StandardError; end
+
     singleton_class.attr_writer :hubs
 
     def self.hubs = @hubs ||= []
 
     def self.find(name) = served[name]
 
-    def self.served = hubs.flat_map { |entry| entry.is_a?(Hash) ? entry.to_a : [ [ entry.name.demodulize.underscore, entry ] ] }.to_h
+    def self.check!
+      problems = unexposed_hubs + shared_names + exposure_problems
+      raise UnservableHubError, problems.join("\n") if problems.any?
+    end
+
+    def self.unexposed_hubs = served.values.reject { |hub| hub.respond_to?(:exposures) && hub.exposures.any? }.map { |hub| "#{hub.name} exposes no methods to serve" }
+
+    def self.shared_names
+      served_pairs.group_by(&:first).select { |_name, pairs| pairs.size > 1 }.map do |name, pairs|
+        "#{pairs.map { |_name, hub| hub.name }.join(" and ")} both answer at #{name}"
+      end
+    end
+
+    def self.exposure_problems = served.values.select { |hub| hub.respond_to?(:exposure_problems) }.flat_map(&:exposure_problems)
+
+    def self.served_pairs = hubs.flat_map { |entry| entry.is_a?(Hash) ? entry.to_a : [ [ entry.name.demodulize.underscore, entry ] ] }
+    private_class_method :unexposed_hubs, :shared_names, :exposure_problems, :served_pairs
+
+    def self.served = served_pairs.to_h
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel-interface
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - tylercschneider
@@ -40,6 +40,7 @@ files:
 - lib/hub_kernel/context.rb
 - lib/hub_kernel/exposes.rb
 - lib/hub_kernel/interface.rb
+- lib/hub_kernel/interface/call_reasons.rb
 - lib/hub_kernel/interface/exposing_hubs.rb
 - lib/hub_kernel/interface/version.rb
 homepage: https://github.com/DYB-Development/hub_kernel-interface