Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make better use of i18n #20096

Merged
merged 36 commits into from
Jun 26, 2022
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
24abae5
Prototyping
Jun 21, 2022
48b9b21
Start work on creating offsets
Jun 22, 2022
8b7ca1c
Modify tests
Jun 22, 2022
8427dbd
Start prototyping with actual MPH
Jun 22, 2022
12605ec
Twiddle around
Jun 23, 2022
b25d0d5
Twiddle around comments
Jun 23, 2022
f70b31a
Convert templates
Jun 23, 2022
f466981
Fix external languages
Jun 23, 2022
ddaf0cb
Fix latest translation
Jun 23, 2022
78bdc57
Fix some test
Jun 23, 2022
ace2fd1
Merge branch 'main' into wow-maths
Jun 23, 2022
24c973b
Tidy up code
Jun 23, 2022
4788be5
Merge branch 'main' into wow-maths
Jun 23, 2022
d498472
Use simple map
Jun 24, 2022
c78f1f1
Merge branch 'main' into wow-maths
Jun 24, 2022
957207b
go mod tidy
Jun 24, 2022
6bfa1ba
Move back to data structure
Jun 24, 2022
36c7844
Apply suggestions from code review
Jun 24, 2022
cac046f
Merge branch 'main' into wow-maths
6543 Jun 24, 2022
432e952
Add some comments
Jun 24, 2022
b2935e7
Merge branch 'main' into wow-maths
Jun 24, 2022
3a6a6b4
Fix tests
Jun 24, 2022
b798d02
Try to fix tests
Jun 24, 2022
4ed361f
Merge branch 'main' into wow-maths
Jun 24, 2022
6568ca1
Use en-US as defacto fallback
Jun 25, 2022
47eb2bb
Use correct slices
Jun 25, 2022
8a1b976
refactor (#4)
wxiaoguang Jun 25, 2022
6d3e754
Remove TryTr, add log for missing translation key
Jun 25, 2022
2cffac5
Merge branch 'main' into wow-maths
zeripath Jun 25, 2022
8334002
Refactor i18n
Jun 25, 2022
f20fd87
Fix live-reloading & check for errors
Jun 25, 2022
1978b74
Make linter happy
Jun 25, 2022
b252dfd
Merge branch 'main' into wow-maths
Jun 25, 2022
05d490d
live-reload with periodic check (#5)
wxiaoguang Jun 26, 2022
fbd3e08
Fix tests
Jun 26, 2022
f66ad02
Merge branch 'main' into wow-maths
Jun 26, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions modules/markup/markdown/toc.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"net/url"

"code.gitea.io/gitea/modules/markup"
"code.gitea.io/gitea/modules/translation/i18n"
"code.gitea.io/gitea/modules/translation"

"github.com/yuin/goldmark/ast"
)
Expand All @@ -18,7 +18,7 @@ func createTOCNode(toc []markup.Header, lang string) ast.Node {
details := NewDetails()
summary := NewSummary()

summary.AppendChild(summary, ast.NewString([]byte(i18n.Tr(lang, "toc"))))
summary.AppendChild(summary, ast.NewString([]byte(translation.NewLocale(lang).Tr("toc"))))
details.AppendChild(details, summary)
ul := ast.NewList('-')
details.AppendChild(details, ul)
Expand Down
2 changes: 0 additions & 2 deletions modules/templates/helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,6 @@ func NewFuncMap() []template.FuncMap {
"Str2html": Str2html,
"TimeSince": timeutil.TimeSince,
"TimeSinceUnix": timeutil.TimeSinceUnix,
"RawTimeSince": timeutil.RawTimeSince,
"FileSize": base.FileSize,
"PrettyNumber": base.PrettyNumber,
"JsPrettyNumber": JsPrettyNumber,
Expand Down Expand Up @@ -484,7 +483,6 @@ func NewTextFuncMap() []texttmpl.FuncMap {
},
"TimeSince": timeutil.TimeSince,
"TimeSinceUnix": timeutil.TimeSinceUnix,
"RawTimeSince": timeutil.RawTimeSince,
"DateFmtLong": func(t time.Time) string {
return t.Format(time.RFC1123Z)
},
Expand Down
117 changes: 56 additions & 61 deletions modules/timeutil/since.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (
"time"

"code.gitea.io/gitea/modules/setting"
"code.gitea.io/gitea/modules/translation/i18n"
"code.gitea.io/gitea/modules/translation"
)

// Seconds-based time units
Expand All @@ -29,146 +29,146 @@ func round(s float64) int64 {
return int64(math.Round(s))
}

func computeTimeDiffFloor(diff int64, lang string) (int64, string) {
var diffStr string
func computeTimeDiffFloor(diff int64, lang translation.Locale) (int64, string) {
diffStr := ""
switch {
case diff <= 0:
diff = 0
diffStr = i18n.Tr(lang, "tool.now")
diffStr = lang.Tr("tool.now")
case diff < 2:
diff = 0
diffStr = i18n.Tr(lang, "tool.1s")
diffStr = lang.Tr("tool.1s")
case diff < 1*Minute:
diffStr = i18n.Tr(lang, "tool.seconds", diff)
diffStr = lang.Tr("tool.seconds", diff)
diff = 0

case diff < 2*Minute:
diff -= 1 * Minute
diffStr = i18n.Tr(lang, "tool.1m")
diffStr = lang.Tr("tool.1m")
case diff < 1*Hour:
diffStr = i18n.Tr(lang, "tool.minutes", diff/Minute)
diffStr = lang.Tr("tool.minutes", diff/Minute)
diff -= diff / Minute * Minute

case diff < 2*Hour:
diff -= 1 * Hour
diffStr = i18n.Tr(lang, "tool.1h")
diffStr = lang.Tr("tool.1h")
case diff < 1*Day:
diffStr = i18n.Tr(lang, "tool.hours", diff/Hour)
diffStr = lang.Tr("tool.hours", diff/Hour)
diff -= diff / Hour * Hour

case diff < 2*Day:
diff -= 1 * Day
diffStr = i18n.Tr(lang, "tool.1d")
diffStr = lang.Tr("tool.1d")
case diff < 1*Week:
diffStr = i18n.Tr(lang, "tool.days", diff/Day)
diffStr = lang.Tr("tool.days", diff/Day)
diff -= diff / Day * Day

case diff < 2*Week:
diff -= 1 * Week
diffStr = i18n.Tr(lang, "tool.1w")
diffStr = lang.Tr("tool.1w")
case diff < 1*Month:
diffStr = i18n.Tr(lang, "tool.weeks", diff/Week)
diffStr = lang.Tr("tool.weeks", diff/Week)
diff -= diff / Week * Week

case diff < 2*Month:
diff -= 1 * Month
diffStr = i18n.Tr(lang, "tool.1mon")
diffStr = lang.Tr("tool.1mon")
case diff < 1*Year:
diffStr = i18n.Tr(lang, "tool.months", diff/Month)
diffStr = lang.Tr("tool.months", diff/Month)
diff -= diff / Month * Month

case diff < 2*Year:
diff -= 1 * Year
diffStr = i18n.Tr(lang, "tool.1y")
diffStr = lang.Tr("tool.1y")
default:
diffStr = i18n.Tr(lang, "tool.years", diff/Year)
diffStr = lang.Tr("tool.years", diff/Year)
diff -= (diff / Year) * Year
}
return diff, diffStr
}

func computeTimeDiff(diff int64, lang string) (int64, string) {
var diffStr string
func computeTimeDiff(diff int64, lang translation.Locale) (int64, string) {
diffStr := ""
switch {
case diff <= 0:
diff = 0
diffStr = i18n.Tr(lang, "tool.now")
diffStr = lang.Tr("tool.now")
case diff < 2:
diff = 0
diffStr = i18n.Tr(lang, "tool.1s")
diffStr = lang.Tr("tool.1s")
case diff < 1*Minute:
diffStr = i18n.Tr(lang, "tool.seconds", diff)
diffStr = lang.Tr("tool.seconds", diff)
diff = 0

case diff < Minute+Minute/2:
diff -= 1 * Minute
diffStr = i18n.Tr(lang, "tool.1m")
diffStr = lang.Tr("tool.1m")
case diff < 1*Hour:
minutes := round(float64(diff) / Minute)
if minutes > 1 {
diffStr = i18n.Tr(lang, "tool.minutes", minutes)
diffStr = lang.Tr("tool.minutes", minutes)
} else {
diffStr = i18n.Tr(lang, "tool.1m")
diffStr = lang.Tr("tool.1m")
}
diff -= diff / Minute * Minute

case diff < Hour+Hour/2:
diff -= 1 * Hour
diffStr = i18n.Tr(lang, "tool.1h")
diffStr = lang.Tr("tool.1h")
case diff < 1*Day:
hours := round(float64(diff) / Hour)
if hours > 1 {
diffStr = i18n.Tr(lang, "tool.hours", hours)
diffStr = lang.Tr("tool.hours", hours)
} else {
diffStr = i18n.Tr(lang, "tool.1h")
diffStr = lang.Tr("tool.1h")
}
diff -= diff / Hour * Hour

case diff < Day+Day/2:
diff -= 1 * Day
diffStr = i18n.Tr(lang, "tool.1d")
diffStr = lang.Tr("tool.1d")
case diff < 1*Week:
days := round(float64(diff) / Day)
if days > 1 {
diffStr = i18n.Tr(lang, "tool.days", days)
diffStr = lang.Tr("tool.days", days)
} else {
diffStr = i18n.Tr(lang, "tool.1d")
diffStr = lang.Tr("tool.1d")
}
diff -= diff / Day * Day

case diff < Week+Week/2:
diff -= 1 * Week
diffStr = i18n.Tr(lang, "tool.1w")
diffStr = lang.Tr("tool.1w")
case diff < 1*Month:
weeks := round(float64(diff) / Week)
if weeks > 1 {
diffStr = i18n.Tr(lang, "tool.weeks", weeks)
diffStr = lang.Tr("tool.weeks", weeks)
} else {
diffStr = i18n.Tr(lang, "tool.1w")
diffStr = lang.Tr("tool.1w")
}
diff -= diff / Week * Week

case diff < 1*Month+Month/2:
diff -= 1 * Month
diffStr = i18n.Tr(lang, "tool.1mon")
diffStr = lang.Tr("tool.1mon")
case diff < 1*Year:
months := round(float64(diff) / Month)
if months > 1 {
diffStr = i18n.Tr(lang, "tool.months", months)
diffStr = lang.Tr("tool.months", months)
} else {
diffStr = i18n.Tr(lang, "tool.1mon")
diffStr = lang.Tr("tool.1mon")
}
diff -= diff / Month * Month

case diff < Year+Year/2:
diff -= 1 * Year
diffStr = i18n.Tr(lang, "tool.1y")
diffStr = lang.Tr("tool.1y")
default:
years := round(float64(diff) / Year)
if years > 1 {
diffStr = i18n.Tr(lang, "tool.years", years)
diffStr = lang.Tr("tool.years", years)
} else {
diffStr = i18n.Tr(lang, "tool.1y")
diffStr = lang.Tr("tool.1y")
}
diff -= (diff / Year) * Year
}
Expand All @@ -177,24 +177,24 @@ func computeTimeDiff(diff int64, lang string) (int64, string) {

// MinutesToFriendly returns a user friendly string with number of minutes
// converted to hours and minutes.
func MinutesToFriendly(minutes int, lang string) string {
func MinutesToFriendly(minutes int, lang translation.Locale) string {
duration := time.Duration(minutes) * time.Minute
return TimeSincePro(time.Now().Add(-duration), lang)
}

// TimeSincePro calculates the time interval and generate full user-friendly string.
func TimeSincePro(then time.Time, lang string) string {
func TimeSincePro(then time.Time, lang translation.Locale) string {
return timeSincePro(then, time.Now(), lang)
}

func timeSincePro(then, now time.Time, lang string) string {
func timeSincePro(then, now time.Time, lang translation.Locale) string {
diff := now.Unix() - then.Unix()

if then.After(now) {
return i18n.Tr(lang, "tool.future")
return lang.Tr("tool.future")
}
if diff == 0 {
return i18n.Tr(lang, "tool.now")
return lang.Tr("tool.now")
}

var timeStr, diffStr string
Expand All @@ -209,48 +209,43 @@ func timeSincePro(then, now time.Time, lang string) string {
return strings.TrimPrefix(timeStr, ", ")
}

func timeSince(then, now time.Time, lang string) string {
func timeSince(then, now time.Time, lang translation.Locale) string {
return timeSinceUnix(then.Unix(), now.Unix(), lang)
}

func timeSinceUnix(then, now int64, lang string) string {
func timeSinceUnix(then, now int64, lang translation.Locale) string {
lbl := "tool.ago"
diff := now - then
if then > now {
lbl = "tool.from_now"
diff = then - now
}
if diff <= 0 {
return i18n.Tr(lang, "tool.now")
return lang.Tr("tool.now")
}

_, diffStr := computeTimeDiff(diff, lang)
return i18n.Tr(lang, lbl, diffStr)
}

// RawTimeSince retrieves i18n key of time since t
func RawTimeSince(t time.Time, lang string) string {
return timeSince(t, time.Now(), lang)
return lang.Tr(lbl, diffStr)
}

// TimeSince calculates the time interval and generate user-friendly string.
func TimeSince(then time.Time, lang string) template.HTML {
func TimeSince(then time.Time, lang translation.Locale) template.HTML {
return htmlTimeSince(then, time.Now(), lang)
}

func htmlTimeSince(then, now time.Time, lang string) template.HTML {
func htmlTimeSince(then, now time.Time, lang translation.Locale) template.HTML {
return template.HTML(fmt.Sprintf(`<span class="time-since" title="%s">%s</span>`,
then.In(setting.DefaultUILocation).Format(GetTimeFormat(lang)),
then.In(setting.DefaultUILocation).Format(GetTimeFormat(lang.Language())),
timeSince(then, now, lang)))
}

// TimeSinceUnix calculates the time interval and generate user-friendly string.
func TimeSinceUnix(then TimeStamp, lang string) template.HTML {
func TimeSinceUnix(then TimeStamp, lang translation.Locale) template.HTML {
return htmlTimeSinceUnix(then, TimeStamp(time.Now().Unix()), lang)
}

func htmlTimeSinceUnix(then, now TimeStamp, lang string) template.HTML {
func htmlTimeSinceUnix(then, now TimeStamp, lang translation.Locale) template.HTML {
return template.HTML(fmt.Sprintf(`<span class="time-since" title="%s">%s</span>`,
then.FormatInLocation(GetTimeFormat(lang), setting.DefaultUILocation),
then.FormatInLocation(GetTimeFormat(lang.Language()), setting.DefaultUILocation),
timeSinceUnix(int64(then), int64(now), lang)))
}
18 changes: 9 additions & 9 deletions modules/timeutil/since_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ func TestMain(m *testing.M) {
}

func TestTimeSince(t *testing.T) {
assert.Equal(t, "now", timeSince(BaseDate, BaseDate, "en"))
assert.Equal(t, "now", timeSince(BaseDate, BaseDate, translation.NewLocale("en-US")))

// test that each diff in `diffs` yields the expected string
test := func(expected string, diffs ...time.Duration) {
t.Run(expected, func(t *testing.T) {
for _, diff := range diffs {
actual := timeSince(BaseDate, BaseDate.Add(diff), "en")
actual := timeSince(BaseDate, BaseDate.Add(diff), translation.NewLocale("en-US"))
assert.Equal(t, i18n.Tr("en", "tool.ago", expected), actual)
actual = timeSince(BaseDate.Add(diff), BaseDate, "en")
actual = timeSince(BaseDate.Add(diff), BaseDate, translation.NewLocale("en-US"))
assert.Equal(t, i18n.Tr("en", "tool.from_now", expected), actual)
}
})
Expand Down Expand Up @@ -82,13 +82,13 @@ func TestTimeSince(t *testing.T) {
}

func TestTimeSincePro(t *testing.T) {
assert.Equal(t, "now", timeSincePro(BaseDate, BaseDate, "en"))
assert.Equal(t, "now", timeSincePro(BaseDate, BaseDate, translation.NewLocale("en-US")))

// test that a difference of `diff` yields the expected string
test := func(expected string, diff time.Duration) {
actual := timeSincePro(BaseDate, BaseDate.Add(diff), "en")
actual := timeSincePro(BaseDate, BaseDate.Add(diff), translation.NewLocale("en-US"))
assert.Equal(t, expected, actual)
assert.Equal(t, "future", timeSincePro(BaseDate.Add(diff), BaseDate, "en"))
assert.Equal(t, "future", timeSincePro(BaseDate.Add(diff), BaseDate, translation.NewLocale("en-US")))
}
test("1 second", time.Second)
test("2 seconds", 2*time.Second)
Expand Down Expand Up @@ -119,7 +119,7 @@ func TestHtmlTimeSince(t *testing.T) {
setting.DefaultUILocation = time.UTC
// test that `diff` yields a result containing `expected`
test := func(expected string, diff time.Duration) {
actual := htmlTimeSince(BaseDate, BaseDate.Add(diff), "en")
actual := htmlTimeSince(BaseDate, BaseDate.Add(diff), translation.NewLocale("en-US"))
assert.Contains(t, actual, `title="Sat Jan 1 00:00:00 UTC 2000"`)
assert.Contains(t, actual, expected)
}
Expand All @@ -138,7 +138,7 @@ func TestComputeTimeDiff(t *testing.T) {
test := func(base int64, str string, offsets ...int64) {
for _, offset := range offsets {
t.Run(fmt.Sprintf("%s:%d", str, offset), func(t *testing.T) {
diff, diffStr := computeTimeDiff(base+offset, "en")
diff, diffStr := computeTimeDiff(base+offset, translation.NewLocale("en"))
assert.Equal(t, offset, diff)
assert.Equal(t, str, diffStr)
})
Expand Down Expand Up @@ -171,7 +171,7 @@ func TestComputeTimeDiff(t *testing.T) {
func TestMinutesToFriendly(t *testing.T) {
// test that a number of minutes yields the expected string
test := func(expected string, minutes int) {
actual := MinutesToFriendly(minutes, "en")
actual := MinutesToFriendly(minutes, translation.NewLocale("en-US"))
assert.Equal(t, expected, actual)
}
test("1 minute", 1)
Expand Down
Loading