quby-compiler 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f3028be16a77f8fbf5f30b7abfb04839a2a501c4e829bda046a415723beafd4
-  data.tar.gz: d682aa3b84a73c5b2f3e41f90c82c0e20fbcb431149be21b6136416ddfa827d8
+  metadata.gz: 886ce60c1b1c37de0dfdbb8d0b14b4c2ed2574f873a2230ff50e80413e50c031
+  data.tar.gz: ee12f0733d624ffea8061b4f9f7bcbcdea9c904eb05d9b1e426b9f646bae91da
 SHA512:
-  metadata.gz: 91673fe9c11612f9c9dba10ab129217942d388830423550376f36972250643660eca53af578183c77d924aee9db44587b4ee4ec19e3e66d445a91367a6df7cff
-  data.tar.gz: 19d1703844eb8a809f68b8a4634af28d97f627a42b575cdb468737dc43b87fda0351ef875edb0c21e70483aaec84d2362256b38c531840f64c9820d7ba69efa6
+  metadata.gz: d24325dcee35fafd2d99d65bc6761eb7fa764efe2c5b549208e5130b3b0218bdc2dbf9e932886f1f05a8ac9461236dd398e9d8d733a4a715c2a62fddeb768da0
+  data.tar.gz: 0d45e85ea11b5c03710011aff584bf6df363f140184519e6a5c374651e516599a7667921560b41d3870b4c3ef98a55cfc097550aba39199f4be233001453e0fc

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 0.4.8
+
+* roqua.json: 
+  * sort parent questions before it's children, to make the order more logical to just dumbly show
+  * parse markdown before stripping tags (questiom.title, option.description)
+  * context-free-titles no longer contain the title as fallback
+* quby2.json
+  * sort visibility rules: flags first, then in question order, so we can apply them in order without issue
+
 # 0.4.7
 
 * seeds.yml: Fix missing title questions (broken by 0.4.6)

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

@@ -31,17 +31,6 @@ module Quby
           "#{description} (true - '#{description_true}', false - '#{description_false}')"
         end
 
-        def to_codebook(_options = {})
-          output = []
-          output << "#{key} flag"
-          output << "'#{description}'" if description.present?
-          output << " 'true' - #{description_true}"
-          output << " 'false' - #{description_false}"
-          output << " '' (leeg) - Vlag niet ingesteld, informatie onbekend"
-          output << ""
-          output.join("\n")
-        end
-
         private
 
         def ensure_valid_descriptions

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

@@ -30,10 +30,6 @@ module Quby
             class: self.class.to_s
           }
         end
-
-        def to_codebook(questionnaire, options = {})
-          ""
-        end
       end
     end
   end

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

@@ -209,6 +209,10 @@ module Quby
         end
         # rubocop:enable CyclomaticComplexity, Metrics/MethodLength
 
+        def context_free_title_or_title
+          context_free_title || title
+        end
+
         # rubocop:disable AccessorMethodName
         def set_depends_on(keys)
           return if keys.blank?
@@ -217,10 +221,6 @@ module Quby
         end
         # rubocop:enable AccessorMethodName
 
-        def context_free_title
-          @context_free_title || @title
-        end
-
         def expand_depends_on_input_keys
           return unless @depends_on
           @depends_on = questionnaire.expand_input_keys(@depends_on)
@@ -329,39 +329,8 @@ module Quby
           !parent_option_key.nil?
         end
 
-        def to_codebook(questionnaire, opts = {})
-          output = []
-          question_key = codebook_key(key, questionnaire, opts)
-          output << "#{question_key} #{codebook_output_type} #{codebook_output_range}#{' deprecated' if hidden}"
-          output << "\"#{context_free_title}\"" unless context_free_title.blank?
-          options_string = options.map do |option|
-            option.to_codebook(questionnaire, opts)
-          end.compact.join("\n")
-          output << options_string unless options.blank?
-          output.join("\n")
-        end
-
-        def codebook_key(key, questionnaire, opts = {})
-          key.to_s.gsub(/^v_/, "#{opts[:roqua_key] || questionnaire.key.to_s}_")
-        end
-
-        def codebook_output_type
-          type
-        end
-
-        def codebook_output_range
-          range_min = validations.find { |i| i[:type] == :minimum }&.fetch(:value, nil)
-          range_max = validations.find { |i| i[:type] == :maximum }&.fetch(:value, nil)
-
-          if range_min || range_max
-            "(#{[range_min, "value", range_max].compact.join(" &lt;= ")})"
-          else
-            ""
-          end
-        end
-
         def variable_descriptions
-          {key => context_free_title}.with_indifferent_access
+          {key => context_free_title_or_title}.with_indifferent_access
         end
       end
     end

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

