1
0
Fork 0
discourse-custom-wizard-unl.../spec/components/custom_wizard/wizard_spec.rb

272 Zeilen
7,9 KiB
Ruby

2021-03-11 07:30:15 +01:00
# frozen_string_literal: true
2020-11-03 01:24:20 +01:00
describe CustomWizard::Wizard do
fab!(:user) { Fabricate(:user) }
2021-03-11 07:30:15 +01:00
fab!(:trusted_user) { Fabricate(:user, trust_level: TrustLevel[3]) }
fab!(:admin_user) { Fabricate(:user, admin: true) }
2020-11-03 01:24:20 +01:00
let(:template_json) {
JSON.parse(
File.open(
"#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json"
).read
)
2020-11-03 01:24:20 +01:00
}
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
let(:permitted_json) {
JSON.parse(
File.open(
"#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard/permitted.json"
).read
)
2020-11-03 01:24:20 +01:00
}
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
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
2020-11-03 01:24:20 +01:00
template_json['steps'].each do |step_template|
@wizard.append_step(step_template['id'])
end
@wizard.update!
2020-11-03 01:24:20 +01:00
end
2021-03-11 07:30:15 +01:00
def progress_step(step_id, acting_user: user, wizard: @wizard)
2020-11-03 01:24:20 +01:00
UserHistory.create(
action: UserHistory.actions[:custom_wizard_step],
acting_user_id: acting_user.id,
context: wizard.id,
2020-11-03 01:24:20 +01:00
subject: step_id
)
@wizard.update!
2021-03-11 07:30:15 +01:00
end
it "appends steps" do
append_steps
2020-11-03 01:24:20 +01:00
expect(@wizard.steps.length).to eq(3)
end
2021-03-11 07:30:15 +01:00
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!
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
2020-11-03 01:24:20 +01:00
it "determines the user's current step" do
append_steps
expect(@wizard.start).to eq('step_1')
2020-11-03 01:24:20 +01:00
progress_step('step_1')
expect(@wizard.start).to eq('step_2')
2020-11-03 01:24:20 +01:00
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "creates a step updater" do
expect(
@wizard.create_updater('step_1', step_1_field_1: "Text input")
.class
).to eq(CustomWizard::StepUpdater)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "determines whether a wizard is unfinished" do
append_steps
2020-11-03 01:24:20 +01:00
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
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "determines whether a wizard has been completed by a user" do
append_steps
2020-11-03 01:24:20 +01:00
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
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "is not completed if steps submitted before after time" do
append_steps
2020-11-03 01:24:20 +01:00
progress_step("step_1")
progress_step("step_2")
progress_step("step_3")
2021-03-11 07:30:15 +01:00
2020-11-23 01:40:46 +01:00
template_json['after_time'] = true
template_json['after_time_scheduled'] = Time.now + 3.hours
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
wizard = CustomWizard::Wizard.new(template_json, user)
expect(wizard.completed?).to eq(false)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "permits admins" do
expect(
CustomWizard::Wizard.new(@permitted_template, admin_user).permitted?
).to eq(true)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "permits permitted users" do
expect(
CustomWizard::Wizard.new(@permitted_template, trusted_user).permitted?
).to eq(true)
end
it "permits everyone if everyone is permitted" do
@permitted_template['permitted'][0]['output'] = Group::AUTO_GROUPS[:everyone]
expect(
CustomWizard::Wizard.new(@permitted_template, user).permitted?
).to eq(true)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "does not permit unpermitted users" do
expect(
CustomWizard::Wizard.new(@permitted_template, user).permitted?
).to eq(false)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "does not let an unpermitted user access a wizard" do
expect(
CustomWizard::Wizard.new(@permitted_template, user).can_access?
).to eq(false)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "lets a permitted user access an incomplete wizard" do
expect(
CustomWizard::Wizard.new(@permitted_template, trusted_user).can_access?
).to eq(true)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
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)
2021-03-11 07:30:15 +01:00
@permitted_template["multiple_submissions"] = true
2020-11-03 01:24:20 +01:00
expect(
CustomWizard::Wizard.new(@permitted_template, trusted_user).can_access?
).to eq(true)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
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)
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
@permitted_template['multiple_submissions'] = false
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
expect(
CustomWizard::Wizard.new(@permitted_template, trusted_user).can_access?
).to eq(false)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "lists the site groups" do
expect(@wizard.groups.length).to eq(8)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "lists the site categories" do
Site.clear_cache
2020-11-03 01:24:20 +01:00
expect(@wizard.categories.length).to eq(1)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
context "submissions" do
before do
CustomWizard::Submission.new(@wizard, step_1_field_1: "I am a user submission").save
2020-11-03 01:24:20 +01:00
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "lists the user's submissions" do
expect(@wizard.submissions.length).to eq(1)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "returns the user's current submission" do
expect(@wizard.current_submission.fields["step_1_field_1"]).to eq("I am a user submission")
2020-11-03 01:24:20 +01:00
end
end
2021-03-11 07:30:15 +01:00
context "class methods" do
2020-11-03 01:24:20 +01:00
before do
CustomWizard::Template.save(@permitted_template, skip_jobs: true)
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
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)
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
template_json_3 = template_json.dup
template_json_3["id"] = 'super_mega_fun_wizard_3'
template_json_3["after_signup"] = true
template_json_3["prompt_completion"] = true
2020-11-03 01:24:20 +01:00
CustomWizard::Template.save(template_json_3, skip_jobs: true)
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
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
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "returns the first after signup wizard" do
expect(CustomWizard::Wizard.after_signup(user).id).to eq('super_mega_fun_wizard_3')
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "lists prompt completion wizards" do
expect(CustomWizard::Wizard.prompt_completion(user).length).to eq(2)
end
2021-03-11 07:30:15 +01:00
it "prompt completion does not include wizards user has completed" do
wizard_2 = CustomWizard::Wizard.new(CustomWizard::Template.find('super_mega_fun_wizard_2'), user)
progress_step("step_1", wizard: wizard_2)
progress_step("step_2", wizard: wizard_2)
progress_step("step_3", wizard: wizard_2)
expect(CustomWizard::Wizard.prompt_completion(user).length).to eq(1)
end
2020-11-03 01:24:20 +01:00
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "sets wizard redirects if user is permitted" do
CustomWizard::Template.save(@permitted_template, skip_jobs: true)
CustomWizard::Wizard.set_user_redirect('super_mega_fun_wizard', trusted_user)
2020-11-03 01:24:20 +01:00
expect(
trusted_user.custom_fields['redirect_to_wizard']
).to eq("super_mega_fun_wizard")
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
it "does not set a wizard redirect if user is not permitted" do
CustomWizard::Template.save(@permitted_template, skip_jobs: true)
CustomWizard::Wizard.set_user_redirect('super_mega_fun_wizard', user)
2020-11-03 01:24:20 +01:00
expect(
trusted_user.custom_fields['redirect_to_wizard']
).to eq(nil)
end
2021-03-11 07:30:15 +01:00
end