igniter 0.5.0 → 0.5.2

data/packages/igniter-web/lib/igniter/web/application_web_mount.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module Igniter
+  module Web
+    class ApplicationWebMount
+      attr_reader :name, :path, :web_application, :application_environment, :metadata
+
+      def initialize(name:, path:, web_application:, application_environment: nil, metadata: {})
+        @name = name.to_sym
+        @path = normalize_mount_path(path)
+        @web_application = web_application
+        @application_environment = application_environment
+        @metadata = metadata.freeze
+      end
+
+      def rack_app
+        ->(env) { call(env) }
+      end
+
+      def bind(environment:)
+        self.class.new(
+          name: name,
+          path: path,
+          web_application: web_application,
+          application_environment: environment,
+          metadata: metadata
+        )
+      end
+
+      def context(env = {})
+        MountContext.new(
+          mount: self,
+          application: application_environment,
+          env: env
+        )
+      end
+
+      def call(env)
+        request_path = env.fetch("PATH_INFO", "/")
+        local_path = local_path_for(request_path)
+        return not_found_response(local_path) unless local_path
+
+        route = route_for(local_path)
+        return not_found_response(local_path) unless route
+
+        render_route(route, env)
+      end
+
+      def to_h
+        {
+          name: name,
+          path: path,
+          metadata: metadata,
+          surface_manifest: surface_manifest.to_h,
+          routes: web_application.routes.map { |route| route_to_h(route) },
+          screens: web_application.screens.map { |screen| screen_to_h(screen) }
+        }
+      end
+
+      private
+
+      def surface_manifest
+        SurfaceManifest.for(
+          web_application,
+          name: name,
+          path: path,
+          metadata: metadata
+        )
+      end
+
+      def normalize_mount_path(value)
+        candidate = value.to_s
+        candidate = "/#{candidate}" unless candidate.start_with?("/")
+        candidate.sub(%r{/+\z}, "").then { |path| path.empty? ? "/" : path }
+      end
+
+      def local_path_for(request_path)
+        return request_path if path == "/"
+        return nil unless request_path == path || request_path.start_with?("#{path}/")
+
+        local = request_path.delete_prefix(path)
+        local.empty? ? "/" : local
+      end
+
+      def route_for(local_path)
+        web_application.routes.find { |route| route.path == local_path && route.verb == :get }
+      end
+
+      def render_route(route, env)
+        body = if route.target.is_a?(Class) && route.target <= Page
+                 route.target.render(assigns: route_assigns(env))
+               elsif route.target.respond_to?(:graph)
+                 ViewGraphRenderer.render(route.target.graph, context: context(env))
+               elsif route.target.respond_to?(:call)
+                 route.target.call(env)
+               else
+                 route.target.to_s
+               end
+
+        html_response(body)
+      end
+
+      def route_assigns(env)
+        mount_context = context(env)
+        {
+          mount: self,
+          ctx: mount_context,
+          context: mount_context,
+          application: application_environment,
+          env: env
+        }
+      end
+
+      def html_response(body)
+        [
+          200,
+          { "content-type" => "text/html; charset=utf-8" },
+          [body.to_s]
+        ]
+      end
+
+      def not_found_response(local_path)
+        [
+          404,
+          { "content-type" => "text/plain; charset=utf-8" },
+          ["No igniter-web route for #{local_path}"]
+        ]
+      end
+
+      def route_to_h(route)
+        {
+          verb: route.verb,
+          path: route.path,
+          target: serialize_target(route.target),
+          metadata: route.metadata
+        }
+      end
+
+      def serialize_target(target)
+        return target.to_h if target.respond_to?(:to_h)
+        return target.name if target.respond_to?(:name)
+
+        target.to_s
+      end
+
+      def screen_to_h(screen)
+        if screen.respond_to?(:graph)
+          {
+            screen: screen.screen.name,
+            success: screen.success?,
+            findings: screen.findings.map(&:to_h),
+            graph: screen.graph.to_h
+          }
+        elsif screen.respond_to?(:to_h)
+          screen.to_h
+        else
+          { screen: screen.to_s }
+        end
+      end
+    end
+  end
+end

