diff options
| author | Bjørn Erik Pedersen <[email protected]> | 2016-06-04 13:45:56 +0200 |
|---|---|---|
| committer | Steve Francia <[email protected]> | 2016-06-04 21:55:56 -0400 |
| commit | a7f51703c4b3acdea7539bde6caed450183db18d (patch) | |
| tree | cc1ee68c41bc2c0c9dc0e4c48c65f1bc2d8da7e6 /transform | |
| parent | 80ebe0578a1b5cbdcb837be4afc5c58aedb8a20a (diff) | |
| download | hugo-a7f51703c4b3acdea7539bde6caed450183db18d.tar.gz hugo-a7f51703c4b3acdea7539bde6caed450183db18d.zip | |
Add Hugo generator tag to home page if not present
Fixes #2182
Diffstat (limited to 'transform')
| -rw-r--r-- | transform/hugogeneratorinject.go | 44 | ||||
| -rw-r--r-- | transform/hugogeneratorinject_test.go | 60 |
2 files changed, 104 insertions, 0 deletions
diff --git a/transform/hugogeneratorinject.go b/transform/hugogeneratorinject.go new file mode 100644 index 000000000..fe82a2eaf --- /dev/null +++ b/transform/hugogeneratorinject.go @@ -0,0 +1,44 @@ +// Copyright 2016 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. +// 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 transform + +import ( + "bytes" + "fmt" + "regexp" + + "github.com/spf13/hugo/helpers" +) + +var metaTagsCheck = regexp.MustCompile(`(?i)<meta\s+name=['|"]?generator['|"]?`) +var hugoGeneratorTag = fmt.Sprintf(`<meta name="generator" content="Hugo %s" />`, helpers.HugoVersion()) + +func HugoGeneratorInject(ct contentTransformer) { + if metaTagsCheck.Match(ct.Content()) { + ct.Write(ct.Content()) + return + } + + head := "<head>" + replace := []byte(fmt.Sprintf("%s\n\t%s", head, hugoGeneratorTag)) + newcontent := bytes.Replace(ct.Content(), []byte(head), replace, 1) + + if len(newcontent) == len(ct.Content()) { + head := "<HEAD>" + replace := []byte(fmt.Sprintf("%s\n\t%s", head, hugoGeneratorTag)) + newcontent = bytes.Replace(ct.Content(), []byte(head), replace, 1) + } + + ct.Write(newcontent) +} diff --git a/transform/hugogeneratorinject_test.go b/transform/hugogeneratorinject_test.go new file mode 100644 index 000000000..3f8b26de7 --- /dev/null +++ b/transform/hugogeneratorinject_test.go @@ -0,0 +1,60 @@ +// Copyright 2016 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. +// 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 transform + +import ( + "bytes" + "testing" + + "github.com/spf13/hugo/helpers" +) + +func TestHugoGeneratorInject(t *testing.T) { + hugoGeneratorTag = "META" + for i, this := range []struct { + in string + expect string + }{ + {`<head> + <foo /> +</head>`, `<head> + META + <foo /> +</head>`}, + {`<HEAD> + <foo /> +</HEAD>`, `<HEAD> + META + <foo /> +</HEAD>`}, + {`<head><meta name="generator" content="Jekyll" /></head>`, `<head><meta name="generator" content="Jekyll" /></head>`}, + {`<head><meta name='generator' content='Jekyll' /></head>`, `<head><meta name='generator' content='Jekyll' /></head>`}, + {`<head><meta name=generator content=Jekyll /></head>`, `<head><meta name=generator content=Jekyll /></head>`}, + {`<head><META NAME="GENERATOR" content="Jekyll" /></head>`, `<head><META NAME="GENERATOR" content="Jekyll" /></head>`}, + {"", ""}, + {"</head>", "</head>"}, + {"<head>", "<head>\n\tMETA"}, + } { + in := helpers.StringToReader(this.in) + out := new(bytes.Buffer) + + tr := NewChain(HugoGeneratorInject) + tr.Apply(out, in, []byte("")) + + if out.String() != this.expect { + t.Errorf("[%d] Expected \n%q got \n%q", i, this.expect, out.String()) + } + } + +} |