quby-compiler 0.4.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feb162904faed7446d9fae791dcf0a03872121a4a0e4ddb5bcb01de6d936e44c
-  data.tar.gz: 04ca9df119e3f7aca8a6724d762f59edc2da56b95649aaef4642c3dc4e72d45a
+  metadata.gz: affdedce52abd30377ecb0919b012353f6af8139cea5747acc4b82c67d9923a8
+  data.tar.gz: d21ad635fd6d232a58d0fd691b91d5f9f9a35f5fe36a024b3056e501870a05ac
 SHA512:
-  metadata.gz: ef6516baf27276cdc608583257f48a26c171e4930d8cb4dca035d1c35faf9ef35584f0fcabb4845807901e0f47e2fa81d49e5df280c99acdd13bdad5b63b4040
-  data.tar.gz: 4b1cd0e9fa3eeacff0e2e6684ce3d3a74460cd7db9723d176bd3c471efb441f509b36d7fe35310479139af7de31346dca1fc807ff7ac1199a83973e39a951792
+  metadata.gz: 83a2a47a517f5666bd34b76d1528ca1ccb7f38e60991eda82c134bec2116640e191954cc643d588a3aa8f95c9bc779ddeabe2152d1d689f3dcdd53a7a029da35
+  data.tar.gz: e44964d5ea73973db1058018ce460fa0a5ef2da25d7acdf0ee6d1891ef7a42254cf55c2485b04af9fa02af881ae7ef6fb3c4c0e5b3ff452a39f6769d97f63bef

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# 0.4.4
+
+* quby-compile will now validate, not compile invalid questionnaires and return 1  when any invalid.
+* roqua.json
+  * add questions hash
+* quby2.json
+  * add `as` to all questions, defaulting to type.
+  * add `minimum`  and `maximum`  to integer/float questions.
+  * add `step`, `defaultPosition`, `startThumbHidden`, `valueTooltip`  and `labels` to slider questions.
+
+# 0.4.3
+
+* roqua.json: add scores hash.
+
+# 0.4.2
+
+* quby2: Added labels to slider questions.
+
+# 0.4.1
+
+* seeds: Fix depends: :present rule being overridden.
+
 # 0.4.0
 
 * rename flag visibilty rule value to trigger_on

data/exe/quby-compile

@@ -30,11 +30,21 @@ end
 
 lookup_tables = Quby::Compiler::Entities::LookupTables.new(lookup_tables_path)
 
+validation_errors_found = false
 paths.each do |path|
   puts "Compiling #{path}"
 
   key = File.basename(File.dirname(path))
   sourcecode = File.read(path)
+
+  definition = Quby::Compiler.validate(key, sourcecode, lookup_tables: lookup_tables)
+  if definition.errors.any?
+    error = definition.errors[:sourcecode].first
+    STDERR.puts error[:message], error[:backtrace], ''
+    validation_errors_found = true
+    next # let's not create new output files for questionnaires with errors
+  end
+
   compiled = Quby::Compiler.compile(key, sourcecode, path: path, lookup_tables: lookup_tables)
 
   FileUtils.mkdir_p(File.join(output_path, key))
@@ -45,3 +55,7 @@ paths.each do |path|
     end
   end
 end
+
+if validation_errors_found
+  exit(1)
+end

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

@@ -89,7 +89,7 @@ module Quby
         end
 
         def as_json
-          question_hash
+          question_hash.as_json
         end
 
         private

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

@@ -231,7 +231,6 @@ module Quby
             title: Quby::MarkdownParser.new(title).to_html,
             description: Quby::MarkdownParser.new(description).to_html,
             type: type,
-            unit: unit,
             size: size,
             hidden: hidden?,
             displayModes: display_modes,
@@ -241,9 +240,11 @@ module Quby
             parentOptionKey: parent_option_key,
             deselectable: deselectable,
             presentation: presentation,
-            as: as,
+            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
+          end
         end
 
         # Returns all keys belonging to html inputs generated by this question.

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

@@ -193,7 +193,7 @@ module Quby
             outcomeDescription: outcome_description,
             shortDescription: short_description,
             panels: panels,
-            fields: fields,
+            fields: fields.as_json,
             flags: flags,
             textvars: textvars,
             validations: validations,

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

@@ -0,0 +1,23 @@
+module Quby::Compiler::Entities::Questions::Concerns
+  module Slider
+    extend ActiveSupport::Concern
+
+    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/float_question.rb

@@ -1,22 +1,28 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/slider'
+
 module Quby
   module Compiler
     module Entities
       module Questions
         class FloatQuestion < Question
+          include Concerns::Slider
+
           def as_json(options = {})
             super.merge(
               minimum: minimum,
-              maximum: maximum,
-              step: 0.01, # fixed in v1.
-              # defaultPosition: default_position # Needs discussion, can be number or string "hidden"
+              maximum: maximum
             )
           end
 
           def size
             @size || 30
           end
+
+          def step
+            0.01
+          end
         end
       end
     end

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

@@ -1,22 +1,28 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/slider'
+
 module Quby
   module Compiler
     module Entities
       module Questions
         class IntegerQuestion < Question
+          include Concerns::Slider
+
           def as_json(options = {})
             super.merge(
               minimum: minimum,
-              maximum: maximum,
-              step: 1, # fixed in v1.
-              # defaultPosition: default_position # Needs discussion, can be number or string "hidden"
+              maximum: maximum
             )
           end
 
           def size
             @size || 30
           end
