Merge pull request #4 from donseba/dep

donseba · web-flow · commit 11b1bf14c27d · 2025-03-12T14:53:06.000+01:00
upgrade to golang 1.24 , harden tests , linter
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,15 @@
+# These are supported funding model platforms
+
+github: donseba # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+thanks_dev: # Replace with a single thanks.dev username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
diff --git a/.github/workflows/golangci-lint.yml b/.github/workflows/golangci-lint.yml
@@ -0,0 +1,56 @@
+name: golangci-lint
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  # pull-requests: read
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.24'
+          cache: false
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          # Require: The version of golangci-lint to use.
+          # When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
+          # When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
+          version: latest
+
+          # Optional: working directory, useful for monorepos
+          # working-directory: somedir
+
+          # Optional: golangci-lint command line arguments.
+          #
+          # Note: By default, the `.golangci.yml` file should be at the root of the repository.
+          # The location of the configuration file can be changed by using `--config=`
+          # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
+          args: --out-format=colored-line-number
+
+          # Optional: show only new issues if it's a pull request. The default value is `false`.
+          # only-new-issues: true
+
+          # Optional: if set to true, then all caching functionality will be completely disabled,
+          #           takes precedence over all other caching options.
+          # skip-cache: true
+
+          # Optional: if set to true, then the action won't cache or restore ~/go/pkg.
+          # skip-pkg-cache: true
+
+          # Optional: if set to true, then the action won't cache or restore ~/.cache/go-build.
+          # skip-build-cache: true
+
+          # Optional: The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
+          # install-mode: "goinstall"
diff --git a/get.go b/get.go
@@ -5,7 +5,7 @@ import (
 )
 
 // Tl translates a string based on the given language tag and key.
