quby-compiler 0.5.15 → 0.5.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 126c7a3a5ef150e332a888dfef85acc264a46fe4a886b2f5ef9b0a19f460b14d
-  data.tar.gz: 9bc6fad59d9da077cca02ab744bed4497dea3764e09f82d4aaf42016f7479dbc
+  metadata.gz: 4be07e6f3fabe1a0b02fbc36ea63c5ccd964519aedb08d0adaf9b6196f4f9830
+  data.tar.gz: 382ea4dc3bd640a7d2e92b9bb27ad1bd5b1176129eb93e84fc71ad954bb691f9
 SHA512:
-  metadata.gz: 183182375a43d83e98bb4667865c78b958fb2443d8f028ea4411b59d2caaf894825072d764753539811bc659d68a8294c284d4226b7dddfdfb56635049a60a01
-  data.tar.gz: '066826a89ee2dd03f8dc8b76b2d284a583331e4e3181823935d9afb3e48f970a8aeeece44ca7b6bc6f479ccd3ee179b47b39a65b26e60fef5489efb8106b41d3'
+  metadata.gz: 1e699567c3318dcc2b4cf9d7b2b44e7c05cacab8783f17e5631bfcee12d1de690aba8ab8ae3e9da93bab07be680a26f4fe9ca735af8c27ea7bbd72b79146aad9
+  data.tar.gz: 8ffbc7c1374528de5edefd0e35cab356c07e98b0e2f6436b0291510be9d0751971261846c7b98300290fc12689dd6a961816de16b1cebf0ff90bf6f0bce70d29

data/CHANGELOG.md

@@ -1,7 +1,29 @@
+# 0.5.17
+
+* Add option#label.
+* quby.json
+  * Add option#label to option#description just in case.
+* quby2.json:
+  * Pass options#hidden.
+  * Allow hr tags in prose.
+  * Allow all prose tags in question#description, except headers.
+  * Allow css_vars to be defined on questionnaire and question level.
+  * Add option#label
+  * quby2.json: Add option#label (without fallback for now, until quby2 0.9.7 is deployed everywhere).
+
+# 0.5.16
+
+* add integer as split_to_units option, with units and conversions as attributes
+* add sexp_variables to do calculations using s expressions, for now in quby2, but later in the backend.
+* test that select/radio options are always numeric
+* quby2.json
+  * add split_to_units question, that saves a integer.
+  * Calculate sexpr variables and allow strings to interpolate them {{calculation.some_var}}
+
 # 0.5.15
 
 * Add context_description to questions, to have a text item that is hidden together with the question.
-* quuby2.json
+* quby2.json
   * Moved quby2 serialization to the serializer, compact everything, no markdown for v2 title/descriptions.
   * Sanitize Quby2 html in v2.
   * Add contextDescription to questions.

