alembic 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26fff39c56e3627fa327fc6ae59d02d9d034687db485abf2e7d991e19beac021
-  data.tar.gz: e8eb409d6bff630da792f4d084138e6c48d7d7b443a659e257a31f19b91e0627
+  metadata.gz: f4ad973a4cd7a81bb2d9ff18e31075ca5b4dc32c20b82c86d3cdbf39445ce28d
+  data.tar.gz: fdf0002e2cb0c7a559be457f24df5af9d64354f6136d5428a81e6a31c7b4e00b
 SHA512:
-  metadata.gz: 45395f01c87606d7a626341112ed4b99c27ba1e4b11b82cb8cc186a8e33f2b3279f9f7542c625f8f879b37327defa4a57ac7bbcfef3846f1b5053d02abf65076
-  data.tar.gz: 523ec9fda8a088f4843bcb3b5347bca4771a523fd42e7c9314ea128792f1279d97186418bcaf56b8b6c650b4f93b9a31f42f7c20789eb61d537f9b6afa123ae3
+  metadata.gz: d0f8baba0a3c8f8b0eef256bae0bf3211a8037216f4ebbf6df5ea09c830de4ed50b23f07f8cf1c754757aa09884216d9fb2402f5d27c871c242f2b88118c2ac5
+  data.tar.gz: 546561d85803831584fa1e8aa6b9ce9bcf6503c51277e6a0b36258cd71ceab78ae252acdd6b4c721b2affbf5e5be62eb59dd128480ea7bcfd7f6e417290667bc

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

@@ -21,6 +21,11 @@ module Alembic
         Flow::AnswerKey.chosen(step_settings(question.id))
       end
 
+      def named_right_answer(question)
+        accepted = Flow::AnswerKey.accepted(step_settings(question.id))
+        accepted.any? ? accepted.to_sentence(two_words_connector: " or ", last_word_connector: ", or ") : super
+      end
+
       def shows_answer_values?
         Flow::Summaries.new(previewed).shows_answer_values?
       end

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

@@ -0,0 +1,21 @@
+module Alembic
+  module Manage
+    class QuizzesController < EasyFlow::Manage::BaseController
+      hosted_by FLOW_HOST
+
+      def new
+        @flow = hosted_flows.new
+      end
+
+      def create
+        @flow = hosted_flows.new(params.require(:quiz).permit(:title))
+
+        if Flow::TitledStart.new(@flow).save
+          redirect_to easy_flow.manage_flow_path(@flow), notice: "Quiz created."
+        else
+          render :new, status: :unprocessable_entity
+        end
+      end
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ 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, :answered_right?, :single_choice?, :drawing_of, :chosen_answer, :step_category, :shown
+      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, :named_right_answer, :step_category, :shown
     end
 
     private
@@ -41,6 +41,11 @@ module Alembic
 
     def chosen_answer(_question); end
 
+    def named_right_answer(question)
+      chosen = chosen_answer(question)
+      @guide.choice_label(question.id, chosen) if chosen.present?
+    end
+
     def start_over_path
       flow_start_path(visited_flow_address)
     end

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

@@ -8,6 +8,10 @@ module Alembic
         else Outputs::WeightedSum.right_answers(step).first
         end
       end
+
+      def self.accepted(step)
+        Array(step["accepted_answers"]).filter_map { |answer| answer["value"].presence }
+      end
     end
   end
 end

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

@@ -0,0 +1,46 @@
+module Alembic
+  module Flow
+    class TitledStart
+      FALLBACK_SLUG = "quiz"
+      MADE_SLUG_LENGTH = 100
+      TRIES_FOR_A_FREE_SLUG = 3
+      SLUGS_THE_ROUTES_USE = %w[manage pages runs].freeze
+
+      def initialize(flow)
+        @flow = flow
+      end
+
+      def save
+        return refuse_blank_title if @flow.title.blank?
+
+        tries = 0
+        begin
+          @flow.slug = free_slug
+          @flow.save
+        rescue ActiveRecord::RecordNotUnique
+          retry if (tries += 1) < TRIES_FOR_A_FREE_SLUG
+          raise
+        end
+      end
+
+      private
+
+      def refuse_blank_title
+        @flow.errors.add(:title, :blank)
+        false
+      end
+
+      def free_slug
+        made = @flow.title.parameterize.first(MADE_SLUG_LENGTH).chomp("-").presence || FALLBACK_SLUG
+        numbered = (2..).lazy.map { |number| "#{made}-#{number}" }
+        taken = unavailable
+
+        [ made ].chain(numbered).find { |candidate| taken.exclude?(candidate) }
+      end
+
+      def unavailable
+        EasyFlow::Definition.where(host: @flow.host, owner: @flow.owner).pluck(:slug) + SLUGS_THE_ROUTES_USE
+      end
+    end
+  end
+end

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

@@ -32,8 +32,8 @@
           <%= render @drawing, step: shown(@question), chosen: chosen_answer(@question) %>
         <% end %>
 
-        <% if (right_answer = chosen_answer(@question)).present? %>
-          <%= ui_value_list(rows: [ { label: ui_badge(label: "Right answer", variant: :success), value: @guide.choice_label(@question.id, right_answer) } ]) %>
+        <% if (right_answer = named_right_answer(@question)).present? %>
+          <%= ui_value_list(rows: [ { label: ui_badge(label: "Right answer", variant: :success), value: right_answer } ]) %>
         <% end %>
 
         <div class="mt-8 flex items-center gap-4">

data/app/views/alembic/manage/quizzes/new.html.erb

