quby 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59b0f189b072474f798a633656ce452b1d3ec39b7a02e8739d3463f9163694d2
-  data.tar.gz: bdd06e8a1c7393482e522b590d61dc7678bea7cd453bf0e7ad29542278417d62
+  metadata.gz: e2eb8296e80cb8b61b38a33c9e462b6bbad21b7a63b4e9f6ad5826b850df4466
+  data.tar.gz: aa7fb433ee7daeb63c03ca2f5aa02afcec788f5d0d9282d92c44a56e052e66cc
 SHA512:
-  metadata.gz: a2f1d264914199c1552167ab37696a5fe9ed5f04fcb900980b34cefcdc27fb1a88de62de5f01d904d87efd9cb78c82c333999f13a9be79aa84351ecdcb80e1c9
-  data.tar.gz: 955464e21cbb604a951ffbdf35c1349db2a50260998945c3b43aeedb91d2104b963be340c9cb11400b37d983babd1571e915a86bfbd2bccff4717506c4280bb1
+  metadata.gz: 3b011248a70f0a10cdd2eb9898bc01065f6d60c9f4ac8035cd51aae76a431b8e6f6a53ecd4a7da94d0c79966d30d348d72b286c55dfe2a4c037aebd8c9cd6f0c
+  data.tar.gz: '08b7f5cb836b4cf03ccb3df3399b0c72baf897d246fc2d65ce63f34d7645d8ad6f768b512fe0939c812dc873ca49fba8ea7b4f1ec71f5fa3fad923d65d325e94'

data/README.markdown

@@ -45,13 +45,22 @@ To generate PDF files, the html_to_pdf docker container must be running and an e
 ENV['HTML_TO_PDF_URL']      = 'http://127.0.0.1:7768'
 ```
 
+## Docker
+
+```bash
+docker-compose build
+docker-compose run test appraisal install # generate lockfiles in mounted local gemfiles. alernatively remove volume.
+docker-compose run --rm test bundle exec appraisal rails60 rspec
+docker-compose run --rm test bundle exec appraisal rails60 teaspoon -r spec/teaspoon_env.rb
+```
+
 ## Testing
 
 When testing with guard or teaspoon, choose the Rails version you want to use and set the teaspoon environment:
 
 ```ruby
