hub_kernel 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8117d21e5e81d6489c16ee5315f636623eafbab7aa0bc9ebe3e25b66fd139cef
-  data.tar.gz: 82f9add4dde24ed15db4be6b649f39b9e9c047292760479b8da9fc8891d72ff5
+  metadata.gz: 03e711745ec2a1b5caccf83f09e80cad02ba4214cc7eff72745c2a6d760e175e
+  data.tar.gz: f3bc9c33cd2f1ae4878f9cb9dd2216ebda64c2c3628f7d1a29794dee4f10ef11
 SHA512:
-  metadata.gz: 7bc2bfa185995e9773224c2d5570e7f7c9d7ed520409524289a40da34132331dfc03546d4c74036f03bad13dfe5d586a9fceac389e00cef0d0ba6456eca0396d
-  data.tar.gz: 7f6465796e50d486e907c0d0d682ca97c1fb69dd0a264ba44d54bb99e133cc78d062b316b4771912d68ca41b7696ad87b78984997ca93acec24392a2ff27aa80
+  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:
@@ -61,6 +73,22 @@ end
 The test fails and names each port the app left unfilled, and each port filled with
 something that cannot be called.
 
+### The exposed list
+A hub names each method outside callers may reach, the values it takes, and whether it
+writes. A layer such as a JSON endpoint looks a method up by name and serves only what
+the hub exposes:
+
+```ruby
+module Supplies
+  extend HubKernel::Exposes
+
+  exposes :record_purchase, takes: %i[supplier_id bought_on lines], writes: true
+end
+
+Supplies.exposed("record_purchase").takes # => [:supplier_id, :bought_on, :lines]
+Supplies.exposed("delete_everything")     # => nil
+```
+
 ## Installation
 Add this line to your application's Gemfile:
 

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/exposes.rb

@@ -0,0 +1,15 @@
+module HubKernel
+  module Exposes
+    Exposed = Data.define(:name, :takes, :writes)
+
+    def exposes(name, takes:, writes:)
+      exposed_methods[name.to_s] = Exposed.new(name: name, takes: takes, writes: writes)
+    end
+
+    def exposed(name) = exposed_methods[name.to_s]
+
+    private
+
+    def exposed_methods = @exposed_methods ||= {}
+  end
+end

data/lib/hub_kernel/version.rb

@@ -1,3 +1,3 @@
 module HubKernel
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end

data/lib/hub_kernel.rb

@@ -5,6 +5,7 @@ require "hub_kernel/answer"
 require "hub_kernel/follow_up"
 require "hub_kernel/markup"
 require "hub_kernel/ports"
+require "hub_kernel/exposes"
 
 module HubKernel
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel
 version: !ruby/object:Gem::Version
-  version: 0.5.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
@@ -45,6 +46,7 @@ files:
 - lib/hub_kernel/conformance/partial.rb
 - lib/hub_kernel/context.rb
 - lib/hub_kernel/engine.rb
+- lib/hub_kernel/exposes.rb
 - lib/hub_kernel/follow_up.rb
 - lib/hub_kernel/hubs.rb
 - lib/hub_kernel/markup.rb