Skip to content

Commit

Permalink
Fix for bugs in the Conditional Questions functionality:
Browse files Browse the repository at this point in the history
     - In case of conditional question with checkbox answers the removed
       questions were not being removed from view, nor was the answer to
    these questions (which persisted in the db.

    Changes:
    - Fixed the broken functionality in the method remove_answers_list in
      app/helpers/conditions_helper.rb.
    - Removed and destroyed the answers of the removed questions.
    - Added more tests for Conditional Questions functionality.
  • Loading branch information
John Pinto committed Sep 13, 2024
1 parent 56759df commit 184068d
Show file tree
Hide file tree
Showing 10 changed files with 607 additions and 4 deletions.
9 changes: 8 additions & 1 deletion app/controllers/answers_controller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,15 @@ def create_or_update
template = @section.phase.template

remove_list_after = remove_list(@plan)

all_question_ids = @plan.questions.pluck(:id)

# Destroy all answers for removed questions
remove_list_after.each do |id|
Answer.where(question_id: id, plan: @plan).each do |a|
Answer.destroy(a.id)
end
end

# rubocop pointed out that these variable is not used
# all_answers = @plan.answers
qn_data = {
Expand Down
2 changes: 1 addition & 1 deletion app/helpers/conditions_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def answer_remove_list(answer, user = nil)
opts = cond.option_list.map(&:to_i).sort
action = cond.action_type
chosen = answer.question_option_ids.sort
if chosen == opts
if !opts.empty? && !chosen.empty? && !(chosen & opts).empty?
if action == 'remove'
rems = cond.remove_data.map(&:to_i)
id_list += rems
Expand Down
4 changes: 3 additions & 1 deletion app/javascript/src/answers/edit.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
} from '../utils/isType';
import { Tinymce } from '../utils/tinymce.js';
import debounce from '../utils/debounce';
import { updateSectionProgress, getQuestionDiv } from '../utils/sectionUpdate';
import { updateSectionProgress, getQuestionDiv , deleteAllAnswersForQuestion } from '../utils/sectionUpdate';
import datePicker from '../utils/datePicker';
import TimeagoFactory from '../utils/timeagoFactory.js.erb';

Expand All @@ -23,7 +23,9 @@ $(() => {
updateSectionProgress(section.sec_id, section.no_ans, section.no_qns);
});
data.qn_data.to_hide.forEach((questionid) => {
deleteAllAnswersForQuestion(questionid);
getQuestionDiv(questionid).slideUp();

});
data.qn_data.to_show.forEach((questionid) => {
getQuestionDiv(questionid).slideDown();
Expand Down
29 changes: 29 additions & 0 deletions app/javascript/src/utils/sectionUpdate.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Tinymce } from '../utils/tinymce.js';

// update details in section progress panel
export const updateSectionProgress = (id, numSecAnswers, numSecQuestions) => {
const progressDiv = $(`#section-panel-${id}`).find('.section-status');
Expand Down Expand Up @@ -25,3 +27,30 @@ export const updateSectionProgress = (id, numSecAnswers, numSecQuestions) => {
// given a question id find the containing div
// used inconditional questions
export const getQuestionDiv = (id) => $(`#answer-form-${id}`).closest('.question-body');

// Clear an answers for a given question id.
export const deleteAllAnswersForQuestion = (questionid) => {
const answerFormDiv = $(`#answer-form-${questionid}`);
const editAnswerForm = $(`#answer-form-${questionid}`).find('.form-answer');

editAnswerForm.find('input:checkbox').prop('checked', false);
editAnswerForm.find('input:radio').prop('checked', false);
editAnswerForm.find('option').prop('selected', false);
editAnswerForm.find('input:text').text('');

// Get the TinyMce editor textarea and rest content to ''
const editorAnswerTextAreaId = `answer-text-${questionid}`;
const tinyMceAnswerEditor = Tinymce.findEditorById(editorAnswerTextAreaId);
if (tinyMceAnswerEditor) {
tinyMceAnswerEditor.setContent('');
}
// Date fields in form are input of type="date"
// The editAnswerForm.find('input:date') throws error, so
// we need an alternate way to reset date.
editAnswerForm.find('#answer_text').each ( (el) => {
if($(el).attr('type') === 'date') {
$(el).val('');
}

});
};
4 changes: 4 additions & 0 deletions app/models/condition.rb
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ class Condition < ApplicationRecord
def deep_copy(**options)
copy = dup
copy.question_id = options.fetch(:question_id, nil)
copy.option_list = options.fetch(:option_list, option_list)
copy.remove_data = options.fetch(:remove_data, remove_data)
copy.action_type = options.fetch(:action_type, action_type)
copy.action_type = options.fetch(:webhook_data, webhook_data)
# TODO: why call validate false here
copy.save!(validate: false) if options.fetch(:save, false)
copy
Expand Down
341 changes: 341 additions & 0 deletions spec/controllers/answers_controller_with_conditional_questions_spec.rb

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions spec/factories/answers.rb
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,11 @@
plan
user
question
trait :question_options do
question_options { [create(:question_option), create(:question_option)] }
end
trait :lock_version do
lock_version { 0 }
end
end
end
12 changes: 12 additions & 0 deletions spec/factories/conditions.rb
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,17 @@
factory :condition do
option_list { nil }
remove_data { nil }
action_type { nil }
# the webhook_data is a Json string of form:
# '{"name":"Joe Bloggs","email":"joe.bloggs@example.com","subject":"Large data volume","message":"A message."}'
webhook_data do
# Generates string from hash
JSON.generate({
name: Faker::Name.name,
email: Faker::Internet.email,
subject: Faker::Lorem.sentence(word_count: 4),
message: Faker::Lorem.paragraph(sentence_count: 2)
})
end
end
end
145 changes: 145 additions & 0 deletions spec/features/questions/conditions_questions_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
# frozen_string_literal: true

require 'rails_helper'

RSpec.describe 'Question::Conditions questions', type: :feature do
before do
@user = create(:user)
@template = create(:template, :default, :published)
@plan = create(:plan, :creator, template: @template)
@phase = create(:phase, template: @template)
@section = create(:section, phase: @phase)

# Different types of questions (than can have conditional options)
@checkbox_question = create(:question, :checkbox, section: @section, options: 5)
@radiobutton_question = create(:question, :radiobuttons, section: @section, options: 5)
@dropdown_question = create(:question, :dropdown, section: @section, options: 5)

create(:role, :creator, :editor, :commenter, user: @user, plan: @plan)
sign_in(@user)
end

# NOTE: Condition is only implemented for checkboxes, radio buttons and dropdowns. In these cases, currently
# the option_list only takes one option in the UI.
# As functionality for more than option per condition does not yet exist in code.
# So all Conditions are created with option_list with a single option id.

scenario 'User answers multiple options for a checkbox with conditional options', :js do
chk_condition1 = create(:condition, question: @checkbox_question,
option_list: [@checkbox_question.question_options[2].id],
action_type: 'remove',
remove_data: [create(:question, :dropdown, section: @section, options: 3).id,
create(:question, :date, section: @section).id,
create(:question, :textfield, section: @section).id])

chk_condition2 = create(:condition, question: @checkbox_question,
option_list: [@checkbox_question.question_options[1].id],
action_type: 'remove',
remove_data: [create(:question, :checkbox, section: @section, options: 3).id,
create(:question, :date, section: @section).id,
create(:question, :textfield, section: @section).id])

chk_condition3 = create(:condition, question: @checkbox_question,
option_list: [@checkbox_question.question_options[3].id],
action_type: 'remove',
remove_data: [create(:question, :radiobuttons, section: @section, options: 3).id,
create(:question, :rda_metadata, section: @section).id,
create(:question, :textarea,
section: @section).id])

visit overview_plan_path(@plan)

click_link 'Write plan'

find("#section-panel-#{@section.id}").click

save_screenshot
expect(page).to have_text('(0 / 12)')

within("#answer-form-#{@checkbox_question.id}") do
check @checkbox_question.question_options[2].text
click_button 'Save'
end

save_screenshot
expect(page).to have_text('Answered just now')
expect(page).not_to have_selector("#answer-form-#{chk_condition1.remove_data[0]}")
expect(page).to have_text('(1 / 9)')

within("#answer-form-#{@checkbox_question.id}") do
check @checkbox_question.question_options[1].text
click_button 'Save'
end

save_screenshot
expect(page).to have_text('Answered just now')
expect(page).not_to have_selector("#answer-form-#{chk_condition2.remove_data[2]}")
expect(page).to have_text('(1 / 6)')

# within("#answer-form-#{question2.id}") do
# select q2_options.last.text
# click_button 'Save'
# end

# expect(page).to have_text('Answered just now')
# expect(page).not_to have_selector("#answer-form-#{question5.id}")
# # As one question has been removed, the total of questions is 3
# expect(page).to have_text('(2 / 5)')
end

# scenario 'Conditions with multiple options selected', :js do
# question = create(:question, :checkbox, section: @section, options: 4)
# dependent_question = create(:question, :textfield, section: @section)

# options = question.question_options

# create(:condition, question: question,
# option_list: [options[0].id, options[1].id],
# action_type: 'remove',
# remove_data: [dependent_question.id])

# visit edit_plan_path(@plan)

# find("#section-panel-#{@section.id}").click

# within("#answer-form-#{question.id}") do
# check options[0].text
# check options[2].text
# click_button 'Save'
# end

# expect(page).to have_selector("#answer-form-#{dependent_question.id}")

# within("#answer-form-#{question.id}") do
# check options[1].text
# click_button 'Save'
# end

# expect(page).not_to have_selector("#answer-form-#{dependent_question.id}")
# end

# scenario 'User answers question', :js do
# # Setup
# visit overview_plan_path(@plan)

# # Action
# click_link 'Write plan'

# # Expectations
# expect(current_path).to eql(edit_plan_path(@plan))
# expect(page).to have_text('(4 / 5)')

# # # Action
# find("#section-panel-#{@section.id}").click
# # # Fill in the answer form...
# within("#answer-form-#{@questions[0].id}") do
# check @questions[0].question_options.first.text
# click_button 'Save'
# end

# # # Expectations
# # expect(page).to have_text 'Answered just now'
# # expect(page).to have_text '(1 / 1)'
# # expect(Answer.where(question_id: @question.id)).to be_any
# end
end
59 changes: 58 additions & 1 deletion spec/models/condition_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,62 @@
require 'rails_helper'

RSpec.describe Condition, type: :model do
pending "add some examples to (or delete) #{__FILE__}"
context 'associations' do
it { is_expected.to belong_to :question }
end

describe '.deep_copy with no options passed in.' do
let!(:question) { build(:question) }

let!(:condition) do
build(:condition, question: question, option_list: [1, 5],
action_type: 'remove',
remove_data: [7, 8, 9])
end

subject { condition.deep_copy }

it 'creates a new record' do
expect(subject).not_to eql(condition)
end
it 'copies the option_list attribute' do
expect(subject.option_list).to contain_exactly(1, 5)
end

it 'copies the action_type attribute' do
expect(subject.action_type).to eql('remove')
end

it 'copies the remove_data attribute' do
expect(subject.remove_data).to contain_exactly(7, 8, 9)
end
end

describe '.deep_copy with options passed in.' do
let!(:question) { build(:question) }

let!(:condition) do
build(:condition, question: question, option_list: [1, 5],
action_type: 'remove',
remove_data: [7, 8, 9])
end
let!(:options) { { option_list: [100, 101], action_type: 'remove', remove_data: [200, 220] } }

subject { condition.deep_copy(**options) }

it 'creates a new record' do
expect(subject).not_to eql(condition)
end
it 'replaces the option_list attribute with passed option_list' do
expect(subject.option_list).to contain_exactly(100, 101)
end

it 'replaces the action_type attribute with passed in action_type' do
expect(subject.action_type).to eql('remove')
end

it 'replaces the remove_data attribute with passed in remove_data' do
expect(subject.remove_data).to contain_exactly(200, 220)
end
end
end

0 comments on commit 184068d

Please sign in to comment.