github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-11-24 14:19:49 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
0f734e2ae2
discourse/spec/models/theme_field_spec.rb

192 lines
6.7 KiB
Ruby
Raw Normal View History

FEATURE: added error messages for bad theme CSS / JS
2017-04-20 04:46:28 +08:00
# encoding: utf-8
require 'rails_helper'
describe ThemeField do
FEATURE: Theme settings (2) (#5611) Allows theme authors to specify custom theme settings for the theme. Centralizes the theme/site settings into a single construct
2018-03-05 08:04:23 +08:00
after(:all) do
ThemeField.destroy_all
end
FEATURE: backend support for user-selectable components * FEATURE: backend support for user-selectable components * fix problems with previewing default theme * rename preview_key => preview_theme_id * omit default theme from child themes dropdown and try a different fix * cache & freeze stylesheets arrays
2018-08-08 12:46:34 +08:00
describe "scope: find_by_theme_ids" do
it "returns result in the specified order" do
theme = Fabricate(:theme)
theme2 = Fabricate(:theme)
theme3 = Fabricate(:theme)
(0..1).each do |num|
ThemeField.create!(theme: theme, target_id: num, name: "header", value: "<a>html</a>")
ThemeField.create!(theme: theme2, target_id: num, name: "header", value: "<a>html</a>")
ThemeField.create!(theme: theme3, target_id: num, name: "header", value: "<a>html</a>")
end
expect(ThemeField.find_by_theme_ids(
[theme3.id, theme.id, theme2.id]
).pluck(:theme_id)).to eq(
[theme3.id, theme3.id, theme.id, theme.id, theme2.id, theme2.id]
)
end
end
DEV: extract inline js when baking theme fields (#6447) * extract inline js when baking theme fields * destroy javascript cache when destroying theme fields This work is needed to support CSP work
2018-10-15 12:55:23 +08:00
it 'does not insert a script tag when there are no inline script' do
theme_field = ThemeField.create!(theme_id: 1, target_id: 0, name: "body_tag", value: '<div>new div</div>')
expect(theme_field.value_baked).to_not include('<script')
end
it 'only extracts inline javascript to an external file' do
DEV: Prefer `<<~` over `<<`.
2018-10-18 14:17:10 +08:00
html = <<~HTML
<script type="text/discourse-plugin" version="0.8">
var a = "inline discourse plugin";
</script>
FIX: only extract script tags with certain types (#6553) `script` tags with custom types (e.g. `text/template`) are not executed by the browser, and should not be extracted into an external theme JavaScript
2018-11-02 04:01:46 +08:00
<script type="text/template" data-template="custom-template">
<div>custom script type</div>
</script>
DEV: Prefer `<<~` over `<<`.
2018-10-18 14:17:10 +08:00
<script>
var b = "inline raw script";
</script>
FIX: only extract script tags with certain types (#6553) `script` tags with custom types (e.g. `text/template`) are not executed by the browser, and should not be extracted into an external theme JavaScript
2018-11-02 04:01:46 +08:00
<script type="texT/jAvasCripT">
var c = "text/javascript";
</script>
<script type="application/javascript">
var d = "application/javascript";
</script>
DEV: Prefer `<<~` over `<<`.
2018-10-18 14:17:10 +08:00
<script src="/external-script.js"></script>
HTML
DEV: extract inline js when baking theme fields (#6447) * extract inline js when baking theme fields * destroy javascript cache when destroying theme fields This work is needed to support CSP work
2018-10-15 12:55:23 +08:00
theme_field = ThemeField.create!(theme_id: 1, target_id: 0, name: "header", value: html)
expect(theme_field.value_baked).to include("<script src=\"#{theme_field.javascript_cache.url}\"></script>")
expect(theme_field.value_baked).to include("external-script.js")
FIX: only extract script tags with certain types (#6553) `script` tags with custom types (e.g. `text/template`) are not executed by the browser, and should not be extracted into an external theme JavaScript
2018-11-02 04:01:46 +08:00
expect(theme_field.value_baked).to include('<script type="text/template"')
expect(theme_field.javascript_cache.content).to include('a = "inline discourse plugin"')
expect(theme_field.javascript_cache.content).to include('b = "inline raw script"')
expect(theme_field.javascript_cache.content).to include('c = "text/javascript"')
expect(theme_field.javascript_cache.content).to include('d = "application/javascript"')
end
it 'adds newlines between the extracted javascripts' do
html = <<~HTML
<script>var a = 10</script>
<script>var b = 10</script>
HTML
extracted = <<~JavaScript
var a = 10
var b = 10
JavaScript
theme_field = ThemeField.create!(theme_id: 1, target_id: 0, name: "header", value: html)
expect(theme_field.javascript_cache.content).to eq(extracted)
DEV: extract inline js when baking theme fields (#6447) * extract inline js when baking theme fields * destroy javascript cache when destroying theme fields This work is needed to support CSP work
2018-10-15 12:55:23 +08:00
end
it "correctly extracts and generates errors for transpiled js" do
FEATURE: added error messages for bad theme CSS / JS
2017-04-20 04:46:28 +08:00
html = <<HTML
<script type="text/discourse-plugin" version="0.8">
badJavaScript(;
</script>
HTML
Fix all the errors to get our tests green on Rails 5.1.
2017-08-31 12:06:56 +08:00
Refactor theme fields so they support custom theme defined vars This paves the way to allowing themes to specify uploads and so on.
2017-05-03 04:01:01 +08:00
field = ThemeField.create!(theme_id: 1, target_id: 0, name: "header", value: html)
FEATURE: added error messages for bad theme CSS / JS
2017-04-20 04:46:28 +08:00
expect(field.error).not_to eq(nil)
DEV: extract inline js when baking theme fields (#6447) * extract inline js when baking theme fields * destroy javascript cache when destroying theme fields This work is needed to support CSP work
2018-10-15 12:55:23 +08:00
expect(field.value_baked).to include("<script src=\"#{field.javascript_cache.url}\"></script>")
expect(field.javascript_cache.content).to include("Theme Transpilation Error:")
Fix all the errors to get our tests green on Rails 5.1.
2017-08-31 12:06:56 +08:00
field.update!(value: '')
FEATURE: added error messages for bad theme CSS / JS
2017-04-20 04:46:28 +08:00
expect(field.error).to eq(nil)
end
Add spec + make it work with .raw templates
2018-04-03 17:53:00 +08:00
it "allows us to use theme settings in handlebars templates" do
html = <<HTML
<script type='text/x-handlebars' data-template-name='my-template'>
<div class="testing-div">{{themeSettings.string_setting}}</div>
</script>
HTML
ThemeField.create!(theme_id: 1, target_id: 3, name: "yaml", value: "string_setting: \"test text \\\" 123!\"")
DEV: extract inline js when baking theme fields (#6447) * extract inline js when baking theme fields * destroy javascript cache when destroying theme fields This work is needed to support CSP work
2018-10-15 12:55:23 +08:00
theme_field = ThemeField.create!(theme_id: 1, target_id: 0, name: "head_tag", value: html)
javascript_cache = theme_field.javascript_cache
Add spec + make it work with .raw templates
2018-04-03 17:53:00 +08:00
DEV: extract inline js when baking theme fields (#6447) * extract inline js when baking theme fields * destroy javascript cache when destroying theme fields This work is needed to support CSP work
2018-10-15 12:55:23 +08:00
expect(theme_field.value_baked).to include("<script src=\"#{javascript_cache.url}\"></script>")
expect(javascript_cache.content).to include("testing-div")
expect(javascript_cache.content).to include("theme-setting-injector")
expect(javascript_cache.content).to include("string_setting")
expect(javascript_cache.content).to include("test text \\\\\\\\u0022 123!")
Add spec + make it work with .raw templates
2018-04-03 17:53:00 +08:00
end
FEATURE: added error messages for bad theme CSS / JS
2017-04-20 04:46:28 +08:00
it "correctly generates errors for transpiled css" do
css = "body {"
Refactor theme fields so they support custom theme defined vars This paves the way to allowing themes to specify uploads and so on.
2017-05-03 04:01:01 +08:00
field = ThemeField.create!(theme_id: 1, target_id: 0, name: "scss", value: css)
FEATURE: added error messages for bad theme CSS / JS
2017-04-20 04:46:28 +08:00
field.reload
expect(field.error).not_to eq(nil)
FIX: detection of error changed, so you can clear errors
2017-04-21 04:55:09 +08:00
field.value = "body {color: blue};"
FEATURE: added error messages for bad theme CSS / JS
2017-04-20 04:46:28 +08:00
field.save!
FIX: detection of error changed, so you can clear errors
2017-04-21 04:55:09 +08:00
field.reload
FEATURE: added error messages for bad theme CSS / JS
2017-04-20 04:46:28 +08:00
expect(field.error).to eq(nil)
end
improve upload functionality
2017-05-11 02:43:05 +08:00
FIX: validates 'ThemeField' name when used in a SCSS variable
2017-12-19 23:10:44 +08:00
def create_upload_theme_field!(name)
ThemeField.create!(
theme_id: 1,
target_id: 0,
value: "",
type_id: ThemeField.types[:theme_upload_var],
name: name,
)
end
it "ensures we don't use invalid SCSS variable names" do
expect { create_upload_theme_field!("42") }.to raise_error(ActiveRecord::RecordInvalid)
expect { create_upload_theme_field!("a42") }.not_to raise_error
end
FEATURE: Theme settings (2) (#5611) Allows theme authors to specify custom theme settings for the theme. Centralizes the theme/site settings into a single construct
2018-03-05 08:04:23 +08:00
def get_fixture(type)
File.read("#{Rails.root}/spec/fixtures/theme_settings/#{type}_settings.yaml")
end
def create_yaml_field(value)
field = ThemeField.create!(theme_id: 1, target_id: Theme.targets[:settings], name: "yaml", value: value)
field.reload
field
end
let(:key) { "themes.settings_errors" }
it "generates errors for bad YAML" do
yaml = "invalid_setting 5"
field = create_yaml_field(yaml)
expect(field.error).to eq(I18n.t("#{key}.invalid_yaml"))
field.value = "valid_setting: true"
field.save!
field.reload
expect(field.error).to eq(nil)
end
it "generates errors when default value's type doesn't match setting type" do
field = create_yaml_field(get_fixture("invalid"))
expect(field.error).to include(I18n.t("#{key}.default_not_match_type", name: "no_match_setting"))
end
it "generates errors when no default value is passed" do
field = create_yaml_field(get_fixture("invalid"))
expect(field.error).to include(I18n.t("#{key}.default_value_missing", name: "no_default_setting"))
end
it "generates errors when invalid type is passed" do
field = create_yaml_field(get_fixture("invalid"))
expect(field.error).to include(I18n.t("#{key}.data_type_not_a_number", name: "invalid_type_setting"))
end
it "generates errors when default value is not within allowed range" do
field = create_yaml_field(get_fixture("invalid"))
expect(field.error).to include(I18n.t("#{key}.default_out_range", name: "default_out_of_range"))
expect(field.error).to include(I18n.t("#{key}.default_out_range", name: "string_default_out_of_range"))
end
it "works correctly when valid yaml is provided" do
field = create_yaml_field(get_fixture("valid"))
expect(field.error).to be_nil
end
FEATURE: added error messages for bad theme CSS / JS
2017-04-20 04:46:28 +08:00
end
Reference in New Issue Copy Permalink