quby-compiler 0.5.19 → 0.5.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17f81efe58813638140bea17b261bfd5145556b8641ed56792058e6e5cfe2e9c
-  data.tar.gz: b28acaf67f88390312252210a18a2c2bb878dae86887fb4ce0bfad433bcb98a1
+  metadata.gz: 58538613874bd655f416eba086f07ba45321bab1306a6bd710df279e3a9cead0
+  data.tar.gz: 1a0c1ea24a9c0fd6e8387f6b1760e14d387e1ed41061d66c8176bf642e72f64e
 SHA512:
-  metadata.gz: df24763f87fec0e7dc98d7c14aeb1b21923574684b1c7dba9da22ca6c9ab58f410625094fc6bb934e182e7733072b296f1c32298ab08c32a0963397ab66f7450
-  data.tar.gz: 55adee69bb962303f1a12415037845b5a4a1675cd8b9d88b0a701258bcf8513ea4b528add011fe8c96f16fc71d6032481b82567b13b6a4717ee20688638e6c32
+  metadata.gz: 68251dfd41c4d5054e0d23c7cfa202f6acced87251d2f16b9373c5494d2cbea52955d241479d807e11af8617ced647b49769204b38907bb3728d045a254431cb
+  data.tar.gz: 6f34cd861fec8ae281c6fffb8dea442054d5500f5e90fb5ff3594cf1d41e3dd28200e601edc29f05e68e7be32653e084f2e5c5c02ea92cbdac87c64c6581e438

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.5.20
+
+* dsl: Add info_block support
+* quby2: Add info_block support
+
 # 0.5.19
 
 * quby2: Make the key for inner title predictable, so the json doesn't change each time, making Roqua think the questionnaire has changed.

data/lib/quby/compiler/dsl/helpers.rb

@@ -24,6 +24,12 @@ module Quby
           end
         end
 
+        def check_key_uniqueness(key, questionnaire:)
+          if questionnaire.key_in_use? key
+            fail "#{questionnaire.key}:#{key}: is already used."
+          end
+        end
+
         def video_tag(*urls, poster: nil, autoplay: false, loop: false)
           # assume the file extension is the video format
           # otherwise, the host's declared mime type is used to figure out compatibility

data/lib/quby/compiler/dsl/info_block_builder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'quby/compiler/entities'
+
+module Quby
+  module Compiler
+    module DSL
+      class InfoBlockBuilder < Base
+        attr_reader :info_block, :default_question_options
+
+        delegate :panel, to: :info_block
+        delegate :questionnaire, to: :panel
+
+        def initialize(key, start_open: true, panel:, default_question_options:)
+          @info_block = Entities::InfoBlock.new(key: , panel:, start_open:)
+          @default_question_options = default_question_options
+          check_key_uniqueness(key, questionnaire:)
+          questionnaire.fields.info_block_keys << key
+          panel.items << @info_block
+        end
+
+        def info_html(value)
+          raise "Can only add one info_html item per info_block" if info_block.html.present?
+          info_block.html = value
+        end
+
+        def html(value)
+          info_block.items << Entities::Text.new('', html_content: value.to_s)
+        end
+
+        def question(key, **options, &block)
+          options = default_question_options.merge(options).merge(questionnaire:)
+
+          check_question_keys_uniqueness key, options, questionnaire
+
+          question = QuestionBuilder.build(key, **options, &block)
+
+          questionnaire.register_question(question)
+          info_block.items << question
+        end
+      end
+    end
+  end
+end

data/lib/quby/compiler/dsl/panel_builder.rb

@@ -65,6 +65,15 @@ module Quby
           table_builder.instance_eval(&block) if block
         end
 
+        def info_block(key, **options, &block)
+          info_block_builder = DSL::InfoBlockBuilder.new \
+            key,
+            panel: @panel,
+            default_question_options: @default_question_options,
+            **options
+          info_block_builder.instance_eval(&block)
+        end
+
         def method_missing(method_sym, *args, **kwargs, &block)
           if @custom_methods.key? method_sym
             instance_exec(*args, **kwargs, &@custom_methods[method_sym])

data/lib/quby/compiler/dsl/questionnaire_builder.rb

@@ -9,6 +9,7 @@ require 'quby/compiler/dsl/charting/radar_chart_builder'
 require 'quby/compiler/dsl/charting/bar_chart_builder'
 require 'quby/compiler/dsl/charting/overview_chart_builder'
 require 'quby/compiler/dsl/sexp_variable_builder'
