vweb.assets: fix am is declared as mutable, but it was never changed message

pull/4006/head
Ian M. Jones 2020-03-13 03:32:24 +00:00 committed by GitHub
parent 4b4c47461b
commit 0e68ca120e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 214 additions and 10 deletions

View File

@ -17,7 +17,7 @@ struct AssetManager {
mut:
css []Asset
js []Asset
pub:
pub mut:
// when true assets will be minified
minify bool
// the directory to store the cached/combined files
@ -46,29 +46,29 @@ pub fn (am mut AssetManager) add_js(file string) bool {
// combine_css returns the combined css as a string when to_file is false
// when to_file is true it combines the css to disk and returns the path of the file
pub fn (am mut AssetManager) combine_css(to_file bool) string {
pub fn (am AssetManager) combine_css(to_file bool) string {
return am.combine('css', to_file)
}
// combine_js returns the combined js as a string when to_file is false
// when to_file is true it combines the css to disk and returns the path of the file
pub fn (am mut AssetManager) combine_js(to_file bool) string {
pub fn (am AssetManager) combine_js(to_file bool) string {
return am.combine('js', to_file)
}
// include_css returns the html <link> tag(s) for including the css files in a page.
// when combine is true the files are combined.
pub fn (am mut AssetManager) include_css(combine bool) string {
pub fn (am AssetManager) include_css(combine bool) string {
return am.include('css', combine)
}
// include_js returns the html <script> tag(s) for including the js files in a page.
// when combine is true the files are combined.
pub fn (am mut AssetManager) include_js(combine bool) string {
pub fn (am AssetManager) include_js(combine bool) string {
return am.include('js', combine)
}
fn (am mut AssetManager) combine(asset_type string, to_file bool) string {
fn (am AssetManager) combine(asset_type string, to_file bool) string {
if am.cache_dir == '' {
panic('vweb.assets: you must set a cache dir.')
}
@ -113,7 +113,7 @@ fn (am mut AssetManager) combine(asset_type string, to_file bool) string {
return out_file
}
fn (am mut AssetManager) get_cache_key(asset_type string) string {
fn (am AssetManager) get_cache_key(asset_type string) string {
mut files_salt := ''
mut latest_modified := 0
for asset in am.get_assets(asset_type) {
@ -126,7 +126,7 @@ fn (am mut AssetManager) get_cache_key(asset_type string) string {
return '$hash-$latest_modified'
}
fn (am mut AssetManager) include(asset_type string, combine bool) string {
fn (am AssetManager) include(asset_type string, combine bool) string {
assets := am.get_assets(asset_type)
mut out := ''
if asset_type == 'css' {
@ -171,7 +171,7 @@ fn (am mut AssetManager) add(asset_type, file string) bool {
return true
}
fn (am mut AssetManager) exists(asset_type, file string) bool {
fn (am AssetManager) exists(asset_type, file string) bool {
assets := am.get_assets(asset_type)
for asset in assets {
if asset.file_path == file {
@ -181,7 +181,7 @@ fn (am mut AssetManager) exists(asset_type, file string) bool {
return false
}
fn (am mut AssetManager) get_assets(asset_type string) []Asset {
fn (am AssetManager) get_assets(asset_type string) []Asset {
if asset_type != 'css' && asset_type != 'js' {
panic('$UnknownAssetTypeError ($asset_type).')
}

View File

@ -0,0 +1,204 @@
import (
vweb.assets
os
)
// clean_cache_dir used before and after tests that write to a cache directory.
// Because of parallel compilation and therefore test running,
// unique cache dirs are needed per test function.
fn clean_cache_dir(dir string) {
if os.is_dir(dir) {
os.rmdir_all(dir)
}
}
fn base_cache_dir() string {
return os.join_path(os.temp_dir(), 'assets_test_cache')
}
fn cache_dir(test_name string) string {
return os.join_path(base_cache_dir(), test_name)
}
fn get_test_file_path(file string) string {
path := os.join_path(base_cache_dir(), file)
if ! os.is_dir(base_cache_dir()) {
os.mkdir_all(base_cache_dir())
}
if ! os.exists(path) {
os.write_file(path, get_test_file_contents(file))
}
return path
}
fn get_test_file_contents(file string) string {
contents := match file {
'test1.js' { '{"one": 1}\n' }
'test2.js' { '{"two": 2}\n' }
'test1.css' { '.one {\n\tcolor: #336699;\n}\n' }
'test2.css' { '.two {\n\tcolor: #996633;\n}\n' }
else { 'wibble\n' }
}
return contents
}
fn test_set_cache() {
mut am := assets.new_manager()
am.cache_dir = 'cache'
}
fn test_set_minify() {
mut am := assets.new_manager()
am.minify = true
}
fn test_add() {
mut am := assets.new_manager()
assert am.add('css', 'testx.css') == false
assert am.add('css', get_test_file_path('test1.css')) == true
assert am.add('js', get_test_file_path('test1.js')) == true
// assert am.add('css', get_test_file_path('test2.js')) == false // TODO: test extension on add
}
fn test_add_css() {
mut am := assets.new_manager()
assert am.add_css('testx.css') == false
assert am.add_css(get_test_file_path('test1.css')) == true
// assert am.add_css(get_test_file_path('test1.js')) == false // TODO: test extension on add
}
fn test_add_js() {
mut am := assets.new_manager()
assert am.add_js('testx.js') == false
assert am.add_css(get_test_file_path('test1.js')) == true
// assert am.add_css(get_test_file_path('test1.css')) == false // TODO: test extension on add
}
fn test_combine_css() {
mut am := assets.new_manager()
am.cache_dir = cache_dir('test_combine_css')
clean_cache_dir(am.cache_dir)
am.add_css(get_test_file_path('test1.css'))
am.add_css(get_test_file_path('test2.css'))
// TODO: How do I test non-minified, is there a "here doc" format that keeps formatting?
am.minify = true
expected := '.one { color: #336699; } .two { color: #996633; }'
actual := am.combine_css(false)
// assert actual == expected // TODO: Why does this not pass, file/line ending?
assert actual.contains(expected)
// Test cache path doesn't change when input files and minify setting do not.
path1 := am.combine_css(true)
clean_cache_dir(am.cache_dir)
path2 := am.combine_css(true)
assert path1 == path2
clean_cache_dir(am.cache_dir)
}
fn test_combine_js() {
mut am := assets.new_manager()
am.cache_dir = cache_dir('test_combine_js')
clean_cache_dir(am.cache_dir)
am.add_js(get_test_file_path('test1.js'))
am.add_js(get_test_file_path('test2.js'))
expected1 := '{"one": 1}'
expected2 := '{"two": 2}'
expected := expected1 + '\n' + expected2
actual := am.combine_js(false)
// assert actual == expected // TODO: Why does this not pass, file/line ending?
assert actual.contains(expected)
assert actual.contains(expected1)
assert actual.contains(expected2)
am.minify = true
clean_cache_dir(am.cache_dir)
expected3 := expected1 + ' ' + expected2
actual2 := am.combine_js(false)
// assert actual2 == expected3 // TODO: Why does this not pass, file/line ending?
assert actual2.contains(expected3)
// Test cache path doesn't change when input files and minify setting do not.
path1 := am.combine_js(true)
clean_cache_dir(am.cache_dir)
path2 := am.combine_js(true)
assert path1 == path2
clean_cache_dir(am.cache_dir)
}
fn test_include_css() {
mut am := assets.new_manager()
file1 := get_test_file_path('test1.css')
am.add_css(file1)
expected := '<link rel="stylesheet" href="$file1">'
actual := am.include_css(false)
// assert actual == expected // TODO: Why does this not pass, file/line ending?
assert actual.contains(expected)
// Two lines of output.
file2 := get_test_file_path('test2.css')
am.add_css(file2)
am.cache_dir = cache_dir('test_include_css')
clean_cache_dir(am.cache_dir)
expected2 := expected + '\n<link rel="stylesheet" href="$file2">'
actual2 := am.include_css(false)
// assert actual2 == expected2 // TODO: Why does this not pass, file/line ending?
assert actual2.contains(expected2)
// Combined output.
clean_cache_dir(am.cache_dir)
actual3 := am.include_css(true)
assert actual3.contains(expected2) == false
assert actual3.starts_with('<link rel="stylesheet" href="${am.cache_dir}/') == true
// Test cache path doesn't change when input files and minify setting do not.
clean_cache_dir(am.cache_dir)
actual4 := am.include_css(true)
assert actual4 == actual3
clean_cache_dir(am.cache_dir)
}
fn test_include_js() {
mut am := assets.new_manager()
file1 := get_test_file_path('test1.js')
am.add_js(file1)
expected := '<script type="text/javascript" src="$file1"></script>'
actual := am.include_js(false)
// assert actual == expected // TODO: Why does this not pass, file/line ending?
assert actual.contains(expected)
// Two lines of output.
file2 := get_test_file_path('test2.js')
am.add_js(file2)
am.cache_dir = cache_dir('test_include_js')
clean_cache_dir(am.cache_dir)
expected2 := expected + '\n<script type="text/javascript" src="$file2"></script>'
actual2 := am.include_js(false)
// assert actual2 == expected2 // TODO: Why does this not pass, file/line ending?
assert actual2.contains(expected2)
// Combined output.
clean_cache_dir(am.cache_dir)
actual3 := am.include_js(true)
assert actual3.contains(expected2) == false
assert actual3.starts_with('<script type="text/javascript" src="${am.cache_dir}/')
// Test cache path doesn't change when input files and minify setting do not.
clean_cache_dir(am.cache_dir)
actual4 := am.include_js(true)
assert actual4 == actual3
clean_cache_dir(am.cache_dir)
}