hub_kernel 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04f59c358a3f035fa56669fe9c6da01ceb7a8e513493ad6ca29b108758510d9c
-  data.tar.gz: 47a75f20985cf4ce0291e61e389d421245c93e90a3e04255ed69af769dc18469
+  metadata.gz: 03e711745ec2a1b5caccf83f09e80cad02ba4214cc7eff72745c2a6d760e175e
+  data.tar.gz: f3bc9c33cd2f1ae4878f9cb9dd2216ebda64c2c3628f7d1a29794dee4f10ef11
 SHA512:
-  metadata.gz: 4cbcfba750818bdf25789490618b5959effc5af6a7aaca97daf17a7571162c25c35f452a2b26291ad62b7affaf74fc52a195ba65fbb00129fe09bed16e51f12f
-  data.tar.gz: 84909e946aac47038945054c3f8548170417388d4af2f96cef7826460385a49e57dc1bf587df6051d5acec6ab57d7355e91b400f9cba29c0306f1d5dcc988dad
+  metadata.gz: 443d578d53ebb20b08fb3e3c3557df70780f8f85e8aab44af99c68ee6f3311897649210b544ba6356b4d1e7a1692576e36e84c36daed045ab2d47270ddc69b2c
+  data.tar.gz: 833fba7864e95ad4ff7e18284bd07998f7ff30df5269489c879a447541e207997ebeb09d2dafad1596aa0299c7a05259d2e997682c6b5edffe490772f405a061

data/README.md

@@ -3,6 +3,18 @@ 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:
+
+```bash
+bin/rails generate hub_kernel:hub Console::Hubs::Billing spend_recorder:record_spend
+```
+
+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.
+
 ### 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,38 @@
+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
+        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
+
+      private
+
+      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.7.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.7.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