quby-compiler 0.5.14 → 0.5.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35bdecff443479812941ad2ced1e6585228fb03881c4ba9c48af3468b48c544f
-  data.tar.gz: 3cf5faea78f741c241c0f57d873480fcc3b028aa91942ff020e9970eaf332530
+  metadata.gz: 126c7a3a5ef150e332a888dfef85acc264a46fe4a886b2f5ef9b0a19f460b14d
+  data.tar.gz: 9bc6fad59d9da077cca02ab744bed4497dea3764e09f82d4aaf42016f7479dbc
 SHA512:
-  metadata.gz: d0b431d1f495544c5541bc5b2e5ceb57ece1d6d5782cabf6bfa80b9d7bb251a33e9b13764ebc6f0ac726523883eab6ee04585d4e4b102cd10ee419a3466cf1e7
-  data.tar.gz: 4f22422b8789dbad63cb5cc57550582971ef47c2958b829bae72e9d140081a4378797534c5d5ae7a9888f562f3cfd87ad87bac6cc0c620032610264cc55b46e2
+  metadata.gz: 183182375a43d83e98bb4667865c78b958fb2443d8f028ea4411b59d2caaf894825072d764753539811bc659d68a8294c284d4226b7dddfdfb56635049a60a01
+  data.tar.gz: '066826a89ee2dd03f8dc8b76b2d284a583331e4e3181823935d9afb3e48f970a8aeeece44ca7b6bc6f479ccd3ee179b47b39a65b26e60fef5489efb8106b41d3'

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.5.15
+
+* Add context_description to questions, to have a text item that is hidden together with the question.
+* quuby2.json
+  * Moved quby2 serialization to the serializer, compact everything, no markdown for v2 title/descriptions.
+  * Sanitize Quby2 html in v2.
+  * Add contextDescription to questions.
+
 # 0.5.14
 
 * Support for activemodel 7.1 and 7.2

data/lib/quby/compiler/dsl/questions/base.rb

@@ -27,6 +27,10 @@ module Quby
             @question.description = value
           end
 
+          def context_description(value)
+            @question.context_description = value
+          end
+
           def presentation(value)
             @question.presentation = value
           end

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

@@ -16,10 +16,6 @@ module Quby
           @items = options[:items] || []
         end
 
-        def as_json(options = {})
-          super.merge(title: title, index: index, items: json_items)
-        end
-
         def index
           @questionnaire.panels.index(self)
         end
@@ -44,20 +40,6 @@ module Quby
           end
         end
 
-        def json_items
-          items.map do |item|
-            case item
-            when Text
-              { type: 'html', html: item.html }
-            when Question
-              next 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 Table
-              { type: "table" }
-            end
-          end.compact
-        end
-
         def validations
           vals = {}
           items.each do |item|

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

@@ -6,6 +6,8 @@ module Quby
   module Compiler
     module Entities
       class Question < Item
+        include ::Quby::InspectExcept.new(*%i[@dependencies @options @questionnaire @table @validations @parent])
+
         MARKDOWN_ATTRIBUTES = %w(description title).freeze
 
         set_callback :after_dsl_enhance, :expand_depends_on_input_keys
@@ -18,6 +20,7 @@ module Quby
         attr_accessor :title
         attr_accessor :context_free_title
         attr_accessor :description
+        attr_accessor :context_description
 
         attr_accessor :labels
 
@@ -229,30 +232,6 @@ module Quby
           options.length > 0 && type != :select ? options.length : @col_span
         end
 
-        def as_json(options = {})
-          # rubocop:disable SymbolName
-          super.merge(
-            key: key,
-            title: Quby::Compiler::MarkdownParser.new(title).to_html,
-            description: Quby::Compiler::MarkdownParser.new(description).to_html,
-            type: type,
-            size: size.presence && Integer(size), # 2022-11: 4k string and 7k integer
-            hidden: hidden?,
-            displayModes: display_modes,
-            defaultInvisible: default_invisible,
-            viewSelector: view_selector,
-            parentKey: parent&.key,
-            parentOptionKey: parent_option_key,
-            deselectable: deselectable,
-            presentation: presentation,
-            as: as || type, # default to type so typescript can narrow on it.
-            questionGroup: question_group
-          ).tap do |json|
-            json[:unit] = unit if %i[integer float string].include?(type) && as != :slider
-            json[:showValues] = [true, :all].include?(show_values) if %i[radio scale].include?(type) && show_values
-          end
-        end
-
         def title_question?
           presentation == :next_to_title
         end

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