-func (t *Translator) tl(loc Localizer, key string, args ...interface{}) string {
+func (t *Translator) tl(loc Localizer, key string, args ...any) string {
 	translator, exists := t.languages[loc.GetLocale()]
 	if !exists {
 		return fmt.Sprintf(DefaultNoTranslationTL, key)
@@ -24,11 +24,11 @@ func (t *Translator) tl(loc Localizer, key string, args ...interface{}) string {
 		return fmt.Sprintf(DefaultNoTranslationTL, key)
 	}
 
-	translated := translator.Get(key, args...)
+	translated := translator.Get(fmt.Sprintf("%s", key), args...) //nolint:gosimple
 	return t.removePrefix(translated)
 }
 
-func (t *Translator) ctl(loc Localizer, ctx, key string, args ...interface{}) string {
+func (t *Translator) ctl(loc Localizer, ctx, key string, args ...any) string {
 	translator, exists := t.languages[loc.GetLocale()]
 	if !exists {
 		return fmt.Sprintf(DefaultNoTranslationCTL, ctx, key)
@@ -55,7 +55,7 @@ func (t *Translator) ctl(loc Localizer, ctx, key string, args ...interface{}) st
 		return fmt.Sprintf(DefaultNoTranslationCTL, ctx, key)
 	}
 
-	translated := translator.GetC(key, ctx, args...)
+	translated := translator.GetC(fmt.Sprintf("%s", key), ctx, args...) //nolint:gosimple
 	return t.removePrefix(translated)
 }
 
@@ -111,7 +111,7 @@ func (t *Translator) ctn(loc Localizer, ctx, singular, plural string, n int, arg
 }
 
 // Tl translates a string based on the given language tag and key.
-func (t *Translator) Tl(loc Localizer, key string, args ...interface{}) string {
+func (t *Translator) Tl(loc Localizer, key string, args ...any) string {
 	return t.tl(loc, key, args...)
 }
 
@@ -121,7 +121,7 @@ func (t *Translator) Tn(loc Localizer, singular, plural string, n int) string {
 }
 
 // Ctl method for handling string translation with context
-func (t *Translator) Ctl(loc Localizer, ctx, key string, args ...interface{}) string {
+func (t *Translator) Ctl(loc Localizer, ctx, key string, args ...any) string {
 	return t.ctl(loc, ctx, key, args...)
 }
 
diff --git a/go.mod b/go.mod
@@ -1,5 +1,5 @@
 module github.com/donseba/go-translator
 
-go 1.21.6
+go 1.24.0
 
-require github.com/donseba/gotext v1.5.7
+require github.com/leonelquinteros/gotext v1.7.2-0.20250311125224-bdb582003488
diff --git a/go.sum b/go.sum
@@ -1,2 +1,2 @@
-github.com/donseba/gotext v1.5.7 h1:7aDhXXdB09GObC350IpJ5xADjgY83tGe5iCD+gUIi1U=
-github.com/donseba/gotext v1.5.7/go.mod h1:LxKX7opw9kjMdEZqplR6sgDp0qFG6AFEvz4oYpNtCcY=
+github.com/leonelquinteros/gotext v1.7.2-0.20250311125224-bdb582003488 h1:ifSZSC/OCl/43oeCGssg+HmSgR/Ni88yEhqEOlLFRwo=
+github.com/leonelquinteros/gotext v1.7.2-0.20250311125224-bdb582003488/go.mod h1:I0WoFDn9u2D3VbPnnDPT8mzZu0iSXG8iih+AH2fHHqg=
diff --git a/set.go b/set.go
@@ -2,10 +2,11 @@ package translator
 
 import (
 	"fmt"
-	"github.com/donseba/gotext"
 	"os"
 	"path/filepath"
 	"time"
+
+	"github.com/leonelquinteros/gotext"
 )
 
 func (t *Translator) SetTL(loc Localizer, key string, value string) error {
diff --git a/set_test.go b/set_test.go
@@ -2,7 +2,6 @@ package translator
 
 import (
 	"fmt"
-	"github.com/donseba/gotext"
 	"testing"
 )
 
@@ -15,7 +14,6 @@ func TestTranslator_SetTL(t *testing.T) {
 	type fields struct {
 		translationsDir string
 		templateDir     string
-		languages       map[string]*gotext.Po
 		uniqueKeys      map[string]uniqueKey
 		uniqueKeysCtx   map[string]map[string]uniqueKey
 	}
@@ -114,7 +112,7 @@ func TestTranslator_SetTL(t *testing.T) {
 				}
 			}
 
-			tls := tr.languages[tt.lang].GetTranslations()
+			tls := tr.languages[tt.lang].GetDomain().GetTranslations()
 			for _, tl := range tls {
 				fmt.Printf("%+v\n", tl)
 			}
diff --git a/test_translations/en_US.po b/test_translations/en_US.po
@@ -25,4 +25,13 @@ msgstr "Third translation text"
 msgid "There is one apple"
 msgid_plural "There are many apples"
 msgstr[0] "There is one apple"
-msgstr[1] "There are many apples"
+msgstr[1] "There are many apples"
+
+msgid "First translation text with %s"
+msgstr "First translation text with %s"
+
+msgid "Second translation text with %s"
+msgstr "Second translation text with %s"
+
+msgid "Third translation text with %s"
+msgstr "Third translation text with %s"
diff --git a/test_translations/translations.pot b/test_translations/translations.pot
@@ -34,3 +34,43 @@ msgid "First translation text"
 msgid_plural "First translation text plural"
 msgstr[0] ""
 msgstr[1] ""
+
+msgid "Testing TN translation with amount"
+msgid_plural "Testing TN translations with amount"
+msgstr[0] ""
+msgstr[1] ""
+
+msgid "Testing TN translation"
+msgid_plural "Testing TN translations"
+msgstr[0] ""
+msgstr[1] ""
+
+msgid "Testing TN translation with amount and vars"
+msgid_plural "Testing %s translations with amount and vars"
+msgstr[0] ""
+msgstr[1] ""
+
+msgid "Testing TL translation"
+msgstr ""
+
+msgctxt "in context"
+msgid "Testing CTL translation"
+msgstr ""
+
+msgctxt "in context"
+msgid "Testing CTN translation"
+msgid_plural "Testing CTN translations"
+msgstr[0] ""
+msgstr[1] ""
+
+msgid "First translation text with %s"
+msgstr ""
+
+msgid "Second translation text with %s"
+msgstr ""
+
+msgid "Third translation text with %s"
+msgstr ""
+
+msgid "Non-existent text with %s"
+msgstr ""
diff --git a/translator.go b/translator.go
@@ -3,13 +3,14 @@ package translator
 import (
 	"bufio"
 	"fmt"
-	"github.com/donseba/gotext"
 	"html/template"
 	"os"
 	"path"
 	"path/filepath"
 	"regexp"
 	"strings"
+
+	"github.com/leonelquinteros/gotext"
 )
 
 var (
@@ -133,8 +134,8 @@ func (t *Translator) CheckMissingTranslations() error {
 	}
 
 	var (
-		tr  = t.pot.GetTranslations()
-		ctr = t.pot.GetCtxTranslations()
+		tr  = t.pot.GetDomain().GetTranslations()
+		ctr = t.pot.GetDomain().GetCtxTranslations()
 	)
 
 	for key, entry := range t.uniqueKeys {
diff --git a/translator_test.go b/translator_test.go
@@ -1,6 +1,8 @@
 package translator
 
-import "testing"
+import (
+	"testing"
+)
 
 var (
 	translationsDir = "test_translations"
@@ -97,6 +99,34 @@ func TestTlFunction(t *testing.T) {
 	}
 }
 
+func TestTlFunctionWithArgs(t *testing.T) {
+	translator := NewTranslator(translationsDir, templateDir)
+	err := translator.AddLanguage(lang)
+	if err != nil {
+		t.Errorf("AddLanguage() error = %v", err)
+	}
+
+	loc := mockLocalizer{locale: lang}
+
+	tests := []struct {
+		key      string
+		expected string
+		args     []any
+	}{
+		{"First translation text with %s", "First translation text with args", []any{"args"}},
+		{"Second translation text with %s", "Second translation text with args", []any{"args"}},
+		{"Third translation text with %s", "Third translation text with args", []any{"args"}},
+		{"Non-existent text with %s", "*Non-existent text with %s*", []any{"args"}}, // Assuming the behavior for non-translated text
+	}
+
+	for _, tt := range tests {
+		result := translator.tl(loc, tt.key, tt.args...)
+		if result != tt.expected {
+			t.Errorf("tl() for key '%s' = %s, want %s", tt.key, result, tt.expected)
+		}
+	}
+}
+
 func TestTlFunctionNL(t *testing.T) {
 	translator := NewTranslator(translationsDir, templateDir)
 	err := translator.AddLanguage(langNL)
@@ -152,7 +182,7 @@ func TestTnFunction(t *testing.T) {
 	}
 }
 
-func TestTnFunctionMultiplural(t *testing.T) {
+func TestTnFunctionMultiPlural(t *testing.T) {
 	translator := NewTranslator("test_translations", "")
 	err := translator.AddLanguage(multiplural)
 	if err != nil {
@@ -166,12 +196,12 @@ func TestTnFunctionMultiplural(t *testing.T) {
 		plural   string
 		count    int
 		expected string
-		vars     []interface{}
+		vars     []any
 	}{
 		{"There is one apple", "There are many apples", 1, "C'è una mela", nil},
 		{"There is one apple", "There are many apples", 2, "Ci sono due mele", nil},
-		{"There is one apple", "There are %d apples", 0, "Ci sono 0 mele", []interface{}{0}},
-		{"There is one apple", "There are %d apples", 5, "Ci sono 5 mele", []interface{}{5}},
+		{"There is one apple", "There are %d apples", 0, "Ci sono 0 mele", []any{0}},
+		{"There is one apple", "There are %d apples", 5, "Ci sono 5 mele", []any{5}},
 		// Add more test cases as needed
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`	`)`
`6`	`6`
`7`	`7`	`// Tl translates a string based on the given language tag and key.`
`8`		`-func (t *Translator) tl(loc Localizer, key string, args ...interface{}) string {`
	`8`	`+func (t *Translator) tl(loc Localizer, key string, args ...any) string {`
`9`	`9`	`translator, exists := t.languages[loc.GetLocale()]`
`10`	`10`	`if !exists {`
`11`	`11`	`return fmt.Sprintf(DefaultNoTranslationTL, key)`
`@@ -24,11 +24,11 @@ func (t *Translator) tl(loc Localizer, key string, args ...interface{}) string {`
`24`	`24`	`return fmt.Sprintf(DefaultNoTranslationTL, key)`
`25`	`25`	`}`
`26`	`26`
`27`		`- translated := translator.Get(key, args...)`
	`27`	`+ translated := translator.Get(fmt.Sprintf("%s", key), args...) //nolint:gosimple`
`28`	`28`	`return t.removePrefix(translated)`
`29`	`29`	`}`
`30`	`30`
`31`		`-func (t *Translator) ctl(loc Localizer, ctx, key string, args ...interface{}) string {`
	`31`	`+func (t *Translator) ctl(loc Localizer, ctx, key string, args ...any) string {`
`32`	`32`	`translator, exists := t.languages[loc.GetLocale()]`
`33`	`33`	`if !exists {`
`34`	`34`	`return fmt.Sprintf(DefaultNoTranslationCTL, ctx, key)`
`@@ -55,7 +55,7 @@ func (t *Translator) ctl(loc Localizer, ctx, key string, args ...interface{}) st`
`55`	`55`	`return fmt.Sprintf(DefaultNoTranslationCTL, ctx, key)`
`56`	`56`	`}`
`57`	`57`
`58`		`- translated := translator.GetC(key, ctx, args...)`
	`58`	`+ translated := translator.GetC(fmt.Sprintf("%s", key), ctx, args...) //nolint:gosimple`
`59`	`59`	`return t.removePrefix(translated)`
`60`	`60`	`}`
`61`	`61`
`@@ -111,7 +111,7 @@ func (t *Translator) ctn(loc Localizer, ctx, singular, plural string, n int, arg`
`111`	`111`	`}`
`112`	`112`
`113`	`113`	`// Tl translates a string based on the given language tag and key.`
`114`		`-func (t *Translator) Tl(loc Localizer, key string, args ...interface{}) string {`
	`114`	`+func (t *Translator) Tl(loc Localizer, key string, args ...any) string {`
`115`	`115`	`return t.tl(loc, key, args...)`
`116`	`116`	`}`
`117`	`117`
`@@ -121,7 +121,7 @@ func (t *Translator) Tn(loc Localizer, singular, plural string, n int) string {`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`// Ctl method for handling string translation with context`
`124`		`-func (t *Translator) Ctl(loc Localizer, ctx, key string, args ...interface{}) string {`
	`124`	`+func (t *Translator) Ctl(loc Localizer, ctx, key string, args ...any) string {`
`125`	`125`	`return t.ctl(loc, ctx, key, args...)`
`126`	`126`	`}`
`127`	`127`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@ package translator`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"fmt"`
`5`		`- "github.com/donseba/gotext"`
`6`	`5`	`"testing"`
`7`	`6`	`)`
`8`	`7`
`@@ -15,7 +14,6 @@ func TestTranslator_SetTL(t *testing.T) {`
`15`	`14`	`type fields struct {`
`16`	`15`	`translationsDir string`
`17`	`16`	`templateDir string`
`18`		`- languages map[string]*gotext.Po`
`19`	`17`	`uniqueKeys map[string]uniqueKey`
`20`	`18`	`uniqueKeysCtx map[string]map[string]uniqueKey`
`21`	`19`	`}`
`@@ -114,7 +112,7 @@ func TestTranslator_SetTL(t *testing.T) {`
`114`	`112`	`}`
`115`	`113`	`}`
`116`	`114`
`117`		`- tls := tr.languages[tt.lang].GetTranslations()`
	`115`	`+ tls := tr.languages[tt.lang].GetDomain().GetTranslations()`
`118`	`116`	`for _, tl := range tls {`
`119`	`117`	`fmt.Printf("%+v\n", tl)`
`120`	`118`	`}`