github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-06-01 02:34:28 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Clean up wizard updater API for better plugin use

Browse Source
This commit is contained in:
Robin Ward
2016-09-09 16:51:07 -04:00
parent e3640ee5f6
commit 28b6c300a0
8 changed files with 164 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
lib/wizard/builder.rb Normal file
View File

@ -0,0 +1,121 @@
class Wizard
class Builder
def initialize(user)
@wizard = Wizard.new(user)
end
def build
@wizard.append_step('locale') do |step|
languages = step.add_field(id: 'default_locale',
type: 'dropdown',
required: true,
value: SiteSetting.default_locale)
LocaleSiteSetting.values.each do |locale|
languages.add_choice(locale[:value], label: locale[:name])
end
step.on_update do |updater, fields|
old_locale = SiteSetting.default_locale
updater.update_setting_field(:default_locale, fields, :default_locale)
updater.refresh_required = true if old_locale != fields[:default_locale]
end
end
@wizard.append_step('forum-title') do |step|
step.add_field(id: 'title', type: 'text', required: true, value: SiteSetting.title)
step.add_field(id: 'site_description', type: 'text', required: true, value: SiteSetting.site_description)
step.on_update do |updater, fields|
updater.update_setting_field(:title, fields, :title)
updater.update_setting_field(:site_description, fields, :site_description)
end
end
@wizard.append_step('privacy') do |step|
locked = SiteSetting.login_required? && SiteSetting.invite_only?
privacy = step.add_field(id: 'privacy',
type: 'radio',
required: true,
value: locked ? 'restricted' : 'open')
privacy.add_choice('open', icon: 'unlock')
privacy.add_choice('restricted', icon: 'lock')
step.on_update do |updater, fields|
updater.update_setting(:login_required, fields[:privacy] == 'restricted')
updater.update_setting(:invite_only, fields[:privacy] == 'restricted')
end
end
@wizard.append_step('contact') do |step|
step.add_field(id: 'contact_email', type: 'text', required: true, value: SiteSetting.contact_email)
step.add_field(id: 'contact_url', type: 'text', value: SiteSetting.contact_url)
step.add_field(id: 'site_contact_username', type: 'text', value: SiteSetting.site_contact_username)
step.on_update do |updater, fields|
updater.update_setting_field(:contact_email, fields, :contact_email)
updater.update_setting_field(:contact_url, fields, :contact_url)
updater.update_setting_field(:site_contact_username, fields, :site_contact_username)
end
end
@wizard.append_step('colors') do |step|
theme_id = ColorScheme.where(via_wizard: true).pluck(:theme_id)
theme_id = theme_id.present? ? theme_id[0] : 'default'
themes = step.add_field(id: 'theme_id', type: 'dropdown', required: true, value: theme_id)
ColorScheme.themes.each {|t| themes.add_choice(t[:id], data: t) }
step.add_field(id: 'theme_preview', type: 'component')
step.on_update do |updater, fields|
scheme_name = fields[:theme_id]
theme = ColorScheme.themes.find {|s| s[:id] == scheme_name }
colors = []
theme[:colors].each do |name, hex|
colors << {name: name, hex: hex[1..-1] }
end
attrs = {
enabled: true,
name: I18n.t("wizard.step.colors.fields.color_scheme.options.#{scheme_name}"),
colors: colors,
theme_id: scheme_name
}
scheme = ColorScheme.where(via_wizard: true).first
if scheme.present?
attrs[:colors] = colors
revisor = ColorSchemeRevisor.new(scheme, attrs)
revisor.revise
else
attrs[:via_wizard] = true
scheme = ColorScheme.new(attrs)
scheme.save!
end
end
end
@wizard.append_step('logos') do |step|
step.add_field(id: 'logo_url', type: 'image', value: SiteSetting.logo_url)
step.add_field(id: 'logo_small_url', type: 'image', value: SiteSetting.logo_small_url)
step.add_field(id: 'favicon_url', type: 'image', value: SiteSetting.favicon_url)
step.add_field(id: 'apple_touch_icon_url', type: 'image', value: SiteSetting.apple_touch_icon_url)
step.on_update do |updater, fields|
updater.update_setting_field(:logo_url, fields, :logo_url)
updater.update_setting_field(:logo_small_url, fields, :logo_small_url)
updater.update_setting_field(:favicon_url, fields, :favicon_url)
updater.update_setting_field(:apple_touch_icon_url, fields, :apple_touch_icon_url)
end
end
@wizard.append_step('finished')
@wizard
end
end
end

