Field Label
") + expect(field.image).to eq("field_image_url.png") + expect(field.description).to eq("Field description") + expect(field.required).to eq(true) + expect(field.key).to eq("field.locale.key") + expect(field.type).to eq("field_type") + expect(field.content).to eq([]) + end + it "registers custom field types" do expect(CustomWizard::Field.types[:location].present?).to eq(true) end diff --git a/spec/components/custom_wizard/step_spec.rb b/spec/components/custom_wizard/step_spec.rb new file mode 100644 index 00000000..bf4613a4 --- /dev/null +++ b/spec/components/custom_wizard/step_spec.rb @@ -0,0 +1,36 @@ +# frozen_string_literal: true +require_relative '../../plugin_helper' + +describe CustomWizard::Step do + let(:step_hash) do + JSON.parse( + File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/step/step.json" + ).read + ).with_indifferent_access + end + + let(:field_hash) do + JSON.parse( + File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/field/field.json" + ).read + ).with_indifferent_access + end + + before do + @step = CustomWizard::Step.new(step_hash[:id]) + end + + it "adds fields" do + @step.add_field(field_hash) + expect(@step.fields.size).to eq(1) + expect(@step.fields.first.index).to eq(0) + end + + it "adds fields with custom indexes" do + field_hash[:index] = 2 + @step.add_field(field_hash) + expect(@step.fields.first.index).to eq(2) + end +end diff --git a/spec/components/custom_wizard/wizard_spec.rb b/spec/components/custom_wizard/wizard_spec.rb index 57d15241..aed44fe6 100644 --- a/spec/components/custom_wizard/wizard_spec.rb +++ b/spec/components/custom_wizard/wizard_spec.rb @@ -1,4 +1,5 @@ # frozen_string_literal: true + require_relative '../../plugin_helper' describe CustomWizard::Wizard do @@ -7,27 +8,33 @@ describe CustomWizard::Wizard do fab!(:admin_user) { Fabricate(:user, admin: true) } let(:template_json) { - JSON.parse(File.open( - "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" - ).read) + JSON.parse( + File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read + ) } let(:permitted_json) { - JSON.parse(File.open( - "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard/permitted.json" - ).read) + JSON.parse( + File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard/permitted.json" + ).read + ) } before do Group.refresh_automatic_group!(:trust_level_3) - @permitted_template = template_json.dup @permitted_template["permitted"] = permitted_json["permitted"] - @wizard = CustomWizard::Wizard.new(template_json, user) + end + + def append_steps template_json['steps'].each do |step_template| @wizard.append_step(step_template['id']) end + @wizard.update_step_order! end def progress_step(step_id, acting_user: user, wizard: @wizard) @@ -37,16 +44,48 @@ describe CustomWizard::Wizard do context: wizard.id, subject: step_id ) + @wizard.update_step_order! end - it "appends steps from a template" do + it "appends steps" do + append_steps expect(@wizard.steps.length).to eq(3) end + it "appends steps with indexes" do + append_steps + expect(@wizard.steps.first.index).to eq(0) + expect(@wizard.steps.last.index).to eq(2) + end + + it "appends steps with custom indexes" do + template_json['steps'][0]['index'] = 2 + template_json['steps'][1]['index'] = 1 + template_json['steps'][2]['index'] = 0 + + template_json['steps'].each do |step_template| + @wizard.append_step(step_template['id']) do |step| + step.index = step_template['index'] if step_template['index'] + end + end + + expect(@wizard.steps.first.index).to eq(2) + expect(@wizard.steps.last.index).to eq(0) + + @wizard.update_step_order! + + expect(@wizard.steps.first.id).to eq("step_3") + expect(@wizard.steps.last.id).to eq("step_1") + + expect(@wizard.steps.first.next.id).to eq("step_2") + expect(@wizard.steps.last.next).to eq(nil) + end + it "determines the user's current step" do - expect(@wizard.start.id).to eq('step_1') + append_steps + expect(@wizard.start).to eq('step_1') progress_step('step_1') - expect(@wizard.start.id).to eq('step_2') + expect(@wizard.start).to eq('step_2') end it "creates a step updater" do @@ -57,6 +96,7 @@ describe CustomWizard::Wizard do end it "determines whether a wizard is unfinished" do + append_steps expect(@wizard.unfinished?).to eq(true) progress_step("step_1") expect(@wizard.unfinished?).to eq(true) @@ -67,6 +107,7 @@ describe CustomWizard::Wizard do end it "determines whether a wizard has been completed by a user" do + append_steps expect(@wizard.completed?).to eq(false) progress_step("step_1") progress_step("step_2") @@ -75,6 +116,8 @@ describe CustomWizard::Wizard do end it "is not completed if steps submitted before after time" do + append_steps + progress_step("step_1") progress_step("step_2") progress_step("step_3") @@ -83,7 +126,6 @@ describe CustomWizard::Wizard do template_json['after_time_scheduled'] = Time.now + 3.hours wizard = CustomWizard::Wizard.new(template_json, user) - expect(wizard.completed?).to eq(false) end @@ -125,6 +167,8 @@ describe CustomWizard::Wizard do end it "lets a permitted user access a complete wizard with multiple submissions" do + append_steps + progress_step("step_1", acting_user: trusted_user) progress_step("step_2", acting_user: trusted_user) progress_step("step_3", acting_user: trusted_user) @@ -135,6 +179,8 @@ describe CustomWizard::Wizard do end it "does not let an unpermitted user access a complete wizard without multiple submissions" do + append_steps + progress_step("step_1", acting_user: trusted_user) progress_step("step_2", acting_user: trusted_user) progress_step("step_3", acting_user: trusted_user) diff --git a/spec/extensions/wizard_field_spec.rb b/spec/extensions/wizard_field_spec.rb deleted file mode 100644 index 370c25e7..00000000 --- a/spec/extensions/wizard_field_spec.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true -require_relative '../plugin_helper' - -describe CustomWizardFieldExtension do - let(:field_hash) do - JSON.parse(File.open( - "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/field/field.json" - ).read).with_indifferent_access - end - - it "adds custom field attributes" do - field = Wizard::Field.new(field_hash) - expect(field.id).to eq("field_id") - expect(field.label).to eq("Field Label
") - expect(field.image).to eq("field_image_url.png") - expect(field.description).to eq("Field description") - expect(field.required).to eq(true) - expect(field.key).to eq("field.locale.key") - expect(field.type).to eq("field_type") - expect(field.content).to eq([]) - end -end diff --git a/spec/extensions/wizard_step_spec.rb b/spec/extensions/wizard_step_spec.rb deleted file mode 100644 index 1a9cc0e5..00000000 --- a/spec/extensions/wizard_step_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -# frozen_string_literal: true -require_relative '../plugin_helper' - -describe CustomWizardStepExtension do - let(:step_hash) do - JSON.parse(File.open( - "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/step/step.json" - ).read).with_indifferent_access - end - - it "adds custom step attributes" do - step = Wizard::Step.new(step_hash[:id]) - [ - :title, - :description, - :key, - :permitted, - :permitted_message - ].each do |attr| - step.send("#{attr.to_s}=", step_hash[attr]) - expect(step.send(attr)).to eq(step_hash[attr]) - end - end -end diff --git a/spec/fixtures/condition/user_condition.json b/spec/fixtures/condition/user_condition.json new file mode 100644 index 00000000..c6347b04 --- /dev/null +++ b/spec/fixtures/condition/user_condition.json @@ -0,0 +1,17 @@ +{ + "condition": [ + { + "type": "validation", + "pairs": [ + { + "index": 0, + "key": "username", + "key_type": "user_field", + "value": "angus", + "value_type": "text", + "connector": "equal" + } + ] + } + ] +} \ No newline at end of file diff --git a/spec/fixtures/condition/wizard_field_condition.json b/spec/fixtures/condition/wizard_field_condition.json new file mode 100644 index 00000000..12d47b38 --- /dev/null +++ b/spec/fixtures/condition/wizard_field_condition.json @@ -0,0 +1,17 @@ +{ + "condition": [ + { + "type": "validation", + "pairs": [ + { + "index": 0, + "key": "step_1_field_1", + "key_type": "wizard_field", + "value": "Condition will pass", + "value_type": "text", + "connector": "equal" + } + ] + } + ] +} \ No newline at end of file diff --git a/spec/fixtures/field/field.json b/spec/fixtures/field/field.json index c2de266d..c46a53cd 100644 --- a/spec/fixtures/field/field.json +++ b/spec/fixtures/field/field.json @@ -1,5 +1,6 @@ { "id": "field_id", + "index": 0, "label": "Field Label", "image": "field_image_url.png", "description": "Field description", diff --git a/spec/fixtures/step/step.json b/spec/fixtures/step/step.json index 5c6c5f58..97cd3318 100644 --- a/spec/fixtures/step/step.json +++ b/spec/fixtures/step/step.json @@ -1,5 +1,6 @@ { "id": "step_1", + "index": 0, "title": "Text", "description": "Step description", "image": "step_image_url.png", diff --git a/spec/fixtures/wizard.json b/spec/fixtures/wizard.json index ccaea390..20ff1441 100644 --- a/spec/fixtures/wizard.json +++ b/spec/fixtures/wizard.json @@ -535,7 +535,7 @@ }, { "id": "action_10", - "run_after": "wizard_completion", + "run_after": "step_3", "type": "route_to", "url": [ { diff --git a/spec/requests/custom_wizard/steps_controller_spec.rb b/spec/requests/custom_wizard/steps_controller_spec.rb index dd3b52a1..c58f13a2 100644 --- a/spec/requests/custom_wizard/steps_controller_spec.rb +++ b/spec/requests/custom_wizard/steps_controller_spec.rb @@ -11,12 +11,49 @@ describe CustomWizard::StepsController do ) } - before do - CustomWizard::Template.save( - JSON.parse(File.open( + fab!(:user2) { + Fabricate( + :user, + username: 'bob', + email: "bob@email.com", + trust_level: TrustLevel[2] + ) + } + + let(:wizard_template) { + JSON.parse( + File.open( "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" - ).read), - skip_jobs: true) + ).read + ) + } + + let(:wizard_field_condition_template) { + JSON.parse( + File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/condition/wizard_field_condition.json" + ).read + ) + } + + let(:user_condition_template) { + JSON.parse( + File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/condition/user_condition.json" + ).read + ) + } + + let(:permitted_json) { + JSON.parse( + File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard/permitted.json" + ).read + ) + } + + before do + CustomWizard::Template.save(wizard_template, skip_jobs: true) sign_in(user) end @@ -27,17 +64,189 @@ describe CustomWizard::StepsController do } } expect(response.status).to eq(200) + expect(response.parsed_body['wizard']['start']).to eq("step_2") - wizard = CustomWizard::Builder.new("super_mega_fun_wizard", user).build - expect(wizard.current_submission['step_1_field_1']).to eq("Text input") - expect(wizard.start.id).to eq("step_2") + wizard_id = response.parsed_body['wizard']['id'] + wizard = CustomWizard::Wizard.create(wizard_id, user) + expect(wizard.submissions.last['step_1_field_1']).to eq("Text input") + end + + context "raises an error" do + it "when the wizard doesnt exist" do + put '/w/not-super-mega-fun-wizard/steps/step_1.json' + expect(response.status).to eq(400) + end + + it "when the user cant access the wizard" do + new_template = wizard_template.dup + new_template["permitted"] = permitted_json["permitted"] + CustomWizard::Template.save(new_template, skip_jobs: true) + + put '/w/super-mega-fun-wizard/steps/step_1.json' + expect(response.status).to eq(403) + end + + it "when the step doesnt exist" do + put '/w/super-mega-fun-wizard/steps/step_10.json' + expect(response.status).to eq(400) + end + + it "when user cant see the step due to conditions" do + sign_in(user2) + + new_wizard_template = wizard_template.dup + new_wizard_template['steps'][0]['condition'] = user_condition_template['condition'] + CustomWizard::Template.save(new_wizard_template, skip_jobs: true) + + put '/w/super-mega-fun-wizard/steps/step_1.json' + expect(response.status).to eq(403) + end end it "works if the step has no fields" do put '/w/super-mega-fun-wizard/steps/step_1.json' expect(response.status).to eq(200) + expect(response.parsed_body['wizard']['start']).to eq("step_2") + end - wizard = CustomWizard::Builder.new("super_mega_fun_wizard", user).build - expect(wizard.start.id).to eq("step_2") + it "returns an updated wizard when condition passes" do + new_template = wizard_template.dup + new_template['steps'][1]['condition'] = wizard_field_condition_template['condition'] + CustomWizard::Template.save(new_template, skip_jobs: true) + + put '/w/super-mega-fun-wizard/steps/step_1.json', params: { + fields: { + step_1_field_1: "Condition will pass" + } + } + expect(response.status).to eq(200) + expect(response.parsed_body['wizard']['start']).to eq("step_2") + end + + it "returns an updated wizard when condition doesnt pass" do + new_template = wizard_template.dup + new_template['steps'][1]['condition'] = wizard_field_condition_template['condition'] + CustomWizard::Template.save(new_template, skip_jobs: true) + + put '/w/super-mega-fun-wizard/steps/step_1.json', params: { + fields: { + step_1_field_1: "Condition wont pass" + } + } + expect(response.status).to eq(200) + expect(response.parsed_body['wizard']['start']).to eq("step_3") + end + + it "runs completion actions if user has completed wizard" do + new_template = wizard_template.dup + + ## route_to action + new_template['actions'].last['run_after'] = 'wizard_completion' + new_template['steps'][1]['condition'] = wizard_field_condition_template['condition'] + new_template['steps'][2]['condition'] = wizard_field_condition_template['condition'] + CustomWizard::Template.save(new_template, skip_jobs: true) + + put '/w/super-mega-fun-wizard/steps/step_1.json', params: { + fields: { + step_1_field_1: "Condition wont pass" + } + } + expect(response.status).to eq(200) + expect(response.parsed_body['redirect_on_complete']).to eq("https://google.com") + end + + it "saves results of completion actions if user has completed wizard" do + new_template = wizard_template.dup + + ## Create group action + new_template['actions'].first['run_after'] = 'wizard_completion' + new_template['steps'][1]['condition'] = wizard_field_condition_template['condition'] + CustomWizard::Template.save(new_template, skip_jobs: true) + + put '/w/super-mega-fun-wizard/steps/step_1.json', params: { + fields: { + step_1_field_1: "My cool group" + } + } + expect(response.status).to eq(200) + + put '/w/super-mega-fun-wizard/steps/step_3.json' + expect(response.status).to eq(200) + + wizard_id = response.parsed_body['wizard']['id'] + wizard = CustomWizard::Wizard.create(wizard_id, user) + group_name = wizard.submissions.last['action_9'] + group = Group.find_by(name: group_name) + expect(group.full_name).to eq("My cool group") + end + + it "returns a final step without conditions" do + put '/w/super-mega-fun-wizard/steps/step_1.json' + expect(response.status).to eq(200) + expect(response.parsed_body['final']).to eq(false) + + put '/w/super-mega-fun-wizard/steps/step_2.json' + expect(response.status).to eq(200) + expect(response.parsed_body['final']).to eq(false) + + put '/w/super-mega-fun-wizard/steps/step_3.json' + expect(response.status).to eq(200) + expect(response.parsed_body['final']).to eq(true) + end + + it "returns the correct final step when the conditional final step and last step are the same" do + new_template = wizard_template.dup + new_template['steps'][0]['condition'] = user_condition_template['condition'] + new_template['steps'][2]['condition'] = wizard_field_condition_template['condition'] + CustomWizard::Template.save(new_template, skip_jobs: true) + + put '/w/super-mega-fun-wizard/steps/step_1.json', params: { + fields: { + step_1_field_1: "Condition will pass" + } + } + expect(response.status).to eq(200) + expect(response.parsed_body['final']).to eq(false) + + put '/w/super-mega-fun-wizard/steps/step_2.json' + expect(response.status).to eq(200) + expect(response.parsed_body['final']).to eq(false) + + put '/w/super-mega-fun-wizard/steps/step_3.json' + expect(response.status).to eq(200) + expect(response.parsed_body['final']).to eq(true) + end + + it "returns the correct final step when the conditional final step and last step are different" do + new_template = wizard_template.dup + new_template['steps'][2]['condition'] = wizard_field_condition_template['condition'] + CustomWizard::Template.save(new_template, skip_jobs: true) + + put '/w/super-mega-fun-wizard/steps/step_1.json', params: { + fields: { + step_1_field_1: "Condition will not pass" + } + } + expect(response.status).to eq(200) + expect(response.parsed_body['final']).to eq(false) + + put '/w/super-mega-fun-wizard/steps/step_2.json' + expect(response.status).to eq(200) + expect(response.parsed_body['final']).to eq(true) + end + + it "returns the correct final step when the conditional final step is determined in the same action" do + new_template = wizard_template.dup + new_template['steps'][1]['condition'] = wizard_field_condition_template['condition'] + new_template['steps'][2]['condition'] = wizard_field_condition_template['condition'] + CustomWizard::Template.save(new_template, skip_jobs: true) + + put '/w/super-mega-fun-wizard/steps/step_1.json', params: { + fields: { + step_1_field_1: "Condition will not pass" + } + } + expect(response.status).to eq(200) + expect(response.parsed_body['final']).to eq(true) end end diff --git a/spec/serializers/custom_wizard/wizard_field_serializer_spec.rb b/spec/serializers/custom_wizard/wizard_field_serializer_spec.rb index 944947e6..1fa9671c 100644 --- a/spec/serializers/custom_wizard/wizard_field_serializer_spec.rb +++ b/spec/serializers/custom_wizard/wizard_field_serializer_spec.rb @@ -20,9 +20,11 @@ describe CustomWizard::FieldSerializer do each_serializer: CustomWizard::FieldSerializer, scope: Guardian.new(user) ).as_json - expect(json_array.length).to eq(4) + + expect(json_array.size).to eq(4) expect(json_array[0][:label]).to eq("Text
") expect(json_array[0][:description]).to eq("Text field description.") + expect(json_array[3][:index]).to eq(3) end it "should return optional field attributes" do @@ -32,7 +34,6 @@ describe CustomWizard::FieldSerializer do scope: Guardian.new(user) ).as_json expect(json_array[0][:format]).to eq("YYYY-MM-DD") - expect(json_array[3][:number]).to eq(4) expect(json_array[6][:file_types]).to eq(".jpg,.jpeg,.png") end end diff --git a/spec/serializers/custom_wizard/wizard_step_serializer.rb b/spec/serializers/custom_wizard/wizard_step_serializer.rb deleted file mode 100644 index c2d82962..00000000 --- a/spec/serializers/custom_wizard/wizard_step_serializer.rb +++ /dev/null @@ -1,59 +0,0 @@ -# frozen_string_literal: true - -require_relative '../../plugin_helper' - -describe CustomWizard::StepSerializer do - fab!(:user) { Fabricate(:user) } - - let(:required_data_json) { - JSON.parse(File.open( - "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/step/required_data.json" - ).read) - } - - before do - CustomWizard::Template.save( - JSON.parse(File.open( - "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" - ).read), - skip_jobs: true) - @wizard = CustomWizard::Builder.new("super_mega_fun_wizard", user).build - end - - it 'should return basic step attributes' do - json_array = ActiveModel::ArraySerializer.new( - @wizard.steps, - each_serializer: CustomWizard::StepSerializer, - scope: Guardian.new(user) - ).as_json - expect(json_array[0][:wizard_step][:title]).to eq("Text") - expect(json_array[0][:wizard_step][:description]).to eq("Text inputs!") - end - - it 'should return fields' do - json_array = ActiveModel::ArraySerializer.new( - @wizard.steps, - each_serializer: CustomWizard::StepSerializer, - scope: Guardian.new(user) - ).as_json - expect(json_array[0][:wizard_step][:fields].length).to eq(4) - end - - context 'with required data' do - before do - @template[:steps][0][:required_data] = required_data_json['required_data'] - @template[:steps][0][:required_data_message] = required_data_json['required_data_message'] - CustomWizard::Template.save(@template.as_json) - end - - it 'should return permitted attributes' do - json_array = ActiveModel::ArraySerializer.new( - @wizard.steps, - each_serializer: CustomWizard::StepSerializer, - scope: Guardian.new(user) - ).as_json - expect(json_array[0][:wizard_step][:permitted]).to eq(false) - expect(json_array[0][:wizard_step][:permitted_message]).to eq("Missing required data") - end - end -end diff --git a/spec/serializers/custom_wizard/wizard_step_serializer_spec.rb b/spec/serializers/custom_wizard/wizard_step_serializer_spec.rb new file mode 100644 index 00000000..35ce0fd2 --- /dev/null +++ b/spec/serializers/custom_wizard/wizard_step_serializer_spec.rb @@ -0,0 +1,67 @@ +# frozen_string_literal: true + +require_relative '../../plugin_helper' + +describe CustomWizard::StepSerializer do + fab!(:user) { Fabricate(:user) } + + let(:wizard_template) { + JSON.parse( + File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read + ) + } + + let(:required_data_json) { + JSON.parse( + File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/step/required_data.json" + ).read + ) + } + + before do + CustomWizard::Template.save(wizard_template, skip_jobs: true) + @wizard = CustomWizard::Builder.new("super_mega_fun_wizard", user).build + end + + it 'should return basic step attributes' do + json_array = ActiveModel::ArraySerializer.new( + @wizard.steps, + each_serializer: described_class, + scope: Guardian.new(user) + ).as_json + expect(json_array[0][:title]).to eq("Text
") + expect(json_array[0][:description]).to eq("Text inputs!
") + expect(json_array[1][:index]).to eq(1) + end + + it 'should return fields' do + json_array = ActiveModel::ArraySerializer.new( + @wizard.steps, + each_serializer: described_class, + scope: Guardian.new(user) + ).as_json + expect(json_array[0][:fields].length).to eq(4) + end + + context 'with required data' do + before do + wizard_template['steps'][0]['required_data'] = required_data_json['required_data'] + wizard_template['steps'][0]['required_data_message'] = required_data_json['required_data_message'] + CustomWizard::Template.save(wizard_template) + @wizard = CustomWizard::Builder.new("super_mega_fun_wizard", user).build + end + + it 'should return permitted attributes' do + json_array = ActiveModel::ArraySerializer.new( + @wizard.steps, + each_serializer: described_class, + scope: Guardian.new(user) + ).as_json + expect(json_array[0][:permitted]).to eq(false) + expect(json_array[0][:permitted_message]).to eq("Missing required data") + end + end +end