@@ -10,7 +10,7 @@ module Quby
 
         attr_reader :key
         attr_reader :value
-        attr_reader :description
+        attr_reader :description, :context_free_description
         attr_reader :questions
         attr_reader :inner_title
         validates :inner_title, inclusion: {in: [true, false, nil], message: "must be boolean"}
@@ -52,10 +52,6 @@ module Quby
           false
         end
 
-        def context_free_description
-          @context_free_description || @description
-        end
-
         def as_json(options = {})
           {
             key: key,
@@ -75,28 +71,6 @@ module Quby
             viewId: view_id
           }
         end
-
-        def to_codebook(questionnaire, opts)
-          return nil if inner_title
-          output = []
-
-          if question.type == :check_box
-            option_key = question.codebook_key(key, questionnaire, opts)
-            output << "#{option_key} #{question.codebook_output_type}#{' deprecated' if hidden || question.hidden }"
-            output << "\"#{question.title} -- #{description}\"" unless question.title.blank? and description.blank?
-            output << "1\tChecked"
-            output << "0\tUnchecked"
-            output << "empty\tUnchecked"
-          else
-            output << "#{value || key}\t\"#{description}\"#{' deprecated' if hidden}"
-          end
-
-          questions.each do |subquestion|
-            output << "\t#{subquestion.to_codebook(questionnaire, opts).gsub("\n", "\n\t")}"
-          end
-
-          output.join("\n")
-        end
       end
     end
   end

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

@@ -172,6 +172,19 @@ module Quby
           end)
         end
 
+        # sorts parents before children, so showing makes more sense and visiblity rules are ordered correctly
+        def sorted_questions
+          return @sorted_questions if @sorted_questions
+
+          key_to_order_by = questions.map.with_index.to_h { [_1.key, [_2]] }
+          questions.each do |question|
+            if question.parent
+              key_to_order_by[question.key].unshift(key_to_order_by[question.parent.key].first)
+            end
+          end
+          @sorted_questions = questions.sort_by { key_to_order_by[_1.key] }
+        end
+
         def questions
           question_hash.values
         end
@@ -201,43 +214,6 @@ module Quby
           }
         end
 
-        # rubocop:disable Metrics/MethodLength
-        def to_codebook(options = {})
-          output = []
-          output << title
-          output << "Date unknown"
-          output << ""
-
-          options[:extra_vars]&.each do |var|
-            output << "#{var[:key]} #{var[:type]}"
-            output << "\"#{var[:description]}\""
-            output << ""
-          end
-
-          top_questions = panels.map do |panel|
-            panel.items.select { |item| item.is_a? Question }
-          end.flatten.compact
-
-          top_questions.each do |question|
-            output << question.to_codebook(self, options)
-            output << ""
-          end
-
-          flags.each_value do |flag|
-            output << flag.to_codebook(options)
-            output << ""
-          end
-
-          textvars.each_value do |textvar|
-            output << textvar.to_codebook(options)
-            output << ""
-          end
-
-          output = output.join("\n")
-          strip_tags(output.gsub(/\<([ 1-9])/, '&lt;\1')).gsub("&lt;", "<")
-        end
-        # rubocop:enable Metrics/MethodLength
-
         def key_in_use?(key)
           fields.key_in_use?(key) || score_calculations.key?(key)
         end
@@ -415,9 +391,14 @@ module Quby
           end.uniq(&:config)
         end
 
+        # Order is important
+        # quby2 follows them one by one and ignores rules by hidden question, so needs to be in order of interface.
+        # Flags don't have this issue, so as long as they are first, their order doesn't matter.
         def visibility_rules
-          @visibility_rules ||= fields.question_hash.values.flat_map { |question| VisibilityRule.from(question) } \
-                              + flags.values.flat_map { |flag| VisibilityRule.from_flag(flag) }
+          @visibility_rules ||= [
+            *flags.values.flat_map { |flag| VisibilityRule.from_flag(flag) },
+            *sorted_questions.flat_map { |question| VisibilityRule.from(question) }
+          ]
         end
 
         private

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

@@ -51,9 +51,9 @@ module Quby
           end
 
           def variable_descriptions
-            options.each_with_object(key => context_free_title) do |option, hash|
+            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} - #{option.description}"
+              hash[option.input_key] = "#{context_free_title_or_title} - #{option.description}"
             end.with_indifferent_access
           end
 
@@ -69,12 +69,6 @@ module Quby
           def as_json(options = {})
             super.merge(options: @options.as_json)
           end
-
-          def to_codebook(questionnaire, opts = {})
-            options.map do |option|
-              option.to_codebook(questionnaire, opts)
-            end.compact.join("\n\n")
-          end
         end
       end
     end

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

