@bookshop/hugo-engine 3.3.2 → 3.4.0-alpha.2

package/hugo-renderer/build.sh

@@ -1,66 +0,0 @@
-#!/bin/bash
-
-TMPFILENAME="hugo_renderer_$(date +%s).wasm"
-OUTPUTFILENAME="hugo_renderer.wasm"
-
-# Clean
-rm -f $OUTPUTFILENAME
-if [ -f $OUTPUTFILENAME ]; then
-    echo "ERROR: previous $OUTPUTFILENAME still in directory"
-    exit 1
-fi
-
-# Build temp module (For Windows use `$Env:GOOS = "js"; $Env:GOARCH = "wasm"` )
-GOOS=js GOARCH=wasm go build -tags nodeploy -o $TMPFILENAME
-printf "Built Hugo WASM via $TMPFILENAME : "
-ls -lh $TMPFILENAME | awk '{print $5}'
-
-# Link repo module
-mv $TMPFILENAME $OUTPUTFILENAME
-if [ ! -f $OUTPUTFILENAME ]; then
-    echo "ERROR: hugo_renderer.wasm not complete"
-    exit 1
-fi
-echo "Done. Repo Hugo WASM available at hugo_renderer.wasm"
-
-gzip --keep $OUTPUTFILENAME
-echo "Repo Hugo WASM also available at hugo_renderer.wasm.gz"
-
-# If we're just in a test run we don't want to touch the CDN repo
-if [[ -z "${PUBLISH_BOOKSHOP_CDN}" ]]; then
-    echo "Not publishing to CDN."
-    exit 0
-fi
-
-if [[ -z "${BOOKSHOP_VERSION}" ]]; then
-    echo "ERROR: BOOKSHOP_VERSION environment variable does not exist"
-    exit 1
-fi
-
-CDNFILENAME="../../../../../bookshopcdn/hugo/hugo_renderer_$BOOKSHOP_VERSION.wasm"
-
-# Check CDN
-if [ ! -d ../../../../../bookshopcdn/hugo ]; then
-    echo "ERROR: bookshopcdn repo does not exist alongside bookshop repo"
-    exit 1
-fi
-
-# Link CDN module
-cp $OUTPUTFILENAME $CDNFILENAME
-if [ ! -f $CDNFILENAME ]; then
-    echo "ERROR: $CDNFILENAME not complete"
-    exit 1
-fi
-echo "Done. CDN Hugo WASM available at $CDNFILENAME"
-
-gzip -k $CDNFILENAME
-echo "Done. Compressed CDN Hugo WASM available at $CDNFILENAME.gz"
-
-cd ../../../../../bookshopcdn
-
-git add -A \
-&& git commit -m "build: releasing $BOOKSHOP_VERSION" \
-&& git tag -a v$BOOKSHOP_VERSION -m "build: releasing $BOOKSHOP_VERSION" \
-&& git push --tags && git push
-
-exit 0

package/hugo-renderer/deps/bookshop_modified_deps.go

@@ -1,6 +0,0 @@
-package deps
-
-// Deps is a stripped back version of Hugo's deps
-// supporting anything needed for the common supported functions.
-type Deps struct {
-}

package/hugo-renderer/go.mod

@@ -1,19 +0,0 @@
-module hugo-renderer
-
-go 1.17
-
-require (
-	github.com/gohugoio/hugo v0.89.4
-	github.com/mitchellh/hashstructure v1.1.0
-	github.com/pkg/errors v0.9.1
-	github.com/spf13/cast v1.4.1
-)
-
-require (
-	github.com/gobuffalo/flect v0.2.4
-	github.com/gomarkdown/markdown v0.0.0-20220114203417-14399d5448c4
-	github.com/kyokomi/emoji/v2 v2.2.8
-	github.com/sanity-io/litter v1.5.1
-)
-
-require github.com/gobwas/glob v0.2.3 // indirect

package/hugo-renderer/helpers/bookshop_modified_content.go

