1
0
Fork 0
discourse-custom-wizard-unl.../lib/custom_wizard/builder.rb

312 Zeilen
8,9 KiB
Ruby

2021-03-11 07:30:15 +01:00
# frozen_string_literal: true
2017-09-23 04:34:07 +02:00
class CustomWizard::Builder
2017-10-22 05:37:58 +02:00
attr_accessor :wizard, :updater, :submissions
2017-10-13 15:02:34 +02:00
2021-03-11 07:30:15 +01:00
def initialize(wizard_id, user = nil)
2020-10-31 08:05:50 +01:00
template = CustomWizard::Template.find(wizard_id)
return nil if template.blank?
2021-03-11 07:30:15 +01:00
2020-10-31 08:05:50 +01:00
@wizard = CustomWizard::Wizard.new(template, user)
@steps = template['steps'] || []
@actions = template['actions'] || []
@submissions = @wizard.submissions
2017-10-05 02:36:46 +02:00
end
def self.sorted_handlers
@sorted_handlers ||= []
end
def self.step_handlers
sorted_handlers.map { |h| { wizard_id: h[:wizard_id], block: h[:block] } }
end
def self.add_step_handler(priority = 0, wizard_id, &block)
sorted_handlers << { priority: priority, wizard_id: wizard_id, block: block }
@sorted_handlers.sort_by! { |h| -h[:priority] }
2017-09-23 04:34:07 +02:00
end
2021-03-11 07:30:15 +01:00
2020-04-14 07:46:06 +02:00
def mapper
CustomWizard::Mapper.new(
user: @wizard.user,
data: @submissions.last
)
end
2018-08-19 02:34:20 +02:00
def build(build_opts = {}, params = {})
2020-04-13 14:17:22 +02:00
return nil if !SiteSetting.custom_wizard_enabled || !@wizard
return @wizard if !@wizard.can_access?
2021-03-11 07:30:15 +01:00
2020-10-31 08:05:50 +01:00
build_opts[:reset] = build_opts[:reset] || @wizard.restart_on_revisit
@steps.each do |step_template|
@wizard.append_step(step_template['id']) do |step|
2020-10-31 08:05:50 +01:00
step.permitted = true
2021-03-11 07:30:15 +01:00
2020-10-31 08:05:50 +01:00
if step_template['required_data']
step = ensure_required_data(step, step_template)
end
2021-03-11 07:30:15 +01:00
2020-10-31 08:05:50 +01:00
if !step.permitted
if step_template['required_data_message']
2021-03-11 07:30:15 +01:00
step.permitted_message = step_template['required_data_message']
2020-10-31 08:05:50 +01:00
end
next
end
2021-03-11 07:30:15 +01:00
step.title = step_template['title'] if step_template['title']
step.banner = step_template['banner'] if step_template['banner']
2020-10-31 08:05:50 +01:00
step.key = step_template['key'] if step_template['key']
2021-03-11 07:30:15 +01:00
2020-04-14 07:46:06 +02:00
if step_template['description']
2020-04-16 07:14:03 +02:00
step.description = mapper.interpolate(
step_template['description'],
user: true,
value: true
2021-03-11 07:30:15 +01:00
)
2020-04-14 07:46:06 +02:00
end
2021-03-11 07:30:15 +01:00
if permitted_params = step_template['permitted_params']
2020-10-31 08:05:50 +01:00
save_permitted_params(permitted_params, params)
end
if step_template['fields'] && step_template['fields'].length
step_template['fields'].each_with_index do |field_template, index|
append_field(step, step_template, field_template, build_opts, index)
2017-09-23 04:34:07 +02:00
end
end
2017-09-23 04:34:07 +02:00
step.on_update do |updater|
@updater = updater
user = @wizard.user
2021-03-11 07:30:15 +01:00
updater.validate
2021-03-11 07:30:15 +01:00
next if updater.errors.any?
2017-10-05 02:36:46 +02:00
CustomWizard::Builder.step_handlers.each do |handler|
if handler[:wizard_id] == @wizard.id
handler[:block].call(self)
2017-10-05 02:36:46 +02:00
end
end
2017-10-05 02:36:46 +02:00
next if updater.errors.any?
2017-10-13 15:02:34 +02:00
submission = updater.submission
2017-11-01 05:21:14 +01:00
if current_submission = @wizard.current_submission
submission = current_submission.merge(submission)
end
2021-03-11 07:30:15 +01:00
2020-04-08 04:52:07 +02:00
final_step = updater.step.next.nil?
2021-03-11 07:30:15 +01:00
2020-04-08 04:52:07 +02:00
if @actions.present?
@actions.each do |action|
2021-03-11 07:30:15 +01:00
2020-04-08 09:59:54 +02:00
if (action['run_after'] === updater.step.id) ||
(final_step && (!action['run_after'] || (action['run_after'] === 'wizard_completion')))
2021-03-11 07:30:15 +01:00
2020-04-08 04:52:07 +02:00
CustomWizard::Action.new(
2020-04-15 02:46:44 +02:00
wizard: @wizard,
2020-04-08 04:52:07 +02:00
action: action,
user: user,
data: submission
2020-04-08 04:52:07 +02:00
).perform
end
2018-05-20 03:57:34 +02:00
end
end
2021-03-11 07:30:15 +01:00
if updater.errors.empty?
if route_to = submission['route_to']
submission.delete('route_to')
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
if @wizard.save_submissions
save_submissions(submission, final_step)
2020-11-03 01:24:20 +01:00
end
2021-03-11 07:30:15 +01:00
if final_step
2020-11-03 01:24:20 +01:00
if @wizard.id == @wizard.user.custom_fields['redirect_to_wizard']
2021-03-11 07:30:15 +01:00
@wizard.user.custom_fields.delete('redirect_to_wizard')
2020-11-03 01:24:20 +01:00
@wizard.user.save_custom_fields(true)
end
2021-03-11 07:30:15 +01:00
redirect_url = route_to || submission['redirect_on_complete'] || submission["redirect_to"]
updater.result[:redirect_on_complete] = redirect_url
elsif route_to
updater.result[:redirect_on_next] = route_to
2018-05-20 03:57:34 +02:00
end
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
true
else
false
2018-05-20 03:57:34 +02:00
end
end
end
end
2021-03-11 07:30:15 +01:00
2018-05-20 03:57:34 +02:00
@wizard
end
2017-10-17 15:17:53 +02:00
def append_field(step, step_template, field_template, build_opts, index)
params = {
id: field_template['id'],
type: field_template['type'],
required: field_template['required'],
number: index + 1
}
2021-03-11 07:30:15 +01:00
params[:label] = field_template['label'] if field_template['label']
params[:description] = field_template['description'] if field_template['description']
params[:image] = field_template['image'] if field_template['image']
params[:key] = field_template['key'] if field_template['key']
2021-01-30 18:46:04 +01:00
params[:validations] = field_template['validations'] if field_template['validations']
2020-10-31 08:05:50 +01:00
params[:min_length] = field_template['min_length'] if field_template['min_length']
params[:max_length] = field_template['max_length'] if field_template['max_length']
params[:char_counter] = field_template['char_counter'] if field_template['char_counter']
2020-10-31 08:05:50 +01:00
params[:value] = prefill_field(field_template, step_template)
2021-03-11 07:30:15 +01:00
2020-11-03 01:24:20 +01:00
if !build_opts[:reset] && (submission = @wizard.current_submission)
params[:value] = submission[field_template['id']] if submission[field_template['id']]
end
2021-03-11 07:30:15 +01:00
2020-04-13 14:17:22 +02:00
if field_template['type'] === 'group' && params[:value].present?
2020-03-30 08:16:03 +02:00
params[:value] = params[:value].first
end
if field_template['type'] === 'checkbox'
params[:value] = standardise_boolean(params[:value])
end
2019-07-19 05:47:17 +02:00
if field_template['type'] === 'upload'
params[:file_types] = field_template['file_types']
end
2021-03-11 07:30:15 +01:00
2020-07-16 05:26:56 +02:00
if ['date', 'time', 'date_time'].include?(field_template['type'])
params[:format] = field_template['format']
end
2021-03-11 07:30:15 +01:00
if field_template['type'] === 'category' || field_template['type'] === 'tag'
params[:limit] = field_template['limit']
end
2021-03-11 07:30:15 +01:00
if field_template['type'] === 'category'
params[:property] = field_template['property']
end
2021-03-11 07:30:15 +01:00
if field_template['type'] === 'category' || (
field_template['validations'] &&
field_template['validations']['similar_topics'] &&
field_template['validations']['similar_topics']['categories'].present?
)
2020-03-19 08:58:45 +01:00
@wizard.needs_categories = true
end
2021-03-11 07:30:15 +01:00
2020-03-19 08:58:45 +01:00
if field_template['type'] === 'group'
@wizard.needs_groups = true
end
2021-03-11 07:30:15 +01:00
2020-04-06 10:36:38 +02:00
if (content_inputs = field_template['content']).present?
content = CustomWizard::Mapper.new(
inputs: content_inputs,
2020-03-30 08:16:03 +02:00
user: @wizard.user,
2020-04-06 10:36:38 +02:00
data: @submissions.last,
opts: {
with_type: true
}
).perform
2021-03-11 07:30:15 +01:00
if content.present? &&
content[:result].present?
2021-03-11 07:30:15 +01:00
2020-04-19 08:11:07 +02:00
if content[:type] == 'association'
content[:result] = content[:result].map do |item|
2021-03-11 07:30:15 +01:00
{
2020-04-19 08:11:07 +02:00
id: item[:key],
2021-03-11 07:30:15 +01:00
name: item[:value]
2020-04-19 08:11:07 +02:00
}
end
2020-04-06 10:36:38 +02:00
end
2021-03-11 07:30:15 +01:00
if content[:type] == 'assignment' && field_template['type'] === 'dropdown'
content[:result] = content[:result].map do |item|
2021-03-11 07:30:15 +01:00
{
id: item,
name: item
}
end
end
2021-03-11 07:30:15 +01:00
2020-04-19 08:11:07 +02:00
params[:content] = content[:result]
2020-04-06 10:36:38 +02:00
end
2020-03-24 10:35:46 +01:00
end
2021-03-11 07:30:15 +01:00
2018-07-04 05:48:03 +02:00
field = step.add_field(params)
end
2021-03-11 07:30:15 +01:00
2020-03-21 18:30:11 +01:00
def prefill_field(field_template, step_template)
if (prefill = field_template['prefill']).present?
2020-03-30 08:16:03 +02:00
CustomWizard::Mapper.new(
inputs: prefill,
user: @wizard.user,
2020-04-07 10:33:51 +02:00
data: @submissions.last
2020-04-06 10:36:38 +02:00
).perform
end
end
def standardise_boolean(value)
2019-09-11 13:30:59 +02:00
ActiveRecord::Type::Boolean.new.cast(value)
end
def save_submissions(submission, final_step)
2018-05-20 03:57:34 +02:00
if final_step
submission['submitted_at'] = Time.now.iso8601
2018-05-20 03:57:34 +02:00
end
if submission.present?
2018-05-20 03:57:34 +02:00
@submissions.pop(1) if @wizard.unfinished?
@submissions.push(submission)
2020-11-03 01:24:20 +01:00
@wizard.set_submissions(@submissions)
2018-05-20 03:57:34 +02:00
end
2017-09-23 04:34:07 +02:00
end
2021-03-11 07:30:15 +01:00
2020-10-31 08:05:50 +01:00
def save_permitted_params(permitted_params, params)
permitted_data = {}
permitted_params.each do |pp|
pair = pp['pairs'].first
params_key = pair['key'].to_sym
submission_key = pair['value'].to_sym
permitted_data[submission_key] = params[params_key] if params[params_key]
end
if permitted_data.present?
current_data = @submissions.last || {}
save_submissions(current_data.merge(permitted_data), false)
end
end
2021-03-11 07:30:15 +01:00
2020-10-31 08:05:50 +01:00
def ensure_required_data(step, step_template)
step_template['required_data'].each do |required|
pairs = required['pairs'].select do |pair|
pair['key'].present? && pair['value'].present?
end
2021-03-11 07:30:15 +01:00
2020-10-31 08:05:50 +01:00
if pairs.any? && !@submissions.last
step.permitted = false
break
end
2021-03-11 07:30:15 +01:00
pairs.each do |pair|
2020-10-31 08:05:50 +01:00
pair['key'] = @submissions.last[pair['key']]
end
2021-03-11 07:30:15 +01:00
2020-10-31 08:05:50 +01:00
if !mapper.validate_pairs(pairs)
step.permitted = false
break
end
end
2021-03-11 07:30:15 +01:00
2020-10-31 08:05:50 +01:00
step
end
2017-09-23 04:34:07 +02:00
end