quby-compiler 0.4.2 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0693e46b261fa2268bf3a406811a27d3782bf34c9c6cb6de4e968206f4d1ab43'
-  data.tar.gz: 7fc5013a7ca5893db68d1276ececc4996d0f72e75737bc8c7a7912d622c3d873
+  metadata.gz: 10321dd1aa2034171ba876aeb77622bde63eac65938ce0a0bec9663119461396
+  data.tar.gz: b98a34612065d23a611ae5d0437463fe20557fbc0c238d50034e528676565284
 SHA512:
-  metadata.gz: 743ea4cc3c41f908806d6937aed62dac028d9684246d61f951846fb1657582f8a300dcc3f32bc590630425a254a3ef69543805f67ad0f0ebd271cd1219440f55
-  data.tar.gz: af49465555957283e67aa518bf0fdeed8250b3888f98f0d68b1e7a19d8158792718a958f91d4b9e99077319125d26eb6e69ee3a232280c4c0d98ba05a062e7cb
+  metadata.gz: a3544401b0db094144e7de1e0e172499a26a37111b73c01abd9ba027c33ac992c0c580e15b3fbd552bf196f70c1ed3dccab12ccb064dc68d3e3d80ff98740bc1
+  data.tar.gz: 0dd6d579368d571f57ea15dc20a5711ae8ba7e548049f8fd0abaaa43f15d1ca1454c1711f573e3d6b5143d198cbca8878f37399219a67c8330396c6fb57eb09e

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+# 0.4.6
+
+* Added type validations for boolean attributes
+* roqua.json
+  * add unit to questions
+  * add title_question_key to questions
+  * add parent_question_key and parent_option_key to questions
+  * add child_question_keys to question_options
+* models
+  * Made title_question attribute on question instead of adding options.last.questions.
+  * Made v1 serializer create backward compatible json (for now)
+  * Made v1 serializer add the full title_question json to question.title_question.
+
+# 0.4.5
+
+* roqua.json: Don't add inner titles and placeholder options
+
+# 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.

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/dsl/questions/base.rb

@@ -114,16 +114,6 @@ module Quby
           def initialize(key, **options, &block)
             super
             @default_question_options = options[:default_question_options] || {}
-            @title_question = nil
-          end
-
-          def build
-            if @title_question
-              @question.options.last.questions << @title_question
-              @title_question = nil
-            end
-
-            super
           end
 
           def title_question(key, **options, &block)
@@ -138,7 +128,7 @@ module Quby
             question = QuestionBuilder.build(key, **options, &block)
 
             @questionnaire.register_question(question)
-            @title_question = question
+            @question.title_question = question
           end
 
           def question(key, **options, &block)

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

@@ -29,9 +29,11 @@ module Quby
 
         # To hide old questions
         attr_accessor :hidden
+        validates :hidden, inclusion: {in: [true, false, nil], message: "must be boolean"}
 
         # Whether to skip the uniqueness validation on radio and select option values
         attr_reader :allow_duplicate_option_values
+        validates :allow_duplicate_option_values, inclusion: {in: [true, false, nil], message: "must be boolean"}
 
         # In what modes do we display this question
         # NOTE We always display questions in print-view (if they have an answer)
@@ -40,9 +42,13 @@ module Quby
         # Multiple-choice questions have options to choose from
         attr_accessor :options
 
+        # string question that is displayed after the  title of this  question.
+        attr_accessor :title_question
+
         # Question validation fails when there are no title and no context_free_title.
         # When :allow_blank_titles => true passed, validation does not fail. Any other value will raise the failure.
         attr_accessor :allow_blank_titles
+        validates :allow_blank_titles, inclusion: {in: [true, false, nil], message: "must be boolean"}
 
         # Minimum and maximum values for float and integer types
         attr_accessor :minimum
@@ -72,6 +78,7 @@ module Quby
 
         # Whether this radio question is deselectable
         attr_accessor :deselectable
+        validates :deselectable, inclusion: {in: [true, false, nil], message: "must be boolean"}
 
         # Some questions are a tree.
         attr_accessor :parent
@@ -79,6 +86,7 @@ module Quby
 
         # Whether we can collapse this in bulk view
         attr_accessor :disallow_bulk
+        validates :disallow_bulk, inclusion: {in: [true, false, nil], message: "must be boolean"}
 
         # This question should not validate itself unless the depends_on question is answered.
         # May also be an array of "#{question_key}_#{option_key}" strings that specify options
@@ -115,6 +123,7 @@ module Quby
         attr_accessor :row_span
 
         attr_accessor :default_invisible
+        validates :default_invisible, inclusion: {in: [true, false], message: "must be boolean"}
 
         # Slider only: where to place the sliding thing by default
         # Can have value :hidden for a hidden handle.