@@ -1,98 +0,0 @@
-// Copyright 2019 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 helpers implements general utility functions that work with
-// and on content.  The helper functions defined here lay down the
-// foundation of how Hugo works with files and filepaths, and perform
-// string operations on content.
-package helpers
-
-import (
-	"bytes"
-	"html/template"
-	"strings"
-	"unicode"
-
-	bp "github.com/gohugoio/hugo/bufferpool"
-)
-
-var (
-	openingPTag        = []byte("<p>")
-	closingPTag        = []byte("</p>")
-	paragraphIndicator = []byte("<p")
-	closingIndicator   = []byte("</")
-)
-
-var stripHTMLReplacer = strings.NewReplacer("\n", " ", "</p>", "\n", "<br>", "\n", "<br />", "\n")
-
-// StripHTML accepts a string, strips out all HTML tags and returns it.
-func StripHTML(s string) string {
-	// Shortcut strings with no tags in them
-	if !strings.ContainsAny(s, "<>") {
-		return s
-	}
-	s = stripHTMLReplacer.Replace(s)
-
-	// Walk through the string removing all tags
-	b := bp.GetBuffer()
-	defer bp.PutBuffer(b)
-	var inTag, isSpace, wasSpace bool
-	for _, r := range s {
-		if !inTag {
-			isSpace = false
-		}
-
-		switch {
-		case r == '<':
-			inTag = true
-		case r == '>':
-			inTag = false
-		case unicode.IsSpace(r):
-			isSpace = true
-			fallthrough
-		default:
-			if !inTag && (!isSpace || (isSpace && !wasSpace)) {
-				b.WriteRune(r)
-			}
-		}
-
-		wasSpace = isSpace
-
-	}
-	return b.String()
-}
-
-// BytesToHTML converts bytes to type template.HTML.
-func BytesToHTML(b []byte) template.HTML {
-	return template.HTML(string(b))
-}
-
-// TrimShortHTML removes the <p>/</p> tags from HTML input in the situation
-// where said tags are the only <p> tags in the input and enclose the content
-// of the input (whitespace excluded).
-// Bookshop: Changed this to _not_ be a method of *ContentSpec
-func TrimShortHTML(input []byte) []byte {
-	firstOpeningP := bytes.Index(input, paragraphIndicator)
-	lastOpeningP := bytes.LastIndex(input, paragraphIndicator)
-
-	lastClosingP := bytes.LastIndex(input, closingPTag)
-	lastClosing := bytes.LastIndex(input, closingIndicator)
-
-	if firstOpeningP == lastOpeningP && lastClosingP == lastClosing {
-		input = bytes.TrimSpace(input)
-		input = bytes.TrimPrefix(input, openingPTag)
-		input = bytes.TrimSuffix(input, closingPTag)
-		input = bytes.TrimSpace(input)
-	}
-	return input
-}

package/hugo-renderer/helpers/bookshop_modified_general.go

@@ -1,33 +0,0 @@
-// Copyright 2019 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 helpers
-
-import (
-	"unicode"
-	"unicode/utf8"
-)
-
-// FirstUpper returns a string with the first character as upper case.
-func FirstUpper(s string) string {
-	if s == "" {
-		return ""
-	}
-	r, n := utf8.DecodeRuneInString(s)
-	return string(unicode.ToUpper(r)) + s[n:]
-}
-
-// IsWhitespace determines if the given rune is whitespace.
-func IsWhitespace(r rune) bool {
-	return r == ' ' || r == '\t' || r == '\n' || r == '\r'
-}

package/hugo-renderer/helpers/emoji.go

@@ -1,96 +0,0 @@
-// 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 helpers
-
-import (
-	"bytes"
-	"sync"
-
-	"github.com/kyokomi/emoji/v2"
-)
-
-var (
-	emojiInit sync.Once
-
-	emojis = make(map[string][]byte)
-
-	emojiDelim     = []byte(":")
-	emojiWordDelim = []byte(" ")
-	emojiMaxSize   int
-)
-
-// Emoji returns the emojy given a key, e.g. ":smile:", nil if not found.
-func Emoji(key string) []byte {
-	emojiInit.Do(initEmoji)
-	return emojis[key]
-}
-
-// Emojify "emojifies" the input source.
-// Note that the input byte slice will be modified if needed.
-// See http://www.emoji-cheat-sheet.com/
-func Emojify(source []byte) []byte {
-	emojiInit.Do(initEmoji)
-
-	start := 0
-	k := bytes.Index(source[start:], emojiDelim)
-
-	for k != -1 {
-
-		j := start + k
-
-		upper := j + emojiMaxSize
-
-		if upper > len(source) {
-			upper = len(source)
-		}
-
-		endEmoji := bytes.Index(source[j+1:upper], emojiDelim)
-		nextWordDelim := bytes.Index(source[j:upper], emojiWordDelim)
-
-		if endEmoji < 0 {
-			start++
-		} else if endEmoji == 0 || (nextWordDelim != -1 && nextWordDelim < endEmoji) {
-			start += endEmoji + 1
-		} else {
-			endKey := endEmoji + j + 2
-			emojiKey := source[j:endKey]
-
-			if emoji, ok := emojis[string(emojiKey)]; ok {
-				source = append(source[:j], append(emoji, source[endKey:]...)...)
-			}
-
-			start += endEmoji
-		}
-
-		if start >= len(source) {
-			break
-		}
-
-		k = bytes.Index(source[start:], emojiDelim)
-	}
-
-	return source
-}
-
-func initEmoji() {
-	emojiMap := emoji.CodeMap()
-
-	for k, v := range emojiMap {
-		emojis[k] = []byte(v)
-
-		if len(k) > emojiMaxSize {
-			emojiMaxSize = len(k)
-		}
-	}
-}

