quby 5.0.0 → 5.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a0b61b70b821b00c262a58f7f7fb7ec04a33d4b26df7719be157d8f4015f823
-  data.tar.gz: 6b897f4f1e7867999c9dda5b0bbd39f6b5493945715edce8194d45beab809926
+  metadata.gz: a67424bdab14ce8f570e5e595dc58802061c049897617c36d17a84700fa48ce1
+  data.tar.gz: 298f5bd393f0aa58c9bdb8302fa35c9f615168c64adbc38427f64d74625c7fb9
 SHA512:
-  metadata.gz: 2595b285e0c4fd37dd708577bafbffc3c830194097d79ebb1c7784c6918f0a40cf4e4695e68cf0755cc7a09fb95a43beee4caebad495c141c61ac377fd90b637
-  data.tar.gz: b575e091c90af8581c044e6866cf5cb328bc513d0f24ba3453efffa212741012f31650bcd07f6fe1d1649fe80e85bd0ff6ebb3e5c03a8e753e7c656bead146be
+  metadata.gz: b267bd9f1df8cae932a0fd1359eb7551d3f6e5359eb63f7e8e8642317fae23f98870f15ad5a706f5a9ba39a3169043b9b9d8500e36030413194d926600f2cf1d
+  data.tar.gz: 20c2afb9a148fa86c197cdb3da6fd95ea84ce44a30e0b927357fb7752e9c9af263d2d81f39c5386fda955d17c734613214c89f2eed424436b24046a18b2529b0

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/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/questionnaires/deserializer.rb

@@ -153,6 +153,7 @@ module Quby
           table: table,
           col_span: item_json.fetch("col_span"),
           row_span: item_json.fetch("row_span"),
+          raw_content: item_json.fetch("raw_content", nil),
 
           # only selectable via options passed in DSL, not via DSL methods
           # many apply only to certain types of questions
@@ -377,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"
@@ -399,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
@@ -438,4 +443,4 @@ module Quby
       end
     end
   end
-end
+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/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.0"
+  VERSION = "5.0.5"
 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/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