mirror of
https://github.com/discourse/discourse.git
synced 2025-02-25 18:55:32 -06:00
DEV: Refactor theme SCSS compilation (#11919)
This commit is contained in:
@@ -21,10 +21,6 @@ module Stylesheet
|
||||
def self.register_imports!
|
||||
@special_imports = {}
|
||||
|
||||
register_import "theme_field" do
|
||||
Import.new("#{theme_dir(@theme_id)}/theme_field.scss", source: @theme_field)
|
||||
end
|
||||
|
||||
Discourse.plugins.each do |plugin|
|
||||
plugin_directory_name = plugin.directory_name
|
||||
|
||||
@@ -118,28 +114,6 @@ module Stylesheet
|
||||
Import.new("theme_colors.scss", source: contents)
|
||||
end
|
||||
|
||||
register_import "theme_variables" do
|
||||
contents = +""
|
||||
|
||||
theme&.all_theme_variables&.each do |field|
|
||||
if field.type_id == ThemeField.types[:theme_upload_var]
|
||||
if upload = field.upload
|
||||
url = upload_cdn_path(upload.url)
|
||||
contents << "$#{field.name}: unquote(\"#{url}\");\n"
|
||||
end
|
||||
else
|
||||
contents << to_scss_variable(field.name, field.value)
|
||||
end
|
||||
end
|
||||
|
||||
theme&.included_settings&.each do |name, value|
|
||||
next if name == "theme_uploads"
|
||||
contents << to_scss_variable(name, value)
|
||||
end
|
||||
|
||||
Import.new("theme_variable.scss", source: contents)
|
||||
end
|
||||
|
||||
register_import "category_backgrounds" do
|
||||
contents = +""
|
||||
Category.where('uploaded_background_id IS NOT NULL').each do |c|
|
||||
@@ -149,23 +123,6 @@ module Stylesheet
|
||||
Import.new("category_background.scss", source: contents)
|
||||
end
|
||||
|
||||
register_import "embedded_theme" do
|
||||
next unless @theme_id
|
||||
|
||||
theme_import(:common, :embedded_scss)
|
||||
end
|
||||
|
||||
register_import "mobile_theme" do
|
||||
next unless @theme_id
|
||||
|
||||
theme_import(:mobile, :scss)
|
||||
end
|
||||
|
||||
register_import "desktop_theme" do
|
||||
next unless @theme_id
|
||||
|
||||
theme_import(:desktop, :scss)
|
||||
end
|
||||
end
|
||||
|
||||
register_imports!
|
||||
@@ -182,9 +139,10 @@ module Stylesheet
|
||||
resolved_ids = Theme.transform_ids([theme_id])
|
||||
|
||||
if resolved_ids
|
||||
contents << " @import \"theme_variables\";"
|
||||
theme = Theme.find_by_id(theme_id)
|
||||
contents << theme&.scss_variables.to_s
|
||||
Theme.list_baked_fields(resolved_ids, :common, :color_definitions).each do |row|
|
||||
contents << "// Color definitions from #{Theme.find_by_id(theme_id)&.name}\n\n"
|
||||
contents << "// Color definitions from #{theme.name}\n\n"
|
||||
contents << row.value
|
||||
end
|
||||
end
|
||||
@@ -201,14 +159,12 @@ module Stylesheet
|
||||
def initialize(options)
|
||||
@theme = options[:theme]
|
||||
@theme_id = options[:theme_id]
|
||||
@theme_field = options[:theme_field]
|
||||
@color_scheme_id = options[:color_scheme_id]
|
||||
|
||||
if @theme && !@theme_id
|
||||
# make up an id so other stuff does not bail out
|
||||
@theme_id = @theme.id || -1
|
||||
end
|
||||
@importable_theme_fields = {}
|
||||
end
|
||||
|
||||
def import_files(files)
|
||||
@@ -222,23 +178,27 @@ module Stylesheet
|
||||
end
|
||||
end
|
||||
|
||||
def theme_import(target, attr)
|
||||
fields = theme.list_baked_fields(target, attr)
|
||||
def theme_import(target)
|
||||
attr = target == :embedded_theme ? :embedded_scss : :scss
|
||||
target = target.to_s.gsub("_theme", "").to_sym
|
||||
|
||||
contents = +""
|
||||
|
||||
fields = theme.list_baked_fields(target, attr)
|
||||
fields.map do |field|
|
||||
value = field.value
|
||||
if value.present?
|
||||
filename = "theme_#{field.theme.id}/#{field.target_name}-#{field.name}-#{field.theme.name.parameterize}.scss"
|
||||
with_comment = <<~COMMENT
|
||||
contents << <<~COMMENT
|
||||
// Theme: #{field.theme.name}
|
||||
// Target: #{field.target_name} #{field.name}
|
||||
// Last Edited: #{field.updated_at}
|
||||
|
||||
#{value}
|
||||
COMMENT
|
||||
Import.new(filename, source: with_comment)
|
||||
end
|
||||
end.compact
|
||||
end
|
||||
contents
|
||||
end
|
||||
|
||||
def theme
|
||||
@@ -248,43 +208,6 @@ module Stylesheet
|
||||
@theme == :nil ? nil : @theme
|
||||
end
|
||||
|
||||
def theme_dir(import_theme_id)
|
||||
"theme_#{import_theme_id}"
|
||||
end
|
||||
|
||||
def extract_theme_id(path)
|
||||
path[/^theme_([0-9]+)\//, 1]
|
||||
end
|
||||
|
||||
def importable_theme_fields(import_theme_id)
|
||||
return {} unless theme && import_theme = Theme.find(import_theme_id)
|
||||
@importable_theme_fields[import_theme_id] ||= begin
|
||||
hash = {}
|
||||
import_theme.theme_fields.where(target_id: Theme.targets[:extra_scss]).each do |field|
|
||||
hash[field.name] = field.value
|
||||
end
|
||||
hash
|
||||
end
|
||||
end
|
||||
|
||||
def match_theme_import(path, parent_path)
|
||||
# Only allow importing theme stylesheets from within stylesheets in the same theme
|
||||
return false unless theme && import_theme_id = extract_theme_id(parent_path) # Could be a child theme
|
||||
parent_dir, _ = File.split(parent_path)
|
||||
|
||||
# Could be relative to the importing file, or relative to the root of the theme directory
|
||||
search_paths = [parent_dir, theme_dir(import_theme_id)].uniq
|
||||
search_paths.each do |search_path|
|
||||
resolved = Pathname.new("#{search_path}/#{path}").cleanpath.to_s # Remove unnecessary ./ and ../
|
||||
next unless resolved.start_with?("#{theme_dir(import_theme_id)}/")
|
||||
resolved_within_theme = resolved.sub(/^theme_[0-9]+\//, "")
|
||||
if importable_theme_fields(import_theme_id).keys.include?(resolved_within_theme)
|
||||
return resolved, importable_theme_fields(import_theme_id)[resolved_within_theme]
|
||||
end
|
||||
end
|
||||
false
|
||||
end
|
||||
|
||||
def category_css(category)
|
||||
full_slug = category.full_slug.split("-")[0..-2].join("-")
|
||||
"body.category-#{full_slug} { background-image: url(#{upload_cdn_path(category.uploaded_background.url)}) }\n"
|
||||
@@ -309,21 +232,11 @@ module Stylesheet
|
||||
contents
|
||||
end
|
||||
|
||||
def to_scss_variable(name, value)
|
||||
escaped = SassC::Script::Value::String.quote(value, sass: true)
|
||||
"$#{name}: unquote(#{escaped});\n"
|
||||
end
|
||||
|
||||
def imports(asset, parent_path)
|
||||
if callback = Importer.special_imports[asset]
|
||||
instance_eval(&callback)
|
||||
else
|
||||
path, source = match_theme_import(asset, parent_path)
|
||||
if path && source
|
||||
Import.new(path, source: source)
|
||||
else
|
||||
Import.new(asset + ".scss")
|
||||
end
|
||||
Import.new(asset + ".scss")
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
Reference in New Issue
Block a user