alembic 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a28b9683aee21510ccc84055b1f946263171af250b924b7fa16b89fe758ae4b
-  data.tar.gz: f64da9c1a64cc8a20fd48aa05e773973fc1eee8d3a8ee222d3d4de5de9d21154
+  metadata.gz: 9e0b25fc3373eb9220014c3c13e37b349b68b928ae417fa2f1b93081304bbb0d
+  data.tar.gz: 0727dcc579e6a0cc0e38eff459ac31f29854e567a072c1ffb21f0eed687f70e2
 SHA512:
-  metadata.gz: fffcf2c82312ff28a404fe1d4569572b9908a1f2b9a30295efaf3c869e246fdcf6258125b5295b2b400898f8b0ffb075ca000b0c33686dadf7d7b0d2d19918fd
-  data.tar.gz: 6d71eaad3a26a0c2e77a033a16ff6fb791af402a2ce04efaca9c731c84eb53d86253f003d8e4b44b57f3f9de7682e4ad7dadcde8a9278111a653e6137fb55ef0
+  metadata.gz: 88f5a0b2349fa2d04fcb5766651d645b031e706146360096e9e215c4bf19b2c5557c3e0e7e294e7700fabe1937da4511f3cbdecfadf4277d30e192d489bfe2f5
+  data.tar.gz: 7f34afb77cc986dfdbe1df1f02a405d1f3a721117e8285be2854a90e5adfc10eb2eb3c1e9971887f5dafaa21817d6791c4eb35ea30df82d7915c75e3a63b5a6a

data/app/controllers/alembic/application_controller.rb

@@ -2,6 +2,7 @@ module Alembic
   class ApplicationController < Alembic.base_controller.constantize
     layout -> { Alembic.layout }
     helper KeystoneUiHelper
+    helper ResultBlocksHelper
 
     rescue_from NotPublished, NotPermitted, Withdrawn, with: :refuse
 

data/app/controllers/alembic/manage/base_controller.rb

@@ -12,6 +12,7 @@ module Alembic
       helper KeystoneUi::React::MountHelper
       helper KsBlocks::ContentHelper
       helper Alembic::PagesHelper
+      helper Alembic::ResultBlocksHelper
     end
   end
 end

data/app/controllers/alembic/manage/flows_controller.rb

@@ -4,12 +4,17 @@ module Alembic
       hosted_by FLOW_HOST
       def edit
         super
-        @summary = Flow::Summaries.new(@flow).text
+        summaries = Flow::Summaries.new(@flow)
+        @summary = summaries.text
+        @summary_page = summaries.summary_page
+        @published_pages = Page.where(id: Page::Version.live.select(:page_id)).order(:name)
       end
 
       def update
-        summary = params.require(:flow)[:summary]
-        Flow::Summaries.new(flow_host.flows.find(params[:id])).describe(summary) unless summary.nil?
+        details = params.require(:flow)
+        summaries = Flow::Summaries.new(flow_host.flows.find(params[:id]))
+        summaries.describe(details[:summary]) unless details[:summary].nil?
+        summaries.finish_on(Page.find_by(id: details[:summary_page_id])) unless details[:summary_page_id].nil?
 
         super
       end

data/app/controllers/concerns/alembic/summarizes.rb

@@ -5,7 +5,10 @@ module Alembic
     included do
       layout -> { Alembic.layout }
       helper ApplicationHelper
-      helper_method :flow_summary, :first_step_path
+      helper PagesHelper
+      helper ResultBlocksHelper
+      helper KsBlocks::LayoutHelper
+      helper_method :flow_summary, :first_step_path, :summary_values
     end
 
     private
@@ -25,7 +28,25 @@ module Alembic
     def finished(answers, finished_run)
       @outputs = outputs_of(answers.transform_keys(&:to_s))
       Flow::Summaries.new(flow).pin(finished_run) if finished_run && run.nil?