@@ -240,14 +249,17 @@ 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
-            json[:labels] = labels if as == :slider
           end
         end
 
+        def title_question?
+          presentation == :next_to_title
+        end
+
         # Returns all keys belonging to html inputs generated by this question.
         def input_keys
           if options.blank?

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

@@ -4,6 +4,8 @@ module Quby
   module Compiler
     module Entities
       class QuestionOption
+        include ActiveModel::Validations
+
         MARKDOWN_ATTRIBUTES = %w(description).freeze
 
         attr_reader :key
@@ -11,16 +13,17 @@ module Quby
         attr_reader :description
         attr_reader :questions
         attr_reader :inner_title
+        validates :inner_title, inclusion: {in: [true, false, nil], message: "must be boolean"}
         attr_reader :hides_questions
         attr_reader :shows_questions
         attr_reader :hidden
+        validates :hidden, inclusion: {in: [true, false], message: "must be boolean"}
         attr_reader :placeholder
+        validates :placeholder, inclusion: {in: [true, false], message: "must be boolean"}
         attr_reader :question
         attr_reader :view_id
         attr_reader :input_key
 
-        attr_reader :start_chosen
-
         def initialize(key, question, options = {})
           @key         = key
           @question    = question

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/quby_frontend_v1_serializer.rb

@@ -61,6 +61,7 @@ module Quby
             question_type: question.type,
             key: question.key,
             title: question.title,
+            title_question: (question_as_json(question.title_question) if question.title_question),
             context_free_title: question.context_free_title,
             description: question.description,
             presentation: question.presentation,
@@ -96,7 +97,7 @@ module Quby
           case question
           when Quby::Compiler::Entities::Questions::CheckboxQuestion
             base_options.merge(
-              options: question.options.map { |option| option_as_json(option) },
+              options: options_as_json(question),
               check_all_option: question.check_all_option,
               uncheck_all_option: question.uncheck_all_option,
               maximum_checked_allowed: question.maximum_checked_allowed,
@@ -114,7 +115,7 @@ module Quby
             )
           when Quby::Compiler::Entities::Questions::DeprecatedQuestion
             base_options.merge(
-              options: question.options.map { |option| option_as_json(option) }
+              options: options_as_json(question)
             )
           when Quby::Compiler::Entities::Questions::FloatQuestion
             base_options.merge(
@@ -130,11 +131,11 @@ module Quby
             )
           when Quby::Compiler::Entities::Questions::RadioQuestion
             base_options.merge(
-              options: question.options.map { |option| option_as_json(option) }
+              options: options_as_json(question)
             )
           when Quby::Compiler::Entities::Questions::SelectQuestion
             base_options.merge(
-              options: question.options.map { |option| option_as_json(option) }
+              options: options_as_json(question)
             )
           when Quby::Compiler::Entities::Questions::StringQuestion
             base_options.merge(
@@ -177,6 +178,16 @@ module Quby
           end
         end
 
+        # Also adds the title question under the last option.
+        # TODO old dsl put it there, remove after quby gem uses title_question
+        def options_as_json(question)
+          question.options.map { |option| option_as_json(option) }.tap do |options_json|
+            if question.title_question
+              options_json.last[:questions] << question_as_json(question.title_question)
+            end
+          end
+        end
+
         def option_as_json(option)
           {
             key: option.key,

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,112 @@ 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
+        # unit [nil/string] no html (not in quby either)
+        # deprecated [nil/true] only show if filled for old answers
+        # default_invisible [nil/true] only show if filled or when all questions are shown
+        # parent_question_key [nil/string] title_questions or question defined under option
+        # parent_option_key [nil/string] question defined under option
+        # title_question_key [nil/string]
+        # 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),
+                unit: question.unit,
+                deprecated: question.hidden.presence,
+                default_invisible: question.default_invisible.presence,
+                parent_question_key: question.parent&.key,
+                parent_option_key: question.parent_option_key,
+                title_question_key: question.title_question&.key,
+                date_parts: date_parts_for(question),
+                options: options_for(question)
+              }.compact
+            ]
+          }
+        end
+
+        # {year: {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
+        # child_question_keys [nil/[string]]
+        def options_for(question)
+          return nil if question.options.empty?
+
+          question.options.reject { |option| option.inner_title || option.placeholder }
+                          .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),
+                child_question_keys: option.questions.map(&:key).presence
+              }.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.presence
+        end
       end
     end
   end
-end
+end

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

@@ -100,6 +100,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)
           end

data/lib/quby/compiler/version.rb

@@ -1,5 +1,5 @@
 module Quby
   module Compiler
-    VERSION = "0.4.2"
+    VERSION = "0.4.6"
   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.2
+  version: 0.4.6
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2022-02-08 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