data/lib/quby/compiler/dsl/merge(values(:v_1, :v_2), values(v_4).rb

@@ -0,0 +1,16 @@
+merge(values(:v_1, :v_2), values(v_4).recode(1 => 3)).sum
+
+
+
+divide(value(:v_2), multiply(value(:v_1), value(:v_1)))
+
+w / l * l
+
+
+sexp_variable :key1 do
+  foo = values(:v_1, :v_2)
+  bar = recode(foo, 1 => 3)
+  bla = merge(foo, bar)
+  sum(bla)
+
+end

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

@@ -8,6 +8,7 @@ require 'quby/compiler/dsl/charting/line_chart_builder'
 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_relative 'standardized_panel_generators'
 
@@ -139,6 +140,12 @@ module Quby
           @questionnaire.extra_css += value
         end
 
+        # css_vars("option-gap-y" => 1)
+        def css_vars(value)
+          @questionnaire.css_vars ||= {}
+          @questionnaire.css_vars.merge!(value)
+        end
+
         def allow_switch_to_bulk(value=true)
           @questionnaire.allow_switch_to_bulk = value
         end
@@ -200,6 +207,10 @@ module Quby
           end
         end
 
+        def sexp_variable(key, &block)
+          @questionnaire.add_sexp_variable(key, SexpVariableBuilder.new(key, &block).build)
+        end
+
         # variable :totaal do
         #   # Plain old Ruby code here, executed in the scope of the answer
         #   # variables are private to the score calculation

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

@@ -12,6 +12,7 @@ module Quby
           end
 
           def build
+            @question.after_build
             @question
           end
 

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

@@ -14,6 +14,16 @@ module Quby
             super
             @question = Entities::Questions::IntegerQuestion.new(key, options)
           end
+
+          # as split_to_units
+          def units(*values)
+            @question.units = values
+          end
+
+          # as split_to_units
+          def conversions(value)
+            @question.conversions = value
+          end
         end
       end
     end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'quby/compiler/entities/sexp_variable'
+module Quby::Compiler
+  module DSL
+    # sexp_variable :myvar do
+    #   sum(number_values(:v_1, :v_2))
+    # end
+    class ::SexpVariableBuilder
+      attr_reader :calculation, :key
+
+      def initialize(key, &block)
+        @key = key
+        @calculation = instance_eval(&block)
+      end
+
+      def string_value(key)
+        Entities::SexpVariables::StringValue.new(op: :string_value, key: key)
+      end
+
+      def number_value(key)
+        Entities::SexpVariables::NumberValue.new(op: :number_value, key: key)
+      end
+
+      def number_values(*keys)
+        keys.map { |key| number_value(key) }
+      end
+
+      %i[sum subtract multiply divide].each do |op|
+        define_method(op) do |*values|
+          Entities::SexpVariables::NumberReducer.new(op:, values: wrap_and_flatten(values))
+        end
+      end
+
+      def round(value)
+        Entities::SexpVariables::NumberMethod.new(op: :round, value: value)
+      end
+
+      def build
+        Entities::SexpVariable.new(key:, calculation:)
+      end
+
+      private
+
+      def wrap_and_flatten(values)
+        values.flat_map { |value|
+          case value
+          when Numeric
+            Entities::SexpVariables::Number.new(op: :number, value: value)
+          else
+            value
+          end 
+        }
+      end
+    end
+  end
+end

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

@@ -30,6 +30,9 @@ module Quby
         # How should we display this question
         attr_accessor :as
 
+        # extra styling options
+        attr_accessor :css_vars
+
         # To hide old questions
         attr_accessor :hidden
         validates :hidden, inclusion: {in: [true, false, nil], message: "must be boolean"}
@@ -164,6 +167,7 @@ module Quby
           @cols = options[:cols] || 40
           @default_invisible = options[:default_invisible] || false
           @labels ||= []
+          @css_vars = options[:css_vars]
 
           @col_span = options[:col_span] || 1
           @row_span = options[:row_span] || 1
@@ -208,6 +212,10 @@ module Quby
         end
         # rubocop:enable CyclomaticComplexity, Metrics/MethodLength
 
+        # called after DSL has instance_evalled everything within the question block.
+        def after_build
+        end
+
         def context_free_title_or_title
           context_free_title || title
         end

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

@@ -11,6 +11,8 @@ module Quby
 
         attr_reader :key
         attr_reader :value
+        validates :value, numericality: {allow_nil: true} # nil for checkbox questions.
+        attr_reader :label
         attr_reader :description, :context_free_description
         attr_reader :questions
         # for scale/radio/checbox questions, piece of of html that is rendered between the options
@@ -31,6 +33,7 @@ module Quby
           @key         = key
           @question    = question
           @value       = options[:value]
+          @label       = options[:label]
           @description = options[:description]
           @context_free_description = options[:context_free_description]
           @questions   = []

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

@@ -40,6 +40,7 @@ module Quby
           @license = :unknown
           @layout_version = nil
           @extra_css = ""
+          @css_vars = nil
           @allow_switch_to_bulk = false
           @panels = []
           @flags = {}.with_indifferent_access
@@ -53,6 +54,7 @@ module Quby
           @outcome_tables = []
           @check_score_keys_consistency = true
           @lookup_tables = {}
+          @sexp_variables = {}
           @versions = []
           @seeds_patch = {}
           @anonymous_conditions = Entities::AnonymousConditions.new
@@ -76,6 +78,7 @@ module Quby
         attr_writer   :leave_page_alert
         attr_reader   :fields
         attr_accessor :extra_css
+        attr_accessor :css_vars
         attr_accessor :allow_switch_to_bulk
         attr_reader   :license
         attr_accessor :licensor
@@ -102,6 +105,7 @@ module Quby
 
         attr_accessor :outcome_tables
         attr_accessor :score_schemas
+        attr_accessor :sexp_variables
         attr_accessor :lookup_tables
         attr_accessor :anonymous_conditions
 
@@ -362,6 +366,10 @@ module Quby
           end
         end
 
+        def add_sexp_variable(key, sexp_variable)
+          sexp_variables[key] = sexp_variable
+        end
+
         def add_outcome_table(outcome_table_options)
           outcome_tables << OutcomeTable.new(**outcome_table_options, questionnaire: self)
         end

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

@@ -0,0 +1,58 @@
+module Quby::Compiler::Entities::Questions::Concerns
+  module SplitToUnits
+    extend ActiveSupport::Concern
+    DEFAULT_SPLIT_TO_UNIT_CONVERSIONS = {
+      minutes: {
+        hours: 60,
+        days: 1440,
+        weeks: 10080
+      },
+      seconds: {
+        minutes: 60,
+        hours: 3600,
+        days: 86400
+      },
+      m: {
+        km: 1000
+      },
+      cm: {
+        m: 100
+      },
+      mm: {
+        cm: 10,
+        m: 1000
+      },
+      g: {
+        kg: 1000
+      }
+    }.freeze
+
+    included do
+      attr_accessor :units, :conversions
+
+      validates :units, :conversions, presence: true, if: -> { as == :split_to_units }
+      validate :validate_split_to_units, if: -> { as == :split_to_units }
+    end
+
+    def after_build
+      super
+      return unless as == :split_to_units
+      @unit = units&.last
+      (@conversions ||= {}).reverse_merge!(default_split_to_units_conversions)
+    end
+
+    def default_split_to_units_conversions
+      (DEFAULT_SPLIT_TO_UNIT_CONVERSIONS[unit] || {}).slice(*units)
+    end
+
+    def validate_split_to_units
+      return unless units.present? && conversions.present?
+
+      (units - [unit]).each do |unit_to_convert|
+        if conversions[unit_to_convert].nil?
+          errors.add(:conversions, "should contain a conversion for unit #{unit_to_convert}")
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'concerns/slider'
+require_relative 'concerns/split_to_units'
 
 module Quby
   module Compiler
@@ -8,6 +9,7 @@ module Quby
       module Questions
         class IntegerQuestion < Question
           include Concerns::Slider
+          include Concerns::SplitToUnits
 
           def size
             @size || 30

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

@@ -0,0 +1,50 @@
+require 'quby/compiler/entities/sexp_variables'
+
+module Quby::Compiler::Entities
+  class SexpVariable
+    attr_reader :calculation, :key
+
+    def initialize(key:, calculation:)
+      @key = key
+      @calculation = calculation
+    end
+
+    # Called by DefinitionValidator.
+    def validate(questionnaire)
+      case calculation
+      when SexpVariables::NumberValue
+        validate_question_exist(questionnaire, calculation)
+        validate_value_is_number(questionnaire, calculation)
+      when SexpVariables::StringValue
+        validate_question_exist(questionnaire, calculation)
+        validate_value_is_string(questionnaire, calculation)
+      end
+    end
+
+    def validate_question_exist(questionnaire, sexp)
+      return if questionnaire.question_hash.key?(sexp.key)
+
+      fail "sexp_variable #{key} uses nonexistent question #{sexp.key}."
+    end
+
+    def validate_value_is_number(questionnaire, sexp)
+      question = questionnaire.question_hash[sexp.key]
+      case question
+      when Questions::IntegerQuestion, Questions::FloatQuestion, Questions::SelectQuestion, Questions::RadioQuestion
+        return
+      end
+
+      fail "sexp_variable #{key} uses non-numeric question #{sexp.key} for number_value."
+    end
+
+    def validate_value_is_string(questionnaire, sexp)
+      question = questionnaire.question_hash[sexp.key]
+      case question
+      when Questions::StringQuestion, Questions::TextareaQuestion
+        return
+      end
+
+      fail "sexp_variable #{key} uses non-string question #{sexp.key} for string_value."
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Quby::Compiler::Entities
+  module SexpVariables
+    class Base < Dry::Struct
+    end
+
+    # recursive dependencies, we so we define the classes first.
+    class NumberValue < Base; end
+    class Number < Base; end
+    class NumberReducer < Base; end
+    class NumberMethod < Base; end
+
+    NumericType = Number | NumberReducer | NumberMethod | NumberValue
+
+    class NumberValue
+      attribute :op, Quby::Types::Symbol.enum(:number_value)
+      attribute :key, Quby::Types::Symbol
+    end
+
+    class StringValue < Base
+      attribute :op, Quby::Types::Symbol.enum(:string_value)
+      attribute :key, Quby::Types::Symbol
+    end
+
+    class Number
+      attribute :op, Quby::Types::Symbol.enum(:value)     
+      attribute :value, Quby::Types::Integer | Quby::Types::Float
+    end
+
+    # returning a Number
+    class NumberReducer
+      attribute :op, Quby::Types::Symbol.enum(:sum, :subtract, :multiply, :divide)
+      attribute :values, Quby::Types::Array.of(NumericType)
+    end
+
+    # returning a Number
+    class NumberMethod
+      attribute :op, Quby::Types::Symbol.enum(:round)     
+      attribute :value, NumericType
+    end
+  end
+end

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

@@ -192,7 +192,7 @@ module Quby
           {
             key: option.key,
             value: option.value,
-            description: option.description,
+            description: option.label ? "#{option.label} #{option.description}" : option.description,
             context_free_description: option.context_free_description,
             questions: option.questions.map {|question| question_as_json(question)},
             inner_title: option.inner_title,

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

@@ -23,7 +23,9 @@ module Quby
             questions: questions,
             textvars: textvars,
             validations: validations,
-            visibilityRules: visibility_rules.as_json
+            visibilityRules: visibility_rules.as_json,
+            sexpVariables: sexp_variables,
+            cssVars: css_vars,
           }
         end
 
@@ -83,10 +85,17 @@ module Quby
         end
 
         def float_question(question)
-          integer_question(question)
+          number_question(question)
         end            
 
         def integer_question(question)
+          {
+            **number_question(question),
+            **split_to_units_question(question),
+          }.compact
+        end
+
+        def number_question(question)
           {
             **base_question(question),
             **slider_question(question),
@@ -94,8 +103,8 @@ module Quby
             maximum: question.maximum,
             size: size(question),
             unit: question.as != :slider && question.unit,
-        }.compact
-        end            
+          }.compact
+        end
 
         def radio_question(question)
           {
@@ -141,6 +150,7 @@ module Quby
             description: handle_html(question.description, type: :question_description),
             contextDescription: handle_html(question.context_description, type: :prose, v1_markdown: false),
             type: question_type(question),
+            cssVars: question.css_vars,
             hidden: question.hidden?,
             displayModes: question.display_modes,
             viewSelector: question.view_selector,
@@ -165,6 +175,13 @@ module Quby
           }
         end
 
