Package goats

import "bitbucket.org/idomdavis/goats"

Overview
Index
Examples

Overview

Package goats requires a description.

Example

Code:

t := time.Date(2015, time.March, 12, 15, 6, 0, 0, time.UTC)

fmt.Println(t.Format(goats.Translate("2006-01-02T15:04:05")))
fmt.Println(t.Format(goats.Translate("Mon, 2 Jan 2006 15:04:05 MST")))
fmt.Println(t.Format(goats.Translate("yyyy-MM-dd'T'HH:mm:ss")))
fmt.Println(t.Format(goats.Translate("EEE, d MMM yyyy HH:mm:ss z")))

Output:

2015-03-12T15:06:00
Thu, 12 Mar 2015 15:06:00 UTC
2015-03-12T15:06:00
Thu, 12 Mar 2015 15:06:00 UTC

Index

func Register(translator Translator)
func Reset()
func Translate(input string) string
type Translation
func Go(source string) *Translation
func Java(source string) *Translation
func (t *Translation) Match(s string) bool
func (t *Translation) Rebuild(strip *regexp.Regexp)
func (t *Translation) Replace(source, target string) bool
func (t *Translation) Strip(literal *regexp.Regexp, placeholder string)
func (t *Translation) Update(find *regexp.Regexp, replace string)
type Translator

Examples

(Expand All)

Package
Register
Translation.Match
Translation.Rebuild
Translation.Replace
Translation.Strip
Translation.Update

Package files

doc.go go.go java.go translate.go translator.go

func Register

func Register(translator Translator)

Register a translator with goats.

Example

Code:

fmt.Printf("%q\n", goats.Translate(""))

goats.Register(func(input string) *goats.Translation {
    return &goats.Translation{Format: "translated", Confidence: math.MaxInt64}
})

fmt.Printf("%q\n", goats.Translate(""))

goats.Reset()

Output:

""
"translated"

func Reset

func Reset()

Reset the translator list to the default.

func Translate

func Translate(input string) string

Translate a string using the highest matching translator. If no translators provide a match then the string is returned as is.

type Translation

Translation of a time format.

type Translation struct {
    // Confidence in the translation. Confidence is set to the number of
    // matching formatting patterns that were found.
    Confidence int

    // Format string for the translation.
    Format string
    // contains filtered or unexported fields
}

func Go

func Go(source string) *Translation

Go translator does nothing to the source string, but set a confidence based on the number of matches to the Go time format string in the source. nolint:gocyclo

func Java

func Java(source string) *Translation

Java will provide a Translation from Java date time format. Both DD and D will produce space padded day of year. Both HH and H will produce a zero padded 24 hour representation of the hour. All zero padded patterns are reduced to the shorted possible number of zeros, except for S which is 0 padded to the number of S's provided. z is a standard timezone (MST), Z returns a numeric timezone (-0700) and z returns a numeric timezone with a colon (-07:00). nolint:funlen,gocyclo

func (*Translation) Match

func (t *Translation) Match(s string) bool

Match the given string and update the Confidence with the number of matches. Returns true if any matches were found, false otherwise.

Example

Code:

format := "'Time' HH:mm"

t := &goats.Translation{Format: format}
t.Match("HH")

fmt.Println(t.Confidence, t.Format)

Output:

1 'Time' HH:mm

func (*Translation) Rebuild

func (t *Translation) Rebuild(strip *regexp.Regexp)

Rebuild the format with the literals stripped with Strip. The literals have any string that matches string replaced with the empty string before being added back into the format.

Example

Code:

format := "'Time' HH:mm"

t := &goats.Translation{Format: format}
t.Strip(regexp.MustCompile(`'(?:[^']|'')*'`), "@")
t.Rebuild(regexp.MustCompile(`^'|'$`))

fmt.Println(t.Format)

Output:

Time HH:mm

func (*Translation) Replace

func (t *Translation) Replace(source, target string) bool

Replace source with target and update the Confidence with the number of matches. Returns true if any replacements were made, false otherwise.

Example

Code:

format := "'Time' HH:mm"

t := &goats.Translation{Format: format}
t.Replace("'Time' ", "")

fmt.Println(t.Confidence, t.Format)

Output:

1 HH:mm

func (*Translation) Strip

func (t *Translation) Strip(literal *regexp.Regexp, placeholder string)

Strip and store literals from the format string. This allows Update, Match Replace to ignore string literals during translation. Use Rebuild to return the literals to the Format.

Example

Code:

format := "'Time' HH:mm"

t := &goats.Translation{Format: format}
t.Strip(regexp.MustCompile(`'(?:[^']|'')*'`), "@")

fmt.Println(t.Format)

Output:

@ HH:mm

func (*Translation) Update

func (t *Translation) Update(find *regexp.Regexp, replace string)

Update the Format by finding and replacing all instances of the find regexp with replace. The Confidence is not affected by Update.

Example

Code:

format := "'Time' HH:mm"

t := &goats.Translation{Format: format}
t.Update(regexp.MustCompile(`'.*' `), "")

fmt.Println(t.Confidence, t.Format)

Output:

0 HH:mm

type Translator

Translator function that will take a source time format and return a Translation.

type Translator func(source string) *Translation

bitbucket.org/idomdavis/goats

Go Alternative Time Strings (goats)