-bundle exec appraisal rails52 bundle # install dependencies for Rails 5.2
-TEASPOON_RAILS_ENV=test bundle exec appraisal rails52 guard
+bundle exec appraisal rails60 bundle # install dependencies for Rails 6.0
+TEASPOON_RAILS_ENV=test bundle exec appraisal rails60 guard
 ```
 
 ## Contributing to Quby

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

@@ -309,7 +309,9 @@
     var hidden = 0;
 
     for(var i = 0; i < groupItems.length; i++){
-      var inputs = $(groupItems[i]).find("input, textarea, select").not(":disabled, :hidden");
+      var inputs = $(groupItems[i]).find("input, textarea, select").not(":disabled, :hidden")
+              .add($(groupItems[i]).find("input.made-slider:hidden")); // slider inputs
+
       if (inputs.length == 0) {
         hidden++;
       } else {

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

@@ -61,7 +61,7 @@ module Quby
         end
 
         def entity(record)
-          entity_class.new(record.to_h).tap(&:enhance_by_dsl)
+          entity_class.new(**record.to_h).tap(&:enhance_by_dsl)
         end
       end
     end

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

@@ -40,7 +40,7 @@ module Quby
         end
 
         def entity(record)
-          entity_class.new(record.to_h).tap(&:enhance_by_dsl)
+          entity_class.new(**record.to_h).tap(&:enhance_by_dsl)
         end
       end
     end

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

@@ -126,6 +126,11 @@ module Quby
         end
 
         def validate_regexp(question, validation, value)
+          # We have decided not to allow bypassing this validation when
+          # aborted, since whatever is using this data further on is likely not
+          # built to take into account values that do not conform to the given
+          # format.
+
           return if value.blank?
           match = validation[:matcher].match(value)
           unless match && match[0] == value
@@ -134,6 +139,11 @@ module Quby
         end
 
         def validate_minimum(question, validation, value)
+          # We have decided not to allow bypassing this validation when
+          # aborted, since whatever is using this data further on is likely not
+          # built to take into account values outside the intended range. (e.g.
+          # BMI calculation)
+
           return if value.blank? || (question.type == :date && value.values.all?(&:empty?))
           converted_answer_value = convert_answer_value(question, value)
           if converted_answer_value < validation[:value]
@@ -142,7 +152,13 @@ module Quby
         end
 
         def validate_maximum(question, validation, value)
+          # We have decided not to allow bypassing this validation when
+          # aborted, since whatever is using this data further on is likely not
+          # built to take into account values outside the intended range. (e.g.
+          # BMI calculation)
+
           return if value.blank? || (question.type == :date && value.values.all?(&:blank?))
+
           converted_answer_value = convert_answer_value(question, value)
           if converted_answer_value > validation[:value]
             answer.send(:add_error, question, validation[:type], validation[:message] || "Exceeds maximum")
@@ -150,12 +166,24 @@ module Quby
         end
 
         def validate_too_many_checked(question, validation, value)
+          # We have decided not to allow bypassing this validation when
+          # aborted, since it's possible to make a decision about which fields
+          # to keep and which ones to blank. If you want to do anything at all
+          # with this completion, you'll need to decide that at some point
+          # anyway, so we think it's best to do that as early as possible.
+
           if answer.send(question.uncheck_all_option) == 1 and value.values.reduce(:+) > 1
             answer.send(:add_error, question, :too_many_checked, validation[:message] || "Invalid combination of options.")
           end
         end
 
         def validate_not_all_checked(question, validation, value)
+          # We have decided not to allow bypassing this validation when
+          # aborted, since it's possible to make a decision about which fields
+          # to keep and which ones to blank. If you want to do anything at all
+          # with this completion, you'll need to decide that at some point
+          # anyway, so we think it's best to do that as early as possible.
+
           if answer.send(question.check_all_option) == 1 and
               value.values.reduce(:+) < value.length - (question.uncheck_all_option ? 1 : 0)
             answer.send(:add_error, question, :not_all_checked, validation[:message] || "Invalid combination of options.")
@@ -163,18 +191,28 @@ module Quby
         end
 
         def validate_maximum_checked_allowed(question, validation, value)
+          # We have decided not to allow bypassing this validation when
+          # aborted, since it's possible to make a decision about which fields
+          # to keep and which ones to blank. If you want to do anything at all
+          # with this completion, you'll need to decide that at some point
+          # anyway, so we think it's best to do that as early as possible.
+
           if value.values.reduce(:+) > question.maximum_checked_allowed.to_i
             answer.send(:add_error, question, :maximum_checked_allowed, validation[:message] || "Too many options checked.")
           end
         end
 
         def validate_minimum_checked_required(question, validation, value)
+          return if @answer.aborted
+
           if value.values.reduce(:+) < question.minimum_checked_required.to_i
             answer.send(:add_error, question, :minimum_checked_required, validation[:message] || "Not enough options checked.")
           end
         end
 
         def validate_answer_group_minimum(question, validation, value)
+          return if @answer.aborted
+
           answered = answer.send(:calc_answered, answer.question_groups[validation[:group]])
           if answered < validation[:value]
             answer.send(:add_error, question, :answer_group_minimum,
@@ -183,6 +221,12 @@ module Quby
         end
 
         def validate_answer_group_maximum(question, validation, value)
+          # We have decided not to allow bypassing this validation when
+          # aborted, since it's possible to make a decision about which fields
+          # to keep and which ones to blank. If you want to do anything at all
+          # with this completion, you'll need to decide that at some point
+          # anyway, so we think it's best to do that as early as possible.
+
           answered = answer.send(:calc_answered, answer.question_groups[validation[:group]])
           if answered > validation[:value]
             answer.send(:add_error, question, :answer_group_maximum,

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

@@ -13,7 +13,7 @@ module Quby
         end
 
         def build
-          Quby::Answers::Entities::Answer.new(attributes)
+          Quby::Answers::Entities::Answer.new(**attributes)
         end
 
         private

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

@@ -12,7 +12,8 @@ module Quby
         class MissingAnswerValues < StandardError
           attr_reader :questionnaire_key, :values, :missing
 
-          def initialize(questionnaire_key:, values:, missing:)
+          def initialize(msg = nil, questionnaire_key:, values:, missing:)
+            super(msg)
             @questionnaire_key = questionnaire_key
             @values = values
             @missing = missing
@@ -21,8 +22,8 @@ module Quby
 
         # Evaluates block within the context of a new calculator
         # instance. All instance methods are accessible.
-        def self.calculate(*args, &block)
-          instance = new(*args)
+        def self.calculate(**kwargs, &block)
+          instance = new(**kwargs)
           result = instance.instance_eval(&block)
           result = result.merge(referenced_values: instance.referenced_values) if result.respond_to?(:merge)
           result
@@ -246,9 +247,10 @@ module Quby
           unanswered_keys = keys.select { |key| missing_value?(@values[key], missing_values: missing_values) }
 
           if unanswered_keys.size > keys.size - minimum_present
-            fail MissingAnswerValues, questionnaire_key: @questionnaire.key,
-                                      values: @values,
-                                      missing: unanswered_keys
+            raise MissingAnswerValues.new \
+                    questionnaire_key: @questionnaire.key,
+                    values: @values,
+                    missing: unanswered_keys
           end
         end
 

data/lib/quby/questionnaires/deserializer.rb

@@ -378,17 +378,22 @@ module Quby
           tick_interval: chart_json.fetch("tick_interval"),
           plotbands: chart_json.fetch("plotbands").map do |plotband_json|
             {
-              color: plotband_json.fetch("color").to_sym,
+              color: plotband_json.fetch("color"),
               from: plotband_json.fetch("from"),
               to: plotband_json.fetch("to")
             }
           end,
+          plotlines: chart_json.fetch("plotlines") { [] }.map do |plotline_json|
+            {
+              color: plotline_json.fetch("color"),
+              value: plotline_json.fetch("value")
+            }
+          end
         }
 
         case chart_json.fetch("type")
         when "bar_chart"
           Quby::Questionnaires::Entities::Charting::BarChart.new(chart_json.fetch("key").to_sym,
-            plotlines: chart_json.fetch("plotlines"),
             **base_args
           )
         when "line_chart"
@@ -400,8 +405,7 @@ module Quby
             **base_args
           )
         when "radar_chart"
-          Quby::Questionnaires::Entities::Charting::BarChart.new(chart_json.fetch("key").to_sym,
-            plotlines: chart_json.fetch("plotlines"),
+          Quby::Questionnaires::Entities::Charting::RadarChart.new(chart_json.fetch("key").to_sym,
             **base_args
           )
         end

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

@@ -7,12 +7,8 @@ module Quby
     module Entities
       module Charting
         class BarChart < Chart
-          # @return [Array]
-          attr_accessor :plotlines
-
-          def initialize(key, plotlines: nil, **kwargs)
+          def initialize(key, **kwargs)
             super(key, **kwargs)
-            self.plotlines = plotlines || []
           end
         end
       end

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

@@ -60,7 +60,10 @@ module Quby
           # @return [Array]
           attr_accessor :plotbands
 
-          def initialize(key, title: nil, plottables: nil, y_categories: nil, y_range_categories: nil, chart_type: nil, y_range: nil, tick_interval: nil, plotbands: nil)
+          # @return [Array]
+          attr_accessor :plotlines
+
+          def initialize(key, title: nil, plottables: nil, y_categories: nil, y_range_categories: nil, chart_type: nil, y_range: nil, tick_interval: nil, plotbands: nil, plotlines: nil)
             self.key = key.to_sym
             self.title = title
             self.plottables = plottables || []
@@ -70,6 +73,7 @@ module Quby
             self.y_range = y_range
             self.tick_interval = tick_interval
             self.plotbands = plotbands || []
+            self.plotlines = plotlines || []
           end
 
           def type

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

@@ -7,12 +7,8 @@ module Quby
     module Entities
       module Charting
         class RadarChart < Chart
-          # @return [Array]
-          attr_accessor :plotlines
-
-          def initialize(key, plotlines: nil, **kwargs)
+          def initialize(key, **kwargs)
             super(key, **kwargs)
-            self.plotlines = plotlines || []
           end
         end
       end

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

@@ -273,7 +273,7 @@ module Quby
           end
           flag_options[:key] = flag_key
           fail(ArgumentError, "Flag '#{flag_key}' already defined") if flags.key?(flag_key)
-          flags[flag_key] = Flag.new(flag_options)
+          flags[flag_key] = Flag.new(**flag_options)
         end
 
         def filter_flags(given_flags)

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

@@ -2,18 +2,20 @@
 
 if defined?(RSpec)
   RSpec.shared_examples 'a valid backend for the questionnaires api' do
+    let(:api) { Quby::Questionnaires::API.new(questionnaire_repo: repo) }
+
     it 'supports finding a questionnaire' do
-      expect(Quby.questionnaires.find('simple').key).to eq('simple')
+      expect(api.find('simple').key).to eq('simple')
     end
 
     it 'supports checking whether a questionnaire exists' do
-      expect(Quby.questionnaires.exists? 'simple').to be_truthy
-      expect(Quby.questionnaires.exists? 'inexistant_questionnaire').to be_falsey
+      expect(api.exists? 'simple').to be_truthy
+      expect(api.exists? 'inexistant_questionnaire').to be_falsey
     end
 
     it 'supports finding all questionnaires' do
-      expect(Quby.questionnaires.all.map(&:key)).to include('simple')
-      expect(Quby.questionnaires.all.map(&:key)).to include('simple_with_outcome')
+      expect(api.all.map(&:key)).to include('simple')
+      expect(api.all.map(&:key)).to include('simple_with_outcome')
     end
   end
 end

data/lib/quby/version.rb

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

data/spec/features/charts_spec.rb

@@ -25,8 +25,15 @@ feature 'Defining charts in a questionnaire' do
   it 'supports plotbands' do
     plotbands = questionnaire_with_chart.charts.first.plotbands
     expect(plotbands).to eq([
-      {from: 30, to: 50, color: :yellow},
-      {from: 50, to: 80, color: :red}
+      {from: 30, to: 50, color: "yellow"},
+      {from: 50, to: 80, color: "red"}
+    ])
+  end
+
+  it 'supports plotlines' do
+    plotlines = questionnaire_with_chart.charts.first.plotlines
+    expect(plotlines).to eq([
+      {value: 20, color: "green"}
     ])
   end
 end

data/spec/features/editing_completed_answer_spec.rb

@@ -25,7 +25,7 @@ feature 'Editing a completed answer' do
     expect(find('#answer_v_1_a2')).to be_checked
 
     # make sure subquestions of selected answers are enabled
-    expect(find('#answer_v_1_a2_val')[:disabled]).to be_falsey
-    expect(find('#answer_v_1_a1_val')[:disabled]).to be_truthy
+    expect(find('#answer_v_1_a2_val')[:disabled]).to eq 'false'
+    expect(find('#answer_v_1_a1_val')[:disabled]).to eq 'true'
   end
 end

data/spec/features/hiding_questions_spec.rb

@@ -66,7 +66,7 @@ feature 'Hiding and showing questions' do
     end
 
     scenario 'by visiting an answer with a flag that hides a question set to true', js: true do
-      answer = create_new_answer_for(questionnaire, {}, flags: {question_hiding_hides_flag: true})
+      answer = create_new_answer_for(questionnaire, flags: {question_hiding_hides_flag: true})
       visit_new_answer_for(questionnaire, "paged", answer)
       expect(page).to have_selector("#item_v_7.hide", visible: false)
     end
@@ -250,7 +250,7 @@ feature 'Hiding and showing questions' do
     end
 
     scenario 'by visiting an answer with a flag that shows a question set to true', js: true do
-      answer = create_new_answer_for(questionnaire, {}, flags: {question_hiding_shows_flag: true})
+      answer = create_new_answer_for(questionnaire, flags: {question_hiding_shows_flag: true})
       visit_new_answer_for(questionnaire, "paged", answer)
       goto_second_page
       expect(page).to have_selector("[data-for=v_9].show", count: 8)

data/spec/features/question_dependencies/group_maximum_answered_spec.rb

@@ -64,6 +64,13 @@ shared_examples 'group_maximum_answered_tests' do
     expect_saved_value 'v_date_day', "10"
   end
 
+  it 'is valid when only slider question filled in' do
+    set_slider_value('v_slider', '50')
+    run_validations
+    expect_no_errors
+    # expect_saved_value 'v_slider', "50" # occasional client side rounding issue :S
+  end
+
   it 'is valid when only radio question is not filled' do
     # select_radio_option 'v_radio', 'a1'
     select_radio_option 'v_scale', 'a1'
@@ -76,6 +83,7 @@ shared_examples 'group_maximum_answered_tests' do
     fill_in_question('v_date_year',  '2013')
     fill_in_question('v_date_month', '12')
     fill_in_question('v_date_day',   '10')
+    set_slider_value('v_slider', '50')
     run_validations
     expect_no_errors
     # expect_saved_value 'v_radio', 'a1'
@@ -102,6 +110,7 @@ shared_examples 'group_maximum_answered_tests' do
     fill_in_question('v_date_year',  '2013')
     fill_in_question('v_date_month', '12')
     fill_in_question('v_date_day',   '10')
+    set_slider_value('v_slider', '50')
     run_validations
     expect_no_errors
     expect_saved_value 'v_radio', 'a1'
@@ -128,6 +137,7 @@ shared_examples 'group_maximum_answered_tests' do
     fill_in_question('v_date_year',  '2013')
     fill_in_question('v_date_month', '12')
     fill_in_question('v_date_day',   '10')
+    set_slider_value('v_slider', '50')
     run_validations
     expect_no_errors
     expect_saved_value 'v_radio', 'a1'
@@ -154,6 +164,7 @@ shared_examples 'group_maximum_answered_tests' do
     fill_in_question('v_date_year',  '2013')
     fill_in_question('v_date_month', '12')
     fill_in_question('v_date_day',   '10')
+    set_slider_value('v_slider', '50')
     run_validations
     expect_no_errors
     expect_saved_value 'v_radio', 'a1'
@@ -180,6 +191,7 @@ shared_examples 'group_maximum_answered_tests' do
     fill_in_question('v_date_year',  '2013')
     fill_in_question('v_date_month', '12')
     fill_in_question('v_date_day',   '10')
+    set_slider_value('v_slider', '50')
     run_validations
     expect_no_errors
     expect_saved_value 'v_radio', 'a1'
@@ -206,6 +218,7 @@ shared_examples 'group_maximum_answered_tests' do
     fill_in_question('v_date_year',  '2013')
     fill_in_question('v_date_month', '12')
     fill_in_question('v_date_day',   '10')
+    set_slider_value('v_slider', '50')
     run_validations
     expect_no_errors
     expect_saved_value 'v_radio', 'a1'
@@ -232,6 +245,7 @@ shared_examples 'group_maximum_answered_tests' do
     fill_in_question('v_date_year',  '2013')
     fill_in_question('v_date_month', '12')
     fill_in_question('v_date_day',   '10')
+    set_slider_value('v_slider', '50')
     run_validations
     expect_no_errors
     expect_saved_value 'v_radio', 'a1'
@@ -258,6 +272,7 @@ shared_examples 'group_maximum_answered_tests' do
     # fill_in_question('v_date_year',  '2013')
     # fill_in_question('v_date_month', '12')
     # fill_in_question('v_date_day',   '10')
+    set_slider_value('v_slider', '50')
     run_validations
     expect_no_errors
     expect_saved_value 'v_radio', 'a1'
@@ -272,6 +287,33 @@ shared_examples 'group_maximum_answered_tests' do
     # expect_saved_value 'v_date_day', "10"
   end
 
+  it 'is valid when only slider question is not filled' do
+    select_radio_option 'v_radio', 'a1'
+    select_radio_option 'v_scale', 'a1'
+    select_select_option 'v_select', 'a1'
+    check_option 'v_ck_a1'
+    uncheck_option 'v_ck_a2'
+    fill_in_question 'v_string', 'kittens!'
+    fill_in_question 'v_integer', '37'
+    fill_in_question 'v_float', '4.2'
+    fill_in_question('v_date_year',  '2013')
+    fill_in_question('v_date_month', '12')
+    fill_in_question('v_date_day',   '10')
+    # set_slider_value('v_slider', '50')
+    run_validations
+    expect_no_errors
+    expect_saved_value 'v_radio', 'a1'
+    expect_saved_value 'v_scale', 'a1'
+    expect_saved_value 'v_select', 'a1'
+    expect_saved_value 'v_check_box', {'v_ck_a1' => 1, 'v_ck_a2' => 0}
+    expect_saved_value 'v_string', 'kittens!'
+    expect_saved_value 'v_integer', "37"
+    expect_saved_value 'v_float', "4.2"
+    expect_saved_value 'v_date_year', "2013"
+    expect_saved_value 'v_date_month', "12"
+    expect_saved_value 'v_date_day', "10"
+  end
+
   it 'is not valid when all questions are filled in' do
     select_radio_option 'v_radio', 'a1'
     select_radio_option 'v_scale', 'a1'
@@ -284,6 +326,7 @@ shared_examples 'group_maximum_answered_tests' do
     fill_in_question('v_date_year',  '2013')
     fill_in_question('v_date_month', '12')
     fill_in_question('v_date_day',   '10')
+    set_slider_value('v_slider', '50')
     run_validations
     expect_errors_on_group
   end
@@ -296,7 +339,7 @@ shared_examples 'group_maximum_answered' do
   context 'maximum number of given answers in a group' do
     let(:questionnaire) do
       inject_questionnaire 'test', <<-END
-        n = 7
+        n = 8
 
         panel do
           question :v_radio, type: :radio, question_group: :group1, group_maximum_answered: n do
@@ -340,6 +383,12 @@ shared_examples 'group_maximum_answered' do
                             year_key: :v_date_year, month_key: :v_date_month, day_key: :v_date_day do
             title "Enter a date"
           end
+
+          question :v_slider, type: :float, as: :slider, size: 20, default_position: :hidden,
+                              question_group: :group1, group_maximum_answered: n do
+            title "Slider"
+            validates_in_range 0..100
+          end
         end; end_panel
       END
     end
@@ -350,7 +399,7 @@ shared_examples 'group_maximum_answered' do
   context 'maximum number of given answers in a group, with a table in the mix' do
     let(:questionnaire) do
       inject_questionnaire 'test', <<-END
-        n = 7
+        n = 8
 
         panel do
           table columns: 20 do
@@ -396,6 +445,12 @@ shared_examples 'group_maximum_answered' do
               title "Enter a date"
             end
           end
+
+          question :v_slider, type: :float, as: :slider, size: 20, default_position: :hidden,
+                              question_group: :group1, group_maximum_answered: n do
+            title "Slider"
+            validates_in_range 0..100
+          end
         end; end_panel
       END
     end
@@ -427,6 +482,13 @@ shared_examples 'group_maximum_answered' do
             option :a1, value: 1, description: "Select Option 1"
             option :a2, value: 2, description: "Select Option 2"
           end
+
+          question :v_slider, type: :float, as: :slider, size: 20, default_position: :hidden,
+                              default_invisible: true,
+                              question_group: :grp1, group_maximum_answered: n do
+            title "Slider"
+            validates_in_range 0..100
+          end
         end; end_panel
       END
     end
@@ -448,6 +510,7 @@ shared_examples 'group_maximum_answered' do
     expect_error_on 'v_integer', 'answer_group_maximum'
     expect_error_on 'v_float', 'answer_group_maximum'
     expect_error_on 'v_date', 'answer_group_maximum'
+    expect_error_on 'v_slider', 'answer_group_maximum'
   end
 end