+        def split_to_units_question(question)
+          {
+            units: question.units,
+            conversions: question.conversions,
+          }
+        end
+
         def question_type(question)
           {
             date: 'date_parts',
@@ -200,8 +217,10 @@ module Quby
             type: 'option',
             key: option.key,
             value: option.question.type != :check_box && option.value,
+            label: option.label, # TODO fallback on description and empty description if no label (after quby2 has been deployed)
             description: option.question.type == :select ? option.description : handle_html(option.description),
-            questions: option.question.type != :select && option.questions.map{ question(_1) }, 
+            questions: option.question.type != :select && option.questions.map{ question(_1) },
+            hidden: option.hidden.presence,
             viewId: option.view_id
         }.compact
         end
@@ -237,9 +256,9 @@ module Quby
             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])
+              html_sanitizer.sanitize(html, tags: %w[strong em b i u sup sub pre blockquote p span br ul ol li a], 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])
+              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 hr], attributes: %w[href class target])
             end
           elsif v1_markdown
             Quby::Compiler::MarkdownParser.new(html).to_html

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

@@ -26,6 +26,7 @@ module Quby
           validate_outcome_tables(questionnaire)
           validate_markdown_fields(questionnaire) if questionnaire.validate_html
           validate_raw_content_items(questionnaire) if questionnaire.validate_html
