A platform for community discussion. Free, open, simple.
# frozen_string_literal: true
RSpec.describe Admin::Config::DesignWizardController do
fab!(:admin)
fab!(:moderator)
fab!(:user)
describe "#index" do
context "when signed in as an admin" do
before { sign_in(admin) }
it "returns the core themes with their palette pairs" do
ThemeField.create!(
theme_id: Theme::CORE_THEMES["horizon"],
name: "en",
type_id: ThemeField.types[:yaml],
target_id: Theme.targets[:translations],
value: <<~YAML,
en:
theme_metadata:
description: "A simple, beautiful theme"
YAML
)
get "/admin/config/design-wizard.json"
expect(response.status).to eq(200)
themes = response.parsed_body["themes"]
expect(themes.map { |theme| theme["id"] }).to contain_exactly(
Theme::CORE_THEMES["foundation"],
Theme::CORE_THEMES["horizon"],
)
horizon = themes.find { |theme| theme["id"] == Theme::CORE_THEMES["horizon"] }
expect(horizon["description"]).to eq("A simple, beautiful theme")
expect(horizon).to include("supports_welcome_banner" => true, "supports_search" => true)
expect(horizon["palette_pairs"].map { |pair| pair["key"] }).to include(
"horizon",
"royal",
"clover",
"lily",
"violet",
"marigold",
)
horizon_pair = horizon["palette_pairs"].find { |pair| pair["key"] == "horizon" }
expect(horizon_pair["light"]["colors"]).to include("primary", "secondary", "tertiary")
expect(horizon_pair["dark"]["name"]).to eq("Horizon Dark")
foundation = themes.find { |theme| theme["id"] == Theme::CORE_THEMES["foundation"] }
expect(foundation).to include(
"screenshot_light_url" => "/images/design-wizard/foundation-light.webp",
"screenshot_dark_url" => "/images/design-wizard/foundation-dark.webp",
)
expect(foundation["palette_pairs"].map { |pair| pair["key"] }).to eq(
%w[default wcag solarized dracula],
)
dracula = foundation["palette_pairs"].find { |pair| pair["key"] == "dracula" }
expect(dracula["dark_only"]).to eq(true)
expect(dracula["light"]).to be_nil
end
it "excludes installed Concord from the choices by default" do
concord =
Fabricate(
:theme,
remote_theme:
Fabricate(
:remote_theme,
remote_url: "https://github.com/discourse/discourse-concord-theme",
),
)
concord.set_default!
get "/admin/config/design-wizard.json"
expect(SiteSetting.concord_in_wizard).to eq(false)
expect(response.parsed_body["themes"].map { |theme| theme["id"] }).to contain_exactly(
*Theme::CORE_THEMES.values,
)
expect(response.parsed_body["current_theme"]).to include("id" => concord.id)
end
it "offers Concord for installation without creating a theme" do
SiteSetting.concord_in_wizard = true
expect { get "/admin/config/design-wizard.json" }.not_to change { Theme.count }
expect(response.status).to eq(200)
expect(response.parsed_body["themes"].find { |theme| theme["id"] == "concord" }).to include(
"name" => "Concord",
"remote_url" => "https://github.com/discourse/discourse-concord-theme",
"description" => I18n.t("design_wizard.themes.concord.description"),
"palette_pairs" => [],
"supports_welcome_banner" => false,
"supports_search" => false,
"screenshot_light_url" => "/images/design-wizard/concord-light.webp",
"screenshot_dark_url" => "/images/design-wizard/concord-dark.webp",
)
end
it "limits choices to core themes and Concord when other themes are installed" do
SiteSetting.concord_in_wizard = true
Fabricate(:theme, name: "Concord")
Fabricate(
:theme,
remote_theme:
Fabricate(:remote_theme, remote_url: "https://github.com/discourse/other-theme"),
)
Fabricate(
:theme,
component: true,
remote_theme:
Fabricate(
:remote_theme,
remote_url: "https://github.com/discourse/discourse-concord-theme",
),
)
get "/admin/config/design-wizard.json"
expect(response.status).to eq(200)
expect(response.parsed_body["themes"].map { |theme| theme["id"] }).to contain_exactly(
*Theme::CORE_THEMES.values,
"concord",
)
end
it "hides installation choices when repository imports are restricted" do
SiteSetting.concord_in_wizard = true
global_setting :allowed_theme_repos, "https://github.com/discourse/other-theme"
get "/admin/config/design-wizard.json"
expect(response.parsed_body["themes"].map { |theme| theme["id"] }).to contain_exactly(
*Theme::CORE_THEMES.values,
)
end
it "hides installation choices when theme creation is disabled" do
SiteSetting.concord_in_wizard = true
plugin = Plugin::Instance.new
modifier = ->(*) { false }
DiscoursePluginRegistry.register_modifier(
plugin,
:user_guardian_can_create_theme,
&modifier
)
get "/admin/config/design-wizard.json"
expect(response.parsed_body["themes"].map { |theme| theme["id"] }).to contain_exactly(
*Theme::CORE_THEMES.values,
)
ensure
DiscoursePluginRegistry.unregister_modifier(
plugin,
:user_guardian_can_create_theme,
&modifier
)
end
it "returns installed Concord as a selectable default with its palette state" do
SiteSetting.concord_in_wizard = true
concord =
Fabricate(
:theme,
remote_theme:
Fabricate(
:remote_theme,
remote_url: "https://github.com/discourse/discourse-concord-theme.git",
),
)
palette = Fabricate(:color_scheme, theme_id: concord.id, user_selectable: true)
concord.update!(color_scheme_id: palette.id)
concord.set_default!
get "/admin/config/design-wizard.json"
themes = response.parsed_body["themes"]
expect(themes.map { |theme| theme["id"] }).to contain_exactly(
*Theme::CORE_THEMES.values,
concord.id,
)
expect(themes.find { |theme| theme["id"] == concord.id }).to include(
"default" => true,
"color_scheme_id" => palette.id,
"supports_welcome_banner" => false,
"supports_search" => false,
"screenshot_light_url" => "/images/design-wizard/concord-light.webp",
"screenshot_dark_url" => "/images/design-wizard/concord-dark.webp",
)
expect(response.parsed_body["current_theme"]).to be_nil
expect(response.parsed_body["palettes_user_selectable"]).to eq(true)
end
context "with a theme screenshot" do
fab!(:upload, :image_upload)
before do
horizon = Theme.horizon_theme
horizon.set_field(
target: :common,
name: "screenshot_light",
type: :theme_screenshot_upload_var,
upload_id: upload.id,
)
horizon.save!
end
def serialized_horizon
get "/admin/config/design-wizard.json"
response.parsed_body["themes"].find do |theme|
theme["id"] == Theme::CORE_THEMES["horizon"]
end
end
it "uses the bundled previews even when the theme has an uploaded screenshot" do
expect(serialized_horizon).to include(
"screenshot_light_url" => "/images/design-wizard/horizon-light.webp",
"screenshot_dark_url" => "/images/design-wizard/horizon-dark.webp",
)
end
end
it "returns the current fonts and homepage" do
SiteSetting.base_font = "lato"
SiteSetting.heading_font = "merriweather"
SiteSetting.default_homepage = "categories"
get "/admin/config/design-wizard.json"
expect(response.parsed_body["base_font"]).to eq("lato")
expect(response.parsed_body["heading_font"]).to eq("merriweather")
expect(response.parsed_body["homepage"]).to eq("categories")
end
it "does not include current_theme when the default theme is a core theme" do
get "/admin/config/design-wizard.json"
expect(response.parsed_body["current_theme"]).to be_nil
end
it "includes current_theme when the default theme is a custom theme" do
theme = Fabricate(:theme)
theme.set_default!
get "/admin/config/design-wizard.json"
expect(response.parsed_body["current_theme"]).to include(
"id" => theme.id,
"name" => theme.name,
)
end
it "reports palettes as not user selectable when only a custom default theme's palettes are selectable" do
theme = Fabricate(:theme)
Fabricate(:color_scheme, theme_id: theme.id, user_selectable: true)
theme.set_default!
get "/admin/config/design-wizard.json"
expect(response.parsed_body["palettes_user_selectable"]).to eq(false)
end
it "reports palettes as not user selectable when there are none to offer" do
ColorScheme.where(theme_id: Theme::CORE_THEMES.values).destroy_all
ColorScheme.where(via_wizard: true).destroy_all
get "/admin/config/design-wizard.json"
expect(response.parsed_body["palettes_user_selectable"]).to eq(false)
end
it "reports palettes as user selectable when horizon's palettes are selectable and the default theme is custom" do
ColorScheme.where(theme_id: Theme::CORE_THEMES["horizon"]).update_all(user_selectable: true)
theme = Fabricate(:theme)
Fabricate(:color_scheme, theme_id: theme.id, user_selectable: false)
theme.set_default!
get "/admin/config/design-wizard.json"
expect(response.parsed_body["palettes_user_selectable"]).to eq(true)
end
end
it "is not accessible to moderators" do
sign_in(moderator)
get "/admin/config/design-wizard.json"
expect(response.status).to eq(403)
end
it "is not accessible to regular users" do
sign_in(user)
get "/admin/config/design-wizard.json"
expect(response.status).to eq(404)
end
it "is not accessible to anonymous users" do
get "/admin/config/design-wizard.json"
expect(response.status).to eq(404)
end
end
describe "#update" do
context "when signed in as an admin" do
before { sign_in(admin) }
it "applies the design choices" do
horizon = Theme.horizon_theme
light = ColorScheme.find_by(theme_id: horizon.id, name: "Royal")
dark = ColorScheme.find_by(theme_id: horizon.id, name: "Royal Dark")
put "/admin/config/design-wizard.json",
params: {
theme_id: horizon.id,
light_palette_id: light.id,
dark_palette_id: dark.id,
palettes_user_selectable: true,
base_font: "lato",
heading_font: "merriweather",
homepage: "categories",
category_page_style: "categories_boxes",
welcome_banner_location: "below_site_header",
}
expect(response.status).to eq(200)
expect(SiteSetting.default_theme_id).to eq(horizon.id)
expect(horizon.reload.color_scheme_id).to eq(light.id)
expect(horizon.dark_color_scheme_id).to eq(dark.id)
expect(SiteSetting.base_font).to eq("lato")
expect(SiteSetting.heading_font).to eq("merriweather")
expect(SiteSetting.default_homepage).to eq("categories")
expect(SiteSetting.desktop_category_page_style).to eq("categories_boxes")
expect(SiteSetting.welcome_banner_location).to eq("below_site_header")
expect(light.reload.user_selectable).to eq(true)
end
it "applies installed Concord" do
SiteSetting.concord_in_wizard = true
concord =
Fabricate(
:theme,
remote_theme:
Fabricate(
:remote_theme,
remote_url: "https://github.com/discourse/discourse-concord-theme",
),
)
put "/admin/config/design-wizard.json", params: { theme_id: concord.id }
expect(response.status).to eq(200)
expect(SiteSetting.default_theme_id).to eq(concord.id)
end
it "rejects installed Concord by default" do
concord =
Fabricate(
:theme,
remote_theme:
Fabricate(
:remote_theme,
remote_url: "https://github.com/discourse/discourse-concord-theme",
),
)
expect do
put "/admin/config/design-wizard.json", params: { theme_id: concord.id }
end.not_to change { SiteSetting.default_theme_id }
expect(response.status).to eq(400)
end
it "rejects unsupported themes without changing the default" do
custom_theme = Fabricate(:theme)
expect do
put "/admin/config/design-wizard.json", params: { theme_id: custom_theme.id }
end.not_to change { SiteSetting.default_theme_id }
expect(response.status).to eq(400)
expect(response.parsed_body["errors"]).to be_present
end
it "applies the welcome banner and search choices to the chosen theme" do
horizon = Theme.horizon_theme
put "/admin/config/design-wizard.json",
params: {
theme_id: horizon.id,
enable_welcome_banner: false,
search_experience: "search_field",
}
expect(response.status).to eq(200)
expect(SiteSetting.enable_welcome_banner(theme_id: horizon.id)).to eq(false)
expect(SiteSetting.search_experience(theme_id: horizon.id)).to eq("search_field")
end
it "returns a 400 for an unsupported search experience" do
put "/admin/config/design-wizard.json",
params: {
theme_id: Theme::CORE_THEMES["horizon"],
search_experience: "not_an_experience",
}
expect(response.status).to eq(400)
expect(response.parsed_body["errors"]).to be_present
end
it "returns a 400 with errors for an invalid contract" do
put "/admin/config/design-wizard.json",
params: {
theme_id: Theme::CORE_THEMES["foundation"],
base_font: "not_a_font",
}
expect(response.status).to eq(400)
expect(response.parsed_body["errors"]).to be_present
end
it "returns a 422 when a palette is not available for the theme" do
horizon_palette = ColorScheme.find_by(theme_id: Theme::CORE_THEMES["horizon"])
put "/admin/config/design-wizard.json",
params: {
theme_id: Theme::CORE_THEMES["foundation"],
light_palette_id: horizon_palette.id,
}
expect(response.status).to eq(422)
expect(response.parsed_body["errors"]).to be_present
end
it "returns a 422 when the site settings cannot be updated" do
SiteSetting.stubs(:shadowed_settings).returns(Set.new(%i[default_theme_id]))
put "/admin/config/design-wizard.json", params: { theme_id: Theme::CORE_THEMES["horizon"] }
expect(response.status).to eq(422)
expect(response.parsed_body["errors"]).to eq(
[I18n.t("design_wizard.errors.site_settings_update_failed")],
)
end
end
it "is not accessible to moderators" do
sign_in(moderator)
put "/admin/config/design-wizard.json", params: { theme_id: Theme::CORE_THEMES["horizon"] }
expect(response.status).to eq(403)
expect(SiteSetting.default_theme_id).not_to eq(Theme::CORE_THEMES["horizon"])
end
it "is not accessible to anonymous users" do
put "/admin/config/design-wizard.json", params: { theme_id: Theme::CORE_THEMES["foundation"] }
expect(response.status).to eq(404)
end
end
end