hub_kernel 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c55c177c5ca371059cf35185392a5b283a314254dff6b18aa2d13f7c12793cd
-  data.tar.gz: 23afef8f196447cecf97c1b2e0355aba897388784e2c1ddb80d6ff7ff9da7f98
+  metadata.gz: 269ad669e7c014af9175190d416dbf7be82bfb8d797eb3a25107bf87b99b1344
+  data.tar.gz: 808639ddaca46f8d8cbe9f187a7d59ae9d50b704f773bf4f255bae731d4339a7
 SHA512:
-  metadata.gz: 61caa0ec7d31d6fbd86dc005dae507895eb2a7e4a1f1c09b3be2976edbc8ff69b5f14108a007dffe38b501b4d773250544ed625457d87e8ed7cbdf7f811796ff
-  data.tar.gz: 532c56d1800f02ab79faab68553fc75edd7f20bdcbc8677d2a4e7416dde7ec063ff79c94825db9bf99f10bd380b5874d52657e6beef5a03b8ef08532b6c71a93
+  metadata.gz: 3c94024970cd0ae83bf695824439a959b6b03061eb39f92268f483ca769fbf323d4210710f805f052028590e65b87a84b43b8801cac1a9b927a9402205f1fd55
+  data.tar.gz: 307661997442f598ee6d2e931540336986a567794113298d496864f86d3ac19e2788ee091e75b8bc9434bd1c61bd3aa1df095b71af29d2479b7898869dfd416b

data/README.md

@@ -134,6 +134,36 @@ 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.
 
+### The crossing check
+A host's test can check that no hub's code names a class another hub owns. The host
+passes a map of which classes each hub owns, and the test fails listing each file and
+the class it names:
+
+```ruby
+require "hub_kernel/conformance/crossings"
+
+class HubCrossingsTest < ActiveSupport::TestCase
+  include HubKernel::Conformance::Crossings
+
+  crossings files: "app/{models,controllers,jobs,views}/shop/**/*.{rb,erb}", except: [ "app/models/shop/hubs.rb" ] do
+    HubKernel::Crossings.new(
+      owners: { supplies: %w[Shop::Purchase Shop::PurchasesController], finance: %w[Shop::Expense], shop: %w[Shop::Home] },
+      shared: %w[Shop::BaseController],
+      host_layer: :shop,
+      interfaces: { supplies: "Shop::Hubs::Supplies", finance: "Shop::Hubs::Finance" }
+    )
+  end
+end
+```
+
+- A constant inside another hub's class counts as naming that class.
+- A name no hub owns, such as a namespace, is not a crossing, and neither is a class on
+  the `shared` list.
+- A view belongs to the hub that owns its controller, then to the hub that owns the
+  record its folder is named after, and otherwise to the `host_layer`.
+- The host's layer may name any hub's interface module, and a hub naming another hub's
+  interface module is a crossing.
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/hub_kernel/conformance/crossings.rb

@@ -0,0 +1,28 @@
+require "active_support/concern"
+require "hub_kernel/crossings"
+
+module HubKernel
+  module Conformance
+    module Crossings
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def crossings(root: nil, files: "app/**/*.{rb,erb}", except: [], &block)
+          define_method(:the_crossings, &block)
+          define_method(:crossing_root) { root || Rails.root }
+          define_method(:crossing_files) { files }
+          define_method(:crossing_exceptions) { except }
+        end
+      end
+
+      included do
+        test "no file names a class another hub owns" do
+          found = (Dir.glob(crossing_files, base: crossing_root) - crossing_exceptions).sort.flat_map do |path|
+            the_crossings.in(path, File.read(File.join(crossing_root, path))).map { |name| "#{path} names #{name}" }
+          end
+          flunk found.join("\n") if found.any?
+        end
+      end
+    end
+  end
+end

data/lib/hub_kernel/crossings.rb

@@ -0,0 +1,40 @@
+require "active_support/core_ext/string/inflections"
+
+module HubKernel
+  class Crossings
+    def initialize(owners:, shared: [], host_layer: nil, interfaces: {})
+      @owners = owners
+      @shared = shared
+      @host_layer = host_layer
+      @interfaces = interfaces
+    end
+
+    def in(path, source)
+      hub = owner_of_file(path)
+      source.scan(/[A-Z]\w*(?:::[A-Z]\w*)*/).filter_map { |name| owned_class_in(name) }.uniq.select { |name| crossing?(name, hub) }
+    end
+
+    private
+
+    def crossing?(name, hub)
+      return false if @shared.include?(name) || owner_of(name) == hub
+
+      !(hub == @host_layer && @interfaces.value?(name))
+    end
+
+    def owned_class_in(name)
+      parts = name.split("::")
+      parts.size.downto(1).map { |size| parts.first(size).join("::") }.find { |candidate| owner_of(candidate) }
+    end
+
+    def owner_of(class_name) = @interfaces.key(class_name) || @owners.find { |_hub, classes| classes.include?(class_name) }&.first
+
+    def owner_of_file(path)
+      return owner_of_view_folder(File.dirname(path.delete_prefix("app/views/")).camelize) if path.start_with?("app/views/")
+
+      owner_of(path.sub(%r{\Aapp/[^/]+/}, "").delete_suffix(".rb").camelize)
+    end
+
+    def owner_of_view_folder(folder) = owner_of("#{folder}Controller") || owner_of(folder) || @host_layer
+  end
+end

data/lib/hub_kernel/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - tylercschneider
@@ -42,10 +42,12 @@ files:
 - lib/hub_kernel/answer.rb
 - lib/hub_kernel/authz.rb
 - lib/hub_kernel/conformance/action.rb
+- lib/hub_kernel/conformance/crossings.rb
 - lib/hub_kernel/conformance/exposed.rb
 - lib/hub_kernel/conformance/hub.rb
 - lib/hub_kernel/conformance/partial.rb
 - lib/hub_kernel/context.rb
+- lib/hub_kernel/crossings.rb
 - lib/hub_kernel/engine.rb
 - lib/hub_kernel/exposes.rb
 - lib/hub_kernel/follow_up.rb