+          validate_sexp_variables(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" \
@@ -364,6 +365,12 @@ scores_schema tables to the resulting seed."
           fail "#{key || html} contains invalid html: #{fragment.errors.map(&:to_s).join(', ')}."
         end
 
+        def validate_sexp_variables(questionnaire)
+          questionnaire.sexp_variables.each_value do |sexp_variable|
+            sexp_variable.validate(questionnaire)
+          end 
+        end
+
         def delete_prefix(key, questionnaire)
           key.delete_prefix("#{questionnaire.key}_")
         end

data/lib/quby/compiler/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: quby-compiler
 version: !ruby/object:Gem::Version
-  version: 0.5.15
+  version: 0.5.17
 platform: ruby
 authors:
 - Marten Veldthuis
 bindir: exe
 cert_chain: []
-date: 2025-02-27 00:00:00.000000000 Z
+date: 2025-04-16 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/merge(values(:v_1, :v_2), values(v_4).rb
 - lib/quby/compiler/dsl/panel_builder.rb
 - lib/quby/compiler/dsl/question_builder.rb
 - lib/quby/compiler/dsl/questionnaire_builder.rb
@@ -165,6 +166,7 @@ files:
 - lib/quby/compiler/dsl/questions/text_question_builder.rb
 - lib/quby/compiler/dsl/score_builder.rb
 - lib/quby/compiler/dsl/score_schema_builder.rb
+- lib/quby/compiler/dsl/sexp_variable_builder.rb
 - lib/quby/compiler/dsl/standardized_panel_generators.rb
 - lib/quby/compiler/dsl/table_builder.rb
 - lib/quby/compiler/entities.rb
@@ -188,6 +190,7 @@ files:
 - lib/quby/compiler/entities/questionnaire.rb
 - lib/quby/compiler/entities/questions/checkbox_question.rb
 - lib/quby/compiler/entities/questions/concerns/slider.rb
+- lib/quby/compiler/entities/questions/concerns/split_to_units.rb
 - lib/quby/compiler/entities/questions/date_question.rb
 - lib/quby/compiler/entities/questions/deprecated_question.rb
 - lib/quby/compiler/entities/questions/float_question.rb
@@ -198,6 +201,8 @@ files:
 - lib/quby/compiler/entities/questions/text_question.rb
 - lib/quby/compiler/entities/score_calculation.rb
 - lib/quby/compiler/entities/score_schema.rb
+- lib/quby/compiler/entities/sexp_variable.rb
+- lib/quby/compiler/entities/sexp_variables.rb
 - lib/quby/compiler/entities/subscore_schema.rb
 - lib/quby/compiler/entities/table.rb
 - lib/quby/compiler/entities/text.rb