quby-compiler 0.5.39 → 0.5.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2279e5f134b33df182ad29e5ef668b690ec78bf64a155943da2572d5427e9515
-  data.tar.gz: e57c0a3a82e23aaa73230141439b3787df75f1143cd2a4192749d6ebb4ae783b
+  metadata.gz: 9e4ea90302f4838a9b7c5f87f6dbd4d27c4966ec54dafc9448168635c32584ec
+  data.tar.gz: 371f50e287667c40f77897d9edc791367cc55d646efa561ca4cf526d8ca4e056
 SHA512:
-  metadata.gz: 174970b103cd572b7d9920c4f135069672339dcfdc8e212dad1209476db4a0cff4fb744a2033b4c39ac12a4745a01344f2ebefad3c61c4b7ab1beb47fe8dba12
-  data.tar.gz: 22374d446918b0b6a04732ac0c024c98c2ffca0ee831f1121e8035285fc5706d967dcf44a074007a5635ccb9d6a6c262b31a29a92576376e7ba8f5108b00a2b7
+  metadata.gz: 3a472cbc39f53181e19b6b9385537e3d15efb9f65cd20c33eb28d3bfff16e8fab4361c5d1df511a58ae14d3c7ccf2ff37046145cd0089db13ede18dbe3a59290
+  data.tar.gz: 9d073a016dc4407b0ef0b39d2ac4691ac18d99c4e37fbfd5a87a5f794db2db82ed9079fe31b78de0930053faf4213eef50ec3c73aca6c81d858f4b9509093bf5

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 0.5.41
+
+* dsl: 
+  * add environments, original, editable_by_professionals
+  * Add visibility_rule method to questionnaire_builder and question_builder.
+* roqua.json
+  * Add name, description, short_description, environments, original, editable_by_professionals
+  * Fix quby_proxy for option labels in more places
+
+# 0.5.40
+
+* add editable_from_version setting
+
 # 0.5.39
 
 * Remove ostruct dependency (next ruby version requires a gem for this). Make tags simple array and only export to roqua.json.

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

@@ -116,15 +116,31 @@ module Quby
           @questionnaire.tags = tags
         end
 
+        def editable_by_professionals
+          @questionnaire.editable_by_professionals = true
+        end
+
+        def environments(*environments)
+          @questionnaire.environments = environments
+        end
+
+        def original(original_key)
+          @questionnaire.original = original_key
+        end
+
         def version(number, release_notes:, regenerate_outcome: false, deactivate_answers: false)
           @questionnaire.versions << Entities::Version.new(
-            number: number,
-            release_notes: release_notes,
-            regenerate_outcome: regenerate_outcome,
-            deactivate_answers: deactivate_answers
+            number:,
+            release_notes:,
+            regenerate_outcome:,
+            deactivate_answers:,
           )
         end
 
+        def editable_from_version(number)
+          @questionnaire.editable_from_version = number
+        end
+
         def outcome_regeneration_requested_at(timestamp)
           @questionnaire.outcome_regeneration_requested_at = timestamp
         end
@@ -301,11 +317,18 @@ module Quby
             type: 'sexp_variable_true',
             sexp_key:
           }