@@ -5,6 +5,7 @@ module Quby
     module Entities
       class QuestionOption
         include ActiveModel::Validations
+        include ::Quby::InspectExcept.new(:@question, :@questions)
 
         MARKDOWN_ATTRIBUTES = %w(description).freeze
 
@@ -53,40 +54,6 @@ module Quby
           @questions.each { |q| return true if q.key_in_use?(k) }
           false
         end
-
-        def as_json(options = {})
-          if inner_title
-            inner_title_as_json(options)
-          elsif placeholder
-            nil # placeholder attr on question.
-          else
-            option_as_json(options)
-          end
-        end
-
-        def inner_title_as_json(options = {})
-          {
-            type: 'html',
-            key: SecureRandom.uuid,
-            html: Quby::Compiler::MarkdownParser.new(description).to_html
-          }
-        end
-
-        def option_as_json(options = {})
-          {
-            type: 'option',
-            key: key,
-            value: value,
-            description: question.type == :select \
-              ? description
-              : Quby::Compiler::MarkdownParser.new(description).to_html,
-            questions: questions,
-            hidesQuestions: hides_questions,
-            showsQuestions: shows_questions,
-            hidden: hidden,
-            viewId: view_id
-          }
-        end
       end
     end
   end

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

@@ -17,6 +17,7 @@ module Quby
       class Questionnaire
         extend  ActiveModel::Naming
         include ActiveModel::Validations
+        include ::Quby::InspectExcept.new(*%i[@attributes @charts @fields @flags @panels @questions @sourcecode @score_calculations @score_schemas @textvars])
 
         class ValidationError < StandardError; end
         class UnknownInputKey < ValidationError; end

data/lib/quby/compiler/entities/questions/checkbox_question.rb

@@ -58,14 +58,6 @@ module Quby
             # Some options don't have a key (inner_title), they are stripped.
             options.map { |opt| opt.input_key }.compact
           end
-
-          def as_json(options = {})
-            super.tap do |json|
-              json[:children] = @options.as_json
-              json[:checkAllOption] = check_all_option if check_all_option.present?
-              json[:uncheckAllOption] = uncheck_all_option if uncheck_all_option.present?
-            end
-          end
         end
       end
     end

data/lib/quby/compiler/entities/questions/concerns/slider.rb

@@ -5,19 +5,5 @@ module Quby::Compiler::Entities::Questions::Concerns
     included do
       validates :minimum, :maximum, presence: true, if: -> { as == :slider }
     end
-
-    def as_json(options = {})
-      if as == :slider
-        super.merge(
-          step: step,
-          defaultPosition: default_position.is_a?(Numeric) ? default_position : minimum,
-          startThumbHidden: default_position == :hidden,
-          valueTooltip: input_data[:value_tooltip] || false,
-          labels: labels
-        )
-      else
-        super
-      end
-    end
   end
 end

data/lib/quby/compiler/entities/questions/date_question.rb

@@ -53,19 +53,6 @@ module Quby
               send("#{component}_key").to_sym
             end
           end
-
-          def as_json(options = {})
-            super.merge(
-              type: 'date_parts',
-              as: 'date_parts',
-              dateParts: components.map { |component|
-                {
-                  part: component,
-                  key: send("#{component}_key")
-                }
-              }
-            )
-          end
         end
       end
     end

data/lib/quby/compiler/entities/questions/deprecated_question.rb

@@ -8,10 +8,6 @@ module Quby
           def hidden?
             true
           end
-
-          def as_json(options = {})
-            super.merge(options: @options.as_json)
-          end
         end
       end
     end

data/lib/quby/compiler/entities/questions/float_question.rb

@@ -9,13 +9,6 @@ module Quby
         class FloatQuestion < Question
           include Concerns::Slider
 
-          def as_json(options = {})
-            super.merge(
-              minimum: minimum,
-              maximum: maximum
-            )
-          end
-
           def size
             @size || 30
           end

data/lib/quby/compiler/entities/questions/integer_question.rb

@@ -9,13 +9,6 @@ module Quby
         class IntegerQuestion < Question
           include Concerns::Slider
 
-          def as_json(options = {})
-            super.merge(
-              minimum: minimum,
-              maximum: maximum
-            )
-          end
-
           def size
             @size || 30
           end

data/lib/quby/compiler/entities/questions/radio_question.rb

@@ -5,9 +5,6 @@ module Quby
     module Entities
       module Questions
         class RadioQuestion < Question