package/hugo-renderer/main.go

@@ -1,42 +0,0 @@
-package main
-
-import (
-	"syscall/js"
-
-	engine "hugo-renderer/tpl/bookshop_engine"
-	library "hugo-renderer/tpl/bookshop_library"
-)
-
-func main() {
-	c := make(chan struct{}, 0)
-	js.Global().Set("renderHugo", js.FuncOf(renderHugo))
-	js.Global().Set("loadHugoBookshopPartials", js.FuncOf(loadHugoBookshopPartials))
-	js.Global().Set("loadHugoBookshopData", js.FuncOf(loadHugoBookshopData))
-	js.Global().Set("loadHugoBookshopMeta", js.FuncOf(loadHugoBookshopMeta))
-	<-c
-}
-
-func renderHugo(this js.Value, args []js.Value) interface{} {
-	templateString := args[0].String()
-	propsString := args[1].String()
-
-	return engine.RenderHugo(templateString, propsString)
-}
-
-func loadHugoBookshopPartials(this js.Value, args []js.Value) interface{} {
-	bookshopPartials := args[0].String()
-
-	return library.LoadHugoBookshopPartials(bookshopPartials)
-}
-
-func loadHugoBookshopData(this js.Value, args []js.Value) interface{} {
-	bookshopData := args[0].String()
-
-	return library.LoadHugoBookshopData(bookshopData)
-}
-
-func loadHugoBookshopMeta(this js.Value, args []js.Value) interface{} {
-	bookshopMeta := args[0].String()
-
-	return library.LoadHugoBookshopMeta(bookshopMeta)
-}

package/hugo-renderer/tpl/bookshop_engine/bookshop_func_importer.go

@@ -1,35 +0,0 @@
-package engine
-
-import (
-	_ "hugo-renderer/tpl/cast"
-	_ "hugo-renderer/tpl/collections" // ———————————— 🥴 TODO: `apply` NYI, relies on tpl.TemplateHandler & co. Reimplement based on bookshop_render -> createFuncMap
-	_ "hugo-renderer/tpl/compare"
-	_ "hugo-renderer/tpl/crypto"
-
-	// _ "hugo-renderer/tpl/data" // ———————————————— ⏭️ NTBI: Networking / FS / Resources
-	_ "hugo-renderer/tpl/debug"
-	_ "hugo-renderer/tpl/encoding"
-	_ "hugo-renderer/tpl/fmt"
-
-	// _ "hugo-renderer/tpl/hugo" // ———————————————— ❗ TODO: Should this be stubbed out ??
-	// _ "hugo-renderer/tpl/images" // —————————————— ❗ TODO: Should this be mocked ??
-	_ "hugo-renderer/tpl/inflect"
-	// _ "hugo-renderer/tpl/js" // —————————————————— ⏭️ NTBI: Shouldn't be done inside a component
-	// _ "hugo-renderer/tpl/lang" // ———————————————— ❗ TODO: Not sure how this would interact in the Bookshop environment
-	_ "hugo-renderer/tpl/math"
-	// _ "hugo-renderer/tpl/openapi/openapi3" // ———— ❗ TODO: Maybe a rabbit hole
-	// _ "hugo-renderer/tpl/os" // —————————————————— ⏭️ NTBI: We don't have an OS
-	_ "hugo-renderer/tpl/partials" // ——————————————— ❗ TODO: Return partials / use bookshop module partials
-	_ "hugo-renderer/tpl/path"
-	_ "hugo-renderer/tpl/reflect"
-
-	// _ "hugo-renderer/tpl/resources" // ——————————— ⏭️ NTBI: Bookshop components won't support resources
-	_ "hugo-renderer/tpl/safe"    // ———————————————— 🥴 TODO: `SanitizeURL` NYI — helpers require is too large
-	_ "hugo-renderer/tpl/site"    // ———————————————— 🥴 TODO: Partially stubbing out site variables. WIP
-	_ "hugo-renderer/tpl/strings" // ———————————————— 🥴 TODO: Only the "Go" title formatting is supported
-
-	// _ "hugo-renderer/tpl/templates" // ——————————— ❗ TODO: Maybe a rabbit hole
-	// _ "hugo-renderer/tpl/time" // ———————————————— ❗ TODO: This relies on lang stuff that is thus far excluded
-	_ "hugo-renderer/tpl/transform" // —————————————— 🥴 TODO: Highlight, unmarshal, commonmark compat
-	// _ "hugo-renderer/tpl/urls" // ———————————————— ❗ TODO: Relies on pathspec that relies on FS impls
-)

