hub_kernel 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e711745ec2a1b5caccf83f09e80cad02ba4214cc7eff72745c2a6d760e175e
-  data.tar.gz: f3bc9c33cd2f1ae4878f9cb9dd2216ebda64c2c3628f7d1a29794dee4f10ef11
+  metadata.gz: a20cf973f68397694b8434e58918a40c31619eb8936aad87f8a183122aad47f4
+  data.tar.gz: 38a563f62a0c9bf630e72823b94c5cdba0cfe71bfe8c54d45d00a7129e8b5f32
 SHA512:
-  metadata.gz: 443d578d53ebb20b08fb3e3c3557df70780f8f85e8aab44af99c68ee6f3311897649210b544ba6356b4d1e7a1692576e36e84c36daed045ab2d47270ddc69b2c
-  data.tar.gz: 833fba7864e95ad4ff7e18284bd07998f7ff30df5269489c879a447541e207997ebeb09d2dafad1596aa0299c7a05259d2e997682c6b5edffe490772f405a061
+  metadata.gz: 13453ee9d42aa2ac1fe4d3e95ad216867f27d9d2b13f9e71cfa52fe244add5f32e7dbb1a43912af43aba99fa060f3d564746265bb5e973ab4064399beb01e7bd
+  data.tar.gz: c55bce27f9ef2d71959cf39102a38a0c8b471f1d35665fedfa16c3325e96d2676cef36dc57f90c8da167cdfdd64d9bd248b029edf496f60f4e471b1d11e798f1

data/README.md

@@ -4,16 +4,43 @@ Gives every hub in a Rails app one way to declare what it needs from another hub
 ## Usage
 
 ### Starting a hub
-The generator writes a new hub's module and its test. Name each port as the port and
-the method the hub's own code calls:
+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 Console::Hubs::Billing spend_recorder:record_spend
+bin/rails generate hub_kernel:hub Ledger entry_recorder:record_entry
 ```
 
-It writes `app/models/console/hubs/billing.rb`, which extends `HubKernel::Ports` and
-declares each port, and `test/models/console/hubs/billing_test.rb`, which includes the
-hub check below. The app then fills the new ports where it fills its others.
+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,

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

@@ -14,6 +14,8 @@ module HubKernel
       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"
@@ -26,8 +28,16 @@ module HubKernel
         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?
 

data/lib/hub_kernel/version.rb

@@ -1,3 +1,3 @@
 module HubKernel
-  VERSION = "0.7.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.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - tylercschneider