hub_kernel 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a20cf973f68397694b8434e58918a40c31619eb8936aad87f8a183122aad47f4
-  data.tar.gz: 38a563f62a0c9bf630e72823b94c5cdba0cfe71bfe8c54d45d00a7129e8b5f32
+  metadata.gz: 6c55c177c5ca371059cf35185392a5b283a314254dff6b18aa2d13f7c12793cd
+  data.tar.gz: 23afef8f196447cecf97c1b2e0355aba897388784e2c1ddb80d6ff7ff9da7f98
 SHA512:
-  metadata.gz: 13453ee9d42aa2ac1fe4d3e95ad216867f27d9d2b13f9e71cfa52fe244add5f32e7dbb1a43912af43aba99fa060f3d564746265bb5e973ab4064399beb01e7bd
-  data.tar.gz: c55bce27f9ef2d71959cf39102a38a0c8b471f1d35665fedfa16c3325e96d2676cef36dc57f90c8da167cdfdd64d9bd248b029edf496f60f4e471b1d11e798f1
+  metadata.gz: 61caa0ec7d31d6fbd86dc005dae507895eb2a7e4a1f1c09b3be2976edbc8ff69b5f14108a007dffe38b501b4d773250544ed625457d87e8ed7cbdf7f811796ff
+  data.tar.gz: 532c56d1800f02ab79faab68553fc75edd7f20bdcbc8677d2a4e7416dde7ec063ff79c94825db9bf99f10bd380b5874d52657e6beef5a03b8ef08532b6c71a93

data/README.md

@@ -116,6 +116,24 @@ Supplies.exposed("record_purchase").takes # => [:supplier_id, :bought_on, :lines
 Supplies.exposed("delete_everything")     # => nil
 ```
 
+### The exposed-list check
+A hub's own test can check its exposed list, so a listed method the hub lacks, or one
+listed with values it does not take, shows in the suite rather than on a caller's
+request:
+
+```ruby
+require "hub_kernel/conformance/exposed"
+
+class SuppliesHubTest < ActiveSupport::TestCase
+  include HubKernel::Conformance::Exposed
+
+  hub { Supplies }
+end
+```
+
+The test fails and names each problem. A method that takes `**` values accepts any
+values it is listed with, as long as it is listed with each value it requires.
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/hub_kernel/conformance/exposed.rb

@@ -0,0 +1,22 @@
+require "active_support/concern"
+
+module HubKernel
+  module Conformance
+    module Exposed
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def hub(&block)
+          define_method(:the_hub, &block)
+        end
+      end
+
+      included do
+        test "every method the hub exposes exists and takes the values it is listed with" do
+          problems = the_hub.exposure_problems
+          flunk problems.join("\n") if problems.any?
+        end
+      end
+    end
+  end
+end

data/lib/hub_kernel/exposes.rb

@@ -8,8 +8,29 @@ module HubKernel
 
     def exposed(name) = exposed_methods[name.to_s]
 
+    def exposure_problems
+      exposed_methods.values.filter_map { |exposure| exposure_problem(exposure) }
+    end
+
     private
 
     def exposed_methods = @exposed_methods ||= {}
+
+    def exposing_hub = name.demodulize
+
+    def exposure_problem(exposure)
+      return "#{exposing_hub} exposes #{exposure.name}, which it has no method for" unless respond_to?(exposure.name)
+      return if takes_listed_values?(exposure)
+
+      "#{exposing_hub} exposes #{exposure.name} with #{exposure.takes.join(", ")}, but it takes #{keywords(exposure, :keyreq, :key).join(", ")}"
+    end
+
+    def takes_listed_values?(exposure)
+      (keywords(exposure, :keyreq) - exposure.takes).empty? && (takes_any_values?(exposure) || (exposure.takes - keywords(exposure, :keyreq, :key)).empty?)
+    end
+
+    def takes_any_values?(exposure) = method(exposure.name).parameters.any? { |kind, _| kind == :keyrest }
+
+    def keywords(exposure, *kinds) = method(exposure.name).parameters.filter_map { |kind, value| value if kinds.include?(kind) }
   end
 end

data/lib/hub_kernel/version.rb

@@ -1,3 +1,3 @@
 module HubKernel
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - tylercschneider
@@ -42,6 +42,7 @@ files:
 - lib/hub_kernel/answer.rb
 - lib/hub_kernel/authz.rb
 - lib/hub_kernel/conformance/action.rb
+- lib/hub_kernel/conformance/exposed.rb
 - lib/hub_kernel/conformance/hub.rb
 - lib/hub_kernel/conformance/partial.rb
 - lib/hub_kernel/context.rb