+require 'quby/compiler/dsl/info_block_builder'
 
 require_relative 'standardized_panel_generators'
 

data/lib/quby/compiler/entities/fields.rb

@@ -23,11 +23,14 @@ module Quby
         # targeted by :depends_on relations.
         attr_reader :input_keys
 
+        attr_reader :info_block_keys
+
         def initialize(questionnaire)
           @question_hash = HashWithIndifferentAccess.new
           @option_hash   = HashWithIndifferentAccess.new
           @answer_keys   = Set.new
           @input_keys    = Set.new
+          @info_block_keys = Set.new
           @questionnaire = questionnaire
         end
 
@@ -59,7 +62,7 @@ module Quby
         end
 
         def key_in_use?(key)
-          @question_hash.key?(key) || input_keys.include?(key.to_sym)
+          @question_hash.key?(key) || input_keys.include?(key.to_sym) || info_block_keys.include?(key)
         end
 
         # Given a list of question and option keys returns a list of input-keys. If a given key is a question-key,

data/lib/quby/compiler/entities/info_block.rb

@@ -0,0 +1,28 @@
+module Quby
+  module Compiler
+    module Entities
+      class InfoBlock < Item
+        attr_reader :key, :items, :start_open, :panel
+        attr_accessor :html
+
+        validates :key, presence: true, 'quby/compiler/type': {is_a: Symbol}
+        validates :html, presence: true
+
+        def initialize(key:, panel:, start_open: true)
+          @panel = panel
+          @key = key
+          @start_open = start_open
+          @items = []
+        end
+
+        def index
+          panel.items.index(self)
+        end
+
+        def path_str
+          "#{panel.questionnaire.key}:InfoBlock:#{key}"
+        end
+      end
+    end
+  end
+end

data/lib/quby/compiler/entities/question.rb

@@ -216,6 +216,10 @@ module Quby
         def after_build
         end
 
+        def path_str
+          "#{questionnaire.key}:Question:#{key}"
+        end
+
         def context_free_title_or_title
           context_free_title || title
         end

data/lib/quby/compiler/entities/question_option.rb

@@ -57,6 +57,10 @@ module Quby
           @questions.each { |q| return true if q.key_in_use?(k) }
           false
         end
+
+        def path_str
+          "#{question.path_str}:Option:#{key}"
+        end
       end
     end
   end

data/lib/quby/compiler/entities.rb

@@ -24,6 +24,7 @@ require 'quby/compiler/entities/charting/plottable'
 require 'quby/compiler/entities/panel'
 require 'quby/compiler/entities/text'
 require 'quby/compiler/entities/table'
+require 'quby/compiler/entities/info_block'
 
 require 'quby/compiler/entities/outcome_table'
 

data/lib/quby/compiler/outputs/quby_frontend_v1_serializer.rb

@@ -15,7 +15,7 @@ module Quby
             {
               key: panel.key,
               title: panel.title,
-              items: panel.items.reject { |item| item.respond_to?(:table) && item.table }.map { |item| item_as_json(item) }
+              items: panel.items.reject { |item| item.respond_to?(:table) && item.table }.flat_map { |item| item_as_json(item) }
             }
           end
         end
@@ -28,6 +28,8 @@ module Quby
             question_as_json(item)
           when Quby::Compiler::Entities::Table
             table_as_json(item)
+          when Quby::Compiler::Entities::InfoBlock
+            item.items.map { item_as_json(_1) }
           end
         end
 

data/lib/quby/compiler/outputs/quby_frontend_v2_serializer.rb

@@ -44,11 +44,23 @@ module Quby
           when Quby::Compiler::Entities::Question
             return if item.table # things inside a table are added to the table, AND ALSO to the panel. skip them.
             { type: 'question', key: item.key }
+          when Quby::Compiler::Entities::InfoBlock
+            info_block_item(item)
           when Quby::Compiler::Entities::Table
             { type: "table" }
           end
         end
 
+        def info_block_item(info_block)
+          {
+            type: 'info',
+            key: info_block.key,
+            html: handle_html(info_block.html, type: :question_description, v1_markdown: false),
+            startOpen: info_block.start_open,
+            items: info_block.items.map { panel_item(_1) }.compact
+          }
+        end
+
         def questions
           fields.question_hash \
             .to_h { |k, question| [k, question(question)] } \

data/lib/quby/compiler/services/definition_validator.rb

@@ -27,6 +27,7 @@ module Quby
           validate_markdown_fields(questionnaire) if questionnaire.validate_html
           validate_raw_content_items(questionnaire) if questionnaire.validate_html
           validate_sexp_variables(questionnaire)
+          validate_info_blocks(questionnaire)
         # Some compilation errors are Exceptions (pure syntax errors) and some StandardErrors (NameErrors)
         rescue Exception => exception # rubocop:disable Lint/RescueException
           definition.errors.add(:sourcecode, message: "Questionnaire error: #{definition.key}\n" \
@@ -67,7 +68,7 @@ module Quby
           end
 
           questionnaire.question_hash.each_value do |question|
-            validate_question(question)
+            validate_item(question)
             subquestions_cant_have_default_invisible question
             validate_subquestion_absence_in_select question
             validate_placeholder_options_nil_values question
@@ -79,10 +80,10 @@ module Quby
           end
         end
 
-        def validate_question(question)
-          unless question.valid?
-            fail "Question #{question.key} is invalid: #{question.errors.full_messages.join(', ')}"
-          end
+        def validate_item(item)
+          return if item.valid?
+
+          fail "#{item.path_str} is invalid: #{item.errors.full_messages.join(', ')}"
         end
 
         def validate_scores(questionnaire)
@@ -105,12 +106,9 @@ module Quby
 
         def validate_question_options(questionnaire, question)
           question.options.each do |option|
-            msg_base = "Question #{option.question.key} option #{option.key}"
-            unless option.valid?
-              fail "#{msg_base} #{option.errors.full_messages.to_sentence}"
-            end
-            to_be_hidden_questions_exist_and_not_subquestion?(questionnaire, option, msg_base: msg_base)
-            to_be_shown_questions_exist_and_not_subquestion?(questionnaire, option, msg_base: msg_base)
+            validate_item(option)
+            to_be_hidden_questions_exist_and_not_subquestion?(questionnaire, option, msg_base: option.path_str)
+            to_be_shown_questions_exist_and_not_subquestion?(questionnaire, option, msg_base: option.path_str)
           end
         end
 
@@ -140,6 +138,16 @@ module Quby
           end
         end
 
+        def validate_info_blocks(questionnaire)
+          questionnaire.panels.each do |panel|
+            panel.items.each do |item|
+              next unless item.is_a?(Entities::InfoBlock)
+
+              validate_item(item)
+            end
+          end
+        end
+
         def ensure_valid_descriptions(questionnaire, flag)
           unless (flag.description_false.present? && flag.description_true.present?) || flag.description.present?
             fail ArgumentError, "Flag '#{flag.key}' Requires at least either both description_true and description_false or a description"

data/lib/quby/compiler/version.rb

@@ -1,5 +1,5 @@
 module Quby
   module Compiler
-    VERSION = "0.5.19"
+    VERSION = "0.5.20"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: quby-compiler
 version: !ruby/object:Gem::Version
-  version: 0.5.19
+  version: 0.5.20
 platform: ruby
 authors:
 - Marten Veldthuis
 bindir: exe
 cert_chain: []
-date: 2025-05-06 00:00:00.000000000 Z
+date: 2025-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -150,6 +150,7 @@ files:
 - lib/quby/compiler/dsl/charting/overview_chart_builder.rb
 - lib/quby/compiler/dsl/charting/radar_chart_builder.rb
 - lib/quby/compiler/dsl/helpers.rb
+- lib/quby/compiler/dsl/info_block_builder.rb
 - lib/quby/compiler/dsl/panel_builder.rb
 - lib/quby/compiler/dsl/question_builder.rb
 - lib/quby/compiler/dsl/questionnaire_builder.rb
@@ -180,6 +181,7 @@ files:
 - lib/quby/compiler/entities/definition.rb
 - lib/quby/compiler/entities/fields.rb
 - lib/quby/compiler/entities/flag.rb
+- lib/quby/compiler/entities/info_block.rb
 - lib/quby/compiler/entities/item.rb
 - lib/quby/compiler/entities/lookup_tables.rb
 - lib/quby/compiler/entities/outcome_table.rb