hub_kernel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e433f46a0cd33d7236e9f57f150a4c8e59b778a320c4dcf1252093a405fbcce
+  data.tar.gz: c8898bc61f4c65dd72a0008ca1dd75e36508102089636964c68da9ec4863115a
+SHA512:
+  metadata.gz: a453b3e41b68ba7f7b9c06b31546fb92ec0d840e6f949657a5a5ec6a8d4b4708d88c3fd21963bd37fe9ebb224362a69e4d287d20f65c24eb275d557dacdee923
+  data.tar.gz: 1eb7d7a09b26da2997ebee5145d148c5f98111fe8372b868e3bdb1290bc2decb401aa406fe6405844d9b0aa00527ef03101939482c970f0f7e3de35ad40da4d1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright tylercschneider
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# HubKernel
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "hub_kernel"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install hub_kernel
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"

data/config/routes.rb

@@ -0,0 +1,2 @@
+HubKernel::Engine.routes.draw do
+end

data/lib/hub_kernel/action.rb

@@ -0,0 +1,13 @@
+module HubKernel
+  class MissingArgumentError < ArgumentError; end
+
+  module Action
+    attr_reader :person, :account, :values
+
+    def initialize(person:, account:, values:)
+      @person = person
+      @account = account
+      @values = values
+    end
+  end
+end

data/lib/hub_kernel/answer.rb

@@ -0,0 +1,15 @@
+module HubKernel
+  class AnswerNotMetError < StandardError; end
+
+  module Answer
+    def self.met_by?(answer)
+      answer.respond_to?(:ok?) && answer.respond_to?(:message)
+    end
+
+    def self.met!(answer)
+      return answer if met_by?(answer)
+
+      raise AnswerNotMetError, "an answer must respond to ok? and message, got #{answer.class}"
+    end
+  end
+end

data/lib/hub_kernel/authz.rb

@@ -0,0 +1,26 @@
+module HubKernel
+  class NonBooleanAnswerError < StandardError; end
+
+  module Authz
+    module Vocabulary
+      def gates(*actions)
+        gated_actions.concat(actions)
+      end
+
+      def gated_actions
+        @gated_actions ||= []
+      end
+    end
+
+    def self.included(hub)
+      hub.extend(Vocabulary)
+    end
+
+    def allowed?(actor, action)
+      answer = authz.allowed?(actor, action)
+      raise NonBooleanAnswerError, "allowed? must return true or false, got #{answer.inspect}" unless [ true, false ].include?(answer)
+
+      answer
+    end
+  end
+end

data/lib/hub_kernel/conformance/action.rb

@@ -0,0 +1,44 @@
+require "active_support/concern"
+
+module HubKernel
+  module Conformance
+    module Action
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def saving_object(&block)
+          saving_objects(the_only: block)
+        end
+
+        def saving_objects(**objects)
+          define_method(:the_saving_objects) { objects.transform_values(&:call) }
+          define_method(:the_saving_object) { the_saving_objects.values.first }
+        end
+      end
+
+      included do
+        test "each named object takes the person, the account and the submitted values" do
+          the_saving_objects.each_value do |object|
+            assert_respond_to object.new(person: a_person, account: an_account, values: values_it_keeps), :call
+          end
+        end
+
+        test "each named object answers whether the change was kept" do
+          the_saving_objects.each_value do |object|
+            answer = object.new(person: a_person, account: an_account, values: values_it_keeps).call
+
+            assert HubKernel::Answer.met_by?(answer), "#{object} must answer with ok? and message"
+          end
+        end
+
+        test "a refused answer carries the reason" do
+          the_saving_objects.each_value do |object|
+            answer = object.new(person: a_person, account: an_account, values: values_it_refuses).call
+
+            assert_not_empty answer.message.to_s, "#{object} must say why it refused"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hub_kernel/conformance/partial.rb