-          @questionnaire.sexp_visibility_rules.concat(
+          @questionnaire.extra_visibility_rules.concat(
             Entities::VisibilityRule.for_condition(condition, show_questions:, hide_questions:)
           )
         end
 
+        # condition: { type: 'answered', field_key: 'v_1' }
+        def visibility_rule(type:, field_key:, show_questions: [], hide_questions: [],  **condition_options)
+          @questionnaire.extra_visibility_rules.concat(
+            Entities::VisibilityRule.for_condition({type:, field_key:, **condition_options}, show_questions:, hide_questions:)
+          )
+        end
+
         private
 
         def default_panel_options

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

@@ -98,6 +98,14 @@ module Quby
           end
         end
 
+        module VisibilityRule
+          def visibility_rule(type:, show_questions: [], hide_questions: [],  **condition_options)
+            @question.visibility_rules.concat(
+              Entities::VisibilityRule.for_condition({type:, field_key: @question.key, **condition_options}, show_questions:, hide_questions:)
+            )
+          end
+        end
+
         module Labeling
           def label(value)
             @question.labels << value

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

@@ -10,6 +10,7 @@ module Quby
           include Units
           include Sizes
           include CompareVisibilityRule
+          include VisibilityRule
 
           def initialize(key, **options, &block)
             super

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

@@ -8,6 +8,7 @@ module Quby
           include RegexpValidations
           include Units
           include Sizes
+          include VisibilityRule
 
           def initialize(key, **options, &block)
             super

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

@@ -6,6 +6,7 @@ module Quby
       module Questions
         class TextQuestionBuilder < Base
           include RegexpValidations
+          include VisibilityRule
 
           def initialize(key, **options, &block)
             super

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

@@ -53,8 +53,9 @@ module Quby
           @check_score_keys_consistency = true
           @lookup_tables = {}
           @sexp_variables = {}
-          @sexp_visibility_rules = []
+          @extra_visibility_rules = []
           @versions = []
+          @editable_from_version = nil
           @seeds_patch = {}
           @anonymous_conditions = Entities::AnonymousConditions.new
           @check_checkbox_options_start_with_question_key = true
@@ -69,9 +70,12 @@ module Quby
         attr_writer   :roqua_keys
         attr_accessor :sbg_key # not required to be unique
         attr_accessor :sbg_domains
-        attr_accessor :versions
+        attr_accessor :versions, :editable_from_version
         attr_accessor :abortable
+        attr_accessor :editable_by_professionals
         attr_accessor :enable_previous_questionnaire_button
+        attr_accessor :environments
+        attr_accessor :original
         attr_accessor :panels
         attr_accessor :score_calculations
         attr_accessor :default_answer_value
@@ -105,7 +109,7 @@ module Quby
         attr_accessor :outcome_tables
         attr_accessor :score_schemas
         attr_accessor :sexp_variables
-        attr_reader   :sexp_visibility_rules
+        attr_reader   :extra_visibility_rules
         attr_accessor :lookup_tables
         attr_accessor :anonymous_conditions
 
@@ -400,7 +404,7 @@ module Quby
           @visibility_rules ||= [
             *flags.values.flat_map { |flag| VisibilityRule.from_flag(flag) },
             *sorted_questions.flat_map { |question| VisibilityRule.from(question) },
-            *sexp_visibility_rules
+            *extra_visibility_rules
           ].sort_by.with_index do |rule, idx|
             [question_order[rule.action[:field_key]], rule.action[:type] == 'show_question' ? 0 : 1, idx]
           end

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

@@ -20,4 +20,4 @@ module Quby
       end
     end
   end
-end
+end

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

@@ -23,8 +23,14 @@ module Quby
         def as_json(options = {})
           {
             key: questionnaire.key,
+            name: questionnaire.title,
+            short_description: questionnaire.short_description,
+            description: questionnaire.description,
             renderer:,
             versions: versions,
+            editable_by_professionals: questionnaire.editable_by_professionals,
+            editable_from_version: questionnaire.editable_from_version,
+            environments: questionnaire.environments,
             keys: questionnaire.roqua_keys,
             roqua_keys: questionnaire.roqua_keys,
             sbg_key: questionnaire.sbg_key,
@@ -34,6 +40,7 @@ module Quby
             respondent_types: questionnaire.respondent_types,
             tags: questionnaire.tags,
             charts: charts,
+            original: questionnaire.original,
             outcome_tables_schema: outcome_tables_schema,
             outcome_description: questionnaire.outcome_description,
             questions: questions,
@@ -43,7 +50,7 @@ module Quby
             textvars: textvars,
             license: questionnaire.license,
             licensor: questionnaire.licensor,
-          }
+          }.compact
         end
 
         def renderer
@@ -56,12 +63,7 @@ module Quby
 
         def versions
           questionnaire.versions.map do |version|
-            {
-              number: version.number,
-              release_notes: version.release_notes,
-              regenerate_outcome: version.regenerate_outcome,
-              deactivate_answers: version.deactivate_answers
-            }
+            version.as_json(only: %w[number release_notes regenerate_outcome deactivate_answers])
           end
         end
 

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

@@ -422,22 +422,54 @@ scores_schema tables to the resulting seed."
 
         def validate_visiblity_rules(questionnaire)
           questionnaire.visibility_rules.each do |rule|
