ref: 05c8bccf84624d3905258c32c8f258bc9eb315c5
dir: /hugolib/taxonomy.go/
// Copyright 2015 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 hugolib
import (
"sort"
"github.com/spf13/hugo/helpers"
)
/*
* An taxonomy list is a list of all taxonomies and their values
* EG. List['tags'] => TagTaxonomy (from above)
*/
type TaxonomyList map[string]Taxonomy
/*
* An taxonomy is a map of keywords to a list of pages.
* For example
* TagTaxonomy['technology'] = WeightedPages
* TagTaxonomy['go'] = WeightedPages2
*/
type Taxonomy map[string]WeightedPages
/*
* A list of Pages with their corresponding (and relative) weight
* [{Weight: 30, Page: *1}, {Weight: 40, Page: *2}]
*/
type WeightedPages []WeightedPage
type WeightedPage struct {
Weight int
Page *Page
}
/*
* This is another representation of an Taxonomy using an array rather than a map.
* Important because you can't order a map.
*/
type OrderedTaxonomy []OrderedTaxonomyEntry
/*
* Similar to an element of an Taxonomy, but with the key embedded (as name)
* Eg: {Name: Technology, WeightedPages: Taxonomyedpages}
*/
type OrderedTaxonomyEntry struct {
Name string
WeightedPages WeightedPages
}
// KeyPrep... Taxonomies should be case insensitive. Can make it easily conditional later.
func kp(in string) string {
return helpers.MakePathSanitized(in)
}
func (i Taxonomy) Get(key string) WeightedPages { return i[kp(key)] }
func (i Taxonomy) Count(key string) int { return len(i[kp(key)]) }
func (i Taxonomy) Add(key string, w WeightedPage, pretty bool) {
if !pretty {
key = kp(key)
}
i[key] = append(i[key], w)
}
// Returns an ordered taxonomy with a non defined order
func (i Taxonomy) TaxonomyArray() OrderedTaxonomy {
ies := make([]OrderedTaxonomyEntry, len(i))
count := 0
for k, v := range i {
ies[count] = OrderedTaxonomyEntry{Name: k, WeightedPages: v}
count++
}
return ies
}
// Returns an ordered taxonomy sorted by key name
func (i Taxonomy) Alphabetical() OrderedTaxonomy {
name := func(i1, i2 *OrderedTaxonomyEntry) bool {
return i1.Name < i2.Name
}
ia := i.TaxonomyArray()
OIby(name).Sort(ia)
return ia
}
// Returns an ordered taxonomy sorted by # of pages per key
func (i Taxonomy) ByCount() OrderedTaxonomy {
count := func(i1, i2 *OrderedTaxonomyEntry) bool {
return len(i1.WeightedPages) > len(i2.WeightedPages)
}
ia := i.TaxonomyArray()
OIby(count).Sort(ia)
return ia
}
// Helper to move the page access up a level
func (ie OrderedTaxonomyEntry) Pages() Pages {
return ie.WeightedPages.Pages()
}
func (ie OrderedTaxonomyEntry) Count() int {
return len(ie.WeightedPages)
}
func (ie OrderedTaxonomyEntry) Term() string {
return ie.Name
}
func (t OrderedTaxonomy) Reverse() OrderedTaxonomy {
for i, j := 0, len(t)-1; i < j; i, j = i+1, j-1 {
t[i], t[j] = t[j], t[i]
}
return t
}
/*
* Implementation of a custom sorter for OrderedTaxonomies
*/
// A type to implement the sort interface for TaxonomyEntries.
type orderedTaxonomySorter struct {
taxonomy OrderedTaxonomy
by OIby
}
// Closure used in the Sort.Less method.
type OIby func(i1, i2 *OrderedTaxonomyEntry) bool
func (by OIby) Sort(taxonomy OrderedTaxonomy) {
ps := &orderedTaxonomySorter{
taxonomy: taxonomy,
by: by, // The Sort method's receiver is the function (closure) that defines the sort order.
}
sort.Stable(ps)
}
// Len is part of sort.Interface.
func (s *orderedTaxonomySorter) Len() int {
return len(s.taxonomy)
}
// Swap is part of sort.Interface.
func (s *orderedTaxonomySorter) Swap(i, j int) {
s.taxonomy[i], s.taxonomy[j] = s.taxonomy[j], s.taxonomy[i]
}
// Less is part of sort.Interface. It is implemented by calling the "by" closure in the sorter.
func (s *orderedTaxonomySorter) Less(i, j int) bool {
return s.by(&s.taxonomy[i], &s.taxonomy[j])
}
func (wp WeightedPages) Pages() Pages {
pages := make(Pages, len(wp))
for i := range wp {
pages[i] = wp[i].Page
}
return pages
}
func (wp WeightedPages) Prev(cur *Page) *Page {
for x, c := range wp {
if c.Page.UniqueID() == cur.UniqueID() {
if x == 0 {
return wp[len(wp)-1].Page
}
return wp[x-1].Page
}
}
return nil
}
func (wp WeightedPages) Next(cur *Page) *Page {
for x, c := range wp {
if c.Page.UniqueID() == cur.UniqueID() {
if x < len(wp)-1 {
return wp[x+1].Page
}
return wp[0].Page
}
}
return nil
}
func (wp WeightedPages) Len() int { return len(wp) }
func (wp WeightedPages) Swap(i, j int) { wp[i], wp[j] = wp[j], wp[i] }
func (wp WeightedPages) Sort() { sort.Stable(wp) }
func (wp WeightedPages) Count() int { return len(wp) }
func (wp WeightedPages) Less(i, j int) bool {
if wp[i].Weight == wp[j].Weight {
if wp[i].Page.Date.Equal(wp[j].Page.Date) {
return wp[i].Page.Title < wp[j].Page.Title
}
return wp[i].Page.Date.After(wp[i].Page.Date)
}
return wp[i].Weight < wp[j].Weight
}
// TODO mimic PagesSorter for WeightedPages