add tests for #1369 and various improvements

Former-commit-id: 2fe1f077cf5b6a0fb32a27cf86462fea776a7d58

_examples/miscellaneous/i18n/main.go

@@ -5,25 +5,29 @@ import (
 	"github.com/kataras/iris/v12/middleware/i18n"
 )
 
+var i18nConfig = i18n.Config{
+	Default:       "en-US",
+	URLParameter:  "lang", // optional.
+	PathParameter: "lang", // optional.
+	Languages: map[string]string{
+		"en-US": "./locales/locale_en-US.ini", // maps to en-US, en-us and en.
+		"el-GR": "./locales/locale_el-GR.ini", // maps to el-GR, el-gr and el.
+		"zh-CN": "./locales/locale_zh-CN.ini", // maps to zh-CN, zh-cn and zh.
+	},
+	Alternatives: map[string]string{ // optional.
+		"english": "en-US", // now english maps to en-US
+		"greek":   "el-GR", // and greek to el-GR
+		"chinese": "zh-CN", // and chinese to zh-CN too.
+	},
+}
+
 func newApp() *iris.Application {
 	app := iris.New()
-	app.Logger().SetLevel("debug")
-
-	i18nConfig := i18n.Config{
-		Default:       "en-US",
-		URLParameter:  "lang",
-		PathParameter: "lang",
-		Languages: map[string]string{
-			"en-US": "./locales/locale_en-US.ini",
-			"el-GR": "./locales/locale_el-GR.ini",
-			"zh-CN": "./locales/locale_zh-CN.ini",
-		},
-		Alternatives: map[string]string{"greek": "el-GR"},
-	}
 
 	// See https://github.com/kataras/iris/issues/1369
-	// if you want to enable this (SEO) feature.
-	app.WrapRouter(i18n.NewWrapper(i18nConfig))
+	// if you want to enable this (SEO) feature (OPTIONAL).
+	i18nWrapper := i18n.NewWrapper(i18nConfig)
+	app.WrapRouter(i18nWrapper)
 
 	i18nMiddleware := i18n.New(i18nConfig)
 	app.Use(i18nMiddleware)
@@ -37,12 +41,10 @@ func newApp() *iris.Application {
 		// it tries to find the language by the "language" cookie
 		// if didn't found then it it set to the Default set on the configuration
 
-		// hi is the key, 'iris' is the %s on the .ini file
+		// hi is the key/word, 'iris' is the %s on the .ini file
 		// the second parameter is optional
 
-		// hi := ctx.Translate("hi", "iris")
-		// or:
-		hi := i18n.Translate(ctx, "hi", "iris")
+		hi := ctx.Translate("hi", "iris")
 
 		// GetTranslateLanguageContextKey() == "language"
 		language := ctx.Values().GetString(ctx.Application().ConfigurationReadOnly().GetTranslateLanguageContextKey())
@@ -61,6 +63,9 @@ func newApp() *iris.Application {
 		ctx.WriteString("sitemap")
 	})
 
+	// Note: It is highly recommended to use one and no more i18n middleware instances at a time,
+	// the first one was already passed by `app.Use` above.
+	// This middleware which registers on "/multi" route is here just for the shake of the example.
 	multiLocale := i18n.New(i18n.Config{
 		Default:      "en-US",
 		URLParameter: "lang",
@@ -73,8 +78,8 @@ func newApp() *iris.Application {
 	app.Get("/multi", multiLocale, func(ctx iris.Context) {
 		language := ctx.Values().GetString(ctx.Application().ConfigurationReadOnly().GetTranslateLanguageContextKey())
 
-		fromFirstFileValue := i18n.Translate(ctx, "key1")
-		fromSecondFileValue := i18n.Translate(ctx, "key2")
+		fromFirstFileValue := ctx.Translate("key1")
+		fromSecondFileValue := ctx.Translate("key2")
 		ctx.Writef("From the language: %s, translated output:\n%s=%s\n%s=%s",
 			language, "key1", fromFirstFileValue,
 			"key2", fromSecondFileValue)

_examples/miscellaneous/i18n/main_test.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+	"strings"
 	"testing"
 
 	"github.com/kataras/iris/v12/httptest"
@@ -12,9 +13,11 @@ func TestI18n(t *testing.T) {
 
 	expectedf := "From the language %s translated output: %s"
 	var (
-		elgr = fmt.Sprintf(expectedf, "el-GR", "γεια, iris")
-		enus = fmt.Sprintf(expectedf, "en-US", "hello, iris")
-		zhcn = fmt.Sprintf(expectedf, "zh-CN", "您好，iris")
+		tests = map[string]string{
+			"en-US": fmt.Sprintf(expectedf, "en-US", "hello, iris"),
+			"el-GR": fmt.Sprintf(expectedf, "el-GR", "γεια, iris"),
+			"zh-CN": fmt.Sprintf(expectedf, "zh-CN", "您好，iris"),
+		}
 
 		elgrMulti = fmt.Sprintf("From the language: %s, translated output:\n%s=%s\n%s=%s", "el-GR",
 			"key1",
@@ -29,20 +32,43 @@ func TestI18n(t *testing.T) {
 	)
 
 	e := httptest.New(t, app)
-	// default is en-US
-	e.GET("/").Expect().Status(httptest.StatusOK).Body().Equal(enus)
-	// default is en-US if lang query unable to be found
-	e.GET("/").Expect().Status(httptest.StatusOK).Body().Equal(enus)
+	// default should be en-US.
+	e.GET("/").Expect().Status(httptest.StatusOK).Body().Equal(tests["en-US"])
 
-	e.GET("/").WithQueryString("lang=el-GR").Expect().Status(httptest.StatusOK).
-		Body().Equal(elgr)
-	e.GET("/").WithQueryString("lang=en-US").Expect().Status(httptest.StatusOK).
-		Body().Equal(enus)
-	e.GET("/").WithQueryString("lang=zh-CN").Expect().Status(httptest.StatusOK).
-		Body().Equal(zhcn)
+	for lang, body := range tests {
+		e.GET("/").WithQueryString("lang=" + lang).Expect().Status(httptest.StatusOK).
+			Body().Equal(body)
+
+		// test lowercase.
+		e.GET("/").WithQueryString("lang=" + strings.ToLower(lang)).Expect().Status(httptest.StatusOK).
+			Body().Equal(body)
+
+		// test first part (e.g. en instead of en-US).
+		langFirstPart := strings.Split(lang, "-")[0]
+		e.GET("/").WithQueryString("lang=" + langFirstPart).Expect().Status(httptest.StatusOK).
+			Body().Equal(body)
+
+		// test accept-language header prefix (i18n wrapper).
+		e.GET("/"+lang).WithHeader("Accept-Language", lang).Expect().Status(httptest.StatusOK).
+			Body().Equal(body)
+
+		// test path prefix (i18n router wrapper).
+		e.GET("/" + lang).Expect().Status(httptest.StatusOK).
+			Body().Equal(body)
+
+		// test path prefix with first part.
+		e.GET("/" + langFirstPart).Expect().Status(httptest.StatusOK).
+			Body().Equal(body)
+	}
 
 	e.GET("/multi").WithQueryString("lang=el-GR").Expect().Status(httptest.StatusOK).
 		Body().Equal(elgrMulti)
 	e.GET("/multi").WithQueryString("lang=en-US").Expect().Status(httptest.StatusOK).
 		Body().Equal(enusMulti)
+
+	// test path prefix (i18n router wrapper).
+	e.GET("/el-gr/multi").Expect().Status(httptest.StatusOK).
+		Body().Equal(elgrMulti)
+	e.GET("/en/multi").Expect().Status(httptest.StatusOK).
+		Body().Equal(enusMulti)
 }