@@ -53,9 +53,9 @@ module Quby
           end
 
           def variable_descriptions
-            components.each_with_object(key => context_free_title) do |component, hash|
+            components.each_with_object(key => context_free_title_or_title) do |component, hash|
               key = send("#{component}_key")
-              hash[key] = "#{context_free_title} (#{I18n.t component})"
+              hash[key] = "#{context_free_title_or_title} (#{I18n.t component})"
             end.with_indifferent_access
           end
 
@@ -65,18 +65,6 @@ module Quby
             end
             super.merge(components: components).merge(component_keys)
           end
-
-          def to_codebook(questionnaire, opts = {})
-            output = []
-            components.each do |component|
-              output << "#{codebook_key(send("#{component}_key"), questionnaire, opts)} " \
-              "#{type}_#{component} #{codebook_output_range}"
-              output << "\"#{title}\"" unless title.blank?
-              output << options.map(&:to_codebook).join("\n") unless options.blank?
-              output << ""
-            end
-            output.join("\n")
-          end
         end
       end
     end

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

@@ -8,10 +8,6 @@ module Quby
           def as_json(options = {})
             super.merge(options: @options.as_json)
           end
-
-          def codebook_output_type
-            :radio
-          end
         end
       end
     end

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

@@ -8,10 +8,6 @@ module Quby
           def as_json(options = {})
             super.merge(options: @options.as_json)
           end
-
-          def codebook_output_type
-            :radio
-          end
         end
       end
     end

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

@@ -10,13 +10,6 @@ module Quby
           super(key, description, default, depends_on_flag)
         end
         # rubocop:enable ParameterLists
-
-        def to_codebook(_options = {})
-          output = []
-          output << "#{key} Textvariabele"
-          output << description
-          output.join("\n")
-        end
       end
     end
   end

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

@@ -160,7 +160,7 @@ module Quby
         # 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
+        # context_free_title [nil/string] no html, not 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
@@ -170,15 +170,15 @@ module Quby
         # date_parts [nil/{..}]
         # options: [nil/{..}]
         def questions
-          questionnaire.questions.reject{_1.type == :hidden}.to_h { |question|
+          questionnaire.sorted_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),
+                title: parse_markdown_and_strip_tags(question.title),
+                context_free_title: question.context_free_title,
                 unit: question.unit,
                 deprecated: question.hidden.presence,
                 default_invisible: question.default_invisible.presence,
@@ -210,7 +210,7 @@ module Quby
         # {a1: {..}}
         # key [string]
         # value [nil/string] nil for check_box, string otherwise
-        # description [nil/string] context_free_description, no html
+        # description [nil/string] context_free_description or parsed/stripped description, no html
         # child_question_keys [nil/[string]]
         def options_for(question)
           return nil if question.options.empty?
@@ -222,7 +222,7 @@ module Quby
               {
                 key: option.key,
                 value: (option.value.to_s unless question.type == :check_box),
-                description: strip_tags_without_html_encode(option.context_free_description),
+                description: option.context_free_description || parse_markdown_and_strip_tags(option.description),
                 child_question_keys: option.questions.map(&:key).presence
               }.compact
             ]
@@ -255,8 +255,17 @@ module Quby
           }
         end
 
+        def parse_markdown_and_strip_tags(markdown)
+          strip_tags_without_html_encode(Quby::MarkdownParser.new(markdown).to_html)
+        end
+
         def strip_tags_without_html_encode(html)
-          Nokogiri::HTML(html).text.presence
+          Nokogiri::HTML(html).tap do |doc|
+            doc.css('br, hr, img').each { |node| node.replace(' ') }
+          end \
+            .text
+            .gsub!(/\s+/, ' ')
+            .presence
         end
       end
     end

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

@@ -40,7 +40,7 @@ module Quby
             when :select
               d_qtypes[question.key.to_s] = { type: :discrete }
               for option in question.options
-                d_qtypes[question.key.to_s][option.value.to_s] = strip_p_tag(option.context_free_description || "") unless option.placeholder
+                d_qtypes[question.key.to_s][option.value.to_s] = strip_p_tag(option.context_free_description || option.description || "") unless option.placeholder
               end
               update_hidden_questions_for(question)
             when :check_box
@@ -49,11 +49,11 @@ module Quby
                 next if option.inner_title
                 vars << option.key.to_s
                 if question.hidden
-                  question_titles[option.key.to_s] = strip_tags question.context_free_title
+                  question_titles[option.key.to_s] = strip_tags(question.context_free_title_or_title)
                 end
                 value = 1
                 option_type = { type: :discrete }
