experimental approach for localisation of report

env/env.go

@@ -33,6 +33,7 @@ const (
 	GaugeReportsDirEnvName      = "gauge_reports_dir" // directory where reports are generated by plugins
 	OverwriteReportsEnvProperty = "overwrite_reports"
 	UseNestedSpecs              = "use_nested_specs"
+	ReportLocalisation          = "report_localisation"
 )
 
 func GetCurrentExecutableDir() (string, string) {
@@ -64,6 +65,14 @@ func GetProjectRoot() string {
 	return projectRoot
 }
 
+func GetLocale() string {
+	locale := os.Getenv(ReportLocalisation)
+	if locale == "" {
+		return "en"
+	}
+	return locale
+}
+
 func AddDefaultPropertiesToProject() {
 	defaultPropertiesFile := getDefaultPropertiesFile()
 
@@ -77,11 +86,16 @@ func AddDefaultPropertiesToProject() {
 		Name:         OverwriteReportsEnvProperty,
 		DefaultValue: "true"})
 
+	reportLocalisationProperty := &(common.Property{
+		Comment:      "The localisation used for the report. Defaults to 'en'",
+		Name:         ReportLocalisation,
+		DefaultValue: "en"})
+
 	if !common.FileExists(defaultPropertiesFile) {
 		fmt.Printf("Failed to setup html report plugin in project. Default properties file does not exist at %s. \n", defaultPropertiesFile)
 		return
 	}
-	if err := common.AppendProperties(defaultPropertiesFile, reportsDirProperty, overwriteReportProperty); err != nil {
+	if err := common.AppendProperties(defaultPropertiesFile, reportsDirProperty, overwriteReportProperty, reportLocalisationProperty); err != nil {
 		fmt.Printf("Failed to setup html report plugin in project: %s \n", err)
 		return
 	}

generator/generate.go

@@ -287,6 +287,16 @@ func readTemplates(themePath string) {
 		return r
 	}
 
+	localFile := env.GetLocale() + ".properties"
+	config, err := ReadPropertiesFile(filepath.Join(getAbsThemePath(themePath), "localisation", localFile))
+	if err != nil {
+		log.Fatalf(err.Error())
+	}
+
+	var localise = func(s string) string {
+		return config[s]
+	}
+
 	var funcs = template.FuncMap{
 		"parseMarkdown":       parseMarkdown,
 		"sanitize":            sanitizeHTML,
@@ -309,6 +319,7 @@ func readTemplates(themePath string) {
 		"stringToUpper":       strings.ToUpper,
 		"stringToTitle":       strings.ToTitle,
 		"sum":                 sum,
+		"localised":           localise,
 	}
 
 	f, err := ioutil.ReadFile(filepath.Join(getAbsThemePath(themePath), "views", "partials.tmpl"))

generator/properties.go

@@ -0,0 +1,45 @@
+package generator
+
+import (
+	"bufio"
+	"log"
+	"os"
+	"strings"
+)
+
+type AppConfigProperties map[string]string
+
+func ReadPropertiesFile(filename string) (AppConfigProperties, error) {
+	config := AppConfigProperties{}
+
+	if len(filename) == 0 {
+		return config, nil
+	}
+	file, err := os.Open(filename)
+	if err != nil {
+		log.Fatal(err)
+		return nil, err
+	}
+	defer file.Close()
+
+	scanner := bufio.NewScanner(file)
+	for scanner.Scan() {
+		line := scanner.Text()
+		if equal := strings.Index(line, "="); equal >= 0 {
+			if key := strings.TrimSpace(line[:equal]); len(key) > 0 {
+				value := ""
+				if len(line) > equal {
+					value = strings.TrimSpace(line[equal+1:])
+				}
+				config[key] = value
+			}
+		}
+	}
+
+	if err := scanner.Err(); err != nil {
+		log.Fatal(err)
+		return nil, err
+	}
+
+	return config, nil
+}

themes/default/localisation/de.properties

@@ -0,0 +1 @@
+generated_on = Erstellt am

themes/default/localisation/en.properties

@@ -0,0 +1 @@
+generated_on = Generated On

themes/default/views/partials.tmpl

@@ -71,7 +71,7 @@
           <span>{{.ExecutionTime}}</span>
         </li>
         <li>
-          <label>Generated On </label>
+          <label>{{(localised "generated_on")}}</label>
           <span>{{.Timestamp}}</span>
         </li>
       </ul>