alembic 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1bbb5e143c708d065ecde4e03e6f15a12370477c90f6eba616df65d6385723b
-  data.tar.gz: e8aaa3d003df05d8ac6f224a24988de3f4c2acb411c923a04dc686bd8d61964d
+  metadata.gz: 9745fd29a830ce8120e72ac117e6ed70668f620a1a8bd73f016dcca369006c19
+  data.tar.gz: 0b4c9f862d77e9841be71f804a6ce7d97d7a2252accca09de540a34ce5588c99
 SHA512:
-  metadata.gz: bc188f2db8802e22f9322e8ca03bf56e184ee85581b96a687e78033ef85385baff38aa4bb8bd711d8dd8453cf2f67894f1b2f0a603a85ac375d15d51ff6171ec
-  data.tar.gz: c354eb980ec4c04a659b216066063bc46de2d8a3f7708f2072ee27e7211590b92216a49d29af5786c74652b785d3fc6ca40384ec9aa32eb4762e1609a0e0b4b2
+  metadata.gz: d3c136947c2ca35cb00702f965965cd4e73c7a6605c44188f7966062602026fdded09c355723b974531397c5fbd9b7232742118123d25bf8501a645e6ada4c9b
+  data.tar.gz: 24920854c0d867b45620284d65823872fd990561bf0fb025b9a73612bb92e75e86c5255b5b7728b73f5167f007d86175702b8467eb43f6a21625d8b3feba85dc

data/app/controllers/alembic/flows_controller.rb

@@ -2,7 +2,7 @@ module Alembic
   class FlowsController < EasyFlow::FlowsController
     hosted_by FLOW_HOST
     include Summarizes
-    helper_method :step_category, :shows_answer_values?
+    helper_method :shows_answer_values?
 
     def step
       return super unless asked_on_one_page?
@@ -32,10 +32,6 @@ module Alembic
       Flow::Summaries.new(run&.flow || flow).shows_answer_values?
     end
 
-    def step_category(question)
-      EasyFlow::Steps::Question.category_of(@guide.step(question.id)&.config)
-    end
-
     def run_location(run)
       alembic.run_path(run)
     end

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

@@ -0,0 +1,30 @@
+module Alembic
+  module Manage
+    class AnswerKeysController < PreviewsController
+      helper_method :shows_answer_values?
+
+      def self.local_prefixes
+        [ "alembic/flows", *super ]
+      end
+
+      private
+
+      def flow_start_path(_slug)
+        alembic.manage_flow_answer_key_path(previewed)
+      end
+
+      def flow_step_path(_slug)
+        alembic.step_manage_flow_answer_key_path(previewed)
+      end
+
+      def chosen_answer(question)
+        step = @guide.step(question.id)
+        Flow::AnswerKey.chosen(step.config.merge("type" => step.type))
+      end
+
+      def shows_answer_values?
+        Flow::Summaries.new(previewed).shows_answer_values?
+      end
+    end
+  end
+end

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

@@ -10,11 +10,23 @@ module Alembic
       helper ContentBlocksHelper
       helper KsBlocks::LayoutHelper
       after_action :keep_ended_inner_run, only: :step
-      helper_method :flow_summary, :first_step_path, :summary_values, :intro_values, :start_over_path, :finish_link, :visited_flow_address
+      helper_method :flow_summary, :first_step_path, :summary_values, :intro_values, :start_over_path, :finish_link, :visited_flow_address, :answered_right?, :single_choice?, :drawing_of, :chosen_answer, :step_category
     end
 
     private
 
+    def single_choice?(question)
+      @guide.step(question.id)&.type == "question"
+    end
+
+    def step_category(question)
+      EasyFlow::Steps::Question.category_of(@guide.step(question.id)&.config)
+    end
+
+    def drawing_of(question)
+      EasyFlow::Drawing.of(@guide.step(question.id))
+    end
+
     def flow_summary(flow)
       Flow::Summaries.new(flow).text
     end
@@ -23,6 +35,8 @@ module Alembic
       flow_step_path(slug)
     end
 
+    def chosen_answer(_question); end
+
     def start_over_path
       flow_start_path(visited_flow_address)
     end
@@ -78,6 +92,10 @@ module Alembic
         .merge("slug" => @guide.slug, "note" => result_note, "answers" => answers_given)
     end
 
+    def answered_right?(step, value)
+      (run&.flow || flow).scored? && Outputs::WeightedSum.weight_of(@guide.step(step).config, value).positive?
+    end
+
     def answers_given
       @answered.map { |step, value| [ @guide.question_text(step), @guide.choice_label(step, value) ] }
     end

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

@@ -0,0 +1,13 @@
+module Alembic
+  module Flow
+    module AnswerKey
+      def self.chosen(step)
+        case step["type"]
+        when "multiple_select" then Outputs::WeightedSum.right_answers(step)
+        when "fill_in_the_blank" then Array(step["accepted_answers"]).first&.fetch("value", nil)
+        else Outputs::WeightedSum.right_answers(step).first
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@
   <div class="space-y-3">
     <% question.choices.each do |choice| %>
       <label class="block cursor-pointer">