-                option_type[value.to_s] = (option.context_free_description || "")
+                option_type[value.to_s] = (option.context_free_description || 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
                 values = [value, value.to_s].uniq
@@ -75,7 +75,7 @@ module Quby
               end
             when :hidden
               if question.options.blank? # string
-                question_titles[question.key.to_s] = strip_tags question.context_free_title
+                question_titles[question.key.to_s] = strip_tags(question.context_free_title_or_title)
                 vars << question.key.to_s unless vars.include? question.key.to_s
                 d_qtypes[question.key.to_s] = { type: :text }
                 d_qtypes[question.key.to_s][:depends] = :present unless options[:without_depends]
@@ -88,16 +88,16 @@ 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 || "")
+                    d_qtypes[question.key.to_s][option.value.to_s] = strip_p_tag(option.context_free_description || option.description || "")
                     # TODO: missing sub-questions
                   else # check_box
                     d_qtypes[question.key.to_s] ||= { type: :check_box }
                     no_keys = false
-                    question_titles[option.key.to_s] = strip_tags question.context_free_title
+                    question_titles[option.key.to_s] = strip_tags(question.context_free_title_or_title)
                     vars << option.key.to_s
                     value = option.value || 1
                     option_type = { type: :discrete }
-                    option_type[value.to_s] = (option.context_free_description || "")
+                    option_type[value.to_s] = (option.context_free_description || 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
@@ -105,7 +105,7 @@ module Quby
                 end
                 if no_keys # scale or radio
                   d_qtypes[question.key.to_s][:depends] = { values: values, variable: question.key.to_s } unless options[:without_depends]
-                  question_titles[question.key.to_s] = strip_tags question.context_free_title
+                  question_titles[question.key.to_s] = strip_tags(question.context_free_title_or_title)
                 end
               end
             else
@@ -194,7 +194,7 @@ module Quby
 
           for question in questions_flat
             unless question.hidden && (question.type == :check_box || question.type == :hidden)
-              title = question.context_free_title || question.description || ""
+              title = question.context_free_title_or_title || question.description || ""
               question_titles[question.key.to_s] = strip_tags(title)
             end
           end
@@ -240,24 +240,24 @@ module Quby
             end
           end
           d_qtypes[quest.key.to_s][:label] = quest.unit unless quest.unit.blank?
-          quests[quest.key.to_s] = strip_tags(quest.context_free_title || "")
+          quests[quest.key.to_s] = strip_tags(quest.context_free_title || quest.title || "")
           vars << quest.key.to_s
         end
 
         def sub_textfield(question, quests, d_qtypes, vars, quest, values, key)
           d_qtypes[quest.key.to_s] = { type: :text_field }
           d_qtypes[quest.key.to_s][:depends] = { values: values, variable: key } unless options[:without_depends]
-          quests[quest.key.to_s] = strip_tags(quest.context_free_title || "")
+          quests[quest.key.to_s] = strip_tags(quest.context_free_title || quest.title || "")
           vars << quest.key.to_s
         end
 
         def sub_radio(question, quests, d_qtypes, vars, quest, values, key)
           d_qtypes[quest.key.to_s] = { type: :scale }
           d_qtypes[quest.key.to_s][:depends] = { values: values, variable: key } unless options[:without_depends]
-          quests[quest.key.to_s] = strip_tags(quest.context_free_title || "")
+          quests[quest.key.to_s] = strip_tags(quest.context_free_title || quest.title || "")
           for option in quest.options
             next if option.inner_title
-            d_qtypes[quest.key.to_s][option.value.to_s] = strip_p_tag(option.context_free_description || "")
+            d_qtypes[quest.key.to_s][option.value.to_s] = strip_p_tag(option.context_free_description || option.description || "")
           end
           vars << quest.key.to_s
           update_hidden_questions_for(quest)
@@ -269,7 +269,7 @@ module Quby
             vars << key
             hash[component] = key.to_s
           end
-          quests[quest.key.to_s] = strip_tags(quest.context_free_title || "")
+          quests[quest.key.to_s] = strip_tags(quest.context_free_title || quest.title || "")
         end
 
         def handle_scale(question, quests, d_qtypes, vars)
@@ -278,7 +278,7 @@ module Quby
           update_hidden_questions_for(question)
           for option in question.options
             next if option.inner_title
-            d_qtypes[question.key.to_s][option.value.to_s] = strip_p_tag(option.context_free_description || "")
+            d_qtypes[question.key.to_s][option.value.to_s] = strip_p_tag(option.context_free_description || option.description || "")
             values << option.value.to_s
             key = question.key.to_s
             handle_subquestions(question, quests, d_qtypes, vars, option, [option.value.to_s], key)

data/lib/quby/compiler/version.rb

@@ -1,5 +1,5 @@
 module Quby
   module Compiler
-    VERSION = "0.4.7"
+    VERSION = "0.4.8"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quby-compiler
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel