mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2025-12-30 17:00:57 -06:00
Code Issues Packages Projects Releases Wiki Activity

feat(l10n): support maps

Browse Source 
Signed-off-by: jkoberg <jkoberg@owncloud.com>
This commit is contained in:
jkoberg
2024-08-06 14:20:03 +02:00
parent 58798a18ec
commit be7ef83fca
2 changed files with 249 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

144
ocis-pkg/l10n/l10n.go
View File

@@ -4,7 +4,6 @@ package l10n
import (
"context"
"errors"
"fmt"
"io/fs"
"os"
"reflect"
@@ -70,7 +69,57 @@ func (t Translator) Locale(locale string) *gotext.Locale {
return l
}
// TranslateEntity translates a slice, array or struct
// TranslateEntity function provides the generic way to translate a struct, array or slice.
// Support for maps is also provided, but non-pointer values will not work.
// The function also takes the entity with fields to translate.
// The function supports nested structs and slices of structs.
/*
tr := NewTranslator("en", _domain, _fsys)
// a slice of translatables can be passed directly
val := []string{"description", "display name"}
err := tr.TranslateEntity(tr, s, val)
// string maps work the same way
val := map[string]string{
"entryOne": "description",
"entryTwo": "display name",
}
err := TranslateEntity(tr, val)
// struct fields need to be specified
type Struct struct {
Description string
DisplayName string
MetaInformation string
}
val := Struct{}
err := TranslateEntity(tr, val,
l10n.TranslateField("Description"),
l10n.TranslateField("DisplayName"),
)
// nested structures are supported
type InnerStruct struct {
Description string
Roles []string
}
type OuterStruct struct {
DisplayName string
First InnerStruct
Others map[string]InnerStruct
}
val := OuterStruct{}
err := TranslateEntity(tr, val,
l10n.TranslateField("DisplayName"),
l10n.TranslateStruct("First",
l10n.TranslateField("Description"),
l10n.TranslateEach("Roles"),
),
l10n.TranslateMap("Others",
l10n.TranslateField("Description"),
},
*/
func (t Translator) TranslateEntity(locale string, entity any, opts ...TranslateOption) error {
return TranslateEntity(t.Locale(locale).Get, entity, opts...)
}
@@ -104,7 +153,7 @@ func GetUserLocale(ctx context.Context, userID string, vc settingssvc.ValueServi
return val[0].GetStringValue(), nil
}
// TranslateOption is used to specify fields in structs or slices to translate
// TranslateOption is used to specify fields in structs to translate
type TranslateOption func() (string, FieldType, []TranslateOption)
// FieldType is used to specify the type of field to translate
@@ -143,44 +192,14 @@ func TranslateEach(fieldName string, args ...TranslateOption) TranslateOption {
}
// TranslateMap function provides the generic way to translate the necessary fields in maps.
// It's not implemented yet.
func TranslateMap(fieldName string, args ...TranslateOption) TranslateOption {
return func() (string, FieldType, []TranslateOption) {
return fieldName, FieldTypeMap, args
}
}
// TranslateEntity function provides the generic way to translate the necessary fields in composite entities.
// The function takes a translation function that has the locale already set, see Translator.TranslateEntity
// The function also takes the entity with fields to translate.
// The function supports nested structs and slices of structs.
//
// type InnerStruct struct {
// Description string
// DisplayName *string
// }
//
// type WrapperStruct struct {
// StructList []*InnerStruct
// }
// s:= &WrapperStruct{
// StructList: []*InnerStruct{
// {
// Description: "innerDescription 1",
// DisplayName: toStrPointer("innerDisplayName 1"),
// },
// {
// Description: "innerDescription 2",
// DisplayName: toStrPointer("innerDisplayName 2"),
// },
// },
// }
// tr := l10n_pkg.NewTranslateLocation(loc, "en")
// err := l10n.TranslateEntity(tr, s,
// l10n.TranslateEach("StructList",
// l10n.TranslateField("Description"),
// l10n.TranslateField("DisplayName"),
// ))
// TranslateEntity translates a slice, array or struct
// See Translator.TranslateEntity for more information
func TranslateEntity(tr func(string, ...any) string, entity any, opts ...TranslateOption) error {
value := reflect.ValueOf(entity)
@@ -191,25 +210,15 @@ func TranslateEntity(tr func(string, ...any) string, entity any, opts ...Transla
switch value.Kind() {
case reflect.Struct:
if !isStruct(value) {
return fmt.Errorf("the root entity must be a struct, got %v", value.Kind())
}
rangeOverArgs(tr, value, opts...)
return nil
case reflect.Slice, reflect.Array:
if len(opts) > 0 {
translateEach(tr, value, opts...)
} else {
translateEach(tr, value)
}
return nil
case reflect.Map:
// TODO implement
case reflect.Slice, reflect.Array, reflect.Map:
translateEach(tr, value, opts...)
case reflect.String:
translateField(tr, value)
return nil
default:
return ErrUnsupportedType
}
return ErrUnsupportedType
return nil
}
func translateEach(tr func(string, ...any) string, value reflect.Value, args ...TranslateOption) {
@@ -222,15 +231,30 @@ func translateEach(tr func(string, ...any) string, value reflect.Value, args ...
case reflect.Array, reflect.Slice:
for i := 0; i < value.Len(); i++ {
v := value.Index(i)
if args != nil {
switch v.Kind() {
case reflect.Struct, reflect.Ptr:
rangeOverArgs(tr, v, args...)
continue
case reflect.String:
translateField(tr, v)
case reflect.Slice, reflect.Array, reflect.Map:
translateEach(tr, v, args...)
}
translateField(tr, v)
}
case reflect.Map:
for _, k := range value.MapKeys() {
rangeOverArgs(tr, value.MapIndex(k), args...)
v := value.MapIndex(k)
switch v.Kind() {
case reflect.Struct:
// FIXME: add support for non-pointer values
case reflect.Pointer:
rangeOverArgs(tr, v, args...)
case reflect.String:
if nv := tr(v.String()); nv != "" {
value.SetMapIndex(k, reflect.ValueOf(nv))
}
case reflect.Slice, reflect.Array, reflect.Map:
translateEach(tr, v, args...)
}
}
}
}
@@ -246,18 +270,15 @@ func rangeOverArgs(tr func(string, ...any) string, value reflect.Value, args ...
switch fieldType {
case FieldTypeString:
// exported field
f := value.FieldByName(fieldName)
translateField(tr, f)
case FieldTypeStruct:
// exported field
innerValue := value.FieldByName(fieldName)
if !innerValue.IsValid() || !isStruct(innerValue) {
return
}
rangeOverArgs(tr, innerValue, opts...)
case FieldTypeIterable:
// exported field
innerValue := value.FieldByName(fieldName)
if !innerValue.IsValid() {
return
@@ -266,6 +287,15 @@ func rangeOverArgs(tr func(string, ...any) string, value reflect.Value, args ...
return
}
translateEach(tr, innerValue, opts...)
case FieldTypeMap:
innerValue := value.FieldByName(fieldName)
if !innerValue.IsValid() {
return
}
if kind := innerValue.Kind(); kind != reflect.Map {
return
}
translateEach(tr, innerValue, opts...)
}
}
}

237
ocis-pkg/l10n/l10n_test.go
View File

@@ -28,14 +28,10 @@ func TestTranslateStruct(t *testing.T) {
return &str
}
type args struct {
structPtr []TranslateOption
//request []any
}
tests := []struct {
name string
entity any
args args
args []TranslateOption
expected any
wantErr bool
}{
@@ -51,11 +47,9 @@ func TestTranslateStruct(t *testing.T) {
DisplayName: toStrPointer("innerDisplayName 2"),
},
},
args: args{
structPtr: []TranslateOption{
TranslateField("Description"),
TranslateField("DisplayName"),
},
args: []TranslateOption{
TranslateField("Description"),
TranslateField("DisplayName"),
},
expected: []*InnerStruct{
{
@@ -74,7 +68,6 @@ func TestTranslateStruct(t *testing.T) {
"inner 1",
"inner 2",
},
args: args{},
expected: []string{
"new Inner 1",
"new Inner 2",
@@ -96,15 +89,13 @@ func TestTranslateStruct(t *testing.T) {
DisplayName: toStrPointer("innerDisplayName 2"),
},
},
args: args{
structPtr: []TranslateOption{
args: []TranslateOption{
TranslateField("Description"),
TranslateField("DisplayName"),
TranslateStruct("SubStruct",
TranslateField("Description"),
TranslateField("DisplayName"),
TranslateStruct("SubStruct",
TranslateField("Description"),
TranslateField("DisplayName"),
),
},
),
},
expected: []*TopLevelStruct{
{
@@ -135,13 +126,11 @@ func TestTranslateStruct(t *testing.T) {
},
},
},
args: args{
structPtr: []TranslateOption{
TranslateEach("StructList",
TranslateField("Description"),
TranslateField("DisplayName"),
),
},
args: []TranslateOption{
TranslateEach("StructList",
TranslateField("Description"),
TranslateField("DisplayName"),
),
},
expected: &WrapperStruct{
StructList: []*InnerStruct{
@@ -159,30 +148,26 @@ func TestTranslateStruct(t *testing.T) {
{
name: "empty struct, NotExistingSubStructName",
entity: &TopLevelStruct{},
args: args{
structPtr: []TranslateOption{
args: []TranslateOption{
TranslateField("Description"),
TranslateField("DisplayName"),
TranslateStruct("NotExistingSubStructName",
TranslateField("Description"),
TranslateField("DisplayName"),
TranslateStruct("NotExistingSubStructName",
TranslateField("Description"),
TranslateField("DisplayName"),
),
},
),
},
expected: &TopLevelStruct{},
},
{
name: "empty struct",
entity: &TopLevelStruct{},
args: args{
structPtr: []TranslateOption{
args: []TranslateOption{
TranslateField("Description"),
TranslateField("DisplayName"),
TranslateStruct("SubStruct",
TranslateField("Description"),
TranslateField("DisplayName"),
TranslateStruct("SubStruct",
TranslateField("Description"),
TranslateField("DisplayName"),
),
},
),
},
expected: &TopLevelStruct{},
},
@@ -192,13 +177,11 @@ func TestTranslateStruct(t *testing.T) {
Description: "description",
DisplayName: toStrPointer("displayName"),
},
args: args{
structPtr: []TranslateOption{
args: []TranslateOption{
TranslateField("NotExistingFieldName"),
TranslateStruct("SubStruct",
TranslateField("NotExistingFieldName"),
TranslateStruct("SubStruct",
TranslateField("NotExistingFieldName"),
),
},
),
},
expected: &TopLevelStruct{
Description: "description",
@@ -211,15 +194,13 @@ func TestTranslateStruct(t *testing.T) {
Description: "description",
DisplayName: toStrPointer("displayName"),
},
args: args{
structPtr: []TranslateOption{
args: []TranslateOption{
TranslateField("Description"),
TranslateField("DisplayName"),
TranslateStruct("SubStruct",
TranslateField("Description"),
TranslateField("DisplayName"),
TranslateStruct("SubStruct",
TranslateField("Description"),
TranslateField("DisplayName"),
),
},
),
},
expected: &TopLevelStruct{
Description: "new Description",
@@ -232,15 +213,13 @@ func TestTranslateStruct(t *testing.T) {
Description: "description",
DisplayName: toStrPointer("displayName"),
},
args: args{
structPtr: []TranslateOption{
args: []TranslateOption{
TranslateField("Description"),
TranslateField("DisplayName"),
TranslateStruct("SubStruct",
TranslateField("Description"),
TranslateField("DisplayName"),
TranslateStruct("SubStruct",
TranslateField("Description"),
TranslateField("DisplayName"),
),
},
),
},
expected: &TopLevelStruct{
Description: "new Description",
@@ -257,15 +236,13 @@ func TestTranslateStruct(t *testing.T) {
DisplayName: toStrPointer("innerDisplayName"),
},
},
args: args{
structPtr: []TranslateOption{
args: []TranslateOption{
TranslateField("Description"),
TranslateField("DisplayName"),
TranslateStruct("SubStruct",
TranslateField("Description"),
TranslateField("DisplayName"),
TranslateStruct("SubStruct",
TranslateField("Description"),
TranslateField("DisplayName"),
),
},
),
},
expected: &TopLevelStruct{
Description: "new Description",
@@ -277,23 +254,133 @@ func TestTranslateStruct(t *testing.T) {
},
},
{
name: "nil",
args: args{
structPtr: nil,
},
name: "nil",
wantErr: true,
},
{
name: "empty slice",
args: args{
structPtr: []TranslateOption{},
},
name: "empty slice",
wantErr: true,
},
{
name: "string slice",
entity: []string{"description", "inner"},
expected: []string{"new Description", "new Inner"},
},
{
name: "string map",
entity: map[string]string{
"entryOne": "description",
"entryTwo": "inner",
},
expected: map[string]string{
"entryOne": "new Description",
"entryTwo": "new Inner",
},
},
{
name: "pointer struct map",
entity: map[string]*InnerStruct{
"entryOne": {Description: "description", DisplayName: toStrPointer("displayName")},
"entryTwo": {Description: "inner", DisplayName: toStrPointer("innerDisplayName")},
},
args: []TranslateOption{
TranslateField("Description"),
TranslateField("DisplayName"),
},
expected: map[string]*InnerStruct{
"entryOne": {Description: "new Description", DisplayName: toStrPointer("new DisplayName")},
"entryTwo": {Description: "new Inner", DisplayName: toStrPointer("new InnerDisplayName")},
},
},
/* FIXME: non pointer maps are currently not working
{
name: "struct map",
entity: map[string]InnerStruct{
"entryOne": {Description: "description", DisplayName: toStrPointer("displayName")},
"entryTwo": {Description: "inner", DisplayName: toStrPointer("innerDisplayName")},
},
args: []TranslateOption{
TranslateField("Description"),
TranslateField("DisplayName"),
},
expected: map[string]InnerStruct{
"entryOne": {Description: "new Description", DisplayName: toStrPointer("new DisplayName")},
"entryTwo": {Description: "new Inner", DisplayName: toStrPointer("new InnerDisplayName")},
},
},
*/
{
name: "slice map",
entity: map[string][]string{
"entryOne": {"description", "inner"},
"entryTwo": {"inner 2", "innerDisplayName 2"},
},
expected: map[string][]string{
"entryOne": {"new Description", "new Inner"},
"entryTwo": {"new Inner 2", "new InnerDisplayName 2"},
},
},
{
name: "double slice",
entity: [][]string{
{"description", "inner"},
{"inner 2", "innerDisplayName 2"},
},
expected: [][]string{
{"new Description", "new Inner"},
{"new Inner 2", "new InnerDisplayName 2"},
},
},
{
name: "nested structs",
entity: [][]*InnerStruct{
{
&InnerStruct{Description: "description", DisplayName: toStrPointer("displayName")},
&InnerStruct{Description: "inner", DisplayName: toStrPointer("innerDisplayName")},
},
{
&InnerStruct{Description: "inner 2", DisplayName: toStrPointer("innerDisplayName 2")},
},
},
args: []TranslateOption{
TranslateField("Description"),
TranslateField("DisplayName"),
},
expected: [][]*InnerStruct{
{
&InnerStruct{Description: "new Description", DisplayName: toStrPointer("new DisplayName")},
&InnerStruct{Description: "new Inner", DisplayName: toStrPointer("new InnerDisplayName")},
},
{
&InnerStruct{Description: "new Inner 2", DisplayName: toStrPointer("new InnerDisplayName 2")},
},
},
},
{
name: "double mapslices",
entity: []map[string][]string{
{
"entryOne": {"inner 1", "innerDisplayName 1"},
"entryTwo": {"inner 2", "innerDisplayName 2"},
},
{
"entryOne": {"description", "displayName"},
},
},
expected: []map[string][]string{
{
"entryOne": {"new Inner 1", "new InnerDisplayName 1"},
"entryTwo": {"new Inner 2", "new InnerDisplayName 2"},
},
{
"entryOne": {"new Description", "new DisplayName"},
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := TranslateEntity(mock(), tt.entity, tt.args.structPtr...)
err := TranslateEntity(mock(), tt.entity, tt.args...)
if (err != nil) != tt.wantErr {
t.Errorf("TranslateEntity() error = %v, wantErr %v", err, tt.wantErr)
}