-      render template: "alembic/flows/complete"
+      @summary_page = Flow::Summaries.new(run&.flow || flow).summary_page
+      render template: @summary_page&.live_version ? "alembic/flows/summary_page" : "alembic/flows/complete"
+    end
+
+    def summary_values
+      @outputs.to_h { |output| [ output.id, output.value ] }
+        .merge("slug" => @guide.slug, "note" => result_note, "answers" => answers_given)
+    end
+
+    def answers_given
+      @answered.map { |step, value| [ @guide.question_text(step), @guide.choice_label(step, value) ] }
+    end
+
+    def result_note
+      finished_flow = run&.flow || flow
+      return Alembic.lead_note.call(finished_flow.title, @outputs.to_h { |output| [ output.id, output.value ] }) if Alembic.lead_note
+
+      [ finished_flow.title, *@outputs.map { |output| "#{output.label}: #{helpers.alembic_output_lines(output.value).join(', ')}" } ]
+        .compact_blank.join(". ")
     end
 
     def outputs_of(state)

data/app/helpers/alembic/application_helper.rb

@@ -2,8 +2,8 @@ module Alembic
   module ApplicationHelper
     def alembic_output_lines(value)
       case value
-      when Hash then value.map { |name, share| "#{name}: #{share}" }
-      when Array then value
+      when Hash then value.key?("name") ? [ value["name"] ] : value.map { |name, share| "#{name}: #{share}" }
+      when Array then value.map { |item| item.is_a?(Hash) ? item["name"] : item }
       else [ value ]
       end
     end

data/app/helpers/alembic/pages_helper.rb

@@ -4,21 +4,22 @@ module Alembic
   module PagesHelper
     UNDRAWABLE = "This block cannot be drawn until its fields are filled in.".freeze
 
-    def drawn_page(page, being_edited: false)
+    def drawn_page(page, being_edited: false, values: {})
       blocks = being_edited ? page.blocks : page.live_version&.blocks.to_a
-      drawn = blocks.to_h { |block| [ block["id"], drawn_block(block) ] }.compact
+      drawn = blocks.to_h { |block| [ block["id"], drawn_block(block, values: values) ] }.compact
 
       block_layout(blocks.select { |block| drawn.key?(block["id"]) }, kind: :pages) do |block|
         drawn.fetch(block["id"])
       end
     end
 
-    def drawn_block(block)
+    def drawn_block(block, values: {})
       component = Page::Drawing.of(block["type"])
       return unless component
 
+      options = Page::Options.for(block, values: values)
       body = Page::Options.body_for(block)
-      body.nil? ? send(component, **Page::Options.for(block)) : send(component, **Page::Options.for(block)) { body }
+      body.nil? ? send(component, **options) : send(component, **options) { body }
     rescue StandardError => undrawable
       Rails.logger.error("Alembic could not draw the #{block['type']} block: #{undrawable.message}")
       nil

data/app/helpers/alembic/result_blocks_helper.rb

@@ -0,0 +1,45 @@
+module Alembic
+  module ResultBlocksHelper
+    def alembic_score_block(value: nil, caption: nil, kicker: "Your result")
+      render "alembic/blocks/score", value: value, caption: caption, kicker: kicker
+    end
+
+    def alembic_band_block(value: nil, score: nil)
+      render "alembic/blocks/band", band: value.to_h, tone: alembic_tone(score)
+    end
+
+    def alembic_categories_block(value: nil, heading: "Where you stand, area by area")
+      render "alembic/blocks/categories", shares: value.to_h, heading: heading
+    end
+
+    def alembic_weakest_block(value: nil, heading: "Your biggest blind spots", cost_label: "What it likely costs you:")
+      render "alembic/blocks/weakest", categories: Array(value), heading: heading, cost_label: cost_label
+    end
+
+    def alembic_answers_block(value: nil, heading: "What you told us")
+      render "alembic/blocks/answers", answers: Array(value), heading: heading
+    end
+
+    def alembic_lead_block(slug:, note: nil, heading: "The next step", blurb: nil, button: "Send", placeholder: "you@example.com")
+      render "alembic/blocks/lead", address: Alembic.lead_address.call(slug), slug: slug, note: note,
+        heading: heading, blurb: blurb, button: button, placeholder: placeholder
+    end
+
+    def alembic_default_result(output, outputs = [])
+      case output.type
+      when "percentage" then alembic_score_block(value: output.value, caption: output.label)
+      when "band" then alembic_band_block(value: output.value, score: outputs.find { |other| other.type == "percentage" }&.value)
+      when "grouped" then alembic_categories_block(value: output.value)
+      when "lowest" then alembic_weakest_block(value: output.value)
+      else ui_stat_card(label: output.label, value: alembic_output_lines(output.value).join(" · "))
+      end
+    end
+
+    def alembic_tone(percentage)
+      return "bg-red-500" if percentage.to_i < 40
+      return "bg-amber-500" if percentage.to_i < 70
+
+      "bg-emerald-500"
+    end
+  end
+end

