2019-01-02 06:33:26 -05:00
|
|
|
// Copyright 2019 The Hugo Authors. All rights reserved.
|
2017-03-05 12:23:00 -05:00
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
|
|
|
package media
|
|
|
|
|
|
|
|
import (
|
2021-03-11 03:18:01 -05:00
|
|
|
"encoding/json"
|
2023-02-18 17:43:26 -05:00
|
|
|
"os"
|
2021-12-16 09:12:13 -05:00
|
|
|
"path/filepath"
|
2021-04-20 06:05:25 -04:00
|
|
|
"sort"
|
2021-12-16 09:12:13 -05:00
|
|
|
"strings"
|
2017-03-05 12:23:00 -05:00
|
|
|
"testing"
|
|
|
|
|
2019-08-10 15:05:17 -04:00
|
|
|
qt "github.com/frankban/quicktest"
|
2021-12-16 09:12:13 -05:00
|
|
|
"github.com/gohugoio/hugo/common/paths"
|
2017-03-05 12:23:00 -05:00
|
|
|
)
|
|
|
|
|
2017-04-03 11:00:23 -04:00
|
|
|
func TestGetByType(t *testing.T) {
|
2019-08-10 15:05:17 -04:00
|
|
|
c := qt.New(t)
|
|
|
|
|
2023-01-04 12:24:36 -05:00
|
|
|
types := DefaultTypes
|
2017-04-03 11:00:23 -04:00
|
|
|
|
|
|
|
mt, found := types.GetByType("text/HTML")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(found, qt.Equals, true)
|
2023-01-04 12:24:36 -05:00
|
|
|
c.Assert(mt.SubType, qt.Equals, "html")
|
2017-04-03 11:00:23 -04:00
|
|
|
|
|
|
|
_, found = types.GetByType("text/nono")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(found, qt.Equals, false)
|
2018-07-10 05:55:22 -04:00
|
|
|
|
|
|
|
mt, found = types.GetByType("application/rss+xml")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(found, qt.Equals, true)
|
2023-01-04 12:24:36 -05:00
|
|
|
c.Assert(mt.SubType, qt.Equals, "rss")
|
2018-07-10 05:55:22 -04:00
|
|
|
|
|
|
|
mt, found = types.GetByType("application/rss")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(found, qt.Equals, true)
|
2023-01-04 12:24:36 -05:00
|
|
|
c.Assert(mt.SubType, qt.Equals, "rss")
|
2018-07-10 05:55:22 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
func TestGetByMainSubType(t *testing.T) {
|
2019-08-10 15:05:17 -04:00
|
|
|
c := qt.New(t)
|
2018-07-10 05:55:22 -04:00
|
|
|
f, found := DefaultTypes.GetByMainSubType("text", "plain")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(found, qt.Equals, true)
|
2023-01-04 12:24:36 -05:00
|
|
|
c.Assert(f.SubType, qt.Equals, "plain")
|
2018-07-10 05:55:22 -04:00
|
|
|
_, found = DefaultTypes.GetByMainSubType("foo", "plain")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(found, qt.Equals, false)
|
2017-04-03 11:00:23 -04:00
|
|
|
}
|
2017-04-03 16:39:37 -04:00
|
|
|
|
2018-08-28 08:18:12 -04:00
|
|
|
func TestBySuffix(t *testing.T) {
|
2019-08-10 15:05:17 -04:00
|
|
|
c := qt.New(t)
|
2018-08-28 08:18:12 -04:00
|
|
|
formats := DefaultTypes.BySuffix("xml")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(len(formats), qt.Equals, 2)
|
|
|
|
c.Assert(formats[0].SubType, qt.Equals, "rss")
|
|
|
|
c.Assert(formats[1].SubType, qt.Equals, "xml")
|
2018-08-28 08:18:12 -04:00
|
|
|
}
|
|
|
|
|
Add Hugo Piper with SCSS support and much more
Before this commit, you would have to use page bundles to do image processing etc. in Hugo.
This commit adds
* A new `/assets` top-level project or theme dir (configurable via `assetDir`)
* A new template func, `resources.Get` which can be used to "get a resource" that can be further processed.
This means that you can now do this in your templates (or shortcodes):
```bash
{{ $sunset := (resources.Get "images/sunset.jpg").Fill "300x200" }}
```
This also adds a new `extended` build tag that enables powerful SCSS/SASS support with source maps. To compile this from source, you will also need a C compiler installed:
```
HUGO_BUILD_TAGS=extended mage install
```
Note that you can use output of the SCSS processing later in a non-SCSSS-enabled Hugo.
The `SCSS` processor is a _Resource transformation step_ and it can be chained with the many others in a pipeline:
```bash
{{ $css := resources.Get "styles.scss" | resources.ToCSS | resources.PostCSS | resources.Minify | resources.Fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
The transformation funcs above have aliases, so it can be shortened to:
```bash
{{ $css := resources.Get "styles.scss" | toCSS | postCSS | minify | fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
A quick tip would be to avoid the fingerprinting part, and possibly also the not-superfast `postCSS` when you're doing development, as it allows Hugo to be smarter about the rebuilding.
Documentation will follow, but have a look at the demo repo in https://github.com/bep/hugo-sass-test
New functions to create `Resource` objects:
* `resources.Get` (see above)
* `resources.FromString`: Create a Resource from a string.
New `Resource` transformation funcs:
* `resources.ToCSS`: Compile `SCSS` or `SASS` into `CSS`.
* `resources.PostCSS`: Process your CSS with PostCSS. Config file support (project or theme or passed as an option).
* `resources.Minify`: Currently supports `css`, `js`, `json`, `html`, `svg`, `xml`.
* `resources.Fingerprint`: Creates a fingerprinted version of the given Resource with Subresource Integrity..
* `resources.Concat`: Concatenates a list of Resource objects. Think of this as a poor man's bundler.
* `resources.ExecuteAsTemplate`: Parses and executes the given Resource and data context (e.g. .Site) as a Go template.
Fixes #4381
Fixes #4903
Fixes #4858
2018-02-20 04:02:14 -05:00
|
|
|
func TestGetFirstBySuffix(t *testing.T) {
|
2019-08-10 15:05:17 -04:00
|
|
|
c := qt.New(t)
|
2021-04-20 06:05:25 -04:00
|
|
|
|
2023-01-04 12:24:36 -05:00
|
|
|
types := make(Types, len(DefaultTypes))
|
|
|
|
copy(types, DefaultTypes)
|
2021-04-20 06:05:25 -04:00
|
|
|
|
|
|
|
// Issue #8406
|
|
|
|
geoJSON := newMediaTypeWithMimeSuffix("application", "geo", "json", []string{"geojson", "gjson"})
|
|
|
|
types = append(types, geoJSON)
|
|
|
|
sort.Sort(types)
|
|
|
|
|
|
|
|
check := func(suffix string, expectedType Type) {
|
|
|
|
t, f, found := types.GetFirstBySuffix(suffix)
|
|
|
|
c.Assert(found, qt.Equals, true)
|
|
|
|
c.Assert(f, qt.Equals, SuffixInfo{
|
|
|
|
Suffix: suffix,
|
2021-12-21 03:39:05 -05:00
|
|
|
FullSuffix: "." + suffix,
|
|
|
|
})
|
2021-04-20 06:05:25 -04:00
|
|
|
c.Assert(t, qt.Equals, expectedType)
|
|
|
|
}
|
|
|
|
|
2023-01-04 12:24:36 -05:00
|
|
|
check("js", Builtin.JavascriptType)
|
|
|
|
check("json", Builtin.JSONType)
|
2021-04-20 06:05:25 -04:00
|
|
|
check("geojson", geoJSON)
|
|
|
|
check("gjson", geoJSON)
|
Add Hugo Piper with SCSS support and much more
Before this commit, you would have to use page bundles to do image processing etc. in Hugo.
This commit adds
* A new `/assets` top-level project or theme dir (configurable via `assetDir`)
* A new template func, `resources.Get` which can be used to "get a resource" that can be further processed.
This means that you can now do this in your templates (or shortcodes):
```bash
{{ $sunset := (resources.Get "images/sunset.jpg").Fill "300x200" }}
```
This also adds a new `extended` build tag that enables powerful SCSS/SASS support with source maps. To compile this from source, you will also need a C compiler installed:
```
HUGO_BUILD_TAGS=extended mage install
```
Note that you can use output of the SCSS processing later in a non-SCSSS-enabled Hugo.
The `SCSS` processor is a _Resource transformation step_ and it can be chained with the many others in a pipeline:
```bash
{{ $css := resources.Get "styles.scss" | resources.ToCSS | resources.PostCSS | resources.Minify | resources.Fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
The transformation funcs above have aliases, so it can be shortened to:
```bash
{{ $css := resources.Get "styles.scss" | toCSS | postCSS | minify | fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```
A quick tip would be to avoid the fingerprinting part, and possibly also the not-superfast `postCSS` when you're doing development, as it allows Hugo to be smarter about the rebuilding.
Documentation will follow, but have a look at the demo repo in https://github.com/bep/hugo-sass-test
New functions to create `Resource` objects:
* `resources.Get` (see above)
* `resources.FromString`: Create a Resource from a string.
New `Resource` transformation funcs:
* `resources.ToCSS`: Compile `SCSS` or `SASS` into `CSS`.
* `resources.PostCSS`: Process your CSS with PostCSS. Config file support (project or theme or passed as an option).
* `resources.Minify`: Currently supports `css`, `js`, `json`, `html`, `svg`, `xml`.
* `resources.Fingerprint`: Creates a fingerprinted version of the given Resource with Subresource Integrity..
* `resources.Concat`: Concatenates a list of Resource objects. Think of this as a poor man's bundler.
* `resources.ExecuteAsTemplate`: Parses and executes the given Resource and data context (e.g. .Site) as a Go template.
Fixes #4381
Fixes #4903
Fixes #4858
2018-02-20 04:02:14 -05:00
|
|
|
}
|
|
|
|
|
2017-04-03 16:39:37 -04:00
|
|
|
func TestFromTypeString(t *testing.T) {
|
2019-08-10 15:05:17 -04:00
|
|
|
c := qt.New(t)
|
2023-01-16 05:05:28 -05:00
|
|
|
f, err := FromString("text/html")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(err, qt.IsNil)
|
2023-01-04 12:24:36 -05:00
|
|
|
c.Assert(f.Type, qt.Equals, Builtin.HTMLType.Type)
|
2017-04-03 16:39:37 -04:00
|
|
|
|
2023-01-16 05:05:28 -05:00
|
|
|
f, err = FromString("application/custom")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(err, qt.IsNil)
|
2023-01-04 12:24:36 -05:00
|
|
|
c.Assert(f, qt.Equals, Type{Type: "application/custom", MainType: "application", SubType: "custom", mimeSuffix: ""})
|
2017-04-03 16:39:37 -04:00
|
|
|
|
2023-01-16 05:05:28 -05:00
|
|
|
f, err = FromString("application/custom+sfx")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(err, qt.IsNil)
|
2023-01-04 12:24:36 -05:00
|
|
|
c.Assert(f, qt.Equals, Type{Type: "application/custom+sfx", MainType: "application", SubType: "custom", mimeSuffix: "sfx"})
|
2017-04-03 16:39:37 -04:00
|
|
|
|
2023-01-16 05:05:28 -05:00
|
|
|
_, err = FromString("noslash")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(err, qt.Not(qt.IsNil))
|
2017-04-03 16:39:37 -04:00
|
|
|
|
2023-01-16 05:05:28 -05:00
|
|
|
f, err = FromString("text/xml; charset=utf-8")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(err, qt.IsNil)
|
2021-03-11 03:18:01 -05:00
|
|
|
|
2023-01-04 12:24:36 -05:00
|
|
|
c.Assert(f, qt.Equals, Type{Type: "text/xml", MainType: "text", SubType: "xml", mimeSuffix: ""})
|
2021-03-11 03:18:01 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
func TestFromStringAndExt(t *testing.T) {
|
|
|
|
c := qt.New(t)
|
|
|
|
f, err := FromStringAndExt("text/html", "html")
|
|
|
|
c.Assert(err, qt.IsNil)
|
2023-01-04 12:24:36 -05:00
|
|
|
c.Assert(f, qt.Equals, Builtin.HTMLType)
|
2021-03-11 03:18:01 -05:00
|
|
|
f, err = FromStringAndExt("text/html", ".html")
|
|
|
|
c.Assert(err, qt.IsNil)
|
2023-01-04 12:24:36 -05:00
|
|
|
c.Assert(f, qt.Equals, Builtin.HTMLType)
|
2018-07-10 05:55:22 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
// Add a test for the SVG case
|
|
|
|
// https://github.com/gohugoio/hugo/issues/4920
|
|
|
|
func TestFromExtensionMultipleSuffixes(t *testing.T) {
|
2019-08-10 15:05:17 -04:00
|
|
|
c := qt.New(t)
|
2021-03-11 03:18:01 -05:00
|
|
|
tp, si, found := DefaultTypes.GetBySuffix("svg")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(found, qt.Equals, true)
|
|
|
|
c.Assert(tp.String(), qt.Equals, "image/svg+xml")
|
2021-03-11 03:18:01 -05:00
|
|
|
c.Assert(si.Suffix, qt.Equals, "svg")
|
|
|
|
c.Assert(si.FullSuffix, qt.Equals, ".svg")
|
|
|
|
c.Assert(tp.FirstSuffix.Suffix, qt.Equals, si.Suffix)
|
|
|
|
c.Assert(tp.FirstSuffix.FullSuffix, qt.Equals, si.FullSuffix)
|
|
|
|
ftp, found := DefaultTypes.GetByType("image/svg+xml")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(found, qt.Equals, true)
|
2021-03-11 03:18:01 -05:00
|
|
|
c.Assert(ftp.String(), qt.Equals, "image/svg+xml")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(found, qt.Equals, true)
|
2017-04-03 16:39:37 -04:00
|
|
|
}
|
|
|
|
|
2021-12-16 09:12:13 -05:00
|
|
|
func TestFromContent(t *testing.T) {
|
|
|
|
c := qt.New(t)
|
|
|
|
|
|
|
|
files, err := filepath.Glob("./testdata/resource.*")
|
|
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
|
|
|
|
for _, filename := range files {
|
2021-12-21 03:39:05 -05:00
|
|
|
name := filepath.Base(filename)
|
|
|
|
c.Run(name, func(c *qt.C) {
|
2023-02-18 17:43:26 -05:00
|
|
|
content, err := os.ReadFile(filename)
|
2021-12-16 09:12:13 -05:00
|
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ext := strings.TrimPrefix(paths.Ext(filename), ".")
|
2021-12-21 04:35:33 -05:00
|
|
|
var exts []string
|
|
|
|
if ext == "jpg" {
|
|
|
|
exts = append(exts, "foo", "bar", "jpg")
|
|
|
|
} else {
|
|
|
|
exts = []string{ext}
|
|
|
|
}
|
2023-01-04 12:24:36 -05:00
|
|
|
expected, _, found := DefaultTypes.GetFirstBySuffix(ext)
|
2021-12-16 09:12:13 -05:00
|
|
|
c.Assert(found, qt.IsTrue)
|
2023-01-04 12:24:36 -05:00
|
|
|
got := FromContent(DefaultTypes, exts, content)
|
2021-12-16 09:12:13 -05:00
|
|
|
c.Assert(got, qt.Equals, expected)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-12-21 04:35:33 -05:00
|
|
|
func TestFromContentFakes(t *testing.T) {
|
|
|
|
c := qt.New(t)
|
|
|
|
|
|
|
|
files, err := filepath.Glob("./testdata/fake.*")
|
|
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
|
|
|
|
for _, filename := range files {
|
|
|
|
name := filepath.Base(filename)
|
|
|
|
c.Run(name, func(c *qt.C) {
|
2023-02-18 17:43:26 -05:00
|
|
|
content, err := os.ReadFile(filename)
|
2021-12-21 04:35:33 -05:00
|
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ext := strings.TrimPrefix(paths.Ext(filename), ".")
|
2023-01-04 12:24:36 -05:00
|
|
|
got := FromContent(DefaultTypes, []string{ext}, content)
|
2021-12-21 04:35:33 -05:00
|
|
|
c.Assert(got, qt.Equals, zero)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-03-11 03:18:01 -05:00
|
|
|
func TestToJSON(t *testing.T) {
|
|
|
|
c := qt.New(t)
|
2023-01-04 12:24:36 -05:00
|
|
|
b, err := json.Marshal(Builtin.MPEGType)
|
2021-03-11 03:18:01 -05:00
|
|
|
c.Assert(err, qt.IsNil)
|
2023-01-04 12:24:36 -05:00
|
|
|
c.Assert(string(b), qt.Equals, `{"mainType":"video","subType":"mpeg","delimiter":".","type":"video/mpeg","string":"video/mpeg","suffixes":["mpg","mpeg"]}`)
|
2021-03-11 03:18:01 -05:00
|
|
|
}
|
|
|
|
|
2021-03-11 04:07:56 -05:00
|
|
|
func BenchmarkTypeOps(b *testing.B) {
|
2023-01-04 12:24:36 -05:00
|
|
|
mt := Builtin.MPEGType
|
2021-03-11 04:07:56 -05:00
|
|
|
mts := DefaultTypes
|
|
|
|
for i := 0; i < b.N; i++ {
|
2021-03-11 03:18:01 -05:00
|
|
|
ff := mt.FirstSuffix
|
|
|
|
_ = ff.FullSuffix
|
2021-03-11 04:07:56 -05:00
|
|
|
_ = mt.IsZero()
|
|
|
|
c, err := mt.MarshalJSON()
|
|
|
|
if c == nil || err != nil {
|
|
|
|
b.Fatal("failed")
|
|
|
|
}
|
|
|
|
_ = mt.String()
|
2021-03-11 03:18:01 -05:00
|
|
|
_ = ff.Suffix
|
2021-03-11 04:07:56 -05:00
|
|
|
_ = mt.Suffixes
|
2023-01-04 12:24:36 -05:00
|
|
|
_ = mt.Type
|
2021-03-11 04:07:56 -05:00
|
|
|
_ = mts.BySuffix("xml")
|
|
|
|
_, _ = mts.GetByMainSubType("application", "xml")
|
2021-03-11 03:18:01 -05:00
|
|
|
_, _, _ = mts.GetBySuffix("xml")
|
2021-03-11 04:07:56 -05:00
|
|
|
_, _ = mts.GetByType("application")
|
2021-03-11 03:18:01 -05:00
|
|
|
_, _, _ = mts.GetFirstBySuffix("xml")
|
2021-03-11 04:07:56 -05:00
|
|
|
|
|
|
|
}
|
|
|
|
}
|