mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-15 20:44:01 +02:00
Add support for minification of final output
Hugo Pipes added minification support for resources fetched via ´resources.Get` and similar. This also adds support for minification of the final output for supported output formats: HTML, XML, SVG, CSS, JavaScript, JSON. To enable, run Hugo with the `--minify` flag: ```bash hugo --minify ``` This commit is also a major spring cleaning of the `transform` package to allow the new minification step fit into that processing chain. Fixes #1251
This commit is contained in:
Bjørn Erik Pedersen
@@ -1,4 +1,4 @@
|
||||
// Copyright 2015 The Hugo Authors. All rights reserved.
|
||||
// Copyright 2018 The Hugo Authors. All rights reserved.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
@@ -15,142 +15,44 @@ package transform
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
bp "github.com/gohugoio/hugo/bufferpool"
|
||||
"github.com/gohugoio/hugo/helpers"
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
const (
|
||||
h5JsContentDoubleQuote = "<!DOCTYPE html><html><head><script src=\"foobar.js\"></script><script src=\"/barfoo.js\"></script></head><body><nav><h1>title</h1></nav><article>content <a href=\"foobar\">foobar</a>. <a href=\"/foobar\">Follow up</a></article></body></html>"
|
||||
h5JsContentSingleQuote = "<!DOCTYPE html><html><head><script src='foobar.js'></script><script src='/barfoo.js'></script></head><body><nav><h1>title</h1></nav><article>content <a href='foobar'>foobar</a>. <a href='/foobar'>Follow up</a></article></body></html>"
|
||||
h5JsContentAbsURL = "<!DOCTYPE html><html><head><script src=\"http://user@host:10234/foobar.js\"></script></head><body><nav><h1>title</h1></nav><article>content <a href=\"https://host/foobar\">foobar</a>. Follow up</article></body></html>"
|
||||
h5JsContentAbsURLSchemaless = "<!DOCTYPE html><html><head><script src=\"//host/foobar.js\"></script><script src='//host2/barfoo.js'></head><body><nav><h1>title</h1></nav><article>content <a href=\"//host/foobar\">foobar</a>. <a href='//host2/foobar'>Follow up</a></article></body></html>"
|
||||
corectOutputSrcHrefDq = "<!DOCTYPE html><html><head><script src=\"foobar.js\"></script><script src=\"http://base/barfoo.js\"></script></head><body><nav><h1>title</h1></nav><article>content <a href=\"foobar\">foobar</a>. <a href=\"http://base/foobar\">Follow up</a></article></body></html>"
|
||||
corectOutputSrcHrefSq = "<!DOCTYPE html><html><head><script src='foobar.js'></script><script src='http://base/barfoo.js'></script></head><body><nav><h1>title</h1></nav><article>content <a href='foobar'>foobar</a>. <a href='http://base/foobar'>Follow up</a></article></body></html>"
|
||||
|
||||
h5XMLXontentAbsURL = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?><feed xmlns=\"http://www.w3.org/2005/Atom\"><entry><content type=\"html\"><p><a href="/foobar">foobar</a></p> <p>A video: <iframe src='/foo'></iframe></p></content></entry></feed>"
|
||||
correctOutputSrcHrefInXML = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?><feed xmlns=\"http://www.w3.org/2005/Atom\"><entry><content type=\"html\"><p><a href="http://base/foobar">foobar</a></p> <p>A video: <iframe src='http://base/foo'></iframe></p></content></entry></feed>"
|
||||
h5XMLContentGuarded = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?><feed xmlns=\"http://www.w3.org/2005/Atom\"><entry><content type=\"html\"><p><a href="//foobar">foobar</a></p> <p>A video: <iframe src='//foo'></iframe></p></content></entry></feed>"
|
||||
)
|
||||
|
||||
const (
|
||||
// additional sanity tests for replacements testing
|
||||
replace1 = "No replacements."
|
||||
replace2 = "ᚠᛇᚻ ᛒᛦᚦ ᚠᚱᚩᚠᚢᚱ\nᚠᛁᚱᚪ ᚷᛖᚻᚹᛦᛚᚳᚢᛗ"
|
||||
replace3 = `End of file: src="/`
|
||||
replace4 = `End of file: srcset="/`
|
||||
replace5 = `Srcsett with no closing quote: srcset="/img/small.jpg do be do be do.`
|
||||
|
||||
// Issue: 816, schemaless links combined with others
|
||||
replaceSchemalessHTML = `Pre. src='//schemaless' src='/normal' <a href="//schemaless">Schemaless</a>. <a href="/normal">normal</a>. Post.`
|
||||
replaceSchemalessHTMLCorrect = `Pre. src='//schemaless' src='http://base/normal' <a href="//schemaless">Schemaless</a>. <a href="http://base/normal">normal</a>. Post.`
|
||||
replaceSchemalessXML = `Pre. src='//schemaless' src='/normal' <a href='//schemaless'>Schemaless</a>. <a href='/normal'>normal</a>. Post.`
|
||||
replaceSchemalessXMLCorrect = `Pre. src='//schemaless' src='http://base/normal' <a href='//schemaless'>Schemaless</a>. <a href='http://base/normal'>normal</a>. Post.`
|
||||
)
|
||||
|
||||
const (
|
||||
// srcset=
|
||||
srcsetBasic = `Pre. <img srcset="/img/small.jpg 200w, /img/medium.jpg 300w, /img/big.jpg 700w" alt="text" src="/img/foo.jpg">`
|
||||
srcsetBasicCorrect = `Pre. <img srcset="http://base/img/small.jpg 200w, http://base/img/medium.jpg 300w, http://base/img/big.jpg 700w" alt="text" src="http://base/img/foo.jpg">`
|
||||
srcsetSingleQuote = `Pre. <img srcset='/img/small.jpg 200w, /img/big.jpg 700w' alt="text" src="/img/foo.jpg"> POST.`
|
||||
srcsetSingleQuoteCorrect = `Pre. <img srcset='http://base/img/small.jpg 200w, http://base/img/big.jpg 700w' alt="text" src="http://base/img/foo.jpg"> POST.`
|
||||
srcsetXMLBasic = `Pre. <img srcset="/img/small.jpg 200w, /img/big.jpg 700w" alt="text" src="/img/foo.jpg">`
|
||||
srcsetXMLBasicCorrect = `Pre. <img srcset="http://base/img/small.jpg 200w, http://base/img/big.jpg 700w" alt="text" src="http://base/img/foo.jpg">`
|
||||
srcsetXMLSingleQuote = `Pre. <img srcset="/img/small.jpg 200w, /img/big.jpg 700w" alt="text" src="/img/foo.jpg">`
|
||||
srcsetXMLSingleQuoteCorrect = `Pre. <img srcset="http://base/img/small.jpg 200w, http://base/img/big.jpg 700w" alt="text" src="http://base/img/foo.jpg">`
|
||||
srcsetVariations = `Pre.
|
||||
Missing start quote: <img srcset=/img/small.jpg 200w, /img/big.jpg 700w" alt="text"> src='/img/foo.jpg'> FOO.
|
||||
<img srcset='/img.jpg'>
|
||||
schemaless: <img srcset='//img.jpg' src='//basic.jpg'>
|
||||
schemaless2: <img srcset="//img.jpg" src="//basic.jpg2> POST
|
||||
`
|
||||
)
|
||||
|
||||
const (
|
||||
srcsetVariationsCorrect = `Pre.
|
||||
Missing start quote: <img srcset=/img/small.jpg 200w, /img/big.jpg 700w" alt="text"> src='http://base/img/foo.jpg'> FOO.
|
||||
<img srcset='http://base/img.jpg'>
|
||||
schemaless: <img srcset='//img.jpg' src='//basic.jpg'>
|
||||
schemaless2: <img srcset="//img.jpg" src="//basic.jpg2> POST
|
||||
`
|
||||
srcsetXMLVariations = `Pre.
|
||||
Missing start quote: <img srcset=/img/small.jpg 200w /img/big.jpg 700w" alt="text"> src='/img/foo.jpg'> FOO.
|
||||
<img srcset='/img.jpg'>
|
||||
schemaless: <img srcset='//img.jpg' src='//basic.jpg'>
|
||||
schemaless2: <img srcset="//img.jpg" src="//basic.jpg2> POST
|
||||
`
|
||||
srcsetXMLVariationsCorrect = `Pre.
|
||||
Missing start quote: <img srcset=/img/small.jpg 200w /img/big.jpg 700w" alt="text"> src='http://base/img/foo.jpg'> FOO.
|
||||
<img srcset='http://base/img.jpg'>
|
||||
schemaless: <img srcset='//img.jpg' src='//basic.jpg'>
|
||||
schemaless2: <img srcset="//img.jpg" src="//basic.jpg2> POST
|
||||
`
|
||||
|
||||
relPathVariations = `PRE. a href="/img/small.jpg" POST.`
|
||||
relPathVariationsCorrect = `PRE. a href="../../img/small.jpg" POST.`
|
||||
|
||||
testBaseURL = "http://base/"
|
||||
)
|
||||
|
||||
var (
|
||||
absURLlBenchTests = []test{
|
||||
{h5JsContentDoubleQuote, corectOutputSrcHrefDq},
|
||||
{h5JsContentSingleQuote, corectOutputSrcHrefSq},
|
||||
{h5JsContentAbsURL, h5JsContentAbsURL},
|
||||
{h5JsContentAbsURLSchemaless, h5JsContentAbsURLSchemaless},
|
||||
}
|
||||
|
||||
xmlAbsURLBenchTests = []test{
|
||||
{h5XMLXontentAbsURL, correctOutputSrcHrefInXML},
|
||||
{h5XMLContentGuarded, h5XMLContentGuarded},
|
||||
}
|
||||
|
||||
sanityTests = []test{{replace1, replace1}, {replace2, replace2}, {replace3, replace3}, {replace3, replace3}, {replace5, replace5}}
|
||||
extraTestsHTML = []test{{replaceSchemalessHTML, replaceSchemalessHTMLCorrect}}
|
||||
absURLTests = append(absURLlBenchTests, append(sanityTests, extraTestsHTML...)...)
|
||||
extraTestsXML = []test{{replaceSchemalessXML, replaceSchemalessXMLCorrect}}
|
||||
xmlAbsURLTests = append(xmlAbsURLBenchTests, append(sanityTests, extraTestsXML...)...)
|
||||
srcsetTests = []test{{srcsetBasic, srcsetBasicCorrect}, {srcsetSingleQuote, srcsetSingleQuoteCorrect}, {srcsetVariations, srcsetVariationsCorrect}}
|
||||
srcsetXMLTests = []test{
|
||||
{srcsetXMLBasic, srcsetXMLBasicCorrect},
|
||||
{srcsetXMLSingleQuote, srcsetXMLSingleQuoteCorrect},
|
||||
{srcsetXMLVariations, srcsetXMLVariationsCorrect}}
|
||||
|
||||
relurlTests = []test{{relPathVariations, relPathVariationsCorrect}}
|
||||
)
|
||||
|
||||
func TestChainZeroTransformers(t *testing.T) {
|
||||
tr := NewChain()
|
||||
tr := New()
|
||||
in := new(bytes.Buffer)
|
||||
out := new(bytes.Buffer)
|
||||
if err := tr.Apply(in, out, []byte("")); err != nil {
|
||||
if err := tr.Apply(in, out); err != nil {
|
||||
t.Errorf("A zero transformer chain returned an error.")
|
||||
}
|
||||
}
|
||||
|
||||
func TestChaingMultipleTransformers(t *testing.T) {
|
||||
f1 := func(ct contentTransformer) {
|
||||
ct.Write(bytes.Replace(ct.Content(), []byte("f1"), []byte("f1r"), -1))
|
||||
f1 := func(ct FromTo) error {
|
||||
_, err := ct.To().Write(bytes.Replace(ct.From().Bytes(), []byte("f1"), []byte("f1r"), -1))
|
||||
return err
|
||||
}
|
||||
f2 := func(ct contentTransformer) {
|
||||
ct.Write(bytes.Replace(ct.Content(), []byte("f2"), []byte("f2r"), -1))
|
||||
f2 := func(ct FromTo) error {
|
||||
_, err := ct.To().Write(bytes.Replace(ct.From().Bytes(), []byte("f2"), []byte("f2r"), -1))
|
||||
return err
|
||||
}
|
||||
f3 := func(ct contentTransformer) {
|
||||
ct.Write(bytes.Replace(ct.Content(), []byte("f3"), []byte("f3r"), -1))
|
||||
f3 := func(ct FromTo) error {
|
||||
_, err := ct.To().Write(bytes.Replace(ct.From().Bytes(), []byte("f3"), []byte("f3r"), -1))
|
||||
return err
|
||||
}
|
||||
|
||||
f4 := func(ct contentTransformer) {
|
||||
ct.Write(bytes.Replace(ct.Content(), []byte("f4"), []byte("f4r"), -1))
|
||||
f4 := func(ct FromTo) error {
|
||||
_, err := ct.To().Write(bytes.Replace(ct.From().Bytes(), []byte("f4"), []byte("f4r"), -1))
|
||||
return err
|
||||
}
|
||||
|
||||
tr := NewChain(f1, f2, f3, f4)
|
||||
tr := New(f1, f2, f3, f4)
|
||||
|
||||
out := new(bytes.Buffer)
|
||||
if err := tr.Apply(out, strings.NewReader("Test: f4 f3 f1 f2 f1 The End."), []byte("")); err != nil {
|
||||
if err := tr.Apply(out, strings.NewReader("Test: f4 f3 f1 f2 f1 The End.")); err != nil {
|
||||
t.Errorf("Multi transformer chain returned an error: %s", err)
|
||||
}
|
||||
|
||||
@@ -161,107 +63,7 @@ func TestChaingMultipleTransformers(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkAbsURL(b *testing.B) {
|
||||
tr := NewChain(AbsURL)
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
apply(b.Errorf, tr, absURLlBenchTests)
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkAbsURLSrcset(b *testing.B) {
|
||||
tr := NewChain(AbsURL)
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
apply(b.Errorf, tr, srcsetTests)
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkXMLAbsURLSrcset(b *testing.B) {
|
||||
tr := NewChain(AbsURLInXML)
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
apply(b.Errorf, tr, srcsetXMLTests)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAbsURL(t *testing.T) {
|
||||
tr := NewChain(AbsURL)
|
||||
|
||||
apply(t.Errorf, tr, absURLTests)
|
||||
|
||||
}
|
||||
|
||||
func TestRelativeURL(t *testing.T) {
|
||||
tr := NewChain(AbsURL)
|
||||
|
||||
applyWithPath(t.Errorf, tr, relurlTests, helpers.GetDottedRelativePath(filepath.FromSlash("/post/sub/")))
|
||||
|
||||
}
|
||||
|
||||
func TestAbsURLSrcSet(t *testing.T) {
|
||||
tr := NewChain(AbsURL)
|
||||
|
||||
apply(t.Errorf, tr, srcsetTests)
|
||||
}
|
||||
|
||||
func TestAbsXMLURLSrcSet(t *testing.T) {
|
||||
tr := NewChain(AbsURLInXML)
|
||||
|
||||
apply(t.Errorf, tr, srcsetXMLTests)
|
||||
}
|
||||
|
||||
func BenchmarkXMLAbsURL(b *testing.B) {
|
||||
tr := NewChain(AbsURLInXML)
|
||||
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
apply(b.Errorf, tr, xmlAbsURLBenchTests)
|
||||
}
|
||||
}
|
||||
|
||||
func TestXMLAbsURL(t *testing.T) {
|
||||
tr := NewChain(AbsURLInXML)
|
||||
apply(t.Errorf, tr, xmlAbsURLTests)
|
||||
}
|
||||
|
||||
func TestNewEmptyTransforms(t *testing.T) {
|
||||
transforms := NewEmptyTransforms()
|
||||
transforms := NewEmpty()
|
||||
assert.Equal(t, 20, cap(transforms))
|
||||
}
|
||||
|
||||
type errorf func(string, ...interface{})
|
||||
|
||||
func applyWithPath(ef errorf, tr chain, tests []test, path string) {
|
||||
out := bp.GetBuffer()
|
||||
defer bp.PutBuffer(out)
|
||||
|
||||
in := bp.GetBuffer()
|
||||
defer bp.PutBuffer(in)
|
||||
|
||||
for _, test := range tests {
|
||||
var err error
|
||||
in.WriteString(test.content)
|
||||
err = tr.Apply(out, in, []byte(path))
|
||||
if err != nil {
|
||||
ef("Unexpected error: %s", err)
|
||||
}
|
||||
if test.expected != out.String() {
|
||||
ef("Expected:\n%s\nGot:\n%s", test.expected, out.String())
|
||||
}
|
||||
out.Reset()
|
||||
in.Reset()
|
||||
}
|
||||
}
|
||||
|
||||
func apply(ef errorf, tr chain, tests []test) {
|
||||
applyWithPath(ef, tr, tests, testBaseURL)
|
||||
}
|
||||
|
||||
type test struct {
|
||||
content string
|
||||
expected string
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user