quby 5.5.0 → 5.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cd923c5c8abb37bb81945262215d61f6d6dd1dc45aeaf10499e00bb1b856a28
-  data.tar.gz: 64b36f46d1ffcde1c9cef8c2ecb68abb94547dec1ba71d5d3748ad23d871b66e
+  metadata.gz: 6ba1a0ec73baa50b61bf5aa61e800b2efad36ee13b2431b4c0b11de6723ea17c
+  data.tar.gz: e71569d856f4ab5f1cac03c89b100bbc42b8b5e2b7340585b8727f4a49570636
 SHA512:
-  metadata.gz: 2e6cc16e77b09cf8b7c5b229f5607330ff22962e72b710dda9d01e2584906b98e7035d16c771e08eb1da6621d12560d4ba685a17a6838016cc4451baaa72795b
-  data.tar.gz: 48a2d9a85b7305ab4d7c19dc651260440c16641f18408d8f4d52708727768d4163dbf8a3d2a01c9cf97921867cce63daf45160e083cd6416c7660fa447f2265f
+  metadata.gz: 8f6f19a3b27df5b7316fe201845d7941c786d234e431b597372512fdfe8284ce5b1c190b4ddd74c2017878ce18a08c3b069bf91e98110b03637b3d45463e6277
+  data.tar.gz: dd04e3f96c639ad1c7819f47bd71f960dff5766463ab9c249f476068839a86a6b32207bc5b32a260c9db1d735eccb0673aef639b4736c74bd67655405fd14c46

data/app/assets/javascripts/quby/answers/navigation.js

@@ -29,23 +29,6 @@
     }
   });
 