data/app/models/alembic/flow/definition_summary.rb

@@ -4,6 +4,7 @@ module Alembic
       self.table_name = "alembic_flow_definition_summaries"
 
       belongs_to :flow, class_name: "EasyFlow::Definition"
+      belongs_to :summary_page, class_name: "Alembic::Page", optional: true
     end
   end
 end

data/app/models/alembic/flow/summaries.rb

@@ -34,6 +34,14 @@ module Alembic
         details.update!(summary: text)
       end
 
+      def summary_page
+        details.summary_page
+      end
+
+      def finish_on(page)
+        details.update!(summary_page: page)
+      end
+
       def pin(run)
         RunSummary.create!(run: run, summary_version: current_version) if current_version
       end

data/app/models/alembic/outputs/band.rb

@@ -15,7 +15,7 @@ module Alembic
       def self.covering(config, number)
         ordered = Array(config["bands"]).sort_by { |band| band["ceiling"] || Float::INFINITY }
 
-        ordered.find { |band| band["ceiling"].nil? || number < band["ceiling"] }&.fetch("name", nil)
+        ordered.find { |band| band["ceiling"].nil? || number < band["ceiling"] }&.slice("name", "description")
       end
     end
   end

data/app/models/alembic/outputs/lowest.rb

@@ -4,7 +4,7 @@ module Alembic
       def self.output_type
         Summary::OutputType.define(:lowest) do
           label "Weakest"
-          compute { |config, _run, so_far| Lowest.of(so_far[config["of"]], config["count"]) }
+          compute { |config, _run, so_far| Lowest.of(so_far[config["of"]], config["count"], config["copy"]) }
         end
       end
 
@@ -12,8 +12,10 @@ module Alembic
         registry.register(output_type)
       end
 
-      def self.of(shares, count)
-        shares.to_h.sort_by { |_name, share| share }.first(count.presence&.to_i || 1).map(&:first)
+      def self.of(shares, count, copy = nil)
+        weakest = shares.to_h.sort_by { |_name, share| share }.first(count.presence&.to_i || 1).map(&:first)
+
+        weakest.map { |name| { "name" => name, **copy.to_h.fetch(name, {}).slice("miss", "cost") } }
       end
     end
   end

data/app/models/alembic/page/options.rb

@@ -6,8 +6,8 @@ module Alembic
         bodies[key.to_sym] = body
       end
 
-      def self.for(block)
-        named(filled(block).except(bodies[block["type"].to_sym]), declared.fetch(block["type"].to_sym, {}))
+      def self.for(block, values: {})
+        named(filled(block).except(bodies[block["type"].to_sym]), declared.fetch(block["type"].to_sym, {}), values)
       end
 
       def self.body_for(block)
@@ -28,19 +28,26 @@ module Alembic
         block.fetch("content", {}).reject { |_key, value| value == "" }.symbolize_keys
       end
 
-      def self.named(filled, options)
+      def self.named(filled, options, values)
         options.each_with_object(filled) do |(option, spec), built|
-          spec.is_a?(Hash) ? fill(built, option, spec) : built[option] = spec
+          spec.is_a?(Hash) ? fill(built, option, spec, values) : built[option] = spec
         end
       end
 
-      def self.fill(built, option, spec)
-        value = built.delete(spec.fetch(:from, option))
+      def self.fill(built, option, spec, values)
+        value = handed(built, option, spec, values)
         built[option] = value.nil? ? spec[:default] : value
         built.delete(option) if built[option].nil?
       end
 
-      private_class_method :filled, :named, :fill
+      def self.handed(built, option, spec, values)
+        return values[spec[:value]] if spec.key?(:value)
+        return values[built.delete(spec[:value_of]).to_s] if spec.key?(:value_of)
+
+        built.delete(spec.fetch(:from, option))
+      end
+
+      private_class_method :filled, :named, :fill, :handed
     end
   end
 end

