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

389 Zeilen
15 KiB
Ruby

2019-12-04 12:13:51 +01:00
# frozen_string_literal: true
require 'rails_helper'
describe CustomWizard::Builder do
2019-12-09 06:51:42 +01:00
fab!(:user) { Fabricate(:user, username: 'angus') }
fab!(:trusted_user) { Fabricate(:user, trust_level: 3) }
2019-12-12 00:20:10 +01:00
fab!(:category1) { Fabricate(:category, name: 'cat1') }
fab!(:category2) { Fabricate(:category, name: 'cat2') }
2019-12-09 06:51:42 +01:00
fab!(:group) { Fabricate(:group) }
2019-12-04 12:13:51 +01:00
2019-12-06 10:05:19 +01:00
let!(:template) do
JSON.parse(File.open(
"#{Rails.root}/plugins/discourse-custom-wizard/spec/fixtures/wizard.json"
2019-12-06 10:05:19 +01:00
).read)
end
2019-12-09 02:43:30 +01:00
let(:permitted_params) {[{"key":"param_key","value":"submission_param_key"}]}
let(:required_data) {[{"key":"nickname","connector":"equals","value":"name"}]}
let(:required_data_message) {"Nickname is required to match your name"}
let(:checkbox_field) {{"id":"checkbox","type":"checkbox","label":"Checkbox"}}
let(:composer_field) {{"id": "composer","label":"Composer","type":"composer"}}
let(:dropdown_categories_field) {{"id": "dropdown_categories","type": "dropdown","label": "Dropdown Categories","choices_type": "preset","choices_preset": "categories"}}
let(:tag_field) {{"id": "tag","type": "tag","label": "Tag","limit": "2"}}
let(:category_field) {{"id": "category","type": "category","limit": "1","label": "Category"}}
let(:image_field) {{"id": "image","type": "image","label": "Image"}}
2019-12-09 06:51:42 +01:00
let(:text_field) {{"id": "text","type": "text","label": "Text"}}
let(:textarea_field) {{"id": "textarea","type": "textarea","label": "Textarea"}}
2019-12-09 02:43:30 +01:00
let(:text_only_field) {{"id": "text_only","type": "text-only","label": "Text only"}}
let(:upload_field) {{"id": "upload","type": "upload","file_types": ".jpg,.png,.pdf","label": "Upload"}}
let(:user_selector_field) {{"id": "user_selector","type": "user-selector","label": "User selector"}}
let(:dropdown_groups_field) {{"id": "dropdown_groups","type": "dropdown","choices_type": "preset","choices_preset": "groups","label": "Dropdown Groups"}}
let(:dropdown_tags_field) {{"id": "dropdown_tags","type": "dropdown","choices_type": "preset","choices_preset": "tags","label": "Dropdown Tags"}}
let(:dropdown_custom_field) {{"id": "dropdown_custom","type": "dropdown","choices_type": "custom","choices": [{"key": "option_1","value": "Option 1"},{"key": "option_2","value": "Option 2"}]}}
let(:dropdown_translation_field) {{"id": "dropdown_translation","type": "dropdown","choices_type": "translation","choices_key": "key1.key2"}}
2019-12-12 00:20:10 +01:00
let(:dropdown_categories_filtered_field) {{"id": "dropdown_categories_filtered_field","type": "dropdown","choices_type": "preset","choices_preset": "categories","choices_filters": [{"key": "slug","value": "cat2"}]}}
2019-12-09 06:51:42 +01:00
let(:create_topic_action) {{"id":"create_topic","type":"create_topic","title":"text","post":"textarea"}}
let(:send_message_action) {{"id":"send_message","type":"send_message","title":"text","post":"textarea","username":"angus"}}
let(:route_to_action) {{"id":"route_to","type":"route_to","url":"https://google.com"}}
let(:open_composer_action) {{"id":"open_composer","type":"open_composer","title":"text","post":"textarea"}}
let(:add_to_group_action) {{"id":"add_to_group","type":"add_to_group","group_id":"dropdown_groups"}}
2019-12-09 02:43:30 +01:00
2019-12-06 10:05:19 +01:00
def build_wizard(t = template, u = user, build_opts = {}, params = {})
CustomWizard::Wizard.add_wizard(t)
CustomWizard::Builder.new(u, 'welcome').build(build_opts, params)
end
2019-12-09 02:43:30 +01:00
def add_submission_data(data = {})
PluginStore.set("welcome_submissions", user.id, {
2019-12-06 10:05:19 +01:00
name: 'Angus',
website: 'https://thepavilion.io'
2019-12-09 02:43:30 +01:00
}.merge(data))
end
def get_submission_data
PluginStore.get("welcome_submissions", user.id)
2019-12-04 12:13:51 +01:00
end
2019-12-09 06:51:42 +01:00
def run_update(t = template, step_id = nil, data = {})
wizard = build_wizard(t)
updater = wizard.create_updater(step_id || t['steps'][0]['id'], data)
updater.update
updater
end
def send_message(extra_field = nil, extra_action_opts = {})
fields = [text_field, textarea_field]
if extra_field
fields.push(extra_field)
end
template['steps'][0]['fields'] = fields
template['steps'][0]["actions"] = [send_message_action.merge(extra_action_opts)]
run_update(template, nil,
text: "Message Title",
textarea: "message body"
)
end
context 'disabled' do
before do
SiteSetting.custom_wizard_enabled = false
end
it "returns no steps" do
wizard = build_wizard
expect(wizard.steps.length).to eq(0)
expect(wizard.name).to eq('Welcome')
end
it "doesn't save submissions" do
run_update(template, nil, name: 'Angus')
expect(get_submission_data.blank?).to eq(true)
end
2019-12-04 12:13:51 +01:00
end
context 'enabled' do
before do
SiteSetting.custom_wizard_enabled = true
2019-12-04 12:13:51 +01:00
end
2019-12-06 10:05:19 +01:00
it "returns steps" do
expect(build_wizard.steps.length).to eq(2)
2019-12-04 12:13:51 +01:00
end
2019-12-06 10:05:19 +01:00
it 'returns no steps if the multiple submissions are disabled and user has completed it' do
history_params = {
action: UserHistory.actions[:custom_wizard_step],
acting_user_id: user.id,
context: template['id']
}
UserHistory.create!(history_params.merge(subject: template['steps'][0]['id']))
UserHistory.create!(history_params.merge(subject: template['steps'][1]['id']))
template["multiple_submissions"] = false
expect(build_wizard(template).steps.length).to eq(0)
2019-12-04 12:13:51 +01:00
end
2019-12-06 10:05:19 +01:00
it 'returns no steps if has min trust and user does not meet it' do
template["min_trust"] = 3
expect(build_wizard(template).steps.length).to eq(0)
2019-12-04 12:13:51 +01:00
end
2019-12-06 10:05:19 +01:00
it 'returns steps if it has min trust and user meets it' do
template["min_trust"] = 3
expect(build_wizard(template, trusted_user).steps.length).to eq(2)
end
2019-12-04 12:13:51 +01:00
2019-12-06 10:05:19 +01:00
it 'returns a wizard with prefilled data if user has partially completed it' do
add_submission_data
wizard = build_wizard
expect(wizard.steps[0].fields.first.value).to eq('Angus')
expect(wizard.steps[1].fields.first.value).to eq('https://thepavilion.io')
2019-12-04 12:13:51 +01:00
end
it 'returns a wizard with no prefilled data if options include reset' do
2019-12-06 10:05:19 +01:00
add_submission_data
wizard = build_wizard(template, user, reset: true)
expect(wizard.steps[0].fields.first.value).to eq(nil)
expect(wizard.steps[1].fields.first.value).to eq(nil)
2019-12-04 12:13:51 +01:00
end
context 'building steps' do
2019-12-06 10:05:19 +01:00
it 'returns step metadata' do
expect(build_wizard.steps[0].title).to eq('Welcome to Pavilion')
expect(build_wizard.steps[1].title).to eq('Tell us about you')
2019-12-04 12:13:51 +01:00
end
it 'saves permitted params' do
2019-12-09 02:43:30 +01:00
template['steps'][0]['permitted_params'] = permitted_params
2019-12-06 10:05:19 +01:00
wizard = build_wizard(template, user, {}, param_key: 'param_value')
2019-12-09 02:43:30 +01:00
submissions = get_submission_data
2019-12-06 10:05:19 +01:00
expect(submissions.first['submission_param_key']).to eq('param_value')
2019-12-04 12:13:51 +01:00
end
2019-12-09 02:43:30 +01:00
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)
2019-12-04 12:13:51 +01:00
end
2019-12-09 02:43:30 +01:00
it "is not permitted if required data is not present" do
template['steps'][0]['required_data'] = required_data
add_submission_data(nickname: "John")
expect(build_wizard(template, user).steps[0].permitted).to eq(false)
2019-12-04 12:13:51 +01:00
end
2019-12-09 02:43:30 +01:00
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)
2019-12-04 12:13:51 +01:00
end
2019-12-09 02:43:30 +01:00
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)
2019-12-04 12:13:51 +01:00
end
2019-12-09 02:43:30 +01:00
it 'returns field metadata' do
expect(build_wizard(template, user).steps[0].fields[0].label).to eq("<p>Name</p>")
expect(build_wizard(template, user).steps[0].fields[0].type).to eq("text")
2019-12-04 12:13:51 +01:00
end
2019-12-09 02:43:30 +01:00
it 'returns fields' do
template['steps'][0]['fields'][1] = checkbox_field
expect(build_wizard(template, user).steps[0].fields.length).to eq(2)
2019-12-04 12:13:51 +01:00
end
2019-12-12 00:20:10 +01:00
it 'returns a preset dropdown' do
2020-02-05 08:20:39 +01:00
SiteSetting.allow_uncategorized_topics = false
2019-12-12 00:20:10 +01:00
template['steps'][0]['fields'][0] = dropdown_categories_field
choices = build_wizard(template, user).steps[0].fields[0].choices
expect(choices.present?).to eq(true)
expect(choices.length).to eq(2)
expect(choices.first.label).to eq("<p>cat1</p>")
end
it 'returns a filtered preset dropdown' do
template['steps'][0]['fields'][0] = dropdown_categories_filtered_field
choices = build_wizard(template, user).steps[0].fields[0].choices
expect(choices.present?).to eq(true)
expect(choices.length).to eq(1)
expect(choices.first.label).to eq("<p>cat2</p>")
end
end
context 'on update' do
2019-12-09 06:51:42 +01:00
it 'saves submissions' do
run_update(template, nil, name: 'Angus')
expect(get_submission_data.first['name']).to eq('Angus')
end
context 'validation' do
2019-12-09 02:43:30 +01:00
it 'applies min length' do
template['steps'][0]['fields'][0]['min_length'] = 10
2019-12-09 06:51:42 +01:00
updater = run_update(template, nil, name: 'short')
2019-12-09 02:43:30 +01:00
expect(updater.errors.messages[:name].first).to eq(
I18n.t('wizard.field.too_short', label: 'Name', min: 10)
)
end
it 'standardises boolean entries' do
2019-12-09 02:43:30 +01:00
template['steps'][0]['fields'][0] = checkbox_field
2019-12-09 06:51:42 +01:00
run_update(template, nil, checkbox: 'false')
expect(get_submission_data.first['checkbox']).to eq(false)
end
it 'requires required fields' do
2019-12-09 06:51:42 +01:00
template['steps'][0]['fields'][0]['required'] = true
expect(run_update(template).errors.messages[:name].first).to eq(
2019-12-09 02:43:30 +01:00
I18n.t('wizard.field.required', label: 'Name')
)
end
end
context 'actions' do
2019-12-09 06:51:42 +01:00
it 'runs actions attached to a step' do
run_update(template, template['steps'][1]['id'], name: "Gus")
expect(user.name).to eq('Gus')
end
2019-12-09 06:51:42 +01:00
it 'interpolates user data correctly' do
user.name = "Angus"
user.save!
expect(
CustomWizard::Builder.fill_placeholders(
"My name is u{name}",
user,
{}
)
).to eq('My name is Angus')
end
it 'creates a topic' do
2019-12-09 06:51:42 +01:00
template['steps'][0]['fields'] = [text_field, textarea_field]
template['steps'][0]["actions"] = [create_topic_action]
updater = run_update(template, nil,
text: "Topic Title",
textarea: "topic body"
)
topic = Topic.where(title: "Topic Title")
expect(topic.exists?).to eq(true)
expect(Post.where(
topic_id: topic.pluck(:id),
raw: "topic body"
).exists?).to eq(true)
end
2019-12-09 06:51:42 +01:00
it 'creates a topic with a custom title' do
user.name = "Angus"
user.save!
template['steps'][0]['fields'] = [text_field, textarea_field]
create_topic_action['custom_title_enabled'] = true
create_topic_action['custom_title'] = "u{name}' Topic Title"
template['steps'][0]["actions"] = [create_topic_action]
run_update(template, nil, textarea: "topic body")
topic = Topic.where(title: "Angus' Topic Title")
expect(topic.exists?).to eq(true)
expect(Post.where(
topic_id: topic.pluck(:id),
raw: "topic body"
).exists?).to eq(true)
end
2019-12-09 06:51:42 +01:00
it 'creates a topic with a custom post' do
user.name = "Angus"
user.save!
template['steps'][0]['fields'] = [text_field, textarea_field]
create_topic_action['post_builder'] = true
create_topic_action['post_template'] = "u{name}' w{textarea}"
template['steps'][0]["actions"] = [create_topic_action]
run_update(template, nil,
text: "Topic Title",
textarea: "topic body"
)
topic = Topic.where(title: "Topic Title")
expect(topic.exists?).to eq(true)
expect(Post.where(
topic_id: topic.pluck(:id),
raw: "Angus' topic body"
).exists?).to eq(true)
end
2019-12-09 06:51:42 +01:00
it 'sends a message' do
send_message
topic = Topic.where(
archetype: Archetype.private_message,
title: "Message Title"
)
expect(topic.exists?).to eq(true)
expect(
topic.first.topic_allowed_users.first.user.username
).to eq('angus')
expect(Post.where(
topic_id: topic.pluck(:id),
raw: "message body"
).exists?).to eq(true)
end
it 'doesnt sent a message if the required data is not present' do
2019-12-09 06:51:42 +01:00
send_message(user_selector_field, required: "user_selector")
topic = Topic.where(
archetype: Archetype.private_message,
title: "Message Title"
)
expect(topic.exists?).to eq(false)
end
it 'updates a profile' do
2019-12-09 06:51:42 +01:00
run_update(template, template['steps'][1]['id'], name: "Sally")
expect(user.name).to eq('Sally')
end
it 'opens a composer' do
2019-12-09 06:51:42 +01:00
template['steps'][0]['fields'] = [text_field, textarea_field]
template['steps'][0]["actions"] = [open_composer_action]
updater = run_update(template, nil,
text: "Topic Title",
textarea: "topic body"
)
expect(updater.result.blank?).to eq(true)
updater = run_update(template, template['steps'][1]['id'])
expect(updater.result[:redirect_on_complete]).to eq(
"/new-topic?title=Topic%20Title&body=topic%20body"
)
end
2019-12-09 06:51:42 +01:00
it 'adds a user to a group' do
template['steps'][0]['fields'] = [dropdown_groups_field]
template['steps'][0]["actions"] = [add_to_group_action]
updater = run_update(template, nil, dropdown_groups: group.id)
expect(group.users.first.username).to eq('angus')
end
it 're-routes a user' do
2019-12-09 06:51:42 +01:00
template['steps'][0]["actions"] = [route_to_action]
updater = run_update(template, nil, {})
expect(updater.result[:redirect_on_next]).to eq(
"https://google.com"
)
end
2019-12-04 12:13:51 +01:00
end
end
end
end