quby-compiler 0.5.4 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 298486fbde9a0b1e4873a639011c6a4fe6c00dd98430a42d2a79afdb0fb92584
-  data.tar.gz: e79bee94168384f1c17fa9abdfd2f9f0d4fd6036a166047474d44f4ab95c7da7
+  metadata.gz: 05f509c76c1f6c67029abdd77d29469b7a825708e86ea0d7d535e1ea05f4f57c
+  data.tar.gz: 1b78d9c1fed73f4642f2e76d942ba5c5619f2bb354ff0024ff3a22d92b3c8aff
 SHA512:
-  metadata.gz: 23233110d98eae072f27e537f2a2ad2c60e47c7a9b76448502f9f73f1ccc3ee8dbda257e88c048b37c74a38f90afeff239e261dd0f6e85a1fe219c534078f880
-  data.tar.gz: b2a3ab1acf6c92160a9a5a23affcb8b9174f032b476d3deb613d5f1d6e352e15bb2447f9a8ed2bdb0ab91f2364e6dc29b378294b0094b516256ee077d5dc3b6e
+  metadata.gz: 9c599463543dff5a691a135d97d374e858b9bf41f971d7bb61dea7448836bc36b3b179cf59dc4d9779a1e890a50d5c3b016fc15c63e634fde10a59ae1623ec41
+  data.tar.gz: b1b8baa09ce07637d8b502421332be3c33bf1eee95d4d9845b5daae4235703cfdef89022858326e90f96dbc3fa8e5a9f91795f56bd58ef1fa6e4fdfe787cffb1

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 0.5.6
+
+* quby2.json:
+  * Add checkAllOption and uncheckAllOption to checkbox questions.
+* Added type to subscore_schema (string, float, integer)
+* roqua.json:
+  * Added type to subscores
+
+# 0.5.5
+
+* roqua.json:
+  * Add sbg_key to scores
+
 # 0.5.4
 
 * quby2:

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

@@ -212,21 +212,22 @@ module Quby
         def score(key, **options, &block)
           @questionnaire.errors.add "Score #{key}", 'misses label in score call' if options[:label].blank?
           schema = options.delete(:schema)
-          score_schema(key, options[:label], schema) if schema.present?
+          score_schema(key, options[:label], schema, sbg_key: options[:sbg_key]) if schema.present?
           variable(key, score: true, **options, &block)
         end
 
-        def score_schema(key, label, options = nil, &block)
+        def score_schema(key, label, subscore_schemas = nil, sbg_key: nil, &block)
           if block
-            schema, calculations = ScoreSchemaBuilder.build(key: key, label: label, &block)
+            schema, calculations = ScoreSchemaBuilder.build(key:, label:, sbg_key:, &block)
             @questionnaire.add_score_schema schema
             calculations.each do |calculation|
               @questionnaire.add_score_calculation calculation
             end
           else
-            @questionnaire.add_score_schema Entities::ScoreSchema.new key: key,
-                                                                      label: label,
-                                                                      subscore_schemas: options
+            @questionnaire.add_score_schema Entities::ScoreSchema.new key:,
+                                                                      label:,
+                                                                      sbg_key:,
+                                                                      subscore_schemas:
           end
         end
 

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

@@ -4,9 +4,10 @@ module Quby
   module Compiler
     module DSL
       class ScoreSchemaBuilder < Base
-        def initialize(key:, label:, &block)
+        def initialize(key:, label:, sbg_key: nil, &block)
           @score_key = key
           @score_label = label
+          @score_sbg_key = sbg_key
           @subschema_params = []
           @generated_calculations = []
         end
@@ -14,6 +15,7 @@ module Quby
         def build
           score_schema = Entities::ScoreSchema.new key: @score_key,
                                                    label: @score_label,
+                                                   sbg_key: @score_sbg_key,
                                                    subscore_schemas: @subschema_params
           [score_schema, @generated_calculations + [generate_score_calculation(score_schema)]]
         end
@@ -44,6 +46,7 @@ module Quby
           score_code_string = "score do\n  {#{inner_hash_string}}\nend"
           Entities::ScoreCalculation.new score_schema.key,
                                          label: score_schema.label,
+                                         sbg_key: score_schema.sbg_key,
                                          score: true,
                                          ruby_string: score_code_string
         end

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

@@ -77,42 +77,9 @@ module Quby
           end
         end
 
