fixes, i18n, sitemap generator and new examples

Former-commit-id: 54801dc705ee0fa66232f65063f8a68c9cc31921

_examples/i18n/hosts

@@ -0,0 +1,26 @@
+# Copyright (c) 1993-2009 Microsoft Corp.
+#
+# This is a sample HOSTS file used by Microsoft TCP/IP for Windows.
+#
+# This file contains the mappings of IP addresses to host names. Each
+# entry should be kept on an individual line. The IP address should
+# be placed in the first column followed by the corresponding host name.
+# The IP address and the host name should be separated by at least one
+# space.
+#
+# Additionally, comments (such as these) may be inserted on individual
+# lines or following the machine name denoted by a '#' symbol.
+#
+# For example:
+#
+#      102.54.94.97     rhino.acme.com          # source server
+#       38.25.63.10     x.acme.com              # x client host
+
+# localhost name resolution is handled within DNS itself.
+#	127.0.0.1       localhost
+#	::1             localhost
+127.0.0.1		mydomain.com
+127.0.0.1		en.mydomain.com
+127.0.0.1		el.mydomain.com
+127.0.0.1		el-gr.mydomain.com
+127.0.0.1		zh.mydomain.com

_examples/i18n/locales/el-GR/locale_el-GR.ini

@@ -0,0 +1 @@
+hi = γεια, %s

_examples/i18n/locales/el-GR/locale_multi_first_el-GR.ini

@@ -0,0 +1 @@
+key1 = αυτό είναι μια τιμή από το πρώτο αρχείο: locale_multi_first

_examples/i18n/locales/el-GR/locale_multi_second_el-GR.ini

@@ -0,0 +1 @@
+key2 = αυτό είναι μια τιμή από το δεύτερο αρχείο μετάφρασης: locale_multi_second

_examples/i18n/locales/en-US/locale_en-US.ini

@@ -0,0 +1 @@
+hi = hello, %s

_examples/i18n/locales/en-US/locale_multi_first_en-US.ini

@@ -0,0 +1 @@
+key1 = this is a value from the first file: locale_multi_first

_examples/i18n/locales/en-US/locale_multi_second_en-US.ini

@@ -0,0 +1 @@
+key2 = this is a value from the second file: locale_multi_second

_examples/i18n/locales/zh-CN/locale_zh-CN.ini

@@ -0,0 +1 @@
+hi = 您好，%s

_examples/i18n/main.go

@@ -0,0 +1,82 @@
+package main
+
+import (
+	"github.com/kataras/iris/v12"
+)
+
+func newApp() *iris.Application {
+	app := iris.New()
+
+	// Configure i18n.
+	// First parameter: Glob filpath patern,
+	// Second variadic parameter: Optional language tags, the first one is the default/fallback one.
+	app.I18n.Load("./locales/*/*.ini", "en-US", "el-GR", "zh-CN")
+	// app.I18n.LoadAssets for go-bindata.
+
+	// Default values:
+	// app.I18n.URLParameter = "lang"
+	// app.I18n.Subdomain = true
+	//
+	// Set to false to disallow path (local) redirects,
+	// see https://github.com/kataras/iris/issues/1369.
+	// app.I18n.PathRedirect = true
+
+	app.Get("/", func(ctx iris.Context) {
+		hi := ctx.Tr("hi", "iris")
+
+		locale := ctx.GetLocale()
+
+		ctx.Writef("From the language %s translated output: %s", locale.Language(), hi)
+	})
+
+	app.Get("/some-path", func(ctx iris.Context) {
+		ctx.Writef("%s", ctx.Tr("hi", "iris"))
+	})
+
+	app.Get("/other", func(ctx iris.Context) {
+		language := ctx.GetLocale().Language()
+
+		fromFirstFileValue := ctx.Tr("key1")
+		fromSecondFileValue := ctx.Tr("key2")
+		ctx.Writef("From the language: %s, translated output:\n%s=%s\n%s=%s",
+			language, "key1", fromFirstFileValue,
+			"key2", fromSecondFileValue)
+	})
+
+	// using in inside your views:
+	view := iris.HTML("./views", ".html")
+	app.RegisterView(view)
+
+	app.Get("/templates", func(ctx iris.Context) {
+		ctx.View("index.html", iris.Map{
+			"tr": ctx.Tr, // word, arguments... {call .tr "hi" "iris"}}
+		})
+
+		// Note that,
+		// Iris automatically adds a "tr" global template function as well,
+		// the only differene is the way you call it inside your templates and
+		// that it accepts a language code as its first argument: {{ tr "el-GR" "hi" "iris"}}
+	})
+	//
+
+	return app
+}
+
+func main() {
+	app := newApp()
+
+	// go to http://localhost:8080/el-gr/some-path (by path prefix)
+	// or http://el.mydomain.com8080/some-path (by subdomain - test locally with the hosts file)
+	// or http://localhost:8080/zh-CN/templates (by path prefix with uppercase)
+	// or http://localhost:8080/some-path?lang=el-GR (by url parameter)
+	// or http://localhost:8080 (default is en-US)
+	// or http://localhost:8080/?lang=zh-CN
+	//
+	// go to http://localhost:8080/other?lang=el-GR
+	// or http://localhost:8080/other (default is en-US)
+	// or http://localhost:8080/other?lang=en-US
+	//
+	// or use cookies to set the language.
+	//
+	app.Run(iris.Addr(":8080"), iris.WithSitemap("http://localhost:8080"))
+}