package/hugo-renderer/tpl/bookshop_engine/bookshop_render.go

@@ -1,64 +0,0 @@
-package engine
-
-import (
-	"bytes"
-	"encoding/json"
-	"fmt"
-	"html/template"
-
-	"hugo-renderer/deps"
-	"hugo-renderer/tpl/internal"
-)
-
-// TODO(bookshop): DRY
-func createFuncMap(d *deps.Deps) map[string]interface{} {
-	funcMap := template.FuncMap{}
-
-	// Merge the namespace funcs
-	for _, nsf := range internal.TemplateFuncsNamespaceRegistry {
-		ns := nsf(d)
-		if _, exists := funcMap[ns.Name]; exists {
-			panic(ns.Name + " is a duplicate template func")
-		}
-		funcMap[ns.Name] = ns.Context
-		for _, mm := range ns.MethodMappings {
-			for _, alias := range mm.Aliases {
-				if _, exists := funcMap[alias]; exists {
-					panic(alias + " is a duplicate template func")
-				}
-				funcMap[alias] = mm.Method
-			}
-		}
-	}
-
-	return funcMap
-}
-
-// RenderHugo takes a component from the browser,
-// as well as a JSON blob of its data,
-// and renders it.
-func RenderHugo(templateString string, props string) interface{} {
-	var parsedProps interface{}
-	err := json.Unmarshal([]byte(props), &parsedProps)
-	if err != nil {
-		buf := bytes.NewBufferString(fmt.Sprintf("BKSHERR: bad json unmarshal: %s", err.Error()))
-		return buf.String()
-	}
-
-	d := deps.Deps{}
-	funcMap := createFuncMap(&d)
-
-	templ, err := template.New("").Funcs(funcMap).Parse(templateString)
-	if err != nil {
-		buf := bytes.NewBufferString(fmt.Sprintf("BKSHERR: bad template parse: %s", err.Error()))
-		return buf.String()
-	}
-
-	buf := bytes.NewBufferString("")
-	err = templ.Execute(buf, parsedProps)
-	if err != nil {
-		buf := bytes.NewBufferString(fmt.Sprintf("BKSHERR: bad template render: %s", err.Error()))
-		return buf.String()
-	}
-	return buf.String()
-}

package/hugo-renderer/tpl/bookshop_library/bookshop_components.go