data/app/models/alembic/result_blocks.rb

@@ -0,0 +1,29 @@
+module Alembic
+  module ResultBlocks
+    OUTPUT = { key: :output, label: "Output" }.freeze
+    HEADING = { key: :heading, label: "Heading" }.freeze
+
+    def self.register
+      Page.block(:alembic_score, name: "Score", width: 12, height: 3, drawn_by: :alembic_score_block,
+        fields: [ OUTPUT, { key: :kicker, label: "Label above" }, { key: :caption, label: "Caption" } ],
+        options: { value: { value_of: :output } })
+      Page.block(:alembic_band, name: "Band", width: 12, height: 2, drawn_by: :alembic_band_block,
+        fields: [ OUTPUT, { key: :score, label: "Score output" } ],
+        options: { value: { value_of: :output }, score: { value_of: :score } })
+      Page.block(:alembic_categories, name: "Score per category", width: 12, height: 4, drawn_by: :alembic_categories_block,
+        fields: [ OUTPUT, HEADING ], options: { value: { value_of: :output } })
+      Page.block(:alembic_weakest, name: "Weakest categories", width: 12, height: 4, drawn_by: :alembic_weakest_block,
+        fields: [ OUTPUT, HEADING, { key: :cost_label, label: "Cost label" } ], options: { value: { value_of: :output } })
+      Page.block(:alembic_answers, name: "Answers given", width: 12, height: 4, drawn_by: :alembic_answers_block,
+        fields: [ HEADING ], options: { value: { value: "answers" } })
+      register_lead if Alembic.lead_address
+    end
+
+    def self.register_lead
+      Page.block(:alembic_lead, name: "Lead", width: 12, height: 3, drawn_by: :alembic_lead_block,
+        fields: [ HEADING, { key: :blurb, label: "Text" }, { key: :button, label: "Button" }, { key: :placeholder, label: "Placeholder" } ],
+        options: { slug: { value: "slug" }, note: { value: "note" } })
+    end
+    private_class_method :register_lead
+  end
+end

data/app/models/alembic/summary/report.rb

@@ -13,7 +13,7 @@ module Alembic
           output_type = @registry.fetch(output["type"])
           produced[output["id"]] = output_type.compute(output, run, produced)
 
-          Result.new(id: output["id"], label: label_for(output, output_type), value: produced[output["id"]])
+          Result.new(id: output["id"], type: output["type"], label: label_for(output, output_type), value: produced[output["id"]])
         end
       end
 

data/app/models/alembic/summary/result.rb

@@ -1,5 +1,5 @@
 module Alembic
   module Summary
-    Result = Data.define(:id, :label, :value)
+    Result = Data.define(:id, :type, :label, :value)
   end
 end

data/app/views/alembic/blocks/_answers.html.erb

@@ -0,0 +1,11 @@
+<div>
+  <h2 class="text-xs font-semibold uppercase tracking-wider text-gray-500 mb-4"><%= heading %></h2>
+  <ul class="divide-y divide-gray-100 border-y border-gray-100">
+    <% answers.each do |question, answer| %>
+      <li class="flex items-baseline justify-between gap-6 py-3">
+        <span class="text-gray-600"><%= question %></span>
+        <span class="shrink-0 font-semibold text-gray-900"><%= answer %></span>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/app/views/alembic/blocks/_band.html.erb

@@ -0,0 +1,6 @@
+<div class="text-center">
+  <span class="inline-block mt-5 px-4 py-1.5 rounded-full text-sm font-semibold text-white <%= tone %>"><%= band["name"] %></span>
+  <% if band["description"].present? %>
+    <p class="text-gray-600 leading-relaxed max-w-lg mx-auto mt-4"><%= band["description"] %></p>
+  <% end %>
+</div>

data/app/views/alembic/blocks/_categories.html.erb