data/packages/igniter-web/lib/igniter/web/arbre.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Igniter
+  module Web
+    module Arbre
+      class MissingDependencyError < LoadError
+      end
+
+      module_function
+
+      def available?
+        !dependency.nil?
+      rescue MissingDependencyError
+        false
+      end
+
+      def component_class
+        dependency.const_get(:Component)
+      end
+
+      def context_class
+        dependency.const_get(:Context)
+      end
+
+      def ensure_available!
+        dependency
+      end
+
+      def dependency
+        return ::Arbre if defined?(::Arbre)
+
+        require "arbre"
+        ::Arbre
+      rescue LoadError
+        raise MissingDependencyError,
+              "`igniter-web` now ships with a required `arbre` dependency. " \
+              "Run bundle install to enable page and component rendering."
+      end
+    end
+  end
+end

data/packages/igniter-web/lib/igniter/web/component.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Igniter
+  module Web
+    module Fallback
+      class Component
+        def self.builder_method(*)
+          nil
+        end
+      end
+    end
+
+    class Component < (Arbre.available? ? Arbre.component_class : Fallback::Component)
+      class << self
+        def define(builder_name = nil, &block)
+          klass = Class.new(self)
+          klass.builder_method(builder_name) if builder_name
+          klass.build_with(&block) if block
+          klass
+        end
+
+        def build_with(&block)
+          return @build_block unless block
+
+          @build_block = block
+        end
+      end
+
+      def build(*args, **kwargs, &_block)
+        build_block = self.class.build_with
+        return super(*args, **kwargs) unless build_block
+
+        instance_exec(*args, **kwargs, &build_block)
+      rescue NoMethodError => e
+        raise unless e.name == :build
+
+        self
+      end
+
+      private
+
+      def render_build_block(block, *args)
+        return unless block
+
+        if block.arity.zero?
+          instance_exec(&block)
+        else
+          block.call(*args)
+        end
+      end
+
+      def class_names(*values)
+        values.flatten.compact.reject(&:empty?).join(" ")
+      end
+
+      def token_class(prefix, value)
+        return nil if value.nil?
+
+        "#{prefix}--#{dasherize(value)}"
+      end
+
+      def humanize(value)
+        value.to_s.tr("_", " ").tr("-", " ").split.map(&:capitalize).join(" ")
+      end
+
+      def dasherize(value)
+        value.to_s.tr("_", "-").downcase
+      end
+
+      def format_value(value)
+        case value
+        when Symbol
+          value.to_s
+        when Array
+          value.map { |item| format_value(item) }.join(", ")
+        when Hash
+          value.map { |key, item| "#{humanize(key)}: #{format_value(item)}" }.join(", ")
+        else
+          value.to_s
+        end
+      end
+
+      def node_label(node)
+        humanize([node.kind, node.name].compact.join(": "))
+      end
+
+      def render_property_list(props)
+        return if props.empty?
+
+        dl class: "ig-node-props" do
+          props.each do |name, value|
+            next if value.nil?
+
+            div class: "ig-node-prop", "data-ig-prop": name do
+              dt humanize(name)
+              dd format_value(value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/packages/igniter-web/lib/igniter/web/components/view_action_node.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Igniter
+  module Web
+    module Components
+      class ViewActionNode < Component
+        builder_method :view_action_node
+
+        def build(node, &block)
+          super(
+            class: class_names(
+              "ig-node",
+              "ig-action",
+              token_class("ig-action", node.name),
+              token_class("ig-role", node.role)
+            ),
+            "data-ig-node-kind": node.kind,
+            "data-ig-node-name": node.name,
+            "data-ig-node-role": node.role,
+            "data-ig-action": node.name
+          )
+
+          button type: "button", class: "ig-action-button", "data-ig-action-run": node.props[:run] do
+            span humanize(node.name || :action), class: "ig-action-label"
+          end
+          render_property_list(node.props)
+          render_build_block(block, self)
+        end
+
+        private
+
+        def tag_name
+          "article"
+        end
+      end
+    end
+  end
+end

data/packages/igniter-web/lib/igniter/web/components/view_ask_node.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Igniter
+  module Web
+    module Components
+      class ViewAskNode < Component
+        builder_method :view_ask_node
+
+        def build(node, &block)
+          field_id = "ig-field-#{dasherize(node.name || :input)}"
+          super(
+            class: class_names("ig-node", "ig-field", token_class("ig-field", node.props[:as])),
+            "data-ig-node-kind": node.kind,
+            "data-ig-node-name": node.name,
+            "data-ig-field": node.name
+          )
+
+          label humanize(node.name), for: field_id
+          render_input(node, field_id)
+          render_property_list(node.props.reject { |key, _| key == :as })
+          render_build_block(block, self)
+        end
+
+        private
+
+        def tag_name
+          "article"
+        end
+
+        def render_input(node, field_id)
+          case node.props[:as]
+          when :textarea
+            textarea "", id: field_id, name: node.name
+          else
+            input id: field_id, name: node.name, type: input_type_for(node.props[:as])
+          end
+        end
+
+        def input_type_for(kind)
+          case kind
+          when :email
+            "email"
+          when :number
+            "number"
+          else
+            "text"
+          end
+        end
+      end
+    end
+  end
+end

data/packages/igniter-web/lib/igniter/web/components/view_chat_node.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Igniter
+  module Web
+    module Components
+      class ViewChatNode < Component
+        builder_method :view_chat_node
+
+        def build(node, &block)
+          super(
+            class: class_names("ig-node", "ig-chat", token_class("ig-chat", node.name)),
+            "data-ig-node-kind": node.kind,
+            "data-ig-node-name": node.name,
+            "data-ig-chat-with": node.name
+          )
+
+          header class: "ig-chat-header" do
+            h2 "Conversation"
+            span format_value(node.name), class: "ig-chat-agent"
+          end
+          div class: "ig-chat-feed", "data-ig-chat-feed": node.name
+          render_property_list(node.props)
+          render_build_block(block, self)
+        end
+
+        private
+
+        def tag_name
+          "article"
+        end
+      end
+    end
+  end
+end

data/packages/igniter-web/lib/igniter/web/components/view_compare_node.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Igniter
+  module Web
+    module Components
+      class ViewCompareNode < Component
+        builder_method :view_compare_node
+
+        def build(node, &block)
+          super(
+            class: class_names("ig-node", "ig-compare"),
+            "data-ig-node-kind": node.kind,
+            "data-ig-node-name": node.name
+          )
+
+          h2 node_label(node)
+          div class: "ig-compare-grid" do
+            compare_side(:left, node.props[:left])
+            compare_side(:right, node.props[:right])
+          end
+          render_property_list(node.props.reject { |key, _| %i[left right].include?(key) })
+          render_build_block(block, self)
+        end
+
+        private
+
+        def tag_name
+          "article"
+        end
+
+        def compare_side(side, value)
+          section class: class_names("ig-compare-side", token_class("ig-compare-side", side)),
+                  "data-ig-compare-side": side do
+            h3 humanize(side)
+            para format_value(value)
+          end
+        end
+      end
+    end
+  end
+end

data/packages/igniter-web/lib/igniter/web/components/view_node.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Igniter
+  module Web
+    module Components
+      class ViewNode < Component
+        builder_method :view_node
+
+        def build(node, &block)
+          super(
+            class: class_names("ig-node", token_class("ig-node", node.kind), token_class("ig-role", node.role)),
+            "data-ig-node-kind": node.kind,
+            "data-ig-node-name": node.name,
+            "data-ig-node-role": node.role
+          )
+
+          h2 node_label(node)
+          render_property_list(node.props)
+          render_build_block(block, self)
+        end
+
+        private
+
+        def tag_name
+          "article"
+        end
+      end
+    end
+  end
+end

data/packages/igniter-web/lib/igniter/web/components/view_screen.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Igniter
+  module Web
+    module Components
+      class ViewScreen < Component
+        builder_method :view_screen
+
+        def build(root, options = {}, &block)
+          title = options.fetch(:title)
+          preset = root.props.fetch(:preset, {})
+          super(
+            class: class_names("ig-screen", token_class("ig-screen", root.role), token_class("ig-preset", preset[:name])),
+            "data-ig-screen": root.name,
+            "data-ig-intent": root.role,
+            "data-ig-preset": preset[:name]
+          )
+
+          header class: "ig-screen-header" do
+            h1 title
+          end
+
+          render_build_block(block, self)
+        end
+
+        private
+
+        def tag_name
+          "main"
+        end
+      end
+    end
+  end
+end

data/packages/igniter-web/lib/igniter/web/components/view_stream_node.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Igniter
+  module Web
+    module Components
+      class ViewStreamNode < Component
+        builder_method :view_stream_node
+
+        def build(node, &block)
+          super(
+            class: class_names("ig-node", "ig-stream", token_class("ig-stream", node.name)),
+            "data-ig-node-kind": node.kind,
+            "data-ig-node-name": node.name,
+            "data-ig-stream": node.name,
+            "data-ig-stream-from": node.props[:from]
+          )
+
+          h2 node_label(node)
+          ol class: "ig-stream-feed", "data-ig-stream-feed": node.name
+          render_property_list(node.props)
+          render_build_block(block, self)
+        end
+
+        private
+
+        def tag_name
+          "article"
+        end
+      end
+    end
+  end
+end

data/packages/igniter-web/lib/igniter/web/components/view_zone.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Igniter
+  module Web
+    module Components
+      class ViewZone < Component
+        builder_method :view_zone
+
+        def build(zone, &block)
+          super(
+            class: class_names("ig-zone", token_class("ig-zone", zone.name)),
+            "data-ig-zone": zone.name
+          )
+
+          render_build_block(block, self)
+        end
+
+        private
+
+        def tag_name
+          "section"
+        end
+      end
+    end
+  end
+end

data/packages/igniter-web/lib/igniter/web/components.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "components/view_screen"
+require_relative "components/view_zone"
+require_relative "components/view_node"
+require_relative "components/view_action_node"
+require_relative "components/view_ask_node"
+require_relative "components/view_chat_node"
+require_relative "components/view_compare_node"
+require_relative "components/view_stream_node"

data/packages/igniter-web/lib/igniter/web/composer.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Igniter
+  module Web
+    class Composer
+      class << self
+        def compose(...)
+          new.compose(...)
+        end
+      end
+
+      def initialize(policy: CompositionPolicy.new)
+        @policy = policy
+      end
+
+      def compose(screen)
+        preset = CompositionPreset.fetch(screen.composition_preset)
+        graph = ViewGraph.new(root: root_node(screen, preset))
+        CompositionResult.new(
+          screen: screen,
+          graph: graph,
+          findings: @policy.findings_for(screen, preset: preset)
+        )
+      end
+
+      private
+
+      def root_node(screen, preset)
+        zones = preset.zone_order.map { |name| zone_node(name, screen, preset) }
+        ViewNode.new(
+          kind: :screen,
+          name: screen.name,
+          role: screen.intent,
+          props: {
+            title: screen.title_text,
+            preset: preset.to_h,
+            options: screen.options
+          }.compact,
+          children: zones
+        )
+      end
+
+      def zone_node(name, screen, preset)
+        children = screen.elements
+                         .select { |element| zone_for(element, preset) == name }
+                         .map { |element| element_node(element) }
+
+        ViewNode.new(
+          kind: :zone,
+          name: name,
+          children: children
+        )
+      end
+
+      def element_node(element)
+        ViewNode.new(
+          kind: element.kind,
+          name: element.name,
+          role: element.role,
+          props: element.options
+        )
+      end
+
+      def zone_for(element, preset)
+        preset_zone = preset.preferred_zone_for(element.kind)
+        return preset_zone if preset_zone
+
+        return :summary if element.role == :summary
+        return :aside if element.role == :aside
+        return :footer if element.kind == :action
+        return :main if %i[ask compare stream].include?(element.kind)
+
+        case element.kind
+        when :subject
+          :summary
+        when :actor, :chat
+          :aside
+        else
+          :main
+        end
+      end
+    end
+  end
+end