added v6
This commit is contained in:
310
v6/filters.go
Normal file
310
v6/filters.go
Normal file
@ -0,0 +1,310 @@
|
||||
package pongo2addons
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"errors"
|
||||
"fmt"
|
||||
"math/rand"
|
||||
"regexp"
|
||||
"strings"
|
||||
"time"
|
||||
"unicode/utf8"
|
||||
|
||||
"github.com/flosch/go-humanize"
|
||||
"github.com/flosch/pongo2/v6"
|
||||
"github.com/gosimple/slug"
|
||||
"github.com/russross/blackfriday/v2"
|
||||
)
|
||||
|
||||
func init() {
|
||||
rand.Seed(time.Now().UTC().UnixNano())
|
||||
|
||||
// Regulars
|
||||
pongo2.RegisterFilter("slugify", filterSlugify)
|
||||
pongo2.RegisterFilter("filesizeformat", filterFilesizeformat)
|
||||
pongo2.RegisterFilter("truncatesentences", filterTruncatesentences)
|
||||
pongo2.RegisterFilter("truncatesentences_html", filterTruncatesentencesHTML)
|
||||
pongo2.RegisterFilter("random", filterRandom)
|
||||
|
||||
// Markup
|
||||
pongo2.RegisterFilter("markdown", filterMarkdown)
|
||||
|
||||
// Humanize
|
||||
pongo2.RegisterFilter("timeuntil", filterTimeuntilTimesince)
|
||||
pongo2.RegisterFilter("timesince", filterTimeuntilTimesince)
|
||||
pongo2.RegisterFilter("naturaltime", filterTimeuntilTimesince)
|
||||
pongo2.RegisterFilter("naturalday", filterNaturalday)
|
||||
pongo2.RegisterFilter("intcomma", filterIntcomma)
|
||||
pongo2.RegisterFilter("ordinal", filterOrdinal)
|
||||
}
|
||||
|
||||
func filterMarkdown(in *pongo2.Value, param *pongo2.Value) (*pongo2.Value, *pongo2.Error) {
|
||||
return pongo2.AsSafeValue(string(blackfriday.Run([]byte(in.String())))), nil
|
||||
}
|
||||
|
||||
func filterSlugify(in *pongo2.Value, param *pongo2.Value) (*pongo2.Value, *pongo2.Error) {
|
||||
return pongo2.AsValue(slug.Make(in.String())), nil
|
||||
}
|
||||
|
||||
func filterFilesizeformat(in *pongo2.Value, param *pongo2.Value) (*pongo2.Value, *pongo2.Error) {
|
||||
return pongo2.AsValue(humanize.IBytes(uint64(in.Integer()))), nil
|
||||
}
|
||||
|
||||
var filterTruncatesentencesRe = regexp.MustCompile(`(?U:.*[\w]{3,}.*([\d][\.!?][\D]|[\D][\.!?][\s]|[\n$]))`)
|
||||
|
||||
func filterTruncatesentences(in *pongo2.Value, param *pongo2.Value) (*pongo2.Value, *pongo2.Error) {
|
||||
count := param.Integer()
|
||||
if count <= 0 {
|
||||
return pongo2.AsValue(""), nil
|
||||
}
|
||||
sentencens := filterTruncatesentencesRe.FindAllString(strings.TrimSpace(in.String()), -1)
|
||||
return pongo2.AsValue(strings.TrimSpace(strings.Join(sentencens[:min(count, len(sentencens))], ""))), nil
|
||||
}
|
||||
|
||||
// Taken from pongo2/filters_builtin.go
|
||||
func filterTruncateHTMLHelper(value string, newOutput *bytes.Buffer, cond func() bool, fn func(c rune, s int, idx int) int, finalize func()) {
|
||||
vLen := len(value)
|
||||
tagStack := make([]string, 0)
|
||||
idx := 0
|
||||
|
||||
for idx < vLen && !cond() {
|
||||
c, s := utf8.DecodeRuneInString(value[idx:])
|
||||
if c == utf8.RuneError {
|
||||
idx += s
|
||||
continue
|
||||
}
|
||||
|
||||
if c == '<' {
|
||||
newOutput.WriteRune(c)
|
||||
idx += s // consume "<"
|
||||
|
||||
if idx+1 < vLen {
|
||||
if value[idx] == '/' {
|
||||
// Close tag
|
||||
|
||||
newOutput.WriteString("/")
|
||||
|
||||
tag := ""
|
||||
idx++ // consume "/"
|
||||
|
||||
for idx < vLen {
|
||||
c2, size2 := utf8.DecodeRuneInString(value[idx:])
|
||||
if c2 == utf8.RuneError {
|
||||
idx += size2
|
||||
continue
|
||||
}
|
||||
|
||||
// End of tag found
|
||||
if c2 == '>' {
|
||||
idx++ // consume ">"
|
||||
break
|
||||
}
|
||||
tag += string(c2)
|
||||
idx += size2
|
||||
}
|
||||
|
||||
if len(tagStack) > 0 {
|
||||
// Ideally, the close tag is TOP of tag stack
|
||||
// In malformed HTML, it must not be, so iterate through the stack and remove the tag
|
||||
for i := len(tagStack) - 1; i >= 0; i-- {
|
||||
if tagStack[i] == tag {
|
||||
// Found the tag
|
||||
tagStack[i] = tagStack[len(tagStack)-1]
|
||||
tagStack = tagStack[:len(tagStack)-1]
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
newOutput.WriteString(tag)
|
||||
newOutput.WriteString(">")
|
||||
} else {
|
||||
// Open tag
|
||||
|
||||
tag := ""
|
||||
|
||||
params := false
|
||||
for idx < vLen {
|
||||
c2, size2 := utf8.DecodeRuneInString(value[idx:])
|
||||
if c2 == utf8.RuneError {
|
||||
idx += size2
|
||||
continue
|
||||
}
|
||||
|
||||
newOutput.WriteRune(c2)
|
||||
|
||||
// End of tag found
|
||||
if c2 == '>' {
|
||||
idx++ // consume ">"
|
||||
break
|
||||
}
|
||||
|
||||
if !params {
|
||||
if c2 == ' ' {
|
||||
params = true
|
||||
} else {
|
||||
tag += string(c2)
|
||||
}
|
||||
}
|
||||
|
||||
idx += size2
|
||||
}
|
||||
|
||||
// Add tag to stack
|
||||
tagStack = append(tagStack, tag)
|
||||
}
|
||||
}
|
||||
} else {
|
||||
idx = fn(c, s, idx)
|
||||
}
|
||||
}
|
||||
|
||||
finalize()
|
||||
|
||||
for i := len(tagStack) - 1; i >= 0; i-- {
|
||||
tag := tagStack[i]
|
||||
// Close everything from the regular tag stack
|
||||
newOutput.WriteString(fmt.Sprintf("</%s>", tag))
|
||||
}
|
||||
}
|
||||
|
||||
func filterTruncatesentencesHTML(in *pongo2.Value, param *pongo2.Value) (*pongo2.Value, *pongo2.Error) {
|
||||
count := param.Integer()
|
||||
if count <= 0 {
|
||||
return pongo2.AsValue(""), nil
|
||||
}
|
||||
|
||||
value := in.String()
|
||||
newLen := max(param.Integer(), 0)
|
||||
|
||||
newOutput := bytes.NewBuffer(nil)
|
||||
|
||||
sentencefilter := 0
|
||||
|
||||
filterTruncateHTMLHelper(value, newOutput, func() bool {
|
||||
return sentencefilter >= newLen
|
||||
}, func(_ rune, _ int, idx int) int {
|
||||
// Get next word
|
||||
wordFound := false
|
||||
|
||||
for idx < len(value) {
|
||||
c2, size2 := utf8.DecodeRuneInString(value[idx:])
|
||||
if c2 == utf8.RuneError {
|
||||
idx += size2
|
||||
continue
|
||||
}
|
||||
|
||||
if c2 == '<' {
|
||||
// HTML tag start, don't consume it
|
||||
return idx
|
||||
}
|
||||
|
||||
newOutput.WriteRune(c2)
|
||||
idx += size2
|
||||
|
||||
if (c2 == '.' && !(idx+1 < len(value) && value[idx+1] >= '0' && value[idx+1] <= '9')) ||
|
||||
c2 == '!' || c2 == '?' || c2 == '\n' {
|
||||
// Sentence ends here, stop capturing it now
|
||||
break
|
||||
} else {
|
||||
wordFound = true
|
||||
}
|
||||
}
|
||||
|
||||
if wordFound {
|
||||
sentencefilter++
|
||||
}
|
||||
|
||||
return idx
|
||||
}, func() {})
|
||||
|
||||
return pongo2.AsSafeValue(newOutput.String()), nil
|
||||
}
|
||||
|
||||
func filterRandom(in *pongo2.Value, param *pongo2.Value) (*pongo2.Value, *pongo2.Error) {
|
||||
if !in.CanSlice() {
|
||||
return nil, &pongo2.Error{
|
||||
Sender: "filter:random",
|
||||
OrigError: errors.New("input is not sliceable"),
|
||||
}
|
||||
}
|
||||
|
||||
if in.Len() <= 0 {
|
||||
return nil, &pongo2.Error{
|
||||
Sender: "filter:random",
|
||||
OrigError: errors.New("input slice is empty"),
|
||||
}
|
||||
}
|
||||
|
||||
return in.Index(rand.Intn(in.Len())), nil
|
||||
}
|
||||
|
||||
func filterTimeuntilTimesince(in *pongo2.Value, param *pongo2.Value) (*pongo2.Value, *pongo2.Error) {
|
||||
basetime, isTime := in.Interface().(time.Time)
|
||||
if !isTime {
|
||||
return nil, &pongo2.Error{
|
||||
Sender: "filter:timeuntil/timesince",
|
||||
OrigError: errors.New("time-value is not a time.Time-instance"),
|
||||
}
|
||||
}
|
||||
var paramtime time.Time
|
||||
if !param.IsNil() {
|
||||
paramtime, isTime = param.Interface().(time.Time)
|
||||
if !isTime {
|
||||
return nil, &pongo2.Error{
|
||||
Sender: "filter:timeuntil/timesince",
|
||||
OrigError: errors.New("time-parameter is not a time.Time-instance"),
|
||||
}
|
||||
}
|
||||
} else {
|
||||
paramtime = time.Now()
|
||||
}
|
||||
|
||||
return pongo2.AsValue(humanize.TimeDuration(basetime.Sub(paramtime))), nil
|
||||
}
|
||||
|
||||
func filterIntcomma(in *pongo2.Value, param *pongo2.Value) (*pongo2.Value, *pongo2.Error) {
|
||||
return pongo2.AsValue(humanize.Comma(int64(in.Integer()))), nil
|
||||
}
|
||||
|
||||
func filterOrdinal(in *pongo2.Value, param *pongo2.Value) (*pongo2.Value, *pongo2.Error) {
|
||||
return pongo2.AsValue(humanize.Ordinal(in.Integer())), nil
|
||||
}
|
||||
|
||||
func filterNaturalday(in *pongo2.Value, param *pongo2.Value) (*pongo2.Value, *pongo2.Error) {
|
||||
basetime, isTime := in.Interface().(time.Time)
|
||||
if !isTime {
|
||||
return nil, &pongo2.Error{
|
||||
Sender: "filter:naturalday",
|
||||
OrigError: errors.New("naturalday-value is not a time.Time-instance"),
|
||||
}
|
||||
}
|
||||
|
||||
var referenceTime time.Time
|
||||
if !param.IsNil() {
|
||||
referenceTime, isTime = param.Interface().(time.Time)
|
||||
if !isTime {
|
||||
return nil, &pongo2.Error{
|
||||
Sender: "filter:naturalday",
|
||||
OrigError: errors.New("naturalday-parameter is not a time.Time-instance"),
|
||||
}
|
||||
}
|
||||
} else {
|
||||
referenceTime = time.Now()
|
||||
}
|
||||
|
||||
d := referenceTime.Sub(basetime) / time.Hour
|
||||
|
||||
switch {
|
||||
case d >= 0 && d < 24:
|
||||
// Today
|
||||
return pongo2.AsValue("today"), nil
|
||||
case d >= 24:
|
||||
return pongo2.AsValue("yesterday"), nil
|
||||
case d < 0 && d >= -24:
|
||||
return pongo2.AsValue("tomorrow"), nil
|
||||
}
|
||||
|
||||
// Default behaviour
|
||||
return pongo2.ApplyFilter("naturaltime", in, param)
|
||||
}
|
||||
97
v6/filters_test.go
Normal file
97
v6/filters_test.go
Normal file
@ -0,0 +1,97 @@
|
||||
package pongo2addons
|
||||
|
||||
import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/flosch/pongo2/v6"
|
||||
. "gopkg.in/check.v1"
|
||||
)
|
||||
|
||||
// Hook up gocheck into the "go test" runner.
|
||||
func Test(t *testing.T) {
|
||||
TestingT(t)
|
||||
}
|
||||
|
||||
// A wrapprt of pongo2.RenderTemplateString
|
||||
func getResult(s string, ctx pongo2.Context) string {
|
||||
result, _ := pongo2.RenderTemplateString(s, ctx)
|
||||
return result
|
||||
}
|
||||
|
||||
type TestSuite1 struct{}
|
||||
|
||||
var _ = Suite(&TestSuite1{})
|
||||
|
||||
func (s *TestSuite1) TestFilters(c *C) {
|
||||
// Markdown
|
||||
c.Assert(getResult("{{ \"**test**\"|markdown }}", nil), Equals, "<p><strong>test</strong></p>\n")
|
||||
|
||||
// Slugify
|
||||
c.Assert(getResult("{{ \"this is ä test!\"|slugify }}", nil), Equals, "this-is-a-test")
|
||||
|
||||
// Filesizeformat
|
||||
c.Assert(getResult("{{ 123456789|filesizeformat }}", nil), Equals, "118MiB")
|
||||
|
||||
// Timesince/timeuntil
|
||||
baseDate := time.Date(2014, time.February, 1, 8, 30, 00, 00, time.UTC)
|
||||
futureDate := baseDate.Add(24*7*4*time.Hour + 2*time.Hour)
|
||||
c.Assert(getResult("{{ future_date|timeuntil:base_date }}",
|
||||
pongo2.Context{"base_date": baseDate, "future_date": futureDate}), Equals, "4 weeks from now")
|
||||
|
||||
baseDate = time.Date(2014, time.February, 1, 8, 30, 00, 00, time.UTC)
|
||||
futureDate = baseDate.Add(2 * time.Hour)
|
||||
c.Assert(getResult("{{ future_date|timeuntil:base_date }}",
|
||||
pongo2.Context{"base_date": baseDate, "future_date": futureDate}), Equals, "2 hours from now")
|
||||
|
||||
baseDate = time.Date(2014, time.February, 1, 8, 30, 00, 00, time.UTC)
|
||||
futureDate = baseDate.Add(2 * time.Hour)
|
||||
c.Assert(getResult("{{ base_date|timesince:future_date }}",
|
||||
pongo2.Context{"base_date": baseDate, "future_date": futureDate}), Equals, "2 hours ago")
|
||||
|
||||
// Natural time
|
||||
baseDate = time.Date(2014, time.February, 1, 8, 30, 00, 00, time.UTC)
|
||||
futureDate = baseDate.Add(4 * time.Second)
|
||||
c.Assert(getResult("{{ base_date|naturaltime:future_date }}",
|
||||
pongo2.Context{"base_date": baseDate, "future_date": futureDate}), Equals, "4 seconds ago")
|
||||
|
||||
// Naturalday
|
||||
today := time.Date(2014, time.February, 1, 8, 30, 00, 00, time.UTC)
|
||||
yesterday := today.Add(-24 * time.Hour)
|
||||
tomorrow := today.Add(24 * time.Hour)
|
||||
todayPlus3 := today.Add(3 * 24 * time.Hour)
|
||||
c.Assert(getResult("{{ date|naturalday:today }}",
|
||||
pongo2.Context{"date": today, "today": today}), Equals, "today")
|
||||
c.Assert(getResult("{{ date|naturalday:today }}",
|
||||
pongo2.Context{"date": yesterday, "today": today}), Equals, "yesterday")
|
||||
c.Assert(getResult("{{ date|naturalday:today }}",
|
||||
pongo2.Context{"date": tomorrow, "today": today}), Equals, "tomorrow")
|
||||
c.Assert(getResult("{{ date|naturalday:today }}",
|
||||
pongo2.Context{"date": todayPlus3, "today": today}), Equals, "3 days from now")
|
||||
|
||||
// Intcomma
|
||||
c.Assert(getResult("{{ 123456789|intcomma }}", nil), Equals, "123,456,789")
|
||||
|
||||
// Ordinal
|
||||
c.Assert(getResult("{{ 1|ordinal }} {{ 2|ordinal }} {{ 3|ordinal }} {{ 18241|ordinal }}", nil),
|
||||
Equals, "1st 2nd 3rd 18241st")
|
||||
|
||||
// Truncatesentences
|
||||
c.Assert(getResult("{{ text|truncatesentences:3|safe }}", pongo2.Context{
|
||||
"text": `This is a first sentence with a 4.50 number. The second one is even more fun! Isn't it? Last sentence, okay.`}),
|
||||
Equals, "This is a first sentence with a 4.50 number. The second one is even more fun! Isn't it?")
|
||||
|
||||
// Truncatesentences_html
|
||||
c.Assert(getResult("{{ text|truncatesentences_html:2 }}", pongo2.Context{
|
||||
"text": `<div class="test"><ul><li>This is a first sentence with a 4.50 number.</li><li>The second one is even more fun! Isn't it?</li><li>Last sentence, okay.</li></ul></div>`}),
|
||||
Equals, `<div class="test"><ul><li>This is a first sentence with a 4.50 number.</li><li>The second one is even more fun!</li></ul></div>`)
|
||||
c.Assert(getResult("{{ text|truncatesentences_html:3 }}", pongo2.Context{
|
||||
"text": `<div class="test"><ul><li>This is a first sentence with a 4.50 number.</li><li>The second one is even more fun! Isn't it?</li><li>Last sentence, okay.</li></ul></div>`}),
|
||||
Equals, `<div class="test"><ul><li>This is a first sentence with a 4.50 number.</li><li>The second one is even more fun! Isn't it?</li></ul></div>`)
|
||||
|
||||
// Random
|
||||
c.Assert(getResult("{{ array|random }}",
|
||||
pongo2.Context{"array": []int{42}}),
|
||||
Equals, "42")
|
||||
|
||||
}
|
||||
15
v6/helpers.go
Normal file
15
v6/helpers.go
Normal file
@ -0,0 +1,15 @@
|
||||
package pongo2addons
|
||||
|
||||
func max(a, b int) int {
|
||||
if a > b {
|
||||
return a
|
||||
}
|
||||
return b
|
||||
}
|
||||
|
||||
func min(a, b int) int {
|
||||
if a < b {
|
||||
return a
|
||||
}
|
||||
return b
|
||||
}
|
||||
Reference in New Issue
Block a user