@@ -0,0 +1,11 @@
+<div>
+  <h2 class="text-xs font-semibold uppercase tracking-wider text-gray-500 mb-4"><%= heading %></h2>
+  <% shares.each do |name, share| %>
+    <div class="flex items-center gap-3 mb-2.5">
+      <span class="text-sm text-gray-600 w-44 shrink-0"><%= name %></span>
+      <span class="flex-1 h-2 bg-gray-100 rounded-full overflow-hidden">
+        <span class="block h-full rounded-full <%= alembic_tone(share) %>" style="width:<%= [ share.to_i, 4 ].max %>%"></span>
+      </span>
+    </div>
+  <% end %>
+</div>

data/app/views/alembic/blocks/_lead.html.erb

@@ -0,0 +1,15 @@
+<%= ui_panel(padding: :lg) do %>
+  <h2 class="text-xl font-semibold text-gray-900 mb-2"><%= heading %></h2>
+  <% if blurb.present? %>
+    <p class="text-gray-600 mb-5"><%= blurb %></p>
+  <% end %>
+  <%= form_with url: address, method: :post, class: "flex flex-col sm:flex-row gap-3" do %>
+    <%= render Alembic.lead_fields_partial if Alembic.lead_fields_partial %>
+    <%= hidden_field_tag "slug", slug %>
+    <%= hidden_field_tag "note", note %>
+    <div class="flex-1">
+      <%= ui_input(name: "email", type: :email, placeholder: placeholder) %>
+    </div>
+    <button type="submit" class="inline-flex items-center justify-center font-semibold rounded-lg bg-accent-600 text-white hover:bg-accent-500 px-6 py-3 cursor-pointer whitespace-nowrap"><%= button %></button>
+  <% end %>
+<% end %>

data/app/views/alembic/blocks/_score.html.erb

@@ -0,0 +1,7 @@
+<div class="text-center">
+  <p class="text-xs font-semibold uppercase tracking-widest text-accent-600 mb-4"><%= kicker %></p>
+  <div class="text-7xl md:text-8xl font-bold tracking-tight text-gray-900"><%= value.nil? ? "—" : "#{value}%" %></div>
+  <% if caption.present? %>
+    <p class="text-sm text-gray-500 mt-1"><%= caption %></p>
+  <% end %>
+</div>

data/app/views/alembic/blocks/_weakest.html.erb

@@ -0,0 +1,12 @@
+<div>
+  <h2 class="text-xs font-semibold uppercase tracking-wider text-gray-500 mb-4"><%= heading %></h2>
+  <div class="space-y-4">
+    <% categories.each do |category| %>
+      <%= ui_panel(padding: :lg) do %>
+        <h3 class="text-lg font-semibold text-gray-900 mb-1.5"><%= category["name"] %></h3>
+        <p class="text-gray-700 mb-2"><%= category["miss"] %></p>
+        <p class="text-sm text-accent-700"><span class="font-semibold"><%= cost_label %></span> <%= category["cost"] %></p>
+      <% end %>
+    <% end %>
+  </div>
+</div>

data/app/views/alembic/flows/complete.html.erb

@@ -11,13 +11,19 @@
 
   <% if @outputs.any? %>
     <%= ui_section do %>
-      <%= ui_grid(cols: { default: 1, sm: 2 }, gap: :lg) do %>
+      <div class="space-y-10">
         <% @outputs.each do |output| %>
           <div data-output="<%= output.id %>">
-            <%= ui_stat_card(label: output.label, value: alembic_output_lines(output.value).join(" · ")) %>
+            <%= alembic_default_result(output, @outputs) %>
           </div>
         <% end %>
-      <% end %>
+      </div>
+    <% end %>
+  <% end %>
+
+  <% if Alembic.lead_address %>
+    <%= ui_section do %>
+      <%= alembic_lead_block(slug: summary_values["slug"], note: summary_values["note"]) %>
     <% end %>
   <% end %>
 

data/app/views/alembic/flows/summary_page.html.erb

@@ -0,0 +1,5 @@
+<% content_for :head do %>
+  <%= stylesheet_link_tag "ks_blocks" %>
+<% end %>
+
+<%= drawn_page(@summary_page, values: summary_values) %>

data/app/views/alembic/manage/flows/edit.html.erb

@@ -17,6 +17,12 @@
       <%= ui_input(name: "flow[start_label]", value: @flow.start_label) %>
     <% end %>
 