@@ -0,0 +1,11 @@
+<% content_for(:title, "New quiz") %>
+
+<%= ui_page(max_width: :md) do %>
+  <%= ui_page_header(title: "New quiz") %>
+
+  <%= ui_form(action: alembic.manage_quizzes_path, method: :post) do %>
+    <%= ui_form_field(attribute: "quiz[title]", label: "Title", value: @flow.title, errors: @flow.errors.full_messages_for(:title)) %>
+
+    <%= ui_button(label: "Create", type: :submit) %>
+  <% end %>
+<% end %>

data/config/routes.rb

@@ -18,6 +18,8 @@ Alembic::Engine.routes.draw do
         get :step
       end
     end
+
+    resources :quizzes, only: [ :new, :create ]
   end
 
   constraints(->(request) { request.path_info.match?(%r{\A/manage/flows(/|\z)}) }) do

data/lib/alembic/answer_explanations.rb

@@ -0,0 +1,25 @@
+module Alembic
+  module AnswerExplanations
+    TEXT = {
+      "question" => {
+        "answers.info" => "Extra detail saved with this answer, which the question page does not show to a player.",
+        "answers.hint" => "A smaller line a player sees under this answer's text.",
+        "answers.label" => "The text a player sees for this answer in place of its value.",
+        "answers.value" => "The text saved when a player picks this answer, which the player also sees when the label is blank or the flow shows answer values.",
+        "answers.weight" => "The points a player scores by picking this answer, and any weight above zero makes it a right answer."
+      },
+      "multiple_select" => {
+        "answers.label" => "The text a player sees for this answer in place of its value.",
+        "answers.value" => "The text saved when a player ticks this answer, which the player also sees when the label is blank.",
+        "answers.weight" => "Any weight above zero makes this a right answer, whatever its size, and the question scores one point only when a player ticks every right answer and no others."
+      },
+      "fill_in_the_blank" => {
+        "accepted_answers.value" => "A typed answer that matches this text, ignoring capitals and the spaces around it, is right and scores one point."
+      }
+    }.freeze
+
+    def explanation_for(step_type, setting)
+      super || TEXT.dig(step_type.to_s, setting.to_s)
+    end
+  end
+end

data/lib/alembic/engine.rb

@@ -33,6 +33,10 @@ module Alembic
       end
     end
 
+    initializer "alembic.answer_explanations" do |app|
+      app.config.to_prepare { Alembic.explain_answer_fields }
+    end
+
     initializer "alembic.question_importer" do |app|
       app.config.to_prepare { require "alembic/question_importer" if defined?(Ixport::Importer) }
     end

data/lib/alembic/version.rb

@@ -1,3 +1,3 @@
 module Alembic
-  VERSION = "0.14.0"
+  VERSION = "0.16.0"
 end

data/lib/alembic.rb

@@ -1,6 +1,7 @@
 require "json"
 require "alembic/version"
 require "alembic/engine"
+require "alembic/answer_explanations"
 
 module Alembic
   NotPublished = EasyFlow::NotPublished
@@ -37,9 +38,12 @@ module Alembic
     end
 
     def set_up_flow_host
-      EasyFlow.host(FLOW_HOST) do |host|
-        FLOW_HOST_SETTINGS.each { |name| host.public_send(:"#{name}=", public_send(name)) }
-      end
+      host = explain_answer_fields
+      FLOW_HOST_SETTINGS.each { |name| host.public_send(:"#{name}=", public_send(name)) }
+    end
+
+    def explain_answer_fields
+      flow_host.extend(AnswerExplanations)
     end
 
     def lead_partial=(_partial)
@@ -69,6 +73,13 @@ module Alembic
     def admin_layout
       @admin_layout || "application"
     end
+
+    private
+
+    def flow_host
+      host = EasyFlow.host_named(FLOW_HOST)
+      host.set_up? ? host : EasyFlow.host(FLOW_HOST)
+    end
   end
 
   set_up_flow_host

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alembic
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - tylercschneider
@@ -57,20 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.32'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.32.1
+        version: '0.35'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.32'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.32.1
+        version: '0.35'
 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.
@@ -95,6 +89,7 @@ files:
 - app/controllers/alembic/manage/page_blocks_controller.rb
 - app/controllers/alembic/manage/pages_controller.rb
 - app/controllers/alembic/manage/previews_controller.rb
+- app/controllers/alembic/manage/quizzes_controller.rb
 - app/controllers/alembic/pages_controller.rb
 - app/controllers/concerns/alembic/manage/authenticates_admin.rb
 - app/controllers/concerns/alembic/owned_pages.rb
@@ -115,6 +110,7 @@ files:
 - app/models/alembic/flow/run_summary.rb
 - app/models/alembic/flow/summaries.rb
 - app/models/alembic/flow/summary_version.rb
+- app/models/alembic/flow/titled_start.rb
 - app/models/alembic/flow/uploaded_question.rb
 - app/models/alembic/flow/uploaded_questions.rb
 - app/models/alembic/outputs/band.rb
@@ -161,6 +157,7 @@ files:
 - app/views/alembic/manage/pages/_block_content.html.erb
 - app/views/alembic/manage/pages/index.html.erb
 - app/views/alembic/manage/pages/show.html.erb
+- app/views/alembic/manage/quizzes/new.html.erb
 - app/views/alembic/pages/show.html.erb
 - app/views/layouts/alembic/application.html.erb
 - config/routes.rb
@@ -225,6 +222,7 @@ files:
 - db/migrate/20261020120000_add_kept_result_to_alembic_flow_run_summaries.rb
 - db/migrate/20261025031225_add_shuffles_answers_to_alembic_flow_definition_summaries.rb
 - lib/alembic.rb
+- lib/alembic/answer_explanations.rb
 - lib/alembic/engine.rb
 - lib/alembic/leftover_stylesheet.rb
 - lib/alembic/question_importer.rb