-  $(document).on("click", ".print .print_button", function(event) {
-    var iOSSafari = !!navigator.platform.match(/iPhone|iPod|iPad/) &&
-                    !!navigator.userAgent.match(/Version\/[\d\.]+.*Safari/);
-    event.preventDefault();
-    var url = $(this).data("url");
-    if (form_submit_semaphore && activePanelsValid()) {
-      setSemaphore($(".print_button"));
-      var old_unload = window.onbeforeunload;
-      window.onbeforeunload = null;
-      if(iOSSafari) {
-        alert($("#ios-download-instruction").text());
-      }
-      formSubmitDownload(url, iOSSafari);
-      window.onbeforeunload = old_unload;
-    }
-  });
-
   $(document).on("ajax:success ajax:error", "form", revertSemaphore);
 
   function formSubmitDownload(url, iOSSafari) {

data/app/assets/stylesheets/quby/print.scss

@@ -16,16 +16,6 @@ body, input {
     margin: 0em;
 }
 
-.print_button{
-    margin: 1em;
-}
-
-@media print {
-    .print_button{
-        display:none;
-    }
-}
-
 h1 {
     margin: 0 0.5em 0.5em 0.5em;
     font: 200% sans-serif;

data/app/views/quby/v1/shared/_pdf_button.html.haml

@@ -1,8 +1,2 @@
 -# frozen_string_literal: true
-.print
-  %a.print_button{id: 'print-button', href: '#', data: {url: pdf_questionnaire_answer_path(@questionnaire, @answer)}}
-    = image_tag "quby/pdf.gif"
-    = translate('download_answers_pdf')
-
-  #ios-download-instruction.hidden
-    = I18n.t('ios_download_instruction')
+.print= translate('download_answers_pdf')

data/config/locales/de.yml

@@ -8,9 +8,7 @@ de:
   abort: Später zu Ende ausfüllen
   previous_questionnaire: Vorheriger Fragebogen
   done: Fertig
-  print_answers: Antworten drucken
-  download_answers_pdf: Als PDF herunterladen
-  pdf_download_failed_message: Beim Vorbereiten des Downloads ist ein Fehler aufgetreten.
+  download_answers_pdf: Als PDF herunterladen ist zum ende der sitzung verschoben
   questionnaire_not_completed:
     heading: Dieser Fragebogen ist noch nicht vollständig ausgefüllt!
     explanation: Wenn Sie diesen Fragebogen dennoch speichern, können unter Umständen Dimensionen des Fragebogens nicht berechnet werden, weil zu wenig Informationen dafür zur Verfügung stehen. Sie können Ihre Antworten unten weiterhin ausfüllen. Fragen die noch unvollständig ausgefüllt sind, erscheinen rot markiert.

data/config/locales/en.yml

@@ -8,9 +8,7 @@ en:
   abort: Save for later
   previous_questionnaire: Previous questionnaire
   done: Done
-  print_answers: Print answers
-  download_answers_pdf: Download as PDF
-  pdf_download_failed_message: An error occurred preparing the download.
+  download_answers_pdf: Download as PDF was moved to the end of the session
   questionnaire_not_completed:
     heading: "This questionnaire hasn't been filled out completely!"
     explanation: "If you decide to save the questionnaire anyway, it could be that scale scores can't be calculated because we don't have all the required answers. You may complete the questionnaire below."

data/config/locales/nl.yml

@@ -8,9 +8,7 @@ nl:
   abort: Later afmaken
   previous_questionnaire: Vorige vragenlijst
   done: Klaar
-  print_answers: Print antwoorden
-  download_answers_pdf: Download als PDF
-  pdf_download_failed_message: Het aanmaken van de download is helaas mislukt.
+  download_answers_pdf: Download als PDF is naar het einde van de sessie verplaatst
   questionnaire_not_completed:
     heading: Deze vragenlijst is nog niet volledig ingevuld!
     explanation: Als u de vragenlijst toch opslaat, kan het zijn dat er geen schaalscores berekend worden omdat hiervoor onvoldoende informatie voorhanden is. U kunt uw antwoorden hieronder alsnog aanvullen. Vragen die nog niet volledig zijn beantwoord, worden rood gemarkeerd.

data/lib/quby/answers/api.rb

@@ -11,10 +11,6 @@ module Quby
         @repo.find questionnaire_key, answer_id, **options
       end
 
-      def find_completed_after(time, answer_ids)
-        @repo.find_completed_after time, answer_ids
-      end
-
       def reload(answer)
         @repo.reload answer
       end

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

@@ -52,8 +52,16 @@ module Quby
         # @return [Time]
         attr_accessor :started_at
 
+        # The observation time of the response, the date at which the information in the response was collected.
+        # Defaults to entered_at, but always set, to make querying easier.
+        # This is used to calculate the age of the respondent at the time of filling out
         # @return [Time]
-        attr_accessor :completed_at
+        attr_accessor :observation_time
+
+        # The time at which the response was entered into the system for the first time,
+        # not necessarily the same as the observation time
+        # @return [Time]
+        attr_accessor :entered_at
 
         # @return [Time]
         attr_accessor :dsl_last_update
@@ -75,10 +83,12 @@ module Quby
 
         attr_accessor :aborted
 
+        # accepts completed_at for now, setting observation_time and entered_at
         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,
-          started_at: nil, completed_at: nil, outcome: nil, outcome_generated_at: nil,
+          started_at: nil, completed_at: nil, observation_time: nil, entered_at: nil,
+          outcome: nil, outcome_generated_at: nil,
           scores: nil, actions: nil, completion: nil, dsl_last_update: nil, import_notes: nil,
           flags: nil, textvars: nil)
 
@@ -95,7 +105,8 @@ module Quby
           self.created_at = created_at
           self.updated_at = updated_at
           self.started_at = started_at
-          self.completed_at = completed_at
+          self.entered_at = entered_at || completed_at
+          self.observation_time = observation_time || entered_at
           self.outcome_generated_at = outcome_generated_at
           self.scores = scores || {}
           self.actions = actions || {}
@@ -135,7 +146,8 @@ module Quby
             created_at: created_at,
             updated_at: updated_at,
             started_at: started_at,
-            completed_at: completed_at,
+            entered_at: entered_at,
+            observation_time: observation_time,
             outcome_generated_at: outcome_generated_at,
             scores: scores,
             actions: actions,
@@ -163,7 +175,8 @@ module Quby
         def mark_completed(start_time)
           if completed? || @aborted
             self.started_at = start_time if started_at.blank?
-            self.completed_at = Time.now if completed_at.blank?
+            self.entered_at ||= Time.now
+            self.observation_time ||= entered_at
           end
         end
 

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

@@ -15,12 +15,12 @@ module Quby
           @birthdate = attributes[:birthdate]
         end
 
-        # returns the age at the given completed_at, as an integer
+        # returns the age at the given observation_time, 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 birthdate && completed_at
-          ((completed_at - birthdate) / 1.year).floor
+        def age_at(observation_time)
+          return nil unless birthdate && observation_time
+          ((observation_time - birthdate) / 1.year).floor
         end
 
         def birthdate

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

@@ -44,7 +44,8 @@ module Quby
           record.import_notes         = answer.import_notes.stringify_keys
           record.value                = answer.value.stringify_keys
           record.started_at           = answer.started_at
-          record.completed_at         = answer.completed_at
+          record.entered_at           = answer.entered_at
+          record.observation_time     = answer.observation_time
           record.outcome_generated_at = answer.outcome_generated_at
           record.scores               = answer.scores.stringify_keys
           record.actions              = answer.actions.stringify_keys

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

@@ -16,13 +16,6 @@ module Quby
           @path = Pathname.new(path).expand_path
         end
 
-        def find_completed_after(time, answer_ids)
-          records = storage.map { |filename| load_file(filename) }.select do |record|
-            answer_ids.include?(record._id) && record.completed_at.present? && record.completed_at > time
-          end
-          records.map { |record| entity(record) }
-        end
-
         private
 
         def all_records(questionnaire_key)

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

@@ -9,13 +9,6 @@ module Quby
         class Record < OpenStruct
         end
 
-        def find_completed_after(time, answer_ids)
-          records = storage.values.select do |record|
-            answer_ids.include?(record._id) && record.completed_at.present? && record.completed_at > time
-          end
-          records.map { |record| entity(record) }
-        end
-
         private
 
         def all_records(questionnaire_key)

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

@@ -31,8 +31,9 @@ module Quby
             scores:               given_attributes.fetch(:scores,               {}),
             actions:              given_attributes.fetch(:actions,              {}),
             completion:           given_attributes.fetch(:completion,           {}),
-            started_at:           given_attributes.fetch(:started_at, nil),
-            completed_at:         given_attributes.fetch(:completed_at,         nil),
+            started_at:           given_attributes.fetch(:started_at,           nil),
+            entered_at:           given_attributes.fetch(:entered_at,           nil),
+            observation_time:     given_attributes.fetch(:observation_time,     nil),
             flags:                calculate_flags,
             textvars:             calculate_textvars,
             value:                calculate_value

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

@@ -24,7 +24,7 @@ module Quby
             begin
               result = ScoreCalculator.calculate(questionnaire: answer.questionnaire,
                                                  values: value_by_regular_values,
-                                                 completed_at: completed_at,
+                                                 observation_time: answer.observation_time,
                                                  patient_attrs: patient&.slice("birthyear", "birthdate", "gender"),
                                                  respondent_attrs: patient&.slice("respondent_type"),
                                                  &calculation.calculation)
@@ -79,10 +79,6 @@ module Quby
           end.to_h
         end
 
-        def completed_at
-          answer.completed_at
-        end
-
         def patient
           answer.patient
         end

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

@@ -40,7 +40,7 @@ module Quby
         #
         # values - The Hash values describes the keys of questions and the values
         #          of the answer given to that question.
-        # completed_at - The Time to be used to calculate the age of the patient.
+        # observation_time - The Time to be used to calculate the age of the patient.
         # patient_attrs - A Hash describing extra patient information (default: {})
         #           :birthyear - The Integer birthyear of the patient to be used in
         #                        score calculation (optional)
@@ -48,10 +48,10 @@ module Quby
         #                     :male, :female or :unknown (optional)
         # respondent_attrs - A Hash describing respondent information (default: {})
         #           :respondent_type - The Symbol or String type of respondent
-        def initialize(questionnaire:, values:, completed_at:, patient_attrs: {}, respondent_attrs: {})
+        def initialize(questionnaire:, values:, observation_time:, patient_attrs: {}, respondent_attrs: {})
           @questionnaire = questionnaire
           @values = values
-          @completed_at = completed_at
+          @observation_time = observation_time
           @patient = Entities::Patient.new(patient_attrs)
           @respondent = Entities::Respondent.new(respondent_attrs)
           @score = {}
@@ -206,17 +206,17 @@ module Quby
         # Public: Returns false if response was completed before the given date, true if on or after
         # completed_on_or_after input could be a Date, e.g. `Date::new(2020,1,30)`
         def observed_on_or_after(date)
-          @completed_at >= date
+          @observation_time >= date
         end
 
         # Public: Returns initial completion date, for manual comparisons. Preferably use observed_on_or_after instead,
         def observation_time
-          @completed_at
+          @observation_time
         end
 
         # Public: Returns the Integer age of the patient, or nil if it's not known.
         def age
-          @patient.age_at @completed_at
+          @patient.age_at @observation_time
         end
 
         # Public: Returns the Symbol describing the gender of the patient.
@@ -241,6 +241,17 @@ module Quby
           instance_eval(&calculation.calculation)
         end
 
+        def get_subscore(score_key, subscore_key)
+          fail "Score #{score_key} does not exist" unless @questionnaire.score_schemas.key?(score_key)
+          fail "Subscore #{subscore_key} for #{score_key} does not exist" unless @questionnaire.score_schemas[score_key].subscore(subscore_key)
+
+          # Must match with QubyCompilers ScoreSchemaBuilder internals.
+          # Annoying and ugly but all of these `variable :foo do` blocks in the definitions are too,
+          # and because score() will check the existence, this shouldn't fail silently
+          calculation_key = :"_#{score_key}.#{subscore_key}"
+          score(calculation_key)
+        end
+
         def referenced_values
           @values.keys.select { |key| @referenced_values.include? key }
         end
@@ -257,6 +268,7 @@ module Quby
         # Way to test and warn about age/gender requirements for subscore calculation.
         # If all given arguments are matched, the block is yielded.
         # If an argument is given but does not match an outcome_warning is added to the score.
+        # Returns value of block if a match, nil otherwise
         # May be called multiple times per score.
         # ages - range or array of Ranges of valid ages
         # genders - array of Symbols for genders we can calculate for (:male, :female, :unknown)

data/lib/quby/answers/specs/api_specs.rb

@@ -24,15 +24,6 @@ if defined?(RSpec)
       expect(api.all('simple').map(&:id).sort).to eq([answer, other_answer].map(&:id).sort)
     end
 
-    it 'supports finding all answers completed after some date' do
-      answer.completed_at = 3.days.ago
-      repo.update! answer
-      recent_answer     = api.create! 'simple', completed_at: 1.day.ago
-      incomplete_answer = api.create! 'simple'
-      answer_ids = [answer, recent_answer, incomplete_answer].map(&:id).sort
-      expect(api.find_completed_after(2.days.ago, answer_ids).map(&:id).sort).to eq([recent_answer.id])
-    end
-
     it 'supports creating an answer' do
       expect(api.create!('simple').id).to eq(repo.all('simple').first.id)
     end

data/lib/quby/answers/specs/repo_specs.rb

@@ -17,7 +17,8 @@ if defined?(RSpec)
         active:               true,
         test:                 false,
         started_at:           Time.local(2014, 1, 2, 3, 4, 0),
-        completed_at:         Time.local(2014, 1, 2, 3, 4, 5),
+        entered_at:           Time.local(2014, 1, 2, 3, 4, 5),
+        observation_time:     Time.local(2014, 1, 1, 3, 4, 5),
         outcome_generated_at: Time.local(2014, 1, 2, 3, 6, 7),
         scores:               {tot: {label: 'Totaalscore', value: 20}},
         actions:              {attention: [:v_1], alarm: []},
@@ -72,7 +73,8 @@ if defined?(RSpec)
         answer.active               = attributes[:active]
         answer.test                 = attributes[:test]
         answer.started_at           = attributes[:started_at]
-        answer.completed_at         = attributes[:completed_at]
+        answer.entered_at           = attributes[:entered_at]
+        answer.observation_time     = attributes[:observation_time]
         answer.outcome_generated_at = attributes[:outcome_generated_at]
         answer.scores               = attributes[:scores]
         answer.actions              = attributes[:actions]
@@ -100,19 +102,6 @@ if defined?(RSpec)
       end
     end
 
-    describe 'retrieving all records' do
-      it 'finds records updated since some time' do
-        answer1 = api.create!('simple')
-        answer2 = api.create!('simple', completed_at: 4.days.ago)
-        answer3 = api.create!('simple', completed_at: 1.days.ago)
-        answer4 = api.create!('simple', completed_at: 1.days.ago)
-
-        results = repo.find_completed_after(2.days.ago, [answer1.id, answer2.id, answer3.id]).to_a
-        expect(results.map(&:id)).to eq([answer3.id])
-        expect(results.map(&:id)).not_to include(answer4.id)
-      end
-    end
-
     def verify(record)
       expect(record.questionnaire_key).to    eq('simple')
       expect(record.raw_params).to           eq(stringified(attributes[:raw_params]))
@@ -121,7 +110,8 @@ if defined?(RSpec)
       expect(record.active).to               eq(true)
       expect(record.test).to                 eq(false)
       expect(record.started_at).to           eq(attributes[:started_at])
-      expect(record.completed_at).to         eq(attributes[:completed_at])
+      expect(record.entered_at).to           eq(attributes[:entered_at])
+      expect(record.observation_time).to     eq(attributes[:observation_time])
       expect(record.outcome_generated_at).to eq(attributes[:outcome_generated_at])
       expect(record.scores).to               eq(stringified(attributes[:scores]))
       expect(record.actions).to              eq(stringified(attributes[:actions]))

data/lib/quby/inspect_except.rb

@@ -0,0 +1,15 @@
+# Overrides inspect to exclude given attributes
+#
+# usage: `include InspectExcept.new(:@foo, :@bar)
+class Quby::InspectExcept < Module
+  def initialize(*excepts)
+    define_method :inspect do
+      prefix = "#<#{self.class}:0x#{self.__id__.to_s(16)}"
+
+      parts = (instance_variables - excepts).map do |var|
+        "#{var}=#{instance_variable_get(var).inspect}"
+      end
+      "#{prefix}\n #{parts.join(", ")}>"
+    end
+  end
+end

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

@@ -6,6 +6,8 @@ module Quby
   module Questionnaires
     module Entities
       class Question < Item
+        include ::Quby::InspectExcept.new(*%i[@dependencies @options @questionnaire @table @validations])
+
         MARKDOWN_ATTRIBUTES = %w(description title).freeze
 
         # Standard attributes

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

@@ -4,6 +4,8 @@ module Quby
   module Questionnaires
     module Entities
       class QuestionOption
+        include ::Quby::InspectExcept.new(:@question, :@questions)
+
         MARKDOWN_ATTRIBUTES = %w(description).freeze
 
         attr_reader :key

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

@@ -14,6 +14,8 @@ module Quby
   module Questionnaires
     module Entities
       class Questionnaire
+        include ::Quby::InspectExcept.new(*%i[@attributes @charts @fields @flags @panels @questions @sourcecode @score_calculations @score_schemas @textvars])
+
         extend  ActiveModel::Naming
         include ActiveModel::Validations
 

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

@@ -30,6 +30,10 @@ module Quby
           self.subscore_schemas = subscore_schemas&.map { |suboptions| Entities::SubscoreSchema.new suboptions }
         end
 
+        def subscore(key)
+          subscore_schemas.find { _1.key == key.to_sym }
+        end
+
         def export_key_labels
           subscore_schemas.map { |schema| [schema.export_key, schema.label] }.to_h.with_indifferent_access
         end

data/lib/quby/questionnaires/entities.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'quby/inspect_except'
 require 'quby/questionnaires/entities/definition'
 require 'quby/questionnaires/entities/questionnaire'
 require 'quby/questionnaires/entities/question_option'

data/lib/quby/version.rb

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

data/spec/features/age_calculation_spec.rb

@@ -6,7 +6,7 @@ module Quby
     it 'can access age in a real score calculation' do
       answer  = Quby.answers.create!('aged_score_interpretations',
                                      patient: {"birthyear" => Time.zone.now.year - 18, "gender" => :male},
-                                     completed_at: Time.now)
+                                     observation_time: Time.now)
 
       outcome = Quby.answers.generate_outcome(answer)
       expect(outcome.scores).to eq({"tot" => {"label" => "Totaalscore",

data/spec/features/analytics_spec.rb

@@ -22,7 +22,7 @@ feature 'Analytics' do
       end
 
       expect(Quby.answers.reload(answer).started_at).to   eq(time_opened)
-      expect(Quby.answers.reload(answer).completed_at).to eq(time_completed)
+      expect(Quby.answers.reload(answer).entered_at).to eq(time_completed)
     end
   end
 end