quby 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b0670981a64e79ab88a754974855a9d1cfd1fcb682720c8a60a03b1849a4ead
-  data.tar.gz: e70e435bf9c0be46044ceb248a0709dd02cf3a4a2041f923f0203e30688c7377
+  metadata.gz: 4cd923c5c8abb37bb81945262215d61f6d6dd1dc45aeaf10499e00bb1b856a28
+  data.tar.gz: 64b36f46d1ffcde1c9cef8c2ecb68abb94547dec1ba71d5d3748ad23d871b66e
 SHA512:
-  metadata.gz: 8a4ce1912e9a974f2dfe3de3fc413f9daada2a7f8c1c41ea558825768c0cc32bb20e1d4283a1b2f5f6a469626309ea164bc6141a114045c765c50fda52e32fe1
-  data.tar.gz: 357b7e522e8136feeb6b77a9bd80d60b5c770f8d4775b75512270e1cd3e4c55ffa7f4cafa777e944eb7250de2fe42c9c85effc9b0a672281e65133c39585abf5
+  metadata.gz: 2e6cc16e77b09cf8b7c5b229f5607330ff22962e72b710dda9d01e2584906b98e7035d16c771e08eb1da6621d12560d4ba685a17a6838016cc4451baaa72795b
+  data.tar.gz: 48a2d9a85b7305ab4d7c19dc651260440c16641f18408d8f4d52708727768d4163dbf8a3d2a01c9cf97921867cce63daf45160e083cd6416c7660fa447f2265f

data/README.markdown

@@ -1,7 +1,5 @@
 Quby
 ====