-          def as_json(options = {})
-            super.merge(children: @options.as_json)
-          end
         end
       end
     end

data/lib/quby/compiler/entities/questions/select_question.rb

@@ -5,12 +5,6 @@ module Quby
     module Entities
       module Questions
         class SelectQuestion < Question
-          def as_json(options = {})
-            super.merge(
-              children: @options.as_json.compact, # for now just options, but we'll add optgroups later.
-              placeholder: @options.find { _1.placeholder }&.description # nil for no placeholder
-            )
-          end
         end
       end
     end

data/lib/quby/compiler/entities/questions/string_question.rb

@@ -5,12 +5,6 @@ module Quby
     module Entities
       module Questions
         class StringQuestion < Question
-          def as_json(options = {})
-            super.merge(autocomplete: @autocomplete)
-            super.merge(autocomplete: @autocomplete).tap do |json|
-              json[:setsTextvar] = sets_textvar if sets_textvar
-            end
-          end
         end
       end
     end

data/lib/quby/compiler/entities/questions/text_question.rb

@@ -5,9 +5,6 @@ module Quby
     module Entities
       module Questions
         class TextQuestion < Question
-          def as_json(options = {})
-            super.merge(autocomplete: @autocomplete, lines: lines)
-          end
         end
       end
     end

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

@@ -19,12 +19,202 @@ module Quby
             description: description,
             shortDescription: short_description,
             defaultAnswerValue: Services::TransformQuby1ValuesIntoQuby2Values.run!(@questionnaire, default_answer_value),
-            panels: panels,
-            questions: fields.question_hash.as_json,
-            flags: flags,
+            panels: panels.map { panel(_1) },
+            questions: questions,
             textvars: textvars,
             validations: validations,
-            visibilityRules: visibility_rules
+            visibilityRules: visibility_rules.as_json
+          }
+        end
+
+        def panel(panel)
+          {
+            title: panel.title,
+            items: panel.items.map { panel_item(_1) }.compact,
+          }.compact
+        end
+
+        def panel_item(item)
+          case item
+          when Quby::Compiler::Entities::Text
+            { type: 'html', html: handle_html(item.html, type: :prose, v1_markdown: false) }
+          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::Table
+            { type: "table" }
+          end
+        end
+
+        def questions
+          fields.question_hash \
+            .to_h { |k, question| [k, question(question)] } \
+            .compact
+        end
+
+        def question(question)
+          send(:"#{question_type(question)}_question", question)
+        end
+
+        def check_box_question(question)
+          {
+            **base_question(question),
+            children: children(question),
+            checkAllOption: question.check_all_option,
+            uncheckAllOption: question.uncheck_all_option,
+         }.compact
+        end
+
+        def date_parts_question(question)
+          {
+            **base_question(question),
+            dateParts: question.components.map { |component|
+              {
+                part: component,
+                key: question.send("#{component}_key"),
+              }
+            },
+          }.compact
+        end
+
+        # deprecated
+        def hidden_question(question)
+          nil
+        end
+
+        def float_question(question)
+          integer_question(question)
+        end            
+
+        def integer_question(question)
+          {
+            **base_question(question),
+            **slider_question(question),
+            minimum: question.minimum,
+            maximum: question.maximum,
+            size: size(question),
+            unit: question.as != :slider && question.unit,
+        }.compact
+        end            
+
+        def radio_question(question)
+          {
+            **base_question(question),
+            children: children(question),
+            showValues: [true, :all].include?(question.show_values),
+        }.compact
+        end
+
+        def scale_question(question)
+          radio_question(question)
+        end
+
+        def select_question(question)
+          {
+            **base_question(question),
+            children: children(question),
+            placeholder: question.options.find { _1.placeholder }&.description,
+          }.compact
+        end
+
+        def string_question(question)
+          {
+            **base_question(question),
+            setsTextvar: question.sets_textvar,
+            size: size(question),
+            unit: question.as != :slider && question.unit,
+        }.compact
+        end
+
+        def textarea_question(question)
+          {
+            **base_question(question),
+            autocomplete: question.autocomplete,
+            lines: question.lines,
+          }.compact
+        end
+
+        def base_question(question)
+          {
+            key: question.key,
+            title: handle_html(question.title),
+            description: handle_html(question.description, type: :question_description),
+            contextDescription: handle_html(question.context_description, type: :prose, v1_markdown: false),
+            type: question_type(question),
+            hidden: question.hidden?,
+            displayModes: question.display_modes,
+            viewSelector: question.view_selector,
+            parentKey: question.parent&.key,
+            parentOptionKey: question.parent_option_key,
+            deselectable: question.deselectable,
+            presentation: question.presentation,
+            as: question.as || question_type(question), # default to type so typescript can narrow on it.
+            questionGroup: question.question_group,
+          }
+        end
+
+        def slider_question(question)
+          return {} unless question.as == :slider
+
+          {
+            step: question.step,
+            defaultPosition: question.default_position.is_a?(Numeric) ? question.default_position : question.minimum,
+            startThumbHidden: question.default_position == :hidden,
+            valueTooltip: question.input_data[:value_tooltip] || false,
+            labels: question.labels,
+          }
+        end
+
+        def question_type(question)
+          {
+            date: 'date_parts',
+          }[question.type] || question.type
+        end
+
+        def size(question)
+          question.size.presence && Integer(question.size) # 2022-11: 4k string and 7k integer
+        end
+
+        def children(question)
+          question.options.map { |child|
+            if child.inner_title
+              inner_title_as_json(child)
+            elsif child.placeholder
+              nil # placeholder attr on question.
+            else
+              option_as_json(child)
+            end
+          }.compact
+        end
+
+        def inner_title_as_json(option)
+          {
+            type: 'html',
+            key: SecureRandom.uuid,
+            html: handle_html(option.description)
+          }
+        end
+
+        def option_as_json(option)
+          {
+            type: 'option',
+            key: option.key,
+            value: option.question.type != :check_box && option.value,
+            description: option.question.type == :select ? option.description : handle_html(option.description),
+            questions: option.question.type != :select && option.questions.map{ question(_1) }, 
+            viewId: option.view_id
+        }.compact
+        end
+
+        def textvars
+          @questionnaire.textvars.to_h { |key, textvar|
+            [
+              key,
+              {
+                key: textvar.key,
+                default: textvar.default,
+              }
+            ]
           }
         end
 
