* Implementation of a custom sorter for Pages
*/
-// A PageSorter implements the sort interface for Pages
-type PageSorter struct {
+// A pageSorter implements the sort interface for Pages
+type pageSorter struct {
pages Pages
- by PageBy
+ by pageBy
}
-// PageBy is a closure used in the Sort.Less method.
-type PageBy func(p1, p2 *Page) bool
+// pageBy is a closure used in the Sort.Less method.
+type pageBy func(p1, p2 *Page) bool
// Sort stable sorts the pages given the receiver's sort order.
-func (by PageBy) Sort(pages Pages) {
- ps := &PageSorter{
+func (by pageBy) Sort(pages Pages) {
+ ps := &pageSorter{
pages: pages,
by: by, // The Sort method's receiver is the function (closure) that defines the sort order.
}
sort.Stable(ps)
}
-// DefaultPageSort is the default sort for pages in Hugo:
+// defaultPageSort is the default sort for pages in Hugo:
// Order by Weight, Date, LinkTitle and then full file path.
-var DefaultPageSort = func(p1, p2 *Page) bool {
+var defaultPageSort = func(p1, p2 *Page) bool {
if p1.Weight == p2.Weight {
if p1.Date.Unix() == p2.Date.Unix() {
if p1.LinkTitle() == p2.LinkTitle() {
return p1.Weight < p2.Weight
}
-func (ps *PageSorter) Len() int { return len(ps.pages) }
-func (ps *PageSorter) Swap(i, j int) { ps.pages[i], ps.pages[j] = ps.pages[j], ps.pages[i] }
+func (ps *pageSorter) Len() int { return len(ps.pages) }
+func (ps *pageSorter) Swap(i, j int) { ps.pages[i], ps.pages[j] = ps.pages[j], ps.pages[i] }
// Less is part of sort.Interface. It is implemented by calling the "by" closure in the sorter.
-func (ps *PageSorter) Less(i, j int) bool { return ps.by(ps.pages[i], ps.pages[j]) }
+func (ps *pageSorter) Less(i, j int) bool { return ps.by(ps.pages[i], ps.pages[j]) }
// Sort sorts the pages by the default sort order defined:
// Order by Weight, Date, LinkTitle and then full file path.
func (p Pages) Sort() {
- PageBy(DefaultPageSort).Sort(p)
+ pageBy(defaultPageSort).Sort(p)
}
// Limit limits the number of pages returned to n.
// This may safely be executed in parallel.
func (p Pages) ByWeight() Pages {
key := "pageSort.ByWeight"
- pages, _ := spc.get(key, p, PageBy(DefaultPageSort).Sort)
+ pages, _ := spc.get(key, p, pageBy(defaultPageSort).Sort)
return pages
}
return p1.Title < p2.Title
}
- pages, _ := spc.get(key, p, PageBy(title).Sort)
+ pages, _ := spc.get(key, p, pageBy(title).Sort)
return pages
}
return p1.linkTitle < p2.linkTitle
}
- pages, _ := spc.get(key, p, PageBy(linkTitle).Sort)
+ pages, _ := spc.get(key, p, pageBy(linkTitle).Sort)
return pages
}
return p1.Date.Unix() < p2.Date.Unix()
}
- pages, _ := spc.get(key, p, PageBy(date).Sort)
+ pages, _ := spc.get(key, p, pageBy(date).Sort)
return pages
}
return p1.PublishDate.Unix() < p2.PublishDate.Unix()
}
- pages, _ := spc.get(key, p, PageBy(pubDate).Sort)
+ pages, _ := spc.get(key, p, pageBy(pubDate).Sort)
return pages
}
return len(p1.Content) < len(p2.Content)
}
- pages, _ := spc.get(key, p, PageBy(length).Sort)
+ pages, _ := spc.get(key, p, pageBy(length).Sort)
return pages
}
"github.com/spf13/hugo/helpers"
)
-// PathPattern represents a string which builds up a URL from attributes
-type PathPattern string
+// pathPattern represents a string which builds up a URL from attributes
+type pathPattern string
-// PageToPermaAttribute is the type of a function which, given a page and a tag
+// pageToPermaAttribute is the type of a function which, given a page and a tag
// can return a string to go in that position in the page (or an error)
-type PageToPermaAttribute func(*Page, string) (string, error)
+type pageToPermaAttribute func(*Page, string) (string, error)
// PermalinkOverrides maps a section name to a PathPattern
-type PermalinkOverrides map[string]PathPattern
+type PermalinkOverrides map[string]pathPattern
// knownPermalinkAttributes maps :tags in a permalink specification to a
// function which, given a page and the tag, returns the resulting string
// to be used to replace that tag.
-var knownPermalinkAttributes map[string]PageToPermaAttribute
+var knownPermalinkAttributes map[string]pageToPermaAttribute
var attributeRegexp *regexp.Regexp
// validate determines if a PathPattern is well-formed
-func (pp PathPattern) validate() bool {
+func (pp pathPattern) validate() bool {
fragments := strings.Split(string(pp[1:]), "/")
var bail = false
for i := range fragments {
}
type permalinkExpandError struct {
- pattern PathPattern
+ pattern pathPattern
section string
err error
}
// Expand on a PathPattern takes a Page and returns the fully expanded Permalink
// or an error explaining the failure.
-func (pp PathPattern) Expand(p *Page) (string, error) {
+func (pp pathPattern) Expand(p *Page) (string, error) {
if !pp.validate() {
return "", &permalinkExpandError{pattern: pp, section: "<all>", err: errPermalinkIllFormed}
}
}
func init() {
- knownPermalinkAttributes = map[string]PageToPermaAttribute{
+ knownPermalinkAttributes = map[string]pageToPermaAttribute{
"year": pageToPermalinkDate,
"month": pageToPermalinkDate,
"monthname": pageToPermalinkDate,
projects / brevno-suite / hugo / commitdiff