2019-01-02 06:33:26 -05:00
|
|
|
// Copyright 2019 The Hugo Authors. All rights reserved.
|
2017-03-13 18:55:02 -04: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 collections
|
|
|
|
|
|
|
|
import (
|
2022-02-17 10:51:19 -05:00
|
|
|
"context"
|
2020-12-02 07:23:25 -05:00
|
|
|
"fmt"
|
2019-12-10 13:56:44 -05:00
|
|
|
"io"
|
|
|
|
"reflect"
|
2017-03-13 18:55:02 -04:00
|
|
|
"testing"
|
|
|
|
|
2019-08-10 15:05:17 -04:00
|
|
|
qt "github.com/frankban/quicktest"
|
2023-01-04 12:24:36 -05:00
|
|
|
"github.com/gohugoio/hugo/config/testconfig"
|
2020-01-15 09:59:56 -05:00
|
|
|
"github.com/gohugoio/hugo/output"
|
2023-01-04 12:24:36 -05:00
|
|
|
"github.com/gohugoio/hugo/output/layouts"
|
2017-06-13 12:42:45 -04:00
|
|
|
"github.com/gohugoio/hugo/tpl"
|
2017-03-13 18:55:02 -04:00
|
|
|
)
|
|
|
|
|
2017-04-30 15:52:56 -04:00
|
|
|
type templateFinder int
|
2017-03-13 18:55:02 -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 (templateFinder) Lookup(name string) (tpl.Template, bool) {
|
|
|
|
return nil, false
|
2017-04-30 15:52:56 -04:00
|
|
|
}
|
2017-03-13 18:55:02 -04:00
|
|
|
|
2020-01-15 09:59:56 -05:00
|
|
|
func (templateFinder) HasTemplate(name string) bool {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
2019-01-02 06:33:26 -05:00
|
|
|
func (templateFinder) LookupVariant(name string, variants tpl.TemplateVariants) (tpl.Template, bool, bool) {
|
|
|
|
return nil, false, false
|
|
|
|
}
|
|
|
|
|
2020-07-03 12:02:32 -04:00
|
|
|
func (templateFinder) LookupVariants(name string) []tpl.Template {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2023-01-04 12:24:36 -05:00
|
|
|
func (templateFinder) LookupLayout(d layouts.LayoutDescriptor, f output.Format) (tpl.Template, bool, error) {
|
2020-01-15 09:59:56 -05:00
|
|
|
return nil, false, nil
|
|
|
|
}
|
|
|
|
|
2022-03-17 17:03:27 -04:00
|
|
|
func (templateFinder) Execute(t tpl.Template, wr io.Writer, data any) error {
|
2019-12-10 13:56:44 -05:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2022-03-17 17:03:27 -04:00
|
|
|
func (templateFinder) ExecuteWithContext(ctx context.Context, t tpl.Template, wr io.Writer, data any) error {
|
2022-02-17 10:51:19 -05:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2019-12-10 13:56:44 -05:00
|
|
|
func (templateFinder) GetFunc(name string) (reflect.Value, bool) {
|
|
|
|
if name == "dobedobedo" {
|
|
|
|
return reflect.Value{}, false
|
2017-04-30 15:52:56 -04:00
|
|
|
}
|
2019-12-10 13:56:44 -05:00
|
|
|
|
|
|
|
return reflect.ValueOf(fmt.Sprint), true
|
2017-04-30 15:52:56 -04:00
|
|
|
}
|
2017-03-13 18:55:02 -04:00
|
|
|
|
2017-04-30 15:52:56 -04:00
|
|
|
func TestApply(t *testing.T) {
|
|
|
|
t.Parallel()
|
2019-08-10 15:05:17 -04:00
|
|
|
c := qt.New(t)
|
2023-01-04 12:24:36 -05:00
|
|
|
d := testconfig.GetTestDeps(nil, nil)
|
|
|
|
d.SetTempl(&tpl.TemplateHandlers{
|
|
|
|
Tmpl: new(templateFinder),
|
|
|
|
})
|
2020-01-15 09:59:56 -05:00
|
|
|
ns := New(d)
|
2017-03-13 18:55:02 -04:00
|
|
|
|
2022-03-17 17:03:27 -04:00
|
|
|
strings := []any{"a\n", "b\n"}
|
2017-03-13 18:55:02 -04:00
|
|
|
|
2022-03-01 05:30:11 -05:00
|
|
|
ctx := context.Background()
|
|
|
|
|
|
|
|
result, err := ns.Apply(ctx, strings, "print", "a", "b", "c")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(err, qt.IsNil)
|
2022-03-17 17:03:27 -04:00
|
|
|
c.Assert(result, qt.DeepEquals, []any{"abc", "abc"})
|
2017-03-13 18:55:02 -04:00
|
|
|
|
2022-03-01 05:30:11 -05:00
|
|
|
_, err = ns.Apply(ctx, strings, "apply", ".")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(err, qt.Not(qt.IsNil))
|
2017-03-13 18:55:02 -04:00
|
|
|
|
|
|
|
var nilErr *error
|
2022-03-01 05:30:11 -05:00
|
|
|
_, err = ns.Apply(ctx, nilErr, "chomp", ".")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(err, qt.Not(qt.IsNil))
|
2017-03-13 18:55:02 -04:00
|
|
|
|
2022-03-01 05:30:11 -05:00
|
|
|
_, err = ns.Apply(ctx, strings, "dobedobedo", ".")
|
2019-08-10 15:05:17 -04:00
|
|
|
c.Assert(err, qt.Not(qt.IsNil))
|
2017-03-13 18:55:02 -04:00
|
|
|
|
2022-03-01 05:30:11 -05:00
|
|
|
_, err = ns.Apply(ctx, strings, "foo.Chomp", "c\n")
|
2017-03-13 18:55:02 -04:00
|
|
|
if err == nil {
|
2017-04-30 15:52:56 -04:00
|
|
|
t.Errorf("apply with unknown func should fail")
|
2017-03-13 18:55:02 -04:00
|
|
|
}
|
|
|
|
}
|