-            case rule.condition[:type]
-            when 'sexp_variable_true'
-              sexp_key = rule.condition[:sexp_key]
-              unless questionnaire.sexp_variables.key?(sexp_key)
-                fail "sexp_visibility_rule references nonexistent sexp variable :#{sexp_key}."
-              end
-              unless questionnaire.sexp_variables[sexp_key].type == :boolean
-                fail "sexp_visibility_rule references sexp variable :#{sexp_key} with non-boolean type"
-              end
-            end
+            validate_visibility_condition(questionnaire, rule.condition)
+
             unless questionnaire.question_hash.key?(rule.action[:field_key])
               fail "visibility_rule references nonexistent question :#{rule.action[:field_key]}."
             end
           end
         end
 
+        def validate_visibility_condition(questionnaire, condition)
+          case condition[:type]
+          when 'always', 'answered'
+            validate_field_key(questionnaire, condition)
+          when 'equal', 'contains'
+            validate_field_key(questionnaire, condition)
+            if !condition[:value]
+              fail "visibility_rule for #{condition[:field_key]} missing value in condition."
+            end
+          when 'numeric_compare'
+            validate_field_key(questionnaire, condition)
+            unless %w[gt gteq lt lteq eq].include?(condition[:op].to_s)
+              fail "Unknown operator for numeric_compare visibility_rule: #{condition[:op]}"
+            end
+            unless condition[:value].is_a?(Numeric)
+              fail "Value for numeric_compare visibility_rule must be numeric, got: #{condition[:value]}"
+            end
+          when 'sexp_variable_true'
+            sexp_key = condition[:sexp_key]
+            unless questionnaire.sexp_variables.key?(sexp_key)
+              fail "sexp_visibility_rule references nonexistent sexp variable :#{sexp_key}."
+            end
+            unless questionnaire.sexp_variables[sexp_key].type == :boolean
+              fail "sexp_visibility_rule references sexp variable :#{sexp_key} with non-boolean type"
+            end
+          when 'flag_equal' # created correctly by flag method.
+          else
+            fail "Unknown visibility_rule condition type: #{condition[:type]}"
+          end
+        end
+
+        def validate_field_key(questionnaire, condition)
+          if !condition[:field_key]
+            fail "visibility_rule missing field_key in condition."
+          end
+          if !questionnaire.question_hash.key?(condition[:field_key])
+            fail "visibility_rule references nonexistent question :#{condition[:field_key]}."
+          end
+        end
+
         def validate_quby2_unsupported_features(questionnaire)
           return unless questionnaire.layout_version == :v2
 

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

@@ -88,7 +88,7 @@ module Quby
                     next if option.inner_title
                     d_qtypes[question.key.to_s] ||= { type: :scale }
                     values << option.value.to_s
-                    d_qtypes[question.key.to_s][option.value.to_s] = strip_p_tag(option.context_free_description || option.description || "")
+                    d_qtypes[question.key.to_s][option.value.to_s] = strip_p_tag(option.context_free_description || option.label ||  option.description || "")
                     # TODO: missing sub-questions
                   else # check_box
                     d_qtypes[question.key.to_s] ||= { type: :check_box }
@@ -97,7 +97,7 @@ module Quby
                     vars << option.key.to_s
                     value = option.value || 1
                     option_type = { type: :discrete }
-                    option_type[value.to_s] = (option.context_free_description || option.description || "")
+                    option_type[value.to_s] = (option.context_free_description || option.label || option.description || "")
                     option_type[:depends] = { values: [value, value.to_s].uniq, variable: option.key.to_s } unless options[:without_depends]
                     d_qtypes[option.key.to_s] = option_type
                     # TODO: missing sub-questions
@@ -257,7 +257,7 @@ module Quby
           quests[quest.key.to_s] = strip_tags(quest.context_free_title || quest.title || "")
           for option in quest.all_options
             next if option.inner_title
-            d_qtypes[quest.key.to_s][option.value.to_s] = strip_p_tag(option.context_free_description || option.description || "")
+            d_qtypes[quest.key.to_s][option.value.to_s] = strip_p_tag(option.context_free_description || option.label || option.description || "")
           end
           vars << quest.key.to_s
           update_hidden_questions_for(quest)

data/lib/quby/compiler/version.rb

@@ -1,5 +1,5 @@
 module Quby
   module Compiler
-    VERSION = "0.5.39"
+    VERSION = "0.5.41"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quby-compiler
 version: !ruby/object:Gem::Version
-  version: 0.5.39
+  version: 0.5.41
 platform: ruby
 authors:
 - Marten Veldthuis