@@ -40,6 +230,27 @@ module Quby
               end.as_json
           end
         end
+
+        def handle_html(html, type: :simple, v1_markdown: true)
+          if layout_version == :v2
+            case type
+            when :simple
+              html_sanitizer.sanitize(html, tags: %w[strong em sup sub br span], attributes: %w[class])
+            when :question_description
+              html_sanitizer.sanitize(html, tags: %w[strong em b i u sup sub p span br ul ol li], attributes: %w[class])
+            when :prose
+              html_sanitizer.sanitize(html, tags: %w[strong em b i u sup sub pre blockquote p span br ul ol li a h1 h2 h3 h4], attributes: %w[href class target])
+            end
+          elsif v1_markdown
+            Quby::Compiler::MarkdownParser.new(html).to_html
+          else
+            html
+          end
+        end
+
+        def html_sanitizer
+          @html_sanitize ||= Rails::HTML5::SafeListSanitizer.new
+        end
       end
     end
   end

data/lib/quby/compiler/version.rb

@@ -1,5 +1,5 @@
 module Quby
   module Compiler
-    VERSION = "0.5.14"
+    VERSION = "0.5.15"
   end
 end

data/lib/quby/compiler.rb

@@ -15,6 +15,7 @@ module Quby
   end
 end
 
+require 'quby/inspect_except'
 require 'quby/compiler/markdown_parser'
 require 'quby/range_categories'
 require 'quby/compiler/type_validator'

data/lib/quby/inspect_except.rb

@@ -0,0 +1,12 @@
+class Quby::InspectExcept < Module
+  def initialize(*excepts)
+    define_method :inspect do
+      prefix = "#<#{self.class}:0x#{self.__id__.to_s(16)}"
+
+      parts = (instance_variables - excepts).map do |var|
+        "#{var}=#{instance_variable_get(var).inspect}"
+      end
+      "#{prefix}\n #{parts.join(", ")}>"
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: quby-compiler
 version: !ruby/object:Gem::Version
-  version: 0.5.14
+  version: 0.5.15
 platform: ruby
 authors:
 - Marten Veldthuis
 bindir: exe
 cert_chain: []
-date: 2025-02-13 00:00:00.000000000 Z
+date: 2025-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -220,6 +220,7 @@ files:
 - lib/quby/compiler/services/transform_quby1_values_into_quby2_values.rb
 - lib/quby/compiler/type_validator.rb
 - lib/quby/compiler/version.rb
+- lib/quby/inspect_except.rb
 - lib/quby/range_categories.rb
 - lib/quby/settings.rb
 - lib/quby/text_transformation.rb