mycorrhiza/tree/tree.go

package tree

import (
	"fmt"
	"path"
	"sort"
	"strings"

	"github.com/bouncepaw/mycorrhiza/util"
)

// If Name == "", the tree is empty.
type tree struct {
	name          string
	exists        bool
	prevSibling   string
	nextSibling   string
	siblings      []string
	descendants   []*tree
	root          bool
	hyphaIterator func(func(string))
}

// Tree generates a tree for `hyphaName` as html and returns next and previous hyphae if any.
func Tree(hyphaName string, hyphaIterator func(func(string))) (html, prev, next string) {
	t := &tree{name: hyphaName, root: true, hyphaIterator: hyphaIterator}
	t.fill()
	return t.asHtml(), util.BeautifulName(t.prevSibling), util.BeautifulName(t.nextSibling)
}

// subtree adds a descendant tree to `t` and returns that tree.
func (t *tree) fork(descendantName string) *tree {
	subt := &tree{
		name:          descendantName,
		root:          false,
		hyphaIterator: t.hyphaIterator,
	}
	t.descendants = append(t.descendants, subt)
	return subt
}

// Compare current prev next hyphae and decide if any of them should be set to `name2`.
func (t *tree) prevNextDetermine(name2 string) {
	if name2 < t.name && (name2 > t.prevSibling || t.prevSibling == "") {
		t.prevSibling = name2
	} else if name2 > t.name && (name2 < t.nextSibling || t.nextSibling == "") {
		t.nextSibling = name2
	}
}

// Compares names and does something with them, may generate a subtree.
func (t *tree) compareNamesAndAppend(name2 string) {
	switch {
	case t.name == name2:
		t.exists = true
	case t.root && path.Dir(t.name) == path.Dir(name2):
		t.prevNextDetermine(name2)
		t.siblings = append(t.siblings, name2)
	case t.name == path.Dir(name2):
		t.fork(name2).fill()
	}
}

// Fills t.siblings and t.descendants, sorts them and does the same to the descendants.
func (t *tree) fill() {
	t.hyphaIterator(func(hyphaName string) {
		t.compareNamesAndAppend(hyphaName)
	})
	sort.Strings(t.siblings)
	sort.Slice(t.descendants, func(i, j int) bool {
		return t.descendants[i].name < t.descendants[j].name
	})
}

// asHtml returns HTML representation of a tree.
// It applies itself recursively on the tree's children.
func (t *tree) asHtml() (html string) {
	if t.root {
		html += navitreeEntry(t.name, "navitree__pagename")
	} else {
		html += navitreeEntry(t.name, "navitree__name")
	}

	for _, subtree := range t.descendants {
		html += subtree.asHtml()
	}

	if t.root {
		for _, siblingName := range t.siblings {
			html += navitreeEntry(siblingName, "navitree__sibling")
		}
	}

	return `<ul class="navitree__node">` + html + `</ul>`
}

// Strip hypha name from all ancestor names, replace _ with spaces, title case
func beautifulName(uglyName string) string {
	return strings.Title(strings.ReplaceAll(path.Base(uglyName), "_", " "))
}

// navitreeEntry is a small utility function that makes generating html easier.
func navitreeEntry(name, class string) string {
	return fmt.Sprintf(`<li class="navitree__entry %s">
	<a class="navitree__link" href="/page/%s">%s</a>
</li>
`, class, name, beautifulName(name))
}