hub_kernel 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04f59c358a3f035fa56669fe9c6da01ceb7a8e513493ad6ca29b108758510d9c
-  data.tar.gz: 47a75f20985cf4ce0291e61e389d421245c93e90a3e04255ed69af769dc18469
+  metadata.gz: a20cf973f68397694b8434e58918a40c31619eb8936aad87f8a183122aad47f4
+  data.tar.gz: 38a563f62a0c9bf630e72823b94c5cdba0cfe71bfe8c54d45d00a7129e8b5f32
 SHA512:
-  metadata.gz: 4cbcfba750818bdf25789490618b5959effc5af6a7aaca97daf17a7571162c25c35f452a2b26291ad62b7affaf74fc52a195ba65fbb00129fe09bed16e51f12f
-  data.tar.gz: 84909e946aac47038945054c3f8548170417388d4af2f96cef7826460385a49e57dc1bf587df6051d5acec6ab57d7355e91b400f9cba29c0306f1d5dcc988dad
+  metadata.gz: 13453ee9d42aa2ac1fe4d3e95ad216867f27d9d2b13f9e71cfa52fe244add5f32e7dbb1a43912af43aba99fa060f3d564746265bb5e973ab4064399beb01e7bd
+  data.tar.gz: c55bce27f9ef2d71959cf39102a38a0c8b471f1d35665fedfa16c3325e96d2676cef36dc57f90c8da167cdfdd64d9bd248b029edf496f60f4e471b1d11e798f1

data/README.md

@@ -3,6 +3,45 @@ Gives every hub in a Rails app one way to declare what it needs from another hub
 
 ## Usage
 
+### Starting a hub
+A hub usually lives in a domain gem, next to the domain logic it serves. Run the
+generator from the gem's root, naming each port as the port and the method the hub's
+own code calls:
+
+```bash
+bin/rails generate hub_kernel:hub Ledger entry_recorder:record_entry
+```
+
+Inside a Rails engine gem it writes the hub under the gem's namespace, such as
+`app/models/billing/ledger.rb` with `module Billing::Ledger`, which extends
+`HubKernel::Ports` and declares each port. It also adds hub_kernel to the gem's
+gemspec. It writes no hub check into the gem's tests, since the gem never fills its own
+ports.
+
+### Using a hub from a gem
+The app that installs the gem fills each of the hub's ports in its own setup, then
+runs the start check:
+
+```ruby
+Rails.application.config.to_prepare do
+  Billing::Ledger.entry_recorder = Finance.method(:record_entry)
+  HubKernel::Hubs.check!
+end
+```
+
+The app's own test for that hub includes the hub check, where the ports are filled:
+
+```ruby
+class Billing::LedgerHubTest < ActiveSupport::TestCase
+  include HubKernel::Conformance::Hub
+
+  hub { Billing::Ledger }
+end
+```
+
+Run inside an app rather than a gem, the generator writes the hub under
+`app/models` and its hub check under `test/models`.
+
 ### Ports
 A port is something a hub needs from outside itself. The hub declares it by name,
 with the method its own code calls:

data/lib/generators/hub_kernel/hub/hub_generator.rb

@@ -0,0 +1,48 @@
+require "rails/generators/named_base"
+
+module HubKernel
+  module Generators
+    class HubGenerator < Rails::Generators::NamedBase
+      argument :ports, type: :array, default: [], banner: "port:method port:method"
+
+      def create_hub
+        create_file "app/models/#{file_path}.rb", <<~RUBY
+          module #{class_name}
+            extend HubKernel::Ports
+          #{port_lines}end
+        RUBY
+      end
+
+      def create_hub_test
+        return if gemspec
+
+        create_file "test/models/#{file_path}_test.rb", <<~RUBY
+          require "test_helper"
+          require "hub_kernel/conformance/hub"
+
+          class #{class_name}Test < ActiveSupport::TestCase
+            include HubKernel::Conformance::Hub
+
+            hub { #{class_name} }
+          end
+        RUBY
+      end
+
+      def depend_on_hub_kernel
+        return unless gemspec
+
+        inject_into_file gemspec, "  spec.add_dependency \"hub_kernel\", \"~> #{HubKernel::VERSION[/\A\d+\.\d+/]}\"\n", before: /^end\s*\z/
+      end
+
+      private
+
+      def gemspec = Dir.glob("*.gemspec", base: destination_root).first
+
+      def port_lines
+        return "" if ports.empty?
+
+        "\n" + ports.map { |pair| pair.split(":") }.map { |port, method| "  port :#{port}, as: :#{method}\n" }.join
+      end
+    end
+  end
+end

data/lib/hub_kernel/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - tylercschneider
@@ -36,6 +36,7 @@ files:
 - README.md
 - Rakefile
 - config/routes.rb
+- lib/generators/hub_kernel/hub/hub_generator.rb
 - lib/hub_kernel.rb
 - lib/hub_kernel/action.rb
 - lib/hub_kernel/answer.rb