-        # returns a human readable string description given a key of a question,
-        # question component (date components, checkbox options), score, flag or textvar
-        def description_for_variable(key)
-          # for questionnaires where we do not check_key_clashes we cannot reliably retrace the variable keys,
-          # since they contain conflicts between option keys and question keys
-          # in order to be safe we return a string explaining the issue
-          return "No description due to question/option key clash" if option_hash.key?(key) && question_hash.key?(key)
-
-          variable_description(key)
-        end
-
         def as_json
           question_hash.as_json
         end
-
-        private
-
-        # warning, will contain a result even if option/answer key clashes exist for a given key
-        def variable_description(key)
-          @question_variable_descriptions ||= @questionnaire.questions
-                                                            .map(&:variable_descriptions)
-                                                            .reduce({}, &:merge!)
-          @question_variable_descriptions[key] ||
-            score_descriptions[key] ||
-            @questionnaire.flags[key]&.variable_description ||
-            @questionnaire.textvars[key]&.description
-        end
-
-        def score_descriptions
-          @score_variable_descriptions ||=
-            @questionnaire.score_schemas.values.map do |score_schema|
-              score_schema.subscore_schemas.map do |subschema|
-                [subschema.export_key, "#{score_schema.label} #{subschema.label}"]
-              end
-            end.flatten(1).to_h.with_indifferent_access
-        end
       end
     end
   end

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

@@ -27,10 +27,6 @@ module Quby
           yield if answer_flags[key] == trigger_on
         end
 
-        def variable_description
-          "#{description} (true - '#{description_true}', false - '#{description_false}')"
-        end
-
         private
 
         def ensure_valid_descriptions

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

@@ -326,10 +326,6 @@ module Quby
         def subquestion?
           !parent_option_key.nil?
         end
-
-        def variable_descriptions
-          {key => context_free_title_or_title}.with_indifferent_access
-        end
       end
     end
   end

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

@@ -200,21 +200,6 @@ module Quby
           @license = type
         end
 
-        def as_json(options = {})
-          {
-            key: key,
-            title: title,
-            description: description,
-            outcomeDescription: outcome_description,
-            shortDescription: short_description,
-            panels: panels,
-            questions: fields.question_hash.as_json,
-            flags: flags,
-            textvars: textvars,
-            visibilityRules: visibility_rules
-          }
-        end
-
         def key_in_use?(key)
           fields.key_in_use?(key) || score_calculations.key?(key)
         end

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

@@ -50,13 +50,6 @@ module Quby
             end
           end
 
-          def variable_descriptions
-            options.each_with_object(key => context_free_title_or_title) do |option, hash|
-              next if option.input_key.blank?
-              hash[option.input_key] = "#{context_free_title_or_title} - #{option.description}"
-            end.with_indifferent_access
-          end
-
           def claimed_keys
             [key]
           end
@@ -67,7 +60,11 @@ module Quby
           end
 
           def as_json(options = {})
-            super.merge(children: @options.as_json)
+            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

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

@@ -54,13 +54,6 @@ module Quby
             end
           end
 