6
lib/wizard/step.rb
View File

@ -1,6 +1,6 @@
class Wizard
class Step
attr_reader :id
attr_reader :id, :updater
attr_accessor :index, :fields, :next, :previous
def initialize(id)
@ -14,5 +14,9 @@ class Wizard
@fields << field
field
end
def on_update(&block)
@updater = block
end
end
end

87
lib/wizard/step_updater.rb
View File

@ -2,73 +2,16 @@ class Wizard
class StepUpdater
include ActiveModel::Model
def initialize(current_user, id)
attr_accessor :refresh_required
def initialize(current_user, step)
@current_user = current_user
@id = id
@step = step
@refresh_required = false
end
def update(fields)
updater_method = "update_#{@id.underscore}".to_sym
send(updater_method, fields.symbolize_keys) if respond_to?(updater_method)
end
def update_locale(fields)
old_locale = SiteSetting.default_locale
update_setting_field(:default_locale, fields, :default_locale)
@refresh_required = true if old_locale != fields[:default_locale]
end
def update_privacy(fields)
update_setting(:login_required, fields[:privacy] == 'restricted')
update_setting(:invite_only, fields[:privacy] == 'restricted')
end
def update_forum_title(fields)
update_setting_field(:title, fields, :title)
update_setting_field(:site_description, fields, :site_description)
end
def update_contact(fields)
update_setting_field(:contact_email, fields, :contact_email)
update_setting_field(:contact_url, fields, :contact_url)
update_setting_field(:site_contact_username, fields, :site_contact_username)
end
def update_colors(fields)
scheme_name = fields[:theme_id]
theme = ColorScheme.themes.find {|s| s[:id] == scheme_name }
colors = []
theme[:colors].each do |name, hex|
colors << {name: name, hex: hex[1..-1] }
end
attrs = {
enabled: true,
name: I18n.t("wizard.step.colors.fields.color_scheme.options.#{scheme_name}"),
colors: colors,
theme_id: scheme_name
}
scheme = ColorScheme.where(via_wizard: true).first
if scheme.present?
attrs[:colors] = colors
revisor = ColorSchemeRevisor.new(scheme, attrs)
revisor.revise
else
attrs[:via_wizard] = true
scheme = ColorScheme.new(attrs)
scheme.save!
end
end
def update_logos(fields)
update_setting_field(:logo_url, fields, :logo_url)
update_setting_field(:logo_small_url, fields, :logo_small_url)
update_setting_field(:favicon_url, fields, :favicon_url)
update_setting_field(:apple_touch_icon_url, fields, :apple_touch_icon_url)
@step.updater.call(self, fields) if @step.updater.present?
end
def success?
@ -79,18 +22,16 @@ class Wizard
@refresh_required
end
protected
def update_setting(id, value)
value.strip! if value.is_a?(String)
SiteSetting.set_and_log(id, value, @current_user) if SiteSetting.send(id) != value
end
def update_setting(id, value)
value.strip! if value.is_a?(String)
SiteSetting.set_and_log(id, value, @current_user) if SiteSetting.send(id) != value
end
def update_setting_field(id, fields, field_id)
update_setting(id, fields[field_id])
rescue Discourse::InvalidParameters => e
errors.add(field_id, e.message)
end
def update_setting_field(id, fields, field_id)
update_setting(id, fields[field_id])
rescue Discourse::InvalidParameters => e
errors.add(field_id, e.message)
end
end
end