+    <%= ui_section(title: "Where this finishes") do %>
+      <%= ui_select(name: "flow[summary_page_id]", selected: @summary_page&.id,
+            include_blank: "Alembic's default summary page",
+            options: @published_pages.map { |page| [ page.name, page.id ] }) %>
+    <% end %>
+
     <%= ui_section(title: "What this keeps of a run") do %>
       <%= ui_select(name: "flow[persists]", selected: @flow.persists,
             options: [ [ "Nothing", "unsaved" ],

data/db/migrate/20260930120000_add_summary_page_to_alembic_flow_definition_summaries.rb

@@ -0,0 +1,6 @@
+class AddSummaryPageToAlembicFlowDefinitionSummaries < ActiveRecord::Migration[8.1]
+  def change
+    add_reference :alembic_flow_definition_summaries, :summary_page,
+      foreign_key: { to_table: :alembic_pages, on_delete: :nullify }
+  end
+end

data/lib/alembic/engine.rb

@@ -30,5 +30,9 @@ module Alembic
         Alembic::Outputs::Band.register
       end
     end
+
+    initializer "alembic.result_blocks" do |app|
+      app.config.to_prepare { Alembic::ResultBlocks.register }
+    end
   end
 end

data/lib/alembic/version.rb

@@ -1,3 +1,3 @@
 module Alembic
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/alembic.rb

@@ -13,7 +13,7 @@ module Alembic
                           visitor_authorization_method refusal_method].freeze
 
   class << self
-    attr_accessor :lead_partial
+    attr_accessor :lead_address, :lead_fields_partial, :lead_note
     attr_reader :admin_authentication_method, :visitor_authorization_method, :refusal_method
 
     FLOW_HOST_SETTINGS.each do |name|
@@ -29,6 +29,10 @@ module Alembic
       end
     end
 
+    def lead_partial=(_partial)
+      warn "Alembic.lead_partial no longer exists and draws nothing. Set Alembic.lead_address to where the lead block posts."
+    end
+
     def base_controller=(value)
       @base_controller = value
       EasyFlow.base_controller = value

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alembic
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - tylercschneider
@@ -98,6 +98,7 @@ files:
 - app/controllers/concerns/alembic/summarizes.rb
 - app/helpers/alembic/application_helper.rb
 - app/helpers/alembic/pages_helper.rb
+- app/helpers/alembic/result_blocks_helper.rb
 - app/javascript/alembic/page_builder.jsx
 - app/javascript/alembic/page_builder/PageBuilder.jsx
 - app/jobs/alembic/application_job.rb
@@ -117,14 +118,22 @@ files:
 - app/models/alembic/page/drawing.rb
 - app/models/alembic/page/options.rb
 - app/models/alembic/page/version.rb
+- app/models/alembic/result_blocks.rb
 - app/models/alembic/summary.rb
 - app/models/alembic/summary/output_type.rb
 - app/models/alembic/summary/registry.rb
 - app/models/alembic/summary/report.rb
 - app/models/alembic/summary/result.rb
 - app/models/alembic/summary/run.rb
+- app/views/alembic/blocks/_answers.html.erb
+- app/views/alembic/blocks/_band.html.erb
+- app/views/alembic/blocks/_categories.html.erb
+- app/views/alembic/blocks/_lead.html.erb
+- app/views/alembic/blocks/_score.html.erb
+- app/views/alembic/blocks/_weakest.html.erb
 - app/views/alembic/flows/complete.html.erb
 - app/views/alembic/flows/show.html.erb
+- app/views/alembic/flows/summary_page.html.erb
 - app/views/alembic/manage/flows/edit.html.erb
 - app/views/alembic/manage/pages/_block_content.html.erb
 - app/views/alembic/manage/pages/index.html.erb
@@ -185,6 +194,7 @@ files:
 - db/migrate/20260922120000_add_slug_to_alembic_pages.rb
 - db/migrate/20260922130000_create_alembic_page_versions.rb
 - db/migrate/20260924220000_move_flows_onto_easy_flow.rb
+- db/migrate/20260930120000_add_summary_page_to_alembic_flow_definition_summaries.rb
 - lib/alembic.rb
 - lib/alembic/engine.rb
 - lib/alembic/leftover_stylesheet.rb