-        <%= radio_button_tag "answers[#{question.id}]", choice.value, false, class: "peer sr-only", onchange: (local_assigns.fetch(:sends_on_choice, true) ? "this.form.requestSubmit()" : nil) %>
+        <%= radio_button_tag "answers[#{question.id}]", choice.value, choice.value == local_assigns[:chosen], class: "peer sr-only", onchange: (local_assigns.fetch(:sends_on_choice, true) ? "this.form.requestSubmit()" : nil) %>
         <span class="ks-radio-card ks-radio-card-highlight flex items-start gap-3 transition hover:border-(color:--ks-color-hover-border)">
           <% if shows_values %>
             <span class="text-xs font-semibold uppercase tracking-wider text-(color:--ks-color-link) dark:text-(color:--ks-color-link-dark) border border-(color:--ks-color-tint-border) rounded px-2 py-0.5 shrink-0 mt-0.5"><%= choice.value %></span>

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

@@ -40,7 +40,12 @@
       <% @answered.each do |step, value| %>
         <li data-answer="<%= step %>" class="flex items-baseline justify-between gap-6 py-3">
           <span class="ks-tone-muted"><%= @guide.question_text(step) %></span>
-          <span class="shrink-0 font-(weight:--ks-font-weight-medium) ks-tone-neutral"><%= @guide.choice_label(step, value) %></span>
+          <span class="flex shrink-0 items-center gap-2 font-(weight:--ks-font-weight-medium) ks-tone-neutral">
+            <%= @guide.choice_label(step, value) %>
+            <% if answered_right?(step, value) %>
+              <svg aria-label="Right" role="img" class="size-5 ks-tone-success" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor"><path fill-rule="evenodd" d="M16.704 4.153a.75.75 0 0 1 .143 1.052l-8 10.5a.75.75 0 0 1-1.127.075l-4.5-4.5a.75.75 0 0 1 1.06-1.06l3.894 3.893 7.48-9.817a.75.75 0 0 1 1.05-.143Z" clip-rule="evenodd" /></svg>
+            <% end %>
+          </span>
         </li>
       <% end %>
     </ul>

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

@@ -13,7 +13,11 @@
       <% @questions.each_with_index do |question, index| %>
         <div data-one-page-question>
           <div class="mb-8"><%= ui_progress(value: index, max: @questions.size, label: "Question #{index + 1} of #{@questions.size}") %></div>
-          <%= render "alembic/flows/question", question: question, category: step_category(question), shows_values: shows_answer_values?, sends_on_choice: false %>
+          <% if single_choice?(question) %>
+            <%= render "alembic/flows/question", question: question, category: step_category(question), shows_values: shows_answer_values?, sends_on_choice: false %>
+          <% else %>
+            <%= render drawing_of(question), step: question %>
+          <% end %>
           <% if index.positive? %>
             <button type="button" data-one-page-previous hidden class="mt-6 ks-tone-muted cursor-pointer text-sm underline underline-offset-2 hover:text-(color:--ks-color-text) dark:hover:text-(color:--ks-color-text-dark)">← Previous</button>
           <% end %>

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

@@ -25,11 +25,11 @@
           <% end %>
         <% end %>
 
-        <% if @question.respond_to?(:choices) %>
+        <% if single_choice?(@question) %>
           <%= render "alembic/flows/question", question: @question, category: step_category(@question),
-                shows_values: shows_answer_values? %>
+                shows_values: shows_answer_values?, chosen: chosen_answer(@question) %>
         <% else %>
-          <%= render @drawing, step: @question %>
+          <%= render @drawing, step: @question, chosen: chosen_answer(@question) %>
         <% end %>
 
         <div class="mt-8 flex items-center gap-4">

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

@@ -11,6 +11,10 @@
     <% end %>
   <% end %>
 
+  <%= ui_section(title: "Answer key") do %>
+    <%= link_to "Walk through the answer key", alembic.step_manage_flow_answer_key_path(@flow), class: "text-sm text-(color:--ks-color-link) hover:text-(color:--ks-color-link-hover) dark:text-(color:--ks-color-link-dark) dark:hover:text-(color:--ks-color-link-hover-dark)" %>
+  <% end %>
+
   <%= ui_form(action: easy_flow.manage_flow_path(@flow), method: :patch) do %>
     <%= ui_section(title: "How this is introduced") do %>
       <label class="ks-label mb-1">Title</label>

data/config/routes.rb

@@ -14,6 +14,9 @@ Alembic::Engine.routes.draw do
       resource :preview, only: :show, controller: "previews" do
         get :step
       end
+      resource :answer_key, only: :show, controller: "answer_keys" do
+        get :step
+      end
     end
   end
 

data/lib/alembic/version.rb

@@ -1,3 +1,3 @@
 module Alembic
-  VERSION = "0.8.2"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alembic
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - tylercschneider
@@ -57,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.27'
+        version: '0.29'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.27'
+        version: '0.29'
 description: Alembic builds and runs data-driven interactive diagnostics — scored
   assessments and branching guides — that place a visitor on an outcome and capture
   the result. A runtime engine plus a UI builder.
@@ -83,6 +83,7 @@ files:
 - app/assets/stylesheets/alembic/application.css
 - app/controllers/alembic/application_controller.rb
 - app/controllers/alembic/flows_controller.rb
+- app/controllers/alembic/manage/answer_keys_controller.rb
 - app/controllers/alembic/manage/base_controller.rb
 - app/controllers/alembic/manage/flows_controller.rb
 - app/controllers/alembic/manage/page_blocks_controller.rb
@@ -101,6 +102,7 @@ files:
 - app/jobs/alembic/application_job.rb
 - app/mailers/alembic/application_mailer.rb
 - app/models/alembic/application_record.rb
+- app/models/alembic/flow/answer_key.rb
 - app/models/alembic/flow/definition_summary.rb
 - app/models/alembic/flow/output_form.rb
 - app/models/alembic/flow/preview_values.rb