-[![CircleCI](https://circleci.com/gh/roqua/quby_engine.png?circle-token=b8c29e6c847094da985e5cbcd0e20648b11f0217&style=shield)](https://circleci.com/gh/roqua/quby_engine)
-[![Code Climate](https://codeclimate.com/github/roqua/quby_engine/badges/gpa.svg)](https://codeclimate.com/github/roqua/quby_engine)
 [![Dependency Status](https://gemnasium.com/roqua/quby_engine.svg)](https://gemnasium.com/roqua/quby_engine)
 
 ## Usage
@@ -42,7 +40,7 @@ ENV['OPENCPU_TIMEOUT']      = '30' # request timeout in seconds.
 To generate PDF files, the html_to_pdf docker container must be running and an environment variable with the address of this container should be configured.
 
 ```ruby
-ENV['HTML_TO_PDF_URL']      = 'http://127.0.0.1:7768'
+ENV['GOTENBERG_URL']      = 'http://127.0.0.1:8080'
 ```
 
 ## Docker

data/app/controllers/quby/answers_controller.rb

@@ -70,7 +70,7 @@ module Quby
         begin
           pdf_binary = Quby::PdfRenderer.render_pdf(template_string)
           # type is not a application/pdf, to prevent previews on ios
-          send_data pdf_binary, filename: "#{@questionnaire.title} #{Time.zone.now.to_s(:filename)}.pdf",
+          send_data pdf_binary, filename: "#{@questionnaire.title} #{Time.zone.now.to_fs(:filename)}.pdf",
                               type: 'application/octet-stream', disposition: :attachment
         rescue StandardError
           flash.now[:notice] = I18n.t('pdf_download_failed_message')
@@ -269,7 +269,7 @@ module Quby
     # This is done instead of configuring I18n.locale to allow for example
     # English questionnaires within a Dutch RoQua.
     def translate(key, options = {})
-      I18n.t(key, options.merge(locale: @questionnaire.language))
+      I18n.t(key, **options.merge(locale: @questionnaire.language))
     end
     helper_method :translate
 

data/app/views/quby/v1/bulk.html.haml

@@ -12,7 +12,6 @@
   = render partial: "quby/v1/session_params"
   = render partial: "quby/v1/shared/force_submit", locals: {show_force_submit: @answer.errors.empty?}
   = render partial: "quby/v1/hotkey_dialog"
-  - all_items = @questionnaire.panels.map(&:items).flatten
   - previous_item = nil
 
   - @questionnaire.panels.each_with_index do |panel, panel_counter|

data/lib/quby/answers/api.rb

@@ -7,8 +7,8 @@ module Quby
         @repo = answer_repo
       end
 
-      def find(questionnaire_key, answer_id, options = {})
-        @repo.find questionnaire_key, answer_id, options
+      def find(questionnaire_key, answer_id, **options)
+        @repo.find questionnaire_key, answer_id, **options
       end
 
       def find_completed_after(time, answer_ids)

data/lib/quby/answers/entities/answer.rb

@@ -12,7 +12,7 @@ module Quby
         extend ActiveModel::Translation
 
         # @return [String]
-        attr_accessor :_id
+        attr_reader :_id
 
         # @return [String]
         attr_accessor :questionnaire_id
@@ -29,7 +29,7 @@ module Quby
         attr_accessor :value
 
         # @return [String]
-        attr_accessor :patient_id
+        attr_writer :patient_id
 
         # @return [Hash]
         attr_accessor :patient
@@ -55,9 +55,6 @@ module Quby
         # @return [Time]
         attr_accessor :completed_at
 
-        # @return [Outcome]
-        attr_accessor :outcome
-
         # @return [Time]
         attr_accessor :dsl_last_update
 
@@ -66,10 +63,10 @@ module Quby
         attr_accessor :import_notes
 
         # @return [Hash<String, Boolean>]
-        attr_accessor :flags
+        attr_reader :flags
 
         # @return [Hash<String, String>]
-        attr_accessor :textvars
+        attr_reader :textvars
 
         attr_accessor :outcome_generated_at
         attr_writer :scores
@@ -78,10 +75,6 @@ module Quby
 
         attr_accessor :aborted
 
-        # For setting raw content values and failed validations
-        attr_accessor :extra_question_values
-        attr_accessor :extra_failed_validations
-
         def initialize(_id: nil, questionnaire_id: nil, questionnaire_key: nil, questionnaire: nil,
           raw_params: nil, value: nil, patient_id: nil, patient: nil,
           token: nil, active: true, test: false, created_at: nil, updated_at: nil,
@@ -256,6 +249,7 @@ module Quby
           {}
         end
 
+        # @return [Outcome]
         def outcome
           Outcome.new(scores: @scores, actions: @actions, completion: @completion, generated_at: @outcome_generated_at)
         end
@@ -356,7 +350,7 @@ module Quby
         end
 
         def add_error(question, validationtype, message)
-          errors.add(question.key, {message: message, valtype: validationtype})
+          errors.add(question.key, message: message, valtype: validationtype)
         end
       end
     end

data/lib/quby/answers/entities/outcome.rb

@@ -5,10 +5,10 @@ module Quby
     module Entities
       class Outcome
         # @return [Hash]
-        attr_accessor :scores
+        attr_writer :scores
 
         # @return [Hash]
-        attr_accessor :actions
+        attr_writer :actions
 
         # @return [Hash]
         attr_accessor :completion

data/lib/quby/answers/entities/patient.rb

@@ -12,14 +12,19 @@ module Quby
           attributes = attributes.with_indifferent_access
           @gender    = attributes[:gender] || :unknown
           @birthyear = attributes[:birthyear]
+          @birthdate = attributes[:birthdate]
         end
 
         # returns the age at the given completed_at, as an integer
         # NB: if you make this a float, this breaks various questionnaire score calculations that do the following:
         # `if (8..12).cover?(age) ... elsif (13..15).cover?(age)` etc.
         def age_at(completed_at)
-          return nil unless @birthyear and completed_at
-          ((completed_at - Time.gm(@birthyear, 1, 1)) / 1.year).floor
+          return nil unless birthdate && completed_at
+          ((completed_at - birthdate) / 1.year).floor
+        end
+
+        def birthdate
+          @birthdate&.in_time_zone || (@birthyear && Time.gm(@birthyear, 1, 1))
         end
       end
     end

data/lib/quby/answers/repos/base.rb

@@ -4,7 +4,7 @@ module Quby
   module Answers
     module Repos
       class Base
-        def find(questionnaire_key, answer_id, options = {})
+        def find(questionnaire_key, answer_id, **options)
           record = find_record(answer_id)
           fail AnswerNotFound, "Answer #{answer_id.inspect} could not be found." unless record.present?
           entity(record)

data/lib/quby/answers/repos/disk_repo.rb

@@ -38,7 +38,7 @@ module Quby
 
         def load_file(filename)
           File.open(filename, 'r') do |file|
-            record = YAML.load(file.read)
+            record = YAML.unsafe_load(file.read)
             record.created_at ||= File.ctime(filename)
             record
           end

data/lib/quby/answers/services/answer_validator.rb

@@ -10,10 +10,12 @@ module Quby
 
         attr_reader :questionnaire
         attr_reader :answer
+        def validate_required?; @validate_required; end
 
-        def initialize(questionnaire, answer)
+        def initialize(questionnaire, answer, validate_required: !answer.aborted)
           @questionnaire = questionnaire
           @answer        = answer
+          @validate_required = validate_required
         end
 
         # rubocop:disable CyclomaticComplexity, Metrics/MethodLength
@@ -77,7 +79,7 @@ module Quby
         # rubocop:enable CyclomaticComplexity, Metrics/MethodLength
 
         def validate_required(question, validation, value)
-          return if @answer.aborted
+          return unless validate_required?
           valid = case question.type
                   when :date
                     required_keys = question.required_components.map do |key|
@@ -203,7 +205,7 @@ module Quby
         end
 
         def validate_minimum_checked_required(question, validation, value)
-          return if @answer.aborted
+          return unless validate_required?
 
           if value.values.reduce(:+) < question.minimum_checked_required.to_i
             answer.send(:add_error, question, :minimum_checked_required, validation[:message] || "Not enough options checked.")
@@ -211,7 +213,7 @@ module Quby
         end
 
         def validate_answer_group_minimum(question, validation, value)
-          return if @answer.aborted
+          return unless validate_required?
 
           answered = answer.send(:calc_answered, answer.question_groups[validation[:group]])
           if answered < validation[:value]

data/lib/quby/answers/services/outcome_calculation.rb

@@ -25,7 +25,7 @@ module Quby
               result = ScoreCalculator.calculate(questionnaire: answer.questionnaire,
                                                  values: value_by_regular_values,
                                                  completed_at: completed_at,
-                                                 patient_attrs: patient&.slice("birthyear", "gender"),
+                                                 patient_attrs: patient&.slice("birthyear", "birthdate", "gender"),
                                                  respondent_attrs: patient&.slice("respondent_type"),
                                                  &calculation.calculation)
 

data/lib/quby/engine.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
+unless File.respond_to?(:exists?)
+  class File
+    def self.exists?(*args, **kwargs, &block)
+      exist?(*args, **kwargs, &block)
+    end
+  end
+
+  class Dir
+    def self.exists?(*args, **kwargs, &block)
+      exist?(*args, **kwargs, &block)
+    end
+  end
+end
+
 # Engines are run as gems, not really using bundler
 # Therefore, we need to require stuff manually
 require 'rubygems'

data/lib/quby/pdf_renderer.rb

@@ -5,8 +5,25 @@ module Quby
     class EmptyResponse < RuntimeError
     end
     def self.render_pdf(html_str)
-      RestClient.post(ENV['HTML_TO_PDF_URL'], html_str).body.tap do |response|
-        raise EmptyResponse if response.empty?
+      if ENV['GOTENBERG_URL'].present?
+        RestClient.post(ENV['GOTENBERG_URL'],
+        upload: {
+          file: string_to_fileupload(html_str)
+        }).body.tap do |response|
+          raise EmptyResponse if response.empty?
+        end
+      else # deprecated fallback while testing.
+        RestClient.post(ENV['HTML_TO_PDF_URL'], html_str).body.tap do |response|
+          raise EmptyResponse if response.empty?
+        end
+      end
+    end
+
+    def self.string_to_fileupload(string)
+      StringIO.new(string).tap do |file|
+        def file.path
+          "index.html"
+        end
       end
     end
   end

data/lib/quby/questionnaires/deserializer.rb

@@ -32,7 +32,7 @@ module Quby
             build_textvar(attrs)
           end
 
-          questionnaire.lookup_tables = YAML.load(json.fetch("lookup_tables")).transform_values do |attrs|
+          questionnaire.lookup_tables = YAML.unsafe_load(json.fetch("lookup_tables")).transform_values do |attrs|
             Quby::TableBackend::RangeTree.new(levels: attrs[:levels], tree: attrs[:tree])
           end
 
@@ -401,7 +401,7 @@ module Quby
           Quby::Questionnaires::Entities::Charting::LineChart.new(chart_json.fetch("key").to_sym,
             y_label: chart_json.fetch("y_label"),
             tonality: chart_json.fetch("tonality").to_sym,
-            baseline: YAML.load(chart_json.fetch("baseline")),
+            baseline: YAML.unsafe_load(chart_json.fetch("baseline")),
             clinically_relevant_change: chart_json.fetch("clinically_relevant_change"),
             **base_args
           )

data/lib/quby/questionnaires/entities/charting/chart.rb

@@ -49,10 +49,10 @@ module Quby
           attr_accessor :y_range_categories
 
           # @return [Symbol]
-          attr_accessor :chart_type
+          attr_reader :chart_type
 
           # @return [Range]
-          attr_accessor :y_range
+          attr_writer :y_range
 
           # @return [Float]
           attr_accessor :tick_interval

data/lib/quby/questionnaires/entities/charting/line_chart.rb

@@ -12,10 +12,10 @@ module Quby
           attr_accessor :y_label
 
           # @return [Symbol]
-          attr_accessor :tonality
+          attr_reader :tonality
 
           # @return [Proc]
-          attr_accessor :baseline
+          attr_writer :baseline
 
           # @return [Float]
           attr_accessor :clinically_relevant_change

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

@@ -10,7 +10,7 @@ module Quby
         include ActiveSupport::Callbacks
         define_callbacks :after_dsl_enhance
 
-        attr_accessor :presentation
+        attr_writer   :presentation
         attr_accessor :switch_cycle
 
         # Raw content may contain a raw HTML replacement for this item

data/lib/quby/questionnaires/entities/panel.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'quby/questionnaires/entities'
-
 module Quby
   module Questionnaires
     module Entities

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

@@ -14,7 +14,7 @@ module Quby
         attr_accessor :sbg_key
         attr_accessor :questionnaire
         attr_accessor :title
-        attr_accessor :context_free_title
+        attr_writer :context_free_title
         attr_accessor :description
 
         attr_accessor :labels
@@ -42,10 +42,6 @@ module Quby
         # When :allow_blank_titles => true passed, validation does not fail. Any other value will raise the failure.
         attr_accessor :allow_blank_titles
 
-        # Minimum and maximum values for float and integer types
-        attr_accessor :minimum
-        attr_accessor :maximum
-
         # Whether the browser should autocomplete this question (off by default)
         attr_accessor :autocomplete
 
@@ -84,7 +80,7 @@ module Quby
         attr_accessor :depends_on
 
         # Extra data hash to store on the question item's html element
-        attr_accessor :extra_data
+        attr_writer :extra_data
 
         # data-attributes for the input tag.
         attr_accessor :input_data
@@ -109,14 +105,14 @@ module Quby
         attr_accessor :table
 
         # In case of being displayed inside a table, amount of columns/rows to span
-        attr_accessor :col_span
+        attr_writer :col_span
         attr_accessor :row_span
 
         attr_accessor :default_invisible
 
         # Slider only: where to place the sliding thing by default
         # Can have value :hidden for a hidden handle.
-        attr_accessor :default_position
+        attr_writer :default_position
 
         ##########################################################
 
@@ -255,10 +251,12 @@ module Quby
           @default_position || ((minimum + maximum) / half if minimum && maximum)
         end
 
+        # Minimum value for float and integer types, set by validation
         def minimum
           validations.find { |i| i[:type] == :minimum }.try(:fetch, :value)
         end
 
+        # Maximum value for float and integer types, set by validation
         def maximum
           validations.find { |i| i[:type] == :maximum }.try(:fetch, :value)
         end

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

@@ -61,7 +61,7 @@ module Quby
         attr_accessor :description
         attr_accessor :outcome_description
         attr_accessor :short_description
-        attr_accessor :roqua_keys
+        attr_writer   :roqua_keys
         attr_accessor :sbg_key # not required to be unique
         attr_accessor :sbg_domains
         attr_accessor :abortable
@@ -70,11 +70,11 @@ module Quby
         attr_accessor :score_calculations
         attr_accessor :default_answer_value
         attr_accessor :renderer_version
-        attr_accessor :leave_page_alert
+        attr_writer   :leave_page_alert
         attr_reader   :fields
         attr_accessor :extra_css
         attr_accessor :allow_switch_to_bulk
-        attr_accessor :license
+        attr_reader   :license
         attr_accessor :licensor
         attr_accessor :language
         attr_accessor :respondent_types
@@ -89,7 +89,7 @@ module Quby
         attr_accessor :validate_html
 
         attr_accessor :last_author
-        attr_accessor :allow_hotkeys # allow hotkeys for :all views, just :bulk views (default), or :none for never
+        attr_writer :allow_hotkeys # allow hotkeys for :all views, just :bulk views (default), or :none for never
 
         attr_accessor :charts
 

data/lib/quby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Quby
-  VERSION = "5.4.0"
+  VERSION = "5.5.0"
 end

data/spec/features/text_var_spec.rb

@@ -16,6 +16,7 @@ feature 'textvar replacement', js: true do
     visit_new_answer_for(questionnaire, 'paged', answer)
     expect(page).to have_content 'Probleemmiddel: init'
 
+    fill_in 'answer[v_00]', with: ''
     fill_in 'answer[v_00]', with: 'new'
     find('body').click # blur input
     expect(page).to have_content 'Probleemmiddel: new'
@@ -102,7 +103,7 @@ feature 'textvar replacement', js: true do
       end; end_panel
     END
 
-    answer = create_new_answer_for(questionnaire, {})
+    answer = create_new_answer_for(questionnaire)
     visit_new_answer_for(questionnaire, 'paged', answer)
     expect(page).to have_content 'Yo dawg I herd you like cars so we put a car in your car'
   end
@@ -118,7 +119,7 @@ feature 'textvar replacement', js: true do
       end; end_panel
     END
 
-    answer = create_new_answer_for(questionnaire, {})
+    answer = create_new_answer_for(questionnaire)
     visit_new_answer_for(questionnaire, 'paged', answer)
     expect(page).to have_content 'Yo dawg I herd you like {{test_thing}}s so we put a {{test_thing}} in your {{test_thing}}'
   end

data/spec/fixtures/aged_score_interpretations.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 title "Patient age can be used in scores"
 
 panel do

data/spec/fixtures/all_validations.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 title "All validations"
 
 default_question_options deselectable: true
@@ -82,10 +80,10 @@ panel do
   question :v_valid_float, type: :float
   question :v_valid_date, type: :date
   question :v_invalid_regexp, type: :string do
-    validates_format_with /a/
+    validates_format_with(/a/)
   end
   question :v_valid_regexp, type: :string do
-    validates_format_with /a/
+    validates_format_with(/a/)
   end
   question :v_required, type: :string, required: true
   question :v_valid_required, type: :string, required: true

data/spec/fixtures/english.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 title 'SimpleQuestionnaire'
 language :en
 

data/spec/fixtures/question_hiding.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 title "QuestHiding"
 short_description ""
 description ""

data/spec/fixtures/questionnaire_with_chart.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 panel do
   title 'Questionnaire With Chart'
 

data/spec/fixtures/simple.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 title 'SimpleQuestionnaire'
 
 panel do

data/spec/fixtures/simple_with_outcome.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 title 'SimpleQuestionnaireWithOutcome'
 
 panel do

data/spec/fixtures/subquestion_key_clash.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 title 'Subquestion key clash questionnaire'
 do_not_check_key_clashes
 panel do

data/spec/fixtures/subset_mansa.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 title "Subset of MANSA"
 short_description "Kwaliteit van Leven"
 description "Bevat de eerste paar panels van de echte MANSA"