@@ -0,0 +1,52 @@
+require "active_support/concern"
+
+module HubKernel
+  module Conformance
+    module Partial
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def markup(&block)
+          define_method(:the_markup) { block.call }
+        end
+
+        def submits(*names)
+          define_method(:the_action_names) { names }
+        end
+      end
+
+      included do
+        def the_action_names = []
+
+        def the_addresses
+          return { submit_url: "/an/address" } if the_action_names.empty?
+
+          { submit_urls: the_action_names.to_h { |name| [ name, "/an/address/#{name}" ] } }
+        end
+
+        def render_the_markup
+          render partial: the_markup, locals: { person: a_person, account: an_account, **the_addresses }
+        end
+
+        test "it submits to the addresses it was given" do
+          render_the_markup
+
+          expected = the_action_names.empty? ? [ "/an/address" ] : the_action_names.map { |name| "/an/address/#{name}" }
+          expected.each { |address| assert_includes rendered, %(action="#{address}") }
+        end
+
+        test "it reads nothing from an instance variable" do
+          source = File.read(lookup_context.find(the_markup, [], true).identifier)
+
+          assert_no_match(/@[a-z_]+/, source)
+        end
+
+        test "it draws no page heading, page frame or layout of its own" do
+          render_the_markup
+
+          assert_no_match(/<h1|<html|<body/, rendered)
+        end
+      end
+    end
+  end
+end

data/lib/hub_kernel/context.rb

@@ -0,0 +1,13 @@
+module HubKernel
+  module Context
+    class Null
+      def actor
+        :null_actor
+      end
+
+      def tenant
+        :null_tenant
+      end
+    end
+  end
+end

data/lib/hub_kernel/engine.rb

@@ -0,0 +1,5 @@
+module HubKernel
+  class Engine < ::Rails::Engine
+    isolate_namespace HubKernel
+  end
+end

data/lib/hub_kernel/events.rb

@@ -0,0 +1,36 @@
+module HubKernel
+  class UndeclaredEventError < StandardError; end
+  class UnwiredEventError < StandardError; end
+
+  module Events
+    def declared_events
+      instance_methods(false)
+    end
+
+    def on(name, &handler)
+      raise UndeclaredEventError, "undeclared event :#{name}; declared events are #{declared_events}" unless declared_events.include?(name)
+
+      handlers[name] << handler
+    end
+
+    def emit(name, payload)
+      handlers[name].each { |handler| handler.call(payload) }
+    end
+
+    def verify_wired!
+      return if unwired_events.empty?
+
+      raise UnwiredEventError, "unwired events: #{unwired_events}"
+    end
+
+    private
+
+    def unwired_events
+      declared_events.reject { |name| handlers[name].any? }
+    end
+
+    def handlers
+      @handlers ||= Hash.new { |table, name| table[name] = [] }
+    end
+  end
+end

data/lib/hub_kernel/follow_up.rb

@@ -0,0 +1,9 @@
+module HubKernel
+  module FollowUp
+    attr_reader :controller
+
+    def initialize(controller:)
+      @controller = controller
+    end
+  end
+end

data/lib/hub_kernel/markup.rb

@@ -0,0 +1,7 @@
+module HubKernel
+  module Markup
+    def markup_path(within: "app/views")
+      File.join(root.to_s, within, "**", "*.erb")
+    end
+  end
+end

data/lib/hub_kernel/version.rb

@@ -0,0 +1,3 @@
+module HubKernel
+  VERSION = "0.1.0"
+end

data/lib/hub_kernel.rb

@@ -0,0 +1,9 @@
+require "hub_kernel/version"
+require "hub_kernel/engine"
+require "hub_kernel/action"
+require "hub_kernel/answer"
+require "hub_kernel/follow_up"
+require "hub_kernel/markup"
+
+module HubKernel
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: hub_kernel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tylercschneider
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.3
+description: 'hub_kernel wraps a domain and connects it to a host app''s infrastructure
+  through named ports. It ships no domain of its own: each hub is hub_kernel wrapped
+  around one domain.'
+email:
+- tylercschneider@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/routes.rb
+- lib/hub_kernel.rb
+- lib/hub_kernel/action.rb
+- lib/hub_kernel/answer.rb
+- lib/hub_kernel/authz.rb
+- lib/hub_kernel/conformance/action.rb
+- lib/hub_kernel/conformance/partial.rb
+- lib/hub_kernel/context.rb
+- lib/hub_kernel/engine.rb
+- lib/hub_kernel/events.rb
+- lib/hub_kernel/follow_up.rb
+- lib/hub_kernel/markup.rb
+- lib/hub_kernel/version.rb
+homepage: https://github.com/tylercschneider/hub_kernel
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/tylercschneider/hub_kernel
+  source_code_uri: https://github.com/tylercschneider/hub_kernel
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Headless Rails engine that binds a domain to a host app through ports.
+test_files: []