-          def variable_descriptions
-            components.each_with_object(key => context_free_title_or_title) do |component, hash|
-              key = send("#{component}_key")
-              hash[key] = "#{context_free_title_or_title} (#{I18n.t component})"
-            end.with_indifferent_access
-          end
-
           def as_json(options = {})
             super.merge(
               type: 'date_parts',

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

@@ -13,6 +13,8 @@ module Quby
         attribute :key, Types::Symbol
         # A label describing the general purpose of the score
         attribute :label, Types::String
+        # Alternative key used by some external systems
+        attribute :sbg_key?, Types::String.optional
         # An array of SubscoreSchemas describing each key that can be returned in the result hash of a score.
         attribute :subscore_schemas, Types::Array(Entities::SubscoreSchema)
 

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

@@ -18,6 +18,7 @@ module Quby
         # differ in subscores too much to be shown as one table. By default, all scores end up in the `:main` table.
         # When outcome_table is explicitly nil, the value should not be shown in outcome tables
         attribute :outcome_table, Types::Symbol.optional.default(:main)
+        attribute :type, Types::Symbol.enum(:string, :integer, :float).meta(omittable: true)
       end
     end
   end

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

@@ -1,3 +1,5 @@
+require 'quby/compiler/services/transform_quby1_values_into_quby2_values.rb'
+
 module Quby
   module Compiler
     module Outputs
@@ -6,10 +8,23 @@ module Quby
           @questionnaire = questionnaire
         end
 
-        # TODO: Move all attributes here from Questionnaire#as_json
+        delegate_missing_to :@questionnaire
+
         def as_json(options = {})
-          @questionnaire.as_json.merge \
-            validations: validations
+          {
+            key: key,
+            title: title,
+            description: description,
+            outcomeDescription: outcome_description,
+            shortDescription: short_description,
+            defaultAnswerValue: Services::TransformQuby1ValuesIntoQuby2Values.run!(@questionnaire, default_answer_value),
+            panels: panels,
+            questions: fields.question_hash.as_json,
+            flags: flags,
+            textvars: textvars,
+            validations: validations,
+            visibilityRules: visibility_rules
+          }
         end
 
         def validations
@@ -19,6 +34,8 @@ module Quby
               .tap do |validation_hsh|
                 # otherwise ruby will put a (?-mix around the regex, which js errors on.
                 validation_hsh['matcher'] = validation_hsh['matcher'].source.to_s  if validation_hsh['matcher']
+                validation_hsh['type'] = 'minimum_date' if validation_hsh['type'] == :minimum && validation_hsh['subtype'] == :date
+                validation_hsh['type'] = 'maximum_date' if validation_hsh['type'] == :maximum && validation_hsh['subtype'] == :date
               end.as_json
           end
         end

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

@@ -248,8 +248,9 @@ module Quby
             {
               key: score.key,
               label: score.label,
+              sbg_key: score.sbg_key,
               subscores: subscores_for(score)
-            }
+            }.compact
           }
         end
 
@@ -260,7 +261,8 @@ module Quby
               key: subscore.key,
               label: subscore.label,
               export_key: subscore.export_key,
-              only_for_export: subscore.only_for_export.presence
+              only_for_export: subscore.only_for_export.presence,
+              type: subscore.type
             }.compact
           }
         end

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

@@ -0,0 +1,49 @@
+# Copied from RoQua for default_answer_values.
+# Temporary: should change the values when quby1 is off the table
+class Quby::Compiler::Services::TransformQuby1ValuesIntoQuby2Values
+  attr_accessor :questionnaire, :values
+
+  def self.run!(...)
+    new(...).execute
+  end
+
+  def initialize(questionnaire, values)
+    @questionnaire = questionnaire
+    @values = (values || {}).with_indifferent_access
+  end
+
+  # Edits hash in place!
+  # extra v_3 key is not in quby1, but can't really hurt keeping it in.
+  # {v_3: {year: '2020'}} to {'v_3_yyyy' => '2020', v_3: {year: '2020'}}
+  # {v_4: ['a2']} to {v_4_a1: 0, v_4_a2: 1, v_4: {v_4_a1: 0, v_4_a2: 1}}
+  def execute
+    questionnaire.questions.each do |question|
+      case question.type
+      when :date then transform_date_parts(question)
+      when :check_box then transform_multi_select(question)
+      end
+    end
+    values
+  end
+
+  private
+
+  def transform_date_parts(question)
+    date_parts = question.components.map { OpenStruct.new(part: _1, key: question.send("#{_1}_key")) }
+    return if date_parts.all? { values[_1.key].nil? }
+
+    values[question.key] = date_parts.to_h { |date_part|
+      [date_part.part, values[date_part.key]]
+    }.compact
+
+    date_parts.each { values.delete(_1.key) }
+  end
+
+  def transform_multi_select(question)
+    return if values[question.key].nil?
+
+    quby2_style_value = question.options.select { |option| values[question.key][option.key] == 1 }.map(&:key)
+    values[question.key] = quby2_style_value
+    question.options.each { values.delete(_1.key) }
+  end
+end

data/lib/quby/compiler/version.rb

@@ -1,5 +1,5 @@
 module Quby
   module Compiler
-    VERSION = "0.5.4"
+    VERSION = "0.5.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quby-compiler
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.6
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -219,6 +219,7 @@ files:
 - lib/quby/compiler/services/quby_proxy.rb
 - lib/quby/compiler/services/seed_diff.rb
 - lib/quby/compiler/services/text_transformation.rb
+- lib/quby/compiler/services/transform_quby1_values_into_quby2_values.rb
 - lib/quby/compiler/type_validator.rb
 - lib/quby/compiler/version.rb
 - lib/quby/range_categories.rb
@@ -244,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Quby::Compiler compiles a DSL for questionnaires to JSON