+
+          def step
+            1
+          end
         end
       end
     end

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

@@ -2,6 +2,18 @@ module Quby
   module Compiler
     module Outputs
       class RoquaSerializer
+        QUBY_TYPE_TO_ROQUA_TYPE = {
+          check_box: 'multi_select',
+          date: 'date_parts',
+          float: 'float',
+          integer: 'integer',
+          radio: 'single_select',
+          scale: 'single_select',
+          select: 'single_select',
+          string: 'text',
+          textarea: 'text'
+        }
+
         attr_reader :questionnaire
 
         def initialize(questionnaire)
@@ -22,6 +34,8 @@ module Quby
             tags: questionnaire.tags.to_h.keys,
             charts: charts,
             outcome_tables_schema: outcome_tables_schema,
+            questions: questions,
+            scores: scores,
           }
         end
 
@@ -139,7 +153,101 @@ module Quby
             tables: tables,
           }
         end
+
+        # {v_1: {.., options: {..}, date_parts: {..}}, ..}
+        # nils are removed from hash.
+        # key [string]
+        # sbg_key [nil/string] _not_ defaulted to key
+        # type [string]
+        # title [nil/string] no html
+        # context_free_title [nil/string] no html, defaulted to title
+        # deprecated [nil/true] only show if filled for old answers
+        # default_invisible [nil/true] only show if filled or when all questions are shown
+        # date_parts [nil/{..}]
+        # options: [nil/{..}]
+        def questions
+          questionnaire.questions.reject{_1.type == :hidden}.to_h { |question|
+            [
+              question.key,
+              {
+                key: question.key,
+                sbg_key: question.sbg_key,
+                type: QUBY_TYPE_TO_ROQUA_TYPE.fetch(question.type),
+                title: strip_tags_without_html_encode(question.title),
+                context_free_title: strip_tags_without_html_encode(question.context_free_title),
+                deprecated: question.hidden.presence,
+                default_invisible: question.default_invisible.presence,
+                date_parts: date_parts_for(question),
+                options: options_for(question),
+              }.compact
+            ]
+          }
+        end
+
+        # {year_key: {key: "v_date_yyyy"}, ..}
+        # key [string]
+        def date_parts_for(question)
+          return nil unless question.type == :date
+
+          question.components.to_h { |component|
+            [
+              component,
+              {
+                key: question.send("#{component}_key")
+              }
+            ]
+          }
+        end
+
+        # {a1: {..}}
+        # key [string]
+        # value [nil/string] nil for check_box, string otherwise
+        # description [nil/string] context_free_description, no html
+        def options_for(question)
+          return nil if question.options.empty?
+
+          question.options.to_h { |option|
+            [
+              option.key,
+              {
+                key: option.key,
+                value: (option.value.to_s unless question.type == :check_box),
+                description: strip_tags_without_html_encode(option.context_free_description)
+              }.compact
+            ]
+          }
+        end
+
+        # [{ key: { ..,  subscores: { subkey: {..} } } }]
+        def scores
+          questionnaire.score_schemas.transform_values { |score|
+            {
+              key: score.key,
+              label: score.label,
+              subscores: subscores_for(score)
+            }
+          }
+        end
+
+        # { subkey: {..} }
+        def subscores_for(score)
+          score.subscore_schemas.to_h { |subscore|
+            [
+              subscore.key,
+              {
+                key: subscore.key,
+                label: subscore.label,
+                export_key: subscore.export_key,
+                only_for_export: subscore.only_for_export.presence
+              }.compact
+            ]
+          }
+        end
+
+        def strip_tags_without_html_encode(html)
+          Nokogiri::HTML(html).text
+        end
       end
     end
   end
-end
+end

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

@@ -30,9 +30,6 @@ module Quby
           @hidden_questions = {} # hash containing questions hidden by other questions
 
           for question in questions_flat
-            if question.hidden && question.type != :check_box
-              d_qtypes[question.key.to_s] = { depends: :present } unless options[:without_depends]
-            end
             unless question.hidden && (question.type == :check_box || question.type == :hidden)
               vars << question.key.to_s
             end
@@ -184,6 +181,9 @@ module Quby
           if hidden = @hidden_questions[question.key.to_s]
             d_qtypes[question.key.to_s][:depends] ||= hidden unless options[:without_depends]
           end
+          if question.hidden && question.type != :check_box
+            d_qtypes[question.key.to_s][:depends] = :present unless options[:without_depends]
+          end
         end
 
         def generate_question_titles

data/lib/quby/compiler/version.rb

@@ -1,5 +1,5 @@
 module Quby
   module Compiler
-    VERSION = "0.4.0"
+    VERSION = "0.4.4"
   end
 end

data/lib/quby/compiler.rb

@@ -38,7 +38,7 @@ module Quby
       )
     end
 
-    def self.validate(key, sourcecode)
+    def self.validate(key, sourcecode, lookup_tables:)
       Quby::Compiler::Instance.new(lookup_tables: lookup_tables).validate(
         key: key,
         sourcecode: sourcecode,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quby-compiler
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.4
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -204,6 +204,7 @@ files:
 - lib/quby/compiler/entities/question_option.rb
 - 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/date_question.rb
 - lib/quby/compiler/entities/questions/deprecated_question.rb
 - lib/quby/compiler/entities/questions/float_question.rb