_examples/i18n/main_test.go

@@ -0,0 +1,86 @@
+package main
+
+import (
+	"fmt"
+	"strings"
+	"testing"
+
+	"github.com/kataras/iris/v12/httptest"
+)
+
+func TestI18n(t *testing.T) {
+	app := newApp()
+
+	const (
+		expectedf = "From the language %s translated output: %s"
+
+		enUS = "hello, iris"
+		elGR = "γεια, iris"
+		zhCN = "您好，iris"
+	)
+
+	var (
+		tests = map[string]string{
+			"en-US": fmt.Sprintf(expectedf, "en-US", enUS),
+			"el-GR": fmt.Sprintf(expectedf, "el-GR", elGR),
+			"zh-CN": fmt.Sprintf(expectedf, "zh-CN", zhCN),
+		}
+
+		elgrMulti = fmt.Sprintf("From the language: %s, translated output:\n%s=%s\n%s=%s", "el-GR",
+			"key1",
+			"αυτό είναι μια τιμή από το πρώτο αρχείο: locale_multi_first",
+			"key2",
+			"αυτό είναι μια τιμή από το δεύτερο αρχείο μετάφρασης: locale_multi_second")
+		enusMulti = fmt.Sprintf("From the language: %s, translated output:\n%s=%s\n%s=%s", "en-US",
+			"key1",
+			"this is a value from the first file: locale_multi_first",
+			"key2",
+			"this is a value from the second file: locale_multi_second")
+	)
+
+	e := httptest.New(t, app)
+	// default should be en-US.
+	e.GET("/").Expect().Status(httptest.StatusOK).Body().Equal(tests["en-US"])
+
+	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("/other").WithQueryString("lang=el-GR").Expect().Status(httptest.StatusOK).
+		Body().Equal(elgrMulti)
+	e.GET("/other").WithQueryString("lang=en-US").Expect().Status(httptest.StatusOK).
+		Body().Equal(enusMulti)
+
+	// test path prefix (i18n router wrapper).
+	e.GET("/el-gr/other").Expect().Status(httptest.StatusOK).
+		Body().Equal(elgrMulti)
+	e.GET("/en/other").Expect().Status(httptest.StatusOK).
+		Body().Equal(enusMulti)
+
+	e.GET("/el-GRtemplates").Expect().Status(httptest.StatusNotFound)
+	e.GET("/el-templates").Expect().Status(httptest.StatusNotFound)
+
+	e.GET("/el/templates").Expect().Status(httptest.StatusOK).Body().Contains(elGR).Contains(zhCN)
+}

_examples/i18n/views/index.html

@@ -0,0 +1,9 @@
+<h3>Test translate current locale template function <i>[dynamic]</i> ("word", arguments...) <br/> <code>call .tr "hi" "iris"</code></h3>
+
+{{call .tr "hi" "iris"}}
+
+<hr/>
+
+<h3>Test translate of any language template function <i>[static]</i> ("language", "word", arguments...) <br/> <code>tr "zh-CN" "hi" "iris"</code></h3>
+
+{{tr "zh-CN" "hi" "iris"}}