![\":slight_smile:\"](\"/images/emoji/twitter/slight_smile.png?v=9\" "\\":slight_smile:\\"")
Text inputs!
") end - it 'saves permitted params' do - template['steps'][0]['permitted_params'] = permitted_params - wizard = build_wizard(template, user, {}, param_key: 'param_value') - submissions = get_submission_data - expect(submissions.first['submission_param_key']).to eq('param_value') + 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 'is not permitted if required data is not present' do + expect( + CustomWizard::Builder.new(@template[:id], user).build + .steps.first + .permitted + ).to eq(false) + end + + it 'it shows required data message' do + expect( + CustomWizard::Builder.new(@template[:id], user).build + .steps.first + .permitted_message + ).to eq("Missing required data") + end + + it 'is permitted if required data is present' do + CustomWizard::Wizard.set_submissions('super_mega_fun_wizard', user, + required_data: "required_value" + ) + expect( + CustomWizard::Builder.new(@template[:id], user).build + .steps.first + .permitted + ).to eq(true) + end end - it 'is not permitted if required data is not present' do - template['steps'][0]['required_data'] = required_data - expect(build_wizard(template, user).steps[0].permitted).to eq(false) + context "with permitted params" do + before do + @template[:steps][0][:permitted_params] = permitted_param_json['permitted_params'] + CustomWizard::Template.save(@template.as_json) + end + + it 'saves permitted params' do + wizard = CustomWizard::Builder.new(@template[:id], user).build({}, + param: 'param_value' + ) + expect(wizard.current_submission['saved_param']).to eq('param_value') + end end - - it 'it shows required data message if required data has message' do - template['steps'][0]['required_data'] = required_data - template['steps'][0]['required_data_message'] = required_data_message - add_submission_data(nickname: "John") - wizard = build_wizard(template, user) - expect(wizard.steps[0].permitted).to eq(false) - expect(wizard.steps[0].permitted_message).to eq(required_data_message) - end - - it 'is permitted if required data is present' do - template['steps'][0]['required_data'] = required_data - PluginStore.set('welcome_submissions', user.id, nickname: "Angus", name: "Angus") - expect(build_wizard(template, user).steps[0].permitted).to eq(true) - end - + end + + context 'building field' do it 'returns field metadata' do - expect(build_wizard(template, user).steps[0].fields[0].label).to eq("Name
") - expect(build_wizard(template, user).steps[0].fields[0].type).to eq("text") + wizard = CustomWizard::Builder.new(@template[:id], user).build + field = wizard.steps.first.fields.first + + expect(field.label).to eq("Text
") + expect(field.type).to eq("text") + expect(field.id).to eq("step_1_field_1") + expect(field.min_length).to eq("3") end - it 'returns fields' do - template['steps'][0]['fields'][1] = checkbox_field - expect(build_wizard(template, user).steps[0].fields.length).to eq(2) + it 'returns all step fields' do + expect( + CustomWizard::Builder.new(@template[:id], user) + .build + .steps.first + .fields.length + ).to eq(4) end end context 'on update' do + def perform_update(step_id, submission) + wizard = CustomWizard::Builder.new(@template[:id], user).build + updater = wizard.create_updater(step_id, submission) + updater.update + updater + end + it 'saves submissions' do - run_update(template, nil, name: 'Angus') - expect(get_submission_data.first['name']).to eq('Angus') + perform_update('step_1', step_1_field_1: 'Text input') + expect( + CustomWizard::Wizard.submissions(@template[:id], user) + .first['step_1_field_1'] + ).to eq('Text input') + end + + context 'save submissions disabled' do + before do + @template[:save_submissions] = false + CustomWizard::Template.save(@template.as_json) + end + + it "does not save submissions" do + perform_update('step_1', step_1_field_1: 'Text input') + expect( + CustomWizard::Wizard.submissions(@template[:id], user).first + ).to eq(nil) + end end context 'validation' do it 'applies min length' do - template['steps'][0]['fields'][0]['min_length'] = 10 - updater = run_update(template, nil, name: 'short') - expect(updater.errors.messages[:name].first).to eq( - I18n.t('wizard.field.too_short', label: 'Name', min: 10) - ) + expect( + perform_update('step_1', step_1_field_1: 'Te') + .errors.messages[:step_1_field_1].first + ).to eq(I18n.t('wizard.field.too_short', label: 'Text', min: 3)) end it 'standardises boolean entries' do - template['steps'][0]['fields'][0] = checkbox_field - run_update(template, nil, checkbox: 'false') - expect(get_submission_data.first['checkbox']).to eq(false) + perform_update('step_2', step_2_field_5: 'false') + expect( + CustomWizard::Wizard.submissions(@template[:id], user) + .first['step_2_field_5'] + ).to eq(false) end it 'requires required fields' do - template['steps'][0]['fields'][0]['required'] = true - expect(run_update(template).errors.messages[:name].first).to eq( - I18n.t('wizard.field.required', label: 'Name') - ) + @template[:steps][0][:fields][1][:required] = true + CustomWizard::Template.save(@template.as_json) + + expect( + perform_update('step_1', step_1_field_2: nil) + .errors.messages[:step_1_field_2].first + ).to eq(I18n.t('wizard.field.required', label: 'Textarea')) end end - - it 'runs actions attached to a step' do - run_update(template, template['steps'][1]['id'], name: "Gus") - expect(user.name).to eq('Gus') - end end end end \ No newline at end of file diff --git a/spec/components/custom_wizard/field_spec.rb b/spec/components/custom_wizard/field_spec.rb new file mode 100644 index 00000000..d6d6e61a --- /dev/null +++ b/spec/components/custom_wizard/field_spec.rb @@ -0,0 +1,30 @@ +require 'rails_helper' + +describe CustomWizard::Field do + before do + CustomWizard::Field.register( + 'location', + 'discourse-locations', + ['components', 'helpers', 'lib', 'stylesheets', 'templates'], + type_opts: { + prefill: { "coordinates": [35.3082, 149.1244] } + } + ) + end + + it "registers custom field types" do + expect(CustomWizard::Field.types[:location].present?).to eq(true) + end + + it "allows custom field types to set default attributes" do + expect( + CustomWizard::Field.types[:location][:prefill] + ).to eq({ "coordinates": [35.3082, 149.1244] }) + end + + it "registers custom field assets" do + expect( + CustomWizard::Field.require_assets['discourse-locations'] + ).to eq(['components', 'helpers', 'lib', 'stylesheets', 'templates']) + end +end \ No newline at end of file diff --git a/spec/components/custom_wizard/log_spec.rb b/spec/components/custom_wizard/log_spec.rb new file mode 100644 index 00000000..9c8b570d --- /dev/null +++ b/spec/components/custom_wizard/log_spec.rb @@ -0,0 +1,27 @@ +require 'rails_helper' + +describe CustomWizard::Log do + before do + CustomWizard::Log.create("First log message") + CustomWizard::Log.create("Second log message") + CustomWizard::Log.create("Third log message") + end + + it "creates logs" do + expect( + CustomWizard::Log.list.length + ).to eq(3) + end + + it "lists logs by time created" do + expect( + CustomWizard::Log.list.first.message + ).to eq("Third log message") + end + + it "paginates logs" do + expect( + CustomWizard::Log.list(0, 2).length + ).to eq(2) + end +end \ No newline at end of file diff --git a/spec/components/custom_wizard/mapper_spec.rb b/spec/components/custom_wizard/mapper_spec.rb index 4fb8a10e..4ddbee57 100644 --- a/spec/components/custom_wizard/mapper_spec.rb +++ b/spec/components/custom_wizard/mapper_spec.rb @@ -1,14 +1,250 @@ +require 'rails_helper' + describe CustomWizard::Mapper do - -it 'interpolates user data' do - user.name = "Angus" - user.save! - - expect( - CustomWizard::Builder.fill_placeholders( - "My name is u{name}", - user, - {} + fab!(:user1) { + Fabricate(:user, + name: "Angus", + username: "angus", + email: "angus@email.com", + trust_level: TrustLevel[3] ) - ).to eq('My name is Angus') + } + fab!(:user2) { + Fabricate(:user, + name: "Patrick", + username: "patrick", + email: "patrick@email2.com", + trust_level: TrustLevel[1] + ) + } + fab!(:user_field) { + field = Fabricate(:user_field, + id: 3, + name: 'dropdown_field', + description: 'field desc', + field_type: 'dropdown', + user_field_options_attributes: [ + { value: "a" }, + { value: "b" }, + { value: "c" } + ] + ) + } + let(:inputs) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/mapper/inputs.json" + ).read) + } + let(:data) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/mapper/data.json" + ).read) + } + + it "maps values" do + expect(CustomWizard::Mapper.new( + inputs: inputs['assignment'], + data: data, + user: user1 + ).perform).to eq([13]) + end + + it "maps associations" do + association = CustomWizard::Mapper.new( + inputs: inputs['association'], + data: data, + user: user1 + ).perform + expect(association.length).to eq(3) + expect(association.first[:value]).to eq("Choice 1") + end + + context "conditional mapping" do + it "maps when the condition is met" do + expect(CustomWizard::Mapper.new( + inputs: inputs['conditional'], + data: data, + user: user1 + ).perform).to eq("true") + end + + it "does not map when the condition is not met" do + expect(CustomWizard::Mapper.new( + inputs: inputs['conditional'], + data: data, + user: user2 + ).perform).to eq(nil) + end + + it "maps when multiple conditions are met" do + expect(CustomWizard::Mapper.new( + inputs: inputs['conditional_multiple_pairs'], + data: data, + user: user1 + ).perform).to eq("true") + end + + it "does not map when one of multiple conditions are not met" do + user1.email = "angus@other-email.com" + expect(CustomWizard::Mapper.new( + inputs: inputs['conditional_multiple_pairs'], + data: data, + user: user1 + ).perform).to eq(nil) + end + end + + it "validates valid data" do + expect(CustomWizard::Mapper.new( + inputs: inputs['validation'], + data: data, + user: user1 + ).perform).to eq(true) + end + + it "does not validate invalid data" do + data["input_2"] = "value 3" + expect(CustomWizard::Mapper.new( + inputs: inputs['validation'], + data: data, + user: user1 + ).perform).to eq(false) + end + + it "maps text fields" do + expect(CustomWizard::Mapper.new( + inputs: inputs['assignment_text'], + data: data, + user: user1 + ).perform).to eq("Value") + end + + it "maps user fields" do + expect(CustomWizard::Mapper.new( + inputs: inputs['assignment_user_field'], + data: data, + user: user1 + ).perform).to eq("Angus") + end + + it "maps user field options" do + expect(CustomWizard::Mapper.new( + inputs: inputs['assignment_user_field_options'], + data: data, + user: user1 + ).perform).to eq(["a", "b", "c"]) + end + + it "maps wizard fields" do + expect(CustomWizard::Mapper.new( + inputs: inputs['assignment_wizard_field'], + data: data, + user: user1 + ).perform).to eq("value 1") + end + + it "maps wizard actions" do + expect(CustomWizard::Mapper.new( + inputs: inputs['assignment_wizard_action'], + data: data, + user: user1 + ).perform).to eq("value 2") + end + + it "interpolates user fields" do + expect(CustomWizard::Mapper.new( + inputs: inputs['interpolate_user_field'], + data: data, + user: user1 + ).perform).to eq("Name: Angus") + end + + it "interpolates wizard fields" do + expect(CustomWizard::Mapper.new( + inputs: inputs['interpolate_wizard_field'], + data: data, + user: user1 + ).perform).to eq("Input 1: value 1") + end + + it "interpolates date" do + expect(CustomWizard::Mapper.new( + inputs: inputs['interpolate_timestamp'], + data: data, + user: user1 + ).perform).to eq("Time: #{Time.now.strftime("%B %-d, %Y")}") + end + + it "handles greater than pairs" do + expect(CustomWizard::Mapper.new( + inputs: inputs['greater_than_pair'], + data: data, + user: user1 + ).perform).to eq(true) + expect(CustomWizard::Mapper.new( + inputs: inputs['greater_than_pair'], + data: data, + user: user2 + ).perform).to eq(false) + end + + it "handles less than pairs" do + expect(CustomWizard::Mapper.new( + inputs: inputs['less_than_pair'], + data: data, + user: user1 + ).perform).to eq(false) + expect(CustomWizard::Mapper.new( + inputs: inputs['less_than_pair'], + data: data, + user: user2 + ).perform).to eq(true) + end + + it "handles greater than or equal pairs" do + expect(CustomWizard::Mapper.new( + inputs: inputs['greater_than_or_equal_pair'], + data: data, + user: user1 + ).perform).to eq(true) + expect(CustomWizard::Mapper.new( + inputs: inputs['greater_than_or_equal_pair'], + data: data, + user: user2 + ).perform).to eq(true) + end + + it "handles less than or equal pairs" do + expect(CustomWizard::Mapper.new( + inputs: inputs['less_than_or_equal_pair'], + data: data, + user: user1 + ).perform).to eq(true) + expect(CustomWizard::Mapper.new( + inputs: inputs['less_than_or_equal_pair'], + data: data, + user: user2 + ).perform).to eq(true) + end + + it "handles regex pairs" do + expect(CustomWizard::Mapper.new( + inputs: inputs['regex_pair'], + data: data, + user: user1 + ).perform).to eq(true) + expect(CustomWizard::Mapper.new( + inputs: inputs['regex_pair'], + data: data, + user: user2 + ).perform).to eq(false) + end + + it "handles shorthand pairs" do + expect(CustomWizard::Mapper.new( + inputs: inputs['shorthand_pair'], + data: data, + user: user1 + ).perform).to eq(false) + end end \ No newline at end of file diff --git a/spec/components/custom_wizard/template_spec.rb b/spec/components/custom_wizard/template_spec.rb new file mode 100644 index 00000000..594009a8 --- /dev/null +++ b/spec/components/custom_wizard/template_spec.rb @@ -0,0 +1,111 @@ +require 'rails_helper' + +describe CustomWizard::Template do + fab!(:user) { Fabricate(:user) } + + let(:template_json) { + 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) + } + let(:after_time) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard/after_time.json" + ).read).with_indifferent_access + } + + before do + CustomWizard::Template.save(template_json, skip_jobs: true) + end + + it "saves wizard templates" do + expect( + PluginStoreRow.exists?( + plugin_name: 'custom_wizard', + key: 'super_mega_fun_wizard' + ) + ).to eq(true) + end + + it "finds wizard templates" do + expect( + CustomWizard::Template.find('super_mega_fun_wizard')['id'] + ).to eq('super_mega_fun_wizard') + end + + it "removes wizard templates" do + CustomWizard::Template.remove('super_mega_fun_wizard') + expect( + CustomWizard::Template.find('super_mega_fun_wizard') + ).to eq(nil) + end + + it "checks for wizard template existence" do + expect( + CustomWizard::Template.exists?('super_mega_fun_wizard') + ).to eq(true) + end + + context "wizard template list" do + before do + template_json_2 = template_json.dup + template_json_2["id"] = 'super_mega_fun_wizard_2' + template_json_2["permitted"] = permitted_json['permitted'] + CustomWizard::Template.save(template_json_2, skip_jobs: true) + + template_json_3 = template_json.dup + template_json_3["id"] = 'super_mega_fun_wizard_3' + template_json_3["after_signup"] = true + CustomWizard::Template.save(template_json_3, skip_jobs: true) + end + + it "works" do + expect( + CustomWizard::Template.list.length + ).to eq(3) + end + + it "can be filtered by wizard settings" do + expect( + CustomWizard::Template.list(setting: "after_signup").length + ).to eq(1) + end + + it "can be ordered" do + expect( + CustomWizard::Template.list( + order: "(value::json ->> 'permitted') IS NOT NULL DESC" + ).first['id'] + ).to eq('super_mega_fun_wizard_2') + end + end + + context "after time setting" do + before do + freeze_time Time.now + @after_time_template = template_json.dup + @after_time_template["after_time"] = after_time['after_time'] + @after_time_template["after_time_scheduled"] = after_time['after_time_scheduled'] + end + + it 'if enabled queues jobs after wizard is saved' do + expect_enqueued_with(job: :set_after_time_wizard, at: Time.parse(after_time['after_time_scheduled']).utc) do + CustomWizard::Template.save(@after_time_template) + end + end + + it 'if disabled clears jobs after wizard is saved' do + CustomWizard::Template.save(@after_time_template) + @after_time_template['after_time'] = false + + expect_not_enqueued_with(job: :set_after_time_wizard) do + CustomWizard::Template.save(@after_time_template) + end + end + end +end \ No newline at end of file diff --git a/spec/components/custom_wizard/validator_spec.rb b/spec/components/custom_wizard/validator_spec.rb new file mode 100644 index 00000000..5833127e --- /dev/null +++ b/spec/components/custom_wizard/validator_spec.rb @@ -0,0 +1,53 @@ +require 'rails_helper' + +describe CustomWizard::Validator do + fab!(:user) { Fabricate(:user) } + + let(:template) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read).with_indifferent_access + } + + let(:after_time) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard/after_time.json" + ).read).with_indifferent_access + } + + it "validates valid templates" do + expect( + CustomWizard::Validator.new(template).perform + ).to eq(true) + end + + it "invalidates templates without required attributes" do + template.delete(:id) + expect( + CustomWizard::Validator.new(template).perform + ).to eq(false) + end + + it "invalidates templates with duplicate ids if creating a new template" do + CustomWizard::Template.save(template) + expect( + CustomWizard::Validator.new(template, create: true).perform + ).to eq(false) + end + + it "validates after time settings" do + template[:after_time] = after_time[:after_time] + template[:after_time_scheduled] = after_time[:after_time_scheduled] + expect( + CustomWizard::Validator.new(template).perform + ).to eq(true) + end + + it "invalidates invalid after time settings" do + template[:after_time] = after_time[:after_time] + template[:after_time_scheduled] = "not a time" + expect( + CustomWizard::Validator.new(template).perform + ).to eq(false) + end +end \ No newline at end of file diff --git a/spec/components/custom_wizard/wizard_spec.rb b/spec/components/custom_wizard/wizard_spec.rb new file mode 100644 index 00000000..7724cc64 --- /dev/null +++ b/spec/components/custom_wizard/wizard_spec.rb @@ -0,0 +1,230 @@ +require 'rails_helper' + +describe CustomWizard::Wizard do + fab!(:user) { Fabricate(:user) } + fab!(:trusted_user) { Fabricate(:user, trust_level: TrustLevel[3])} + 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) + } + + let(:after_time) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard/after_time.json" + ).read) + } + + let(:permitted_json) { + 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) + template_json['steps'].each do |step_template| + @wizard.append_step(step_template['id']) + end + end + + def progress_step(step_id, acting_user = user) + UserHistory.create( + action: UserHistory.actions[:custom_wizard_step], + acting_user_id: acting_user.id, + context: @wizard.id, + subject: step_id + ) + end + + it "appends steps from a template" do + expect(@wizard.steps.length).to eq(3) + end + + it "determines the user's current step" do + expect(@wizard.start.id).to eq('step_1') + progress_step('step_1') + expect(@wizard.start.id).to eq('step_2') + end + + it "creates a step updater" do + expect( + @wizard.create_updater('step_1', step_1_field_1: "Text input") + .class + ).to eq(CustomWizard::StepUpdater) + end + + it "determines whether a wizard is unfinished" do + expect(@wizard.unfinished?).to eq(true) + progress_step("step_1") + expect(@wizard.unfinished?).to eq(true) + progress_step("step_2") + expect(@wizard.unfinished?).to eq(true) + progress_step("step_3") + expect(@wizard.unfinished?).to eq(false) + end + + it "determines whether a wizard has been completed by a user" do + expect(@wizard.completed?).to eq(false) + progress_step("step_1") + progress_step("step_2") + progress_step("step_3") + expect(@wizard.completed?).to eq(true) + end + + it "is not completed if steps submitted before after time" do + progress_step("step_1") + progress_step("step_2") + progress_step("step_3") + + template_json['after_time'] = after_time['after_time'] + template_json['after_time_scheduled'] = after_time['after_time_scheduled'] + + wizard = CustomWizard::Wizard.new(template_json, user) + + expect(wizard.completed?).to eq(false) + end + + it "permits admins" do + expect( + CustomWizard::Wizard.new(@permitted_template, admin_user).permitted? + ).to eq(true) + end + + it "permits permitted users" do + expect( + CustomWizard::Wizard.new(@permitted_template, trusted_user).permitted? + ).to eq(true) + end + + it "does not permit unpermitted users" do + expect( + CustomWizard::Wizard.new(@permitted_template, user).permitted? + ).to eq(false) + end + + it "does not let an unpermitted user access a wizard" do + expect( + CustomWizard::Wizard.new(@permitted_template, user).can_access? + ).to eq(false) + end + + it "lets a permitted user access an incomplete wizard" do + expect( + CustomWizard::Wizard.new(@permitted_template, trusted_user).can_access? + ).to eq(true) + end + + it "lets a permitted user access a complete wizard with multiple submissions" do + progress_step("step_1", trusted_user) + progress_step("step_2", trusted_user) + progress_step("step_3", trusted_user) + + expect( + CustomWizard::Wizard.new(@permitted_template, trusted_user).can_access? + ).to eq(true) + end + + it "does not let an unpermitted user access a complete wizard without multiple submissions" do + progress_step("step_1", trusted_user) + progress_step("step_2", trusted_user) + progress_step("step_3", trusted_user) + + @permitted_template['multiple_submissions'] = false + + expect( + CustomWizard::Wizard.new(@permitted_template, trusted_user).can_access? + ).to eq(false) + end + + it "lists the site groups" do + expect(@wizard.groups.length).to eq(8) + end + + it "lists the site categories" do + expect(@wizard.categories.length).to eq(1) + end + + context "submissions" do + before do + @wizard.set_submissions(step_1_field_1: 'I am a user submission') + end + + it "sets the user's submission" do + expect( + PluginStore.get("#{template_json['id']}_submissions", user.id) + .first['step_1_field_1'] + ).to eq('I am a user submission') + end + + it "lists the user's submissions" do + expect(@wizard.submissions.length).to eq(1) + end + + it "returns the user's current submission" do + expect(@wizard.current_submission['step_1_field_1']).to eq('I am a user submission') + end + end + + it "provides class methods to set and list submissions" do + CustomWizard::Wizard.set_submissions(template_json['id'], user, + step_1_field_1: 'I am a user submission' + ) + expect( + CustomWizard::Wizard.submissions(template_json['id'], user) + .first['step_1_field_1'] + ).to eq('I am a user submission') + end + + context do + before do + CustomWizard::Template.save(@permitted_template, skip_jobs: true) + + template_json_2 = template_json.dup + template_json_2["id"] = 'super_mega_fun_wizard_2' + template_json_2["prompt_completion"] = true + CustomWizard::Template.save(template_json_2, skip_jobs: true) + + template_json_3 = template_json.dup + template_json_3["id"] = 'super_mega_fun_wizard_3' + template_json_3["after_signup"] = true + CustomWizard::Template.save(template_json_3, skip_jobs: true) + end + + it "lists wizards the user can see" do + expect(CustomWizard::Wizard.list(user).length).to eq(2) + expect(CustomWizard::Wizard.list(trusted_user).length).to eq(3) + end + + it "returns the first after signup wizard" do + expect(CustomWizard::Wizard.after_signup(user).id).to eq('super_mega_fun_wizard_3') + end + + it "lists prompt completion wizards" do + expect(CustomWizard::Wizard.prompt_completion(user).length).to eq(2) + end + end + + it "sets wizard redirects if user is permitted" do + CustomWizard::Template.save(@permitted_template, skip_jobs: true) + CustomWizard::Wizard.set_wizard_redirect('super_mega_fun_wizard', trusted_user) + expect( + trusted_user.custom_fields['redirect_to_wizard'] + ).to eq("super_mega_fun_wizard") + end + + it "does not set a wizard redirect if user is not permitted" do + CustomWizard::Template.save(@permitted_template, skip_jobs: true) + CustomWizard::Wizard.set_wizard_redirect('super_mega_fun_wizard', user) + expect( + trusted_user.custom_fields['redirect_to_wizard'] + ).to eq(nil) + end +end \ No newline at end of file diff --git a/spec/extensions/extra_locales_controller_spec.rb b/spec/extensions/extra_locales_controller_spec.rb new file mode 100644 index 00000000..bac0f2c6 --- /dev/null +++ b/spec/extensions/extra_locales_controller_spec.rb @@ -0,0 +1,23 @@ +require 'rails_helper' + +describe ExtraLocalesControllerCustomWizard, type: :request do + before do + CustomWizard::Template.save( + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read), + skip_jobs: true) + end + + before do + @controller = ExtraLocalesController.new + end + + it "returns locales when requested by wizard" do + expect( + ExtraLocalesController.url("wizard") + ).to eq( + "#{Discourse.base_path}/extra-locales/wizard?v=#{ExtraLocalesController.bundle_js_hash("wizard")}" + ) + end +end \ No newline at end of file diff --git a/spec/extensions/invites_controller_spec.rb b/spec/extensions/invites_controller_spec.rb new file mode 100644 index 00000000..05fa58a5 --- /dev/null +++ b/spec/extensions/invites_controller_spec.rb @@ -0,0 +1,24 @@ +require 'rails_helper' + +describe InvitesControllerCustomWizard, type: :request do + fab!(:topic) { Fabricate(:topic) } + let(:invite) do + Invite.invite_by_email("angus@email.com", topic.user, topic) + end + let(:template) do + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read) + end + + before do + @controller = InvitesController.new + end + + it "redirects a user to wizard after invite if after signup is enabled" do + template['after_signup'] = true + CustomWizard::Template.save(template, skip_jobs: true) + put "/invites/show/#{invite.invite_key}.json" + expect(response.parsed_body["redirect_to"]).to eq("/w/super-mega-fun-wizard") + end +end \ No newline at end of file diff --git a/spec/extensions/users_controller_spec.rb b/spec/extensions/users_controller_spec.rb new file mode 100644 index 00000000..5a219dee --- /dev/null +++ b/spec/extensions/users_controller_spec.rb @@ -0,0 +1,21 @@ +require 'rails_helper' + +describe CustomWizardUsersController, type: :request do + let(:template) do + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read) + end + + before do + @controller = UsersController.new + end + + it "redirects a user to wizard after sign up if after signup is enabled" do + template['after_signup'] = true + CustomWizard::Template.save(template, skip_jobs: true) + sign_in(Fabricate(:user)) + get "/u/account-created" + expect(response).to redirect_to("/w/super-mega-fun-wizard") + end +end \ No newline at end of file diff --git a/spec/extensions/wizard_field_spec.rb b/spec/extensions/wizard_field_spec.rb new file mode 100644 index 00000000..d13b3c80 --- /dev/null +++ b/spec/extensions/wizard_field_spec.rb @@ -0,0 +1,21 @@ +require 'rails_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 \ No newline at end of file diff --git a/spec/extensions/wizard_step_spec.rb b/spec/extensions/wizard_step_spec.rb new file mode 100644 index 00000000..7d1fbb68 --- /dev/null +++ b/spec/extensions/wizard_step_spec.rb @@ -0,0 +1,23 @@ +require 'rails_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 \ No newline at end of file diff --git a/spec/fixtures/field/field.json b/spec/fixtures/field/field.json new file mode 100644 index 00000000..c2de266d --- /dev/null +++ b/spec/fixtures/field/field.json @@ -0,0 +1,10 @@ +{ + "id": "field_id", + "label": "Field Label", + "image": "field_image_url.png", + "description": "Field description", + "required": true, + "key": "field.locale.key", + "type": "field_type", + "content": [] +} \ No newline at end of file diff --git a/spec/fixtures/mapper/data.json b/spec/fixtures/mapper/data.json new file mode 100644 index 00000000..eca75a1a --- /dev/null +++ b/spec/fixtures/mapper/data.json @@ -0,0 +1,4 @@ +{ + "input_1": "value 1", + "input_2": "value 2" +} \ No newline at end of file diff --git a/spec/fixtures/mapper/inputs.json b/spec/fixtures/mapper/inputs.json new file mode 100644 index 00000000..8faf2435 --- /dev/null +++ b/spec/fixtures/mapper/inputs.json @@ -0,0 +1,264 @@ +{ + "assignment": [ + { + "type": "assignment", + "output_type": "group", + "output_connector": "set", + "output": [ + 13 + ] + } + ], + "assignment_text": [ + { + "type": "assignment", + "output_type": "text", + "output_connector": "set", + "output": "Value" + } + ], + "assignment_user_field": [ + { + "type": "assignment", + "output_type": "user_field", + "output_connector": "set", + "output": "name" + } + ], + "assignment_user_field_options": [ + { + "type": "assignment", + "output_type": "user_field_options", + "output_connector": "set", + "output": "user_field_3" + } + ], + "assignment_wizard_field": [ + { + "type": "assignment", + "output_type": "wizard_field", + "output_connector": "set", + "output": "input_1" + } + ], + "assignment_wizard_action": [ + { + "type": "assignment", + "output_type": "wizard_action", + "output_connector": "set", + "output": "input_2" + } + ], + "interpolate_user_field": [ + { + "type": "assignment", + "output_type": "text", + "output_connector": "set", + "output": "Name: u{name}" + } + ], + "interpolate_wizard_field": [ + { + "type": "assignment", + "output_type": "text", + "output_connector": "set", + "output": "Input 1: w{input_1}" + } + ], + "interpolate_timestamp": [ + { + "type": "assignment", + "output_type": "text", + "output_connector": "set", + "output": "Time: v{time}" + } + ], + "validation": [ + { + "type": "validation", + "pairs": [ + { + "index": 0, + "key": "input_1", + "key_type": "wizard_field", + "value": "value 1", + "value_type": "text", + "connector": "equal" + }, + { + "index": 1, + "key": "input_2", + "key_type": "wizard_field", + "value": "value 2", + "value_type": "text", + "connector": "equal" + } + ] + } + ], + "association": [ + { + "type": "association", + "pairs": [ + { + "index": 0, + "key": "choice1", + "key_type": "text", + "value": "Choice 1", + "value_type": "text", + "connector": "equal" + }, + { + "index": 1, + "key": "choice2", + "key_type": "text", + "value": "Choice 2", + "value_type": "text", + "connector": "association" + }, + { + "index": 2, + "key": "choice3", + "key_type": "text", + "value": "Choice 3", + "value_type": "text", + "connector": "association" + } + ] + } + ], + "conditional": [ + { + "type": "conditional", + "output": "true", + "output_type": "text", + "output_connector": "then", + "pairs": [ + { + "index": 0, + "key": "name", + "key_type": "user_field", + "value": "Angus", + "value_type": "text", + "connector": "equal" + } + ] + } + ], + "conditional_multiple_pairs": [ + { + "type": "conditional", + "output": "true", + "output_type": "text", + "output_connector": "then", + "pairs": [ + { + "index": 0, + "key": "name", + "key_type": "user_field", + "value": "Angus", + "value_type": "text", + "connector": "equal" + }, + { + "index": 1, + "key": "email", + "key_type": "user_field", + "value": "angus@email.com", + "value_type": "text", + "connector": "equal" + } + ] + } + ], + "greater_than_pair": [ + { + "type": "validation", + "pairs": [ + { + "index": 0, + "key": "trust_level", + "key_type": "user_field", + "value": "2", + "value_type": "text", + "connector": "greater" + } + ] + } + ], + "less_than_pair": [ + { + "type": "validation", + "pairs": [ + { + "index": 0, + "key": "trust_level", + "key_type": "user_field", + "value": "2", + "value_type": "text", + "connector": "less" + } + ] + } + ], + "greater_than_or_equal_pair": [ + { + "type": "validation", + "pairs": [ + { + "index": 0, + "key": "trust_level", + "key_type": "user_field", + "value": "1", + "value_type": "text", + "connector": "greater_or_equal" + } + ] + } + ], + "less_than_or_equal_pair": [ + { + "type": "validation", + "pairs": [ + { + "index": 0, + "key": "trust_level", + "key_type": "user_field", + "value": "3", + "value_type": "text", + "connector": "less_or_equal" + } + ] + } + ], + "regex_pair": [ + { + "type": "validation", + "pairs": [ + { + "index": 0, + "key": "email", + "key_type": "user_field", + "value": "@email.com", + "value_type": "text", + "connector": "regex" + } + ] + } + ], + "shorthand_pair": [ + { + "type": "validation", + "pairs": [ + { + "index": 0, + "key": "bio_raw", + "key_type": "user_field", + "value": "present", + "value_type": "text", + "connector": "is" + } + ] + } + ] +} \ No newline at end of file diff --git a/spec/fixtures/step/permitted_params.json b/spec/fixtures/step/permitted_params.json new file mode 100644 index 00000000..d6b7e729 --- /dev/null +++ b/spec/fixtures/step/permitted_params.json @@ -0,0 +1,17 @@ +{ + "permitted_params": [ + { + "type": "association", + "pairs": [ + { + "index": 0, + "key": "param", + "key_type": "text", + "value": "saved_param", + "value_type": "text", + "connector": "association" + } + ] + } + ] +} \ No newline at end of file diff --git a/spec/fixtures/step/required_data.json b/spec/fixtures/step/required_data.json new file mode 100644 index 00000000..9f65d516 --- /dev/null +++ b/spec/fixtures/step/required_data.json @@ -0,0 +1,18 @@ +{ + "required_data_message": "Missing required data", + "required_data": [ + { + "type": "validation", + "pairs": [ + { + "index": 0, + "key": "required_data", + "key_type": "text", + "value": "required_value", + "value_type": "text", + "connector": "equal" + } + ] + } + ] +} \ No newline at end of file diff --git a/spec/fixtures/step/step.json b/spec/fixtures/step/step.json new file mode 100644 index 00000000..5c6c5f58 --- /dev/null +++ b/spec/fixtures/step/step.json @@ -0,0 +1,10 @@ +{ + "id": "step_1", + "title": "Text", + "description": "Step description", + "image": "step_image_url.png", + "key": "step.locale.key", + "fields": [], + "required_data": [], + "permitted": [] +} \ No newline at end of file diff --git a/spec/fixtures/wizard.json b/spec/fixtures/wizard.json index a9251f65..287f3b60 100644 --- a/spec/fixtures/wizard.json +++ b/spec/fixtures/wizard.json @@ -1,49 +1,516 @@ { - "id": "welcome", - "name": "Welcome", - "background": "#006da3", + "id": "super_mega_fun_wizard", + "name": "Super Mega Fun Wizard", + "background": "#333333", "save_submissions": true, "multiple_submissions": true, - "after_signup": true, - "min_trust": 1, - "theme_id": 4, + "after_signup": false, + "prompt_completion": true, + "theme_id": 2, "steps": [ { - "id": "welcome", - "title": "Welcome to Pavilion", - "raw_description": "Hey there, thanks for signing up.\n\nWe're Pavilion, an international freelancer cooperative that specialises in online communities.\n\nThis site is our own community, where we work with our clients, users of our open source work and our broader community.\n\n", - "description": "Hey there, thanks for signing up.
\nWe’re Pavilion, an international freelancer cooperative that specialises in online communities.
\nThis site is our own community, where we work with our clients, users of our open source work and our broader community.
", + "id": "step_1", + "title": "Text", + "raw_description": "Text inputs!", "fields": [ { - "id": "name", + "id": "step_1_field_1", + "label": "Text", + "description": "Text field description.", "type": "text", - "label": "Name" + "min_length": "3", + "prefill": [ + { + "type": "assignment", + "output": "I am prefilled", + "output_type": "text", + "output_connector": "set" + } + ] + }, + { + "id": "step_1_field_2", + "label": "Textarea", + "type": "textarea", + "min_length": "" + }, + { + "id": "step_1_field_3", + "label": "Composer", + "type": "composer" + }, + { + "id": "step_1_field_4", + "label": "I'm only text", + "description": "", + "type": "text_only" + } + ], + "description": "Text inputs!
" + }, + { + "id": "step_2", + "title": "Values", + "raw_description": "Because I couldn't think of another name for this step :)", + "fields": [ + { + "id": "step_2_field_1", + "label": "Date", + "type": "date", + "format": "YYYY-MM-DD" + }, + { + "id": "step_2_field_2", + "label": "Time", + "type": "time", + "format": "HH:mm" + }, + { + "id": "step_2_field_3", + "label": "Date & Time", + "type": "date_time", + "format": "" + }, + { + "id": "step_2_field_4", + "label": "Number", + "type": "number" + }, + { + "id": "step_2_field_5", + "label": "Checkbox", + "type": "checkbox" + }, + { + "id": "step_2_field_7", + "label": "Upload", + "type": "upload", + "file_types": ".jpg,.png" + } + ], + "description": "Because I couldn’t think of another name for this step
Unfortunately not the edible type ![\":sushi:\"](\"/images/emoji/twitter/sushi.png?v=9\" "\\":sushi:\\"")
We’d like to know a little more about you. Add a your name and your website below. This will update your user profile.
", - "fields": [ + "id": "action_6", + "run_after": "step_1", + "type": "add_to_group", + "group": [ { - "id": "website", - "label": "Website", - "type": "text" + "type": "assignment", + "output": "action_9", + "output_type": "wizard_action", + "output_connector": "set" } - ], - "actions": [ + ] + }, + { + "id": "action_8", + "run_after": "step_1", + "type": "create_category", + "custom_fields": [ { - "id": "update_profile", - "type": "update_profile", - "profile_updates": [ + "type": "association", + "pairs": [ { - "key": "name", - "value": "name" + "index": 0, + "key": "category_custom_field", + "key_type": "text", + "value": "CC Val", + "value_type": "text", + "connector": "association" } ] } + ], + "name": [ + { + "type": "assignment", + "output": "step_1_field_1", + "output_type": "wizard_field", + "output_connector": "set" + } + ], + "slug": [ + { + "type": "assignment", + "output": "step_1_field_1", + "output_type": "wizard_field", + "output_connector": "set" + } + ], + "permissions": [ + { + "type": "association", + "pairs": [ + { + "index": 0, + "key": "action_9", + "key_type": "wizard_action", + "value": "2", + "value_type": "text", + "connector": "association" + } + ] + } + ] + }, + { + "id": "action_5", + "run_after": "step_1", + "type": "watch_categories", + "notification_level": "tracking", + "wizard_user": true, + "categories": [ + { + "type": "assignment", + "output": "action_8", + "output_type": "wizard_action", + "output_connector": "set" + } + ], + "mute_remainder": [ + { + "type": "assignment", + "output": "true", + "output_type": "text", + "output_connector": "set" + } + ] + }, + { + "id": "action_1", + "run_after": "step_3", + "type": "create_topic", + "skip_redirect": true, + "post": "step_1_field_2", + "title": [ + { + "type": "assignment", + "output": "step_1_field_1", + "output_type": "wizard_field", + "output_connector": "set" + } + ], + "category": [ + { + "type": "assignment", + "output": "step_3_field_3", + "output_type": "wizard_field", + "output_connector": "set" + } + ], + "tags": [ + { + "type": "assignment", + "output": "step_3_field_2", + "output_type": "wizard_field", + "output_connector": "set" + } + ], + "custom_fields": [ + { + "type": "association", + "pairs": [ + { + "index": 0, + "key": "custom_field_1", + "key_type": "text", + "value": "title", + "value_type": "user_field", + "connector": "association" + } + ] + } + ], + "visible": [ + { + "type": "conditional", + "output": "true", + "output_type": "text", + "output_connector": "then", + "pairs": [ + { + "index": 0, + "key": "name", + "key_type": "user_field", + "value": "Angus", + "value_type": "text", + "connector": "equal" + } + ] + } + ] + }, + { + "id": "action_4", + "run_after": "step_2", + "type": "update_profile", + "profile_updates": [ + { + "type": "association", + "pairs": [ + { + "index": 0, + "key": "profile_background", + "key_type": "user_field", + "value": "step_2_field_7", + "value_type": "wizard_field", + "connector": "association" + } + ] + } + ] + }, + { + "id": "action_2", + "run_after": "step_2", + "type": "send_message", + "post_builder": true, + "post_template": "I will interpolate some wizard fields w{step_1_field_1} w{step_1_field_2}", + "title": [ + { + "type": "assignment", + "output": "Message title", + "output_type": "text", + "output_connector": "set" + } + ], + "recipient": [ + { + "type": "assignment", + "output_type": "user", + "output_connector": "set", + "output": [ + "angus1" + ] + } + ] + }, + { + "id": "action_3", + "run_after": "step_2", + "type": "open_composer", + "post_builder": true, + "post_template": "I am interpolating some user fields u{name} u{username} u{email}", + "title": [ + { + "type": "assignment", + "output": "Title of the composer topic", + "output_type": "text", + "output_connector": "set" + } + ], + "category": [ + { + "type": "assignment", + "output": "action_8", + "output_type": "wizard_action", + "output_connector": "set", + "pairs": [ + { + "index": 0, + "key": "step_2_field_5", + "key_type": "wizard_field", + "value": "true", + "value_type": "text", + "connector": "is" + } + ] + } + ], + "tags": [ + { + "type": "assignment", + "output": "tag1", + "output_type": "text", + "output_connector": "set" + } + ] + }, + { + "id": "action_10", + "run_after": "wizard_completion", + "type": "route_to", + "url": [ + { + "type": "assignment", + "output": "https://google.com", + "output_type": "text", + "output_connector": "set" + } ] } ] diff --git a/spec/fixtures/wizard/after_time.json b/spec/fixtures/wizard/after_time.json new file mode 100644 index 00000000..691af470 --- /dev/null +++ b/spec/fixtures/wizard/after_time.json @@ -0,0 +1,4 @@ +{ + "after_time": true, + "after_time_scheduled": "2020-11-20T00:59:00.000Z" +} \ No newline at end of file diff --git a/spec/fixtures/wizard/permitted.json b/spec/fixtures/wizard/permitted.json new file mode 100644 index 00000000..91d8edf1 --- /dev/null +++ b/spec/fixtures/wizard/permitted.json @@ -0,0 +1,12 @@ +{ + "permitted": [ + { + "type": "assignment", + "output_type": "group", + "output_connector": "set", + "output": [ + 13 + ] + } + ] +} \ No newline at end of file diff --git a/spec/jobs/clear_after_time_wizard_spec.rb b/spec/jobs/clear_after_time_wizard_spec.rb new file mode 100644 index 00000000..b6d675fe --- /dev/null +++ b/spec/jobs/clear_after_time_wizard_spec.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +require 'rails_helper' + +describe Jobs::ClearAfterTimeWizard do + fab!(:user1) { Fabricate(:user) } + fab!(:user2) { Fabricate(:user) } + fab!(:user3) { Fabricate(:user) } + + let(:template) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read).with_indifferent_access + } + let(:after_time) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard/after_time.json" + ).read).with_indifferent_access + } + + it "clears wizard redirect for all users " do + after_time_template = template.dup + after_time_template["after_time"] = after_time['after_time'] + after_time_template["after_time_scheduled"] = after_time['after_time_scheduled'] + + CustomWizard::Template.save(after_time_template) + + described_class.new.execute(wizard_id: 'super_mega_fun_wizard') + + expect( + UserCustomField.where(" + name = 'redirect_to_wizard' AND + value = 'super_mega_fun_wizard' + ").exists? + ).to eq(false) + end +end \ No newline at end of file diff --git a/spec/jobs/set_after_time_wizard_spec.rb b/spec/jobs/set_after_time_wizard_spec.rb new file mode 100644 index 00000000..49ec211f --- /dev/null +++ b/spec/jobs/set_after_time_wizard_spec.rb @@ -0,0 +1,42 @@ +# frozen_string_literal: true + +require 'rails_helper' + +describe Jobs::SetAfterTimeWizard do + fab!(:user1) { Fabricate(:user) } + fab!(:user2) { Fabricate(:user) } + fab!(:user3) { Fabricate(:user) } + + let(:template) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read).with_indifferent_access + } + let(:after_time) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard/after_time.json" + ).read).with_indifferent_access + } + + it "sets wizard redirect for all users " do + after_time_template = template.dup + after_time_template["after_time"] = after_time['after_time'] + after_time_template["after_time_scheduled"] = after_time['after_time_scheduled'] + + CustomWizard::Template.save(after_time_template) + + messages = MessageBus.track_publish("/redirect_to_wizard") do + described_class.new.execute(wizard_id: 'super_mega_fun_wizard') + end + + expect( + UserCustomField.where( + name: 'redirect_to_wizard', + value: 'super_mega_fun_wizard' + ).length + ).to eq(3) + + expect(messages.first.data).to eq("super_mega_fun_wizard") + expect(messages.first.user_ids).to match_array([user1.id,user2.id,user3.id]) + end +end \ No newline at end of file diff --git a/spec/plugin_helper.rb b/spec/plugin_helper.rb index 47368da5..55deb6a2 100644 --- a/spec/plugin_helper.rb +++ b/spec/plugin_helper.rb @@ -3,6 +3,8 @@ require 'simplecov' SimpleCov.configure do add_filter do |src| src.filename !~ /discourse-custom-wizard/ || - src.filename =~ /spec/ + src.filename =~ /spec/ || + src.filename =~ /db/ || + src.filename =~ /api/ ## API features are currently experimental end end \ No newline at end of file diff --git a/spec/requests/custom_wizard/admin/logs_controller_spec.rb b/spec/requests/custom_wizard/admin/logs_controller_spec.rb new file mode 100644 index 00000000..37a83e90 --- /dev/null +++ b/spec/requests/custom_wizard/admin/logs_controller_spec.rb @@ -0,0 +1,22 @@ +require 'rails_helper' + +describe CustomWizard::AdminLogsController do + fab!(:admin_user) { Fabricate(:user, admin: true) } + + before do + CustomWizard::Log.create("First log message") + CustomWizard::Log.create("Second log message") + CustomWizard::Log.create("Third log message") + sign_in(admin_user) + end + + it "returns a list of logs" do + get "/admin/wizards/logs.json" + expect(response.parsed_body.length).to eq(3) + end + + it "paginates" do + get "/admin/wizards/logs.json", params: { page: 1, limit: 2 } + expect(response.parsed_body.length).to eq(1) + end +end \ No newline at end of file diff --git a/spec/requests/custom_wizard/admin/submissions_controller_spec.rb b/spec/requests/custom_wizard/admin/submissions_controller_spec.rb new file mode 100644 index 00000000..51628ea2 --- /dev/null +++ b/spec/requests/custom_wizard/admin/submissions_controller_spec.rb @@ -0,0 +1,45 @@ +require 'rails_helper' + +describe CustomWizard::AdminSubmissionsController do + fab!(:admin_user) {Fabricate(:user, admin: true)} + fab!(:user1) {Fabricate(:user)} + fab!(:user2) {Fabricate(:user)} + + let(:template) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read) + } + + before do + CustomWizard::Template.save(template, skip_jobs: true) + CustomWizard::Wizard.set_submissions(template['id'], user1, + step_1_field_1: "I am a user1's submission" + ) + CustomWizard::Wizard.set_submissions(template['id'], user2, + step_1_field_1: "I am a user2's submission" + ) + sign_in(admin_user) + end + + it "returns a basic list of wizards" do + get "/admin/wizards/submissions.json" + expect(response.parsed_body.length).to eq(1) + expect(response.parsed_body.first['id']).to eq(template['id']) + end + + it "returns the all user's submissions for a wizard" do + get "/admin/wizards/submissions/#{template['id']}.json" + expect(response.parsed_body['submissions'].length).to eq(2) + end + + it "returns the all user's submissions for a wizard" do + get "/admin/wizards/submissions/#{template['id']}.json" + expect(response.parsed_body['submissions'].length).to eq(2) + end + + it "downloads all user submissions" do + get "/admin/wizards/submissions/#{template['id']}/download" + expect(response.parsed_body.length).to eq(2) + end +end \ No newline at end of file diff --git a/spec/requests/custom_wizard/admin/transfer_controller_spec.rb b/spec/requests/custom_wizard/admin/transfer_controller_spec.rb new file mode 100644 index 00000000..217311c2 --- /dev/null +++ b/spec/requests/custom_wizard/admin/transfer_controller_spec.rb @@ -0,0 +1,52 @@ +require 'rails_helper' + +describe CustomWizard::AdminTransferController do + fab!(:admin_user) { Fabricate(:user, admin: true) } + + let(:template) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read) + } + + before do + sign_in(admin_user) + + CustomWizard::Template.save(template, skip_jobs: true) + + template_2 = template.dup + template_2["id"] = 'super_mega_fun_wizard_2' + CustomWizard::Template.save(template_2, skip_jobs: true) + + template_3 = template.dup + template_3["id"] = 'super_mega_fun_wizard_3' + template_3["after_signup"] = true + CustomWizard::Template.save(template_3, skip_jobs: true) + + @template_array = [template, template_2, template_3] + + FileUtils.mkdir_p(file_from_fixtures_tmp_folder) unless Dir.exists?(file_from_fixtures_tmp_folder) + @tmp_file_path = File.join(file_from_fixtures_tmp_folder, SecureRandom.hex << 'wizards.json') + File.write(@tmp_file_path, @template_array.to_json) + end + + it 'exports all the wizard templates' do + get '/admin/wizards/transfer/export.json', params: { + wizards: [ + 'super_mega_fun_wizard', + 'super_mega_fun_wizard_2', + 'super_mega_fun_wizard_3' + ] + } + expect(response.status).to eq(200) + expect(response.parsed_body).to match_array(@template_array) + end + + it 'imports wizard a template' do + post '/admin/wizards/transfer/import.json', params: { + file: fixture_file_upload(File.open(@tmp_file_path)) + } + expect(response.status).to eq(200) + expect(response.parsed_body['success']).to eq(@template_array.map { |t| t['id'] }) + end +end \ No newline at end of file diff --git a/spec/requests/custom_wizard/admin/wizard_controller_spec.rb b/spec/requests/custom_wizard/admin/wizard_controller_spec.rb new file mode 100644 index 00000000..d33762e4 --- /dev/null +++ b/spec/requests/custom_wizard/admin/wizard_controller_spec.rb @@ -0,0 +1,66 @@ +require 'rails_helper' + +describe CustomWizard::AdminWizardController do + fab!(:admin_user) {Fabricate(:user, admin: true)} + fab!(:user1) {Fabricate(:user)} + fab!(:user2) {Fabricate(:user)} + + let(:template) { + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read) + } + + before do + CustomWizard::Template.save(template, skip_jobs: true) + + template_2 = template.dup + template_2["id"] = 'super_mega_fun_wizard_2' + template_2["permitted"] = template_2['permitted'] + CustomWizard::Template.save(template_2, skip_jobs: true) + + template_3 = template.dup + template_3["id"] = 'super_mega_fun_wizard_3' + template_3["after_signup"] = true + CustomWizard::Template.save(template_3, skip_jobs: true) + + sign_in(admin_user) + end + + it "returns a basic list of wizard templates and wizard field types" do + get "/admin/wizards/wizard.json" + expect( + response.parsed_body['wizard_list'].map { |w| w['id'] } + ).to match_array(['super_mega_fun_wizard', 'super_mega_fun_wizard_2', 'super_mega_fun_wizard_3']) + expect( + response.parsed_body['field_types'].keys + ).to eq(CustomWizard::Field.types.keys.map(&:to_s)) + end + + it "returns a wizard template" do + get "/admin/wizards/wizard/#{template['id']}.json" + expect(response.parsed_body['id']).to eq(template['id']) + expect(response.parsed_body['steps'].length).to eq(3) + end + + it "removes wizard templates" do + delete "/admin/wizards/wizard/#{template['id']}.json" + expect(response.status).to eq(200) + expect(CustomWizard::Template.exists?(template['id'])).to eq(false) + end + + it "saves wizard templates" do + template_updated = template.dup + template_updated['name'] = "Super Mega Fun Wizard 2" + template_updated['multiple_submissions'] = false + template_updated['steps'][0]['fields'][0]['label'] = "Text 2" + + put "/admin/wizards/wizard/#{template['id']}.json", params: { wizard: template_updated } + expect(response.status).to eq(200) + + updated_template = CustomWizard::Template.find('super_mega_fun_wizard') + expect(updated_template['name']).to eq("Super Mega Fun Wizard 2") + expect(updated_template['multiple_submissions']).to eq("false") + expect(updated_template['steps'][0]['fields'][0]['label']).to eq("Text 2") + end +end \ No newline at end of file diff --git a/spec/requests/custom_wizard/admin_controller_spec.rb b/spec/requests/custom_wizard/admin_controller_spec.rb deleted file mode 100644 index 731d0de5..00000000 --- a/spec/requests/custom_wizard/admin_controller_spec.rb +++ /dev/null @@ -1,5 +0,0 @@ -require 'rails_helper' - -describe CustomWizard::AdminController do - -end \ No newline at end of file diff --git a/spec/requests/custom_wizard/application_controller_spec.rb b/spec/requests/custom_wizard/application_controller_spec.rb index 1315748d..4c67cc41 100644 --- a/spec/requests/custom_wizard/application_controller_spec.rb +++ b/spec/requests/custom_wizard/application_controller_spec.rb @@ -1,5 +1,61 @@ require 'rails_helper' describe ApplicationController do + fab!(:user) { + Fabricate( + :user, + username: 'angus', + email: "angus@email.com", + trust_level: TrustLevel[3] + ) + } + before do + CustomWizard::Template.save( + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read), + skip_jobs: true) + @template = CustomWizard::Template.find('super_mega_fun_wizard') + end + + context "with signed in user" do + before do + sign_in(user) + end + + context "who is required to complete wizard" do + before do + user.custom_fields['redirect_to_wizard'] = 'super_mega_fun_wizard' + user.save_custom_fields(true) + end + + it "redirects if user is required to complete a wizard" do + get "/" + expect(response).to redirect_to("/w/super-mega-fun-wizard") + end + + it "saves original destination of user" do + get '/', headers: { 'REFERER' => "/t/2" } + expect( + CustomWizard::Wizard.submissions(@template['id'], user) + .first['redirect_to'] + ).to eq("/t/2") + end + end + + context "who is not required to complete wizard" do + it "does nothing" do + get "/" + expect(response.status).to eq(200) + end + end + end + + context "with guest" do + it "does nothing" do + get "/" + expect(response.status).to eq(200) + end + end end \ No newline at end of file diff --git a/spec/requests/custom_wizard/steps_controller_spec.rb b/spec/requests/custom_wizard/steps_controller_spec.rb new file mode 100644 index 00000000..eeea6c17 --- /dev/null +++ b/spec/requests/custom_wizard/steps_controller_spec.rb @@ -0,0 +1,34 @@ +require 'rails_helper' + +describe CustomWizard::StepsController do + fab!(:user) { + Fabricate( + :user, + username: 'angus', + email: "angus@email.com", + trust_level: TrustLevel[3] + ) + } + + before do + CustomWizard::Template.save( + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read), + skip_jobs: true) + sign_in(user) + end + + it 'performs a step update' do + put '/w/super-mega-fun-wizard/steps/step_1.json', params: { + fields: { + step_1_field_1: "Text input" + } + } + expect(response.status).to eq(200) + + 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") + end +end \ No newline at end of file diff --git a/spec/requests/custom_wizard/wizard_controller_spec.rb b/spec/requests/custom_wizard/wizard_controller_spec.rb index b457eba7..a9833381 100644 --- a/spec/requests/custom_wizard/wizard_controller_spec.rb +++ b/spec/requests/custom_wizard/wizard_controller_spec.rb @@ -1,31 +1,63 @@ require 'rails_helper' describe CustomWizard::WizardController do - it 'returns a wizard if enabled' do - + fab!(:user) { + Fabricate( + :user, + username: 'angus', + email: "angus@email.com", + trust_level: TrustLevel[3] + ) + } + + before do + CustomWizard::Template.save( + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read), + skip_jobs: true) + @template = CustomWizard::Template.find("super_mega_fun_wizard") + sign_in(user) end - it 'returns a disabled message if disabled' do - - end - - it 'returns a missing message if no wizard exists' do - - end - - it 'returns a custom wizard theme' do - - end - - it 'updates the page title' do - - end - - it 'skips a wizard if user is allowed to skip' do + context 'plugin disabled' do + before do + SiteSetting.custom_wizard_enabled = false + end + it 'redirects to root' do + get '/w/super-mega-fun-wizard', xhr: true + expect(response).to redirect_to("/") + end + end + + it 'returns wizard' do + get '/w/super-mega-fun-wizard.json' + expect(response.parsed_body["id"]).to eq("super_mega_fun_wizard") + end + + it 'returns missing message if no wizard exists' do + get '/w/super-mega-fun-wizards.json' + expect(response.parsed_body["error"]).to eq("We couldn't find a wizard at that address.") + end + + it 'skips a wizard if user is allowed to skip' do + put '/w/super-mega-fun-wizard/skip.json' + expect(response.status).to eq(200) end it 'returns a no skip message if user is not allowed to skip' do + @template['required'] = 'true' + CustomWizard::Template.save(@template) + put '/w/super-mega-fun-wizard/skip.json' + expect(response.parsed_body['error']).to eq("Wizard can't be skipped") + end + it 'skip response contains a redirect_to if in users submissions' do + CustomWizard::Wizard.set_submissions(@template['id'], user, + redirect_to: '/t/2' + ) + put '/w/super-mega-fun-wizard/skip.json' + expect(response.parsed_body['redirect_to']).to eq('/t/2') end end \ No newline at end of file diff --git a/spec/serializers/custom_wizard/basic_wizard_serializer_spec.rb b/spec/serializers/custom_wizard/basic_wizard_serializer_spec.rb new file mode 100644 index 00000000..0e088e2d --- /dev/null +++ b/spec/serializers/custom_wizard/basic_wizard_serializer_spec.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +require 'rails_helper' + +describe CustomWizard::BasicWizardSerializer do + fab!(:user) { Fabricate(:user) } + + it 'should return basic wizard attributes' do + CustomWizard::Template.save( + JSON.parse(File.open( + "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json" + ).read), + skip_jobs: true) + json = CustomWizard::BasicWizardSerializer.new( + CustomWizard::Builder.new("super_mega_fun_wizard", user).build, + scope: Guardian.new(user) + ).as_json + expect(json[:basic_wizard][:id]).to eq("super_mega_fun_wizard") + expect(json[:basic_wizard][:name]).to eq("Super Mega Fun Wizard") + end +end \ No newline at end of file diff --git a/spec/serializers/custom_wizard/log_serializer_spec.rb b/spec/serializers/custom_wizard/log_serializer_spec.rb new file mode 100644 index 00000000..2ea39871 --- /dev/null +++ b/spec/serializers/custom_wizard/log_serializer_spec.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +require 'rails_helper' + +describe CustomWizard::LogSerializer do + fab!(:user) { Fabricate(:user) } + + it 'should return log attributes' do + CustomWizard::Log.create("First log message") + CustomWizard::Log.create("Second log message") + + json_array = ActiveModel::ArraySerializer.new( + CustomWizard::Log.list(0), + each_serializer: CustomWizard::LogSerializer + ).as_json + expect(json_array.length).to eq(2) + expect(json_array[0][:message]).to eq("Second log message") + end +end \ No newline at end of file diff --git a/spec/serializers/custom_wizard/wizard_field_serializer_spec.rb b/spec/serializers/custom_wizard/wizard_field_serializer_spec.rb new file mode 100644 index 00000000..02069a9b --- /dev/null +++ b/spec/serializers/custom_wizard/wizard_field_serializer_spec.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +require 'rails_helper' + +describe CustomWizard::FieldSerializer do + fab!(:user) { Fabricate(:user) } + + 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 field attributes" do + json_array = ActiveModel::ArraySerializer.new( + @wizard.steps.first.fields, + each_serializer: CustomWizard::FieldSerializer, + scope: Guardian.new(user) + ).as_json + expect(json_array.length).to eq(4) + expect(json_array[0][:label]).to eq("Text
") + expect(json_array[0][:description]).to eq("Text field description.") + end + + it "should return optional field attributes" do + json_array = ActiveModel::ArraySerializer.new( + @wizard.steps.second.fields, + each_serializer: CustomWizard::FieldSerializer, + scope: Guardian.new(user) + ).as_json + expect(json_array[0][:format]).to eq("YYYY-MM-DD") + expect(json_array[5][:file_types]).to eq(".jpg,.png") + end +end \ No newline at end of file diff --git a/spec/serializers/custom_wizard/wizard_serializer_spec.rb b/spec/serializers/custom_wizard/wizard_serializer_spec.rb index a470bccd..16734f83 100644 --- a/spec/serializers/custom_wizard/wizard_serializer_spec.rb +++ b/spec/serializers/custom_wizard/wizard_serializer_spec.rb @@ -2,48 +2,85 @@ require 'rails_helper' -describe CustomWizardSerializer do +describe CustomWizard::WizardSerializer do fab!(:user) { Fabricate(:user) } fab!(:category) { Fabricate(:category) } - let!(:template) do - JSON.parse(File.open( - "#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.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) + @template = CustomWizard::Template.find('super_mega_fun_wizard') end - let(:category_field) {{"id": "category","type": "category","limit": "1","label": "Category"}} - - def build_wizard(t = template, u = user, build_opts = {}, params = {}) - CustomWizard::Wizard.add_wizard(t) - CustomWizard::Builder.new('welcome', u).build(build_opts, params) - end - it 'should return the wizard attributes' do - json = CustomWizardSerializer.new(build_wizard, scope: Guardian.new(user)).as_json - expect(json[:custom_wizard][:id]).to eq("welcome") - expect(json[:custom_wizard][:name]).to eq("Welcome") - expect(json[:custom_wizard][:background]).to eq("#006da3") - expect(json[:custom_wizard][:required]).to eq(false) - expect(json[:custom_wizard][:min_trust]).to eq(1) + json = CustomWizard::WizardSerializer.new( + CustomWizard::Builder.new(@template[:id], user).build, + scope: Guardian.new(user) + ).as_json + expect(json[:wizard][:id]).to eq("super_mega_fun_wizard") + expect(json[:wizard][:name]).to eq("Super Mega Fun Wizard") + expect(json[:wizard][:background]).to eq("#333333") + expect(json[:wizard][:required]).to eq(false) + end + + it 'should return the wizard steps' do + json = CustomWizard::WizardSerializer.new( + CustomWizard::Builder.new(@template[:id], user).build, + scope: Guardian.new(user) + ).as_json + expect(json[:wizard][:steps].length).to eq(3) end it "should return the wizard user attributes" do - json = CustomWizardSerializer.new(build_wizard, scope: Guardian.new(user)).as_json - expect(json[:custom_wizard][:permitted]).to eq(true) - expect(json[:custom_wizard][:user]).to eq(BasicUserSerializer.new(user, root: false).as_json) + json = CustomWizard::WizardSerializer.new( + CustomWizard::Builder.new(@template[:id], user).build, + scope: Guardian.new(user) + ).as_json + expect( + json[:wizard][:user] + ).to eq(BasicUserSerializer.new(user, root: false).as_json) end - it "should not return category attributes if there are no category fields" do - json = CustomWizardSerializer.new(build_wizard, scope: Guardian.new(user)).as_json - expect(json[:custom_wizard][:categories].present?).to eq(false) - expect(json[:custom_wizard][:uncategorized_category_id].present?).to eq(false) + it "should not return categories if there are no category fields" do + @template[:steps][2][:fields].delete_at(2) + CustomWizard::Template.save(@template) + + json = CustomWizard::WizardSerializer.new( + CustomWizard::Builder.new(@template[:id], user).build, + scope: Guardian.new(user) + ).as_json + expect(json[:wizard][:categories].present?).to eq(false) + expect(json[:wizard][:uncategorized_category_id].present?).to eq(false) end - it "should return category attributes if there is a category selector field" do - template['steps'][0]['fields'][0] = category_field - json = CustomWizardSerializer.new(build_wizard(template), scope: Guardian.new(user)).as_json - expect(json[:custom_wizard][:categories].present?).to eq(true) - expect(json[:custom_wizard][:uncategorized_category_id].present?).to eq(true) + it "should return categories if there is a category selector field" do + json = CustomWizard::WizardSerializer.new( + CustomWizard::Builder.new(@template[:id], user).build, + scope: Guardian.new(user) + ).as_json + expect(json[:wizard][:categories].present?).to eq(true) + expect(json[:wizard][:uncategorized_category_id].present?).to eq(true) + end + + it 'should return groups if there is a group selector field' do + json = CustomWizard::WizardSerializer.new( + CustomWizard::Builder.new(@template[:id], user).build, + scope: Guardian.new(user) + ).as_json + expect(json[:wizard][:groups].length).to eq(8) + end + + it 'should not return groups if there is not a group selector field' do + @template[:steps][2][:fields].delete_at(3) + CustomWizard::Template.save(@template) + + json = CustomWizard::WizardSerializer.new( + CustomWizard::Builder.new(@template[:id], user).build, + scope: Guardian.new(user) + ).as_json + expect(json[:wizard][:groups].present?).to eq(false) end end \ No newline at end of file diff --git a/spec/serializers/custom_wizard/wizard_step_serializer.rb b/spec/serializers/custom_wizard/wizard_step_serializer.rb new file mode 100644 index 00000000..30e8cc5f --- /dev/null +++ b/spec/serializers/custom_wizard/wizard_step_serializer.rb @@ -0,0 +1,59 @@ +# frozen_string_literal: true + +require 'rails_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 \ No newline at end of file