@@ -1,129 +0,0 @@
-package bookshop_library
-
-import (
-	"bytes"
-	"encoding/json"
-	"fmt"
-	"html/template"
-	"strings"
-
-	"hugo-renderer/deps"
-	"hugo-renderer/tpl/internal"
-)
-
-// TODO(bookshop): DRY
-func createFuncMap(d *deps.Deps) map[string]interface{} {
-	funcMap := template.FuncMap{}
-
-	// Merge the namespace funcs
-	for _, nsf := range internal.TemplateFuncsNamespaceRegistry {
-		ns := nsf(d)
-		if _, exists := funcMap[ns.Name]; exists {
-			panic(ns.Name + " is a duplicate template func")
-		}
-		funcMap[ns.Name] = ns.Context
-		for _, mm := range ns.MethodMappings {
-			for _, alias := range mm.Aliases {
-				if _, exists := funcMap[alias]; exists {
-					panic(alias + " is a duplicate template func")
-				}
-				funcMap[alias] = mm.Method
-			}
-		}
-	}
-
-	return funcMap
-}
-
-type bookshopPartial struct {
-	Contents       string `json:"contents"`
-	ParsedContents *template.Template
-}
-
-var componentLibrary map[string]bookshopPartial
-
-// LoadHugoBookshopPartials takes all files that the
-// @bookshop/hugo-engine was given and stashes them away
-// on this side of the wasm boundary, for the partials
-// function to use.
-func LoadHugoBookshopPartials(partials string) interface{} {
-	err := json.Unmarshal([]byte(partials), &componentLibrary)
-	if err != nil {
-		buf := bytes.NewBufferString(fmt.Sprintf("bad json unmarshal: %s", err.Error()))
-		return buf.String()
-	}
-
-	buf := bytes.NewBufferString(fmt.Sprintf("loaded %d components", len(componentLibrary)))
-	return buf.String()
-}
-
-// RetrieveBookshopPartial looks for a Bookshop file
-// and returns its template in a standard lib go html/template.
-// TODO(bookshop): This should probably one day play
-// nicer with the Hugo templating packages.
-func RetrieveBookshopPartial(bookshop_key string) (*template.Template, bool) {
-	if component, ok := componentLibrary[bookshop_key]; ok {
-		if component.ParsedContents == nil {
-			d := deps.Deps{}
-			funcMap := createFuncMap(&d)
-			templ, err := template.New("").Funcs(funcMap).Parse(component.Contents)
-			if err != nil {
-				return nil, false
-			}
-			component.ParsedContents = templ
-		}
-		return component.ParsedContents, true
-	}
-	return nil, false
-}
-
-func bookshopKey(full_key string) string {
-	split := strings.Split(full_key, "/")
-	base := split[len(split)-1]
-	return fmt.Sprintf("components/%s/%s.hugo.html", full_key, base)
-}
-
-// UnwrapBookshopPartial takes the dict or slice that the {{ partial "bookshop" ... }}
-// was given, and pulls out the component / partial name that should be rendered.
-// TODO(bookshop): Ideally our templating support gets better,
-// and we can call the production bookshop module partials.
-func UnwrapBookshopComponent(context interface{}) (string, interface{}) {
-	if componentData, ok := context.(map[string]interface{}); ok {
-		if component, ok := componentData["_bookshop_name"]; ok {
-			key := bookshopKey(component.(string))
-			return key, context
-		}
-		return "err_no_bookshop_name_key", context
-	}
-	if componentData, ok := context.([]interface{}); ok {
-		if component, ok := componentData[0].(string); ok {
-			key := bookshopKey(component)
-			return key, componentData[1]
-		}
-		return "err_slice_zero_not_string", context
-	}
-	if componentData, ok := context.([]string); ok {
-		key := bookshopKey(componentData[0])
-		return key, componentData[1]
-	}
-	if componentName, ok := context.(string); ok {
-		key := bookshopKey(componentName)
-		return key, nil
-	}
-	return "err_not_map_slice_or_string", context
-}
-
-func UnwrapBookshopPartial(context interface{}) (string, interface{}) {
-	if partialData, ok := context.([]interface{}); ok {
-		if partial, ok := partialData[0].(string); ok {
-			key := fmt.Sprintf("shared/hugo/%s.hugo.html", partial)
-			return key, partialData[1]
-		}
-		return "err_slice_zero_not_string", context
-	}
-	if partialName, ok := context.(string); ok {
-		key := fmt.Sprintf("shared/hugo/%s.hugo.html", partialName)
-		return key, nil
-	}
-	return "err_not_slice_or_string", context
-}

package/hugo-renderer/tpl/bookshop_library/bookshop_data.go

@@ -1,53 +0,0 @@
-package bookshop_library
-
-import (
-	"bytes"
-	"encoding/json"
-	"fmt"
-)
-
-type bookshopData struct {
-	Data map[string]interface{} `json:"data"`
-}
-
-var bookshopDataStorage bookshopData
-
-// loadHugoBookshopData takes any data that the @bookshop/hugo-engine
-// was given from info.json and stashes it all away
-// on this side of the wasm boundary, for the site
-// function to use.
-func LoadHugoBookshopData(data string) interface{} {
-	err := json.Unmarshal([]byte(data), &bookshopDataStorage)
-	if err != nil {
-		buf := bytes.NewBufferString(fmt.Sprintf("bad json unmarshal: %s", err.Error()))
-		return buf.String()
-	}
-
-	buf := bytes.NewBufferString("loaded Bookshop site data")
-	return buf.String()
-}
-
-func RetrieveHugoBookshopData() *bookshopData {
-	return &bookshopDataStorage
-}
-
-var bookshopMetaStorage map[string]interface{}
-
-// loadHugoBookshopMeta takes any data that hugo/bookshop
-// injected into the template and stashes it all away
-// on this side of the wasm boundary, for the site
-// function to use.
-func LoadHugoBookshopMeta(data string) interface{} {
-	err := json.Unmarshal([]byte(data), &bookshopMetaStorage)
-	if err != nil {
-		buf := bytes.NewBufferString(fmt.Sprintf("bad json unmarshal: %s", err.Error()))
-		return buf.String()
-	}
-
-	buf := bytes.NewBufferString("loaded Bookshop site data")
-	return buf.String()
-}
-
-func RetrieveHugoBookshopMeta() map[string]interface{} {
-	return bookshopMetaStorage
-}