fix(core): marshal map in sections

* when calling Marshal with sections in options, the map kind was not correctly handled because the map marshaling occured only inside the struct case

Author: Gnoale

core/human/marshal.go

@@ -45,7 +45,6 @@ func Marshal(data interface{}, opt *MarshalOpt) (string, error) {
 	}
 
 	rType := rValue.Type()
-
 	// safely get the marshalerFunc
 	marshalerFunc, _ := getMarshalerFunc(rType)
 	isNil := isInterfaceNil(data)
@@ -84,6 +83,9 @@ func Marshal(data interface{}, opt *MarshalOpt) (string, error) {
 	case rType.Kind() == reflect.Struct:
 		return marshalStruct(rValue, opt)
 
+	case rType.Kind() == reflect.Map:
+		return MarshalMap(rValue, opt)
+
 	// by default we use defaultMarshalerFunc
 	default:
 		return defaultMarshalerFunc(rValue.Interface(), opt)
@@ -481,3 +483,40 @@ func getDefaultFieldsOpt(t reflect.Type) []*MarshalFieldOpt {
 
 	return results
 }
+
+func MarshalMap(m reflect.Value, opt *MarshalOpt) (string, error) {
+	buffer := bytes.Buffer{}
+
+	w := tabwriter.NewWriter(&buffer, 5, 1, colPadding, ' ', tabwriter.ANSIGraphicsRendition)
+
+	mapKeys := m.MapKeys()
+	sort.Slice(mapKeys, func(i, j int) bool {
+		return mapKeys[i].String() < mapKeys[j].String()
+	})
+
+	for _, mapKey := range mapKeys {
+		mapValue := m.MapIndex(mapKey)
+
+		if mapValue.Type().Kind() == reflect.Slice {
+			sort.Slice(mapValue.Interface(), func(i, j int) bool {
+				return mapValue.Index(i).String() < mapValue.Index(j).String()
+			})
+			sliceLen := mapValue.Len()
+			values := make([]string, sliceLen)
+			for i := range sliceLen {
+				values[i] = fmt.Sprint(mapValue.Index(i).Interface())
+			}
+			fmt.Fprintf(w, "%s\t%s\n", mapKey.String(), strings.Join(values, " "))
+		} else {
+			content, err := Marshal(mapValue.Interface(), opt)
+			if err != nil {
+				return "", err
+			}
+			fmt.Fprintf(w, "%s\t%s\n", mapKey.String(), content)
+		}
+	}
+
+	w.Flush()
+
+	return strings.TrimSpace(buffer.String()), nil
+}

core/human/marshal_test.go

@@ -152,13 +152,15 @@ func TestMarshal(t *testing.T) {
 		`,
 	}))
 
-	t.Run("structWithTitle", run(&testCase{
+	t.Run("structWithMapsInSection", run(&testCase{
 		opt: &human.MarshalOpt{
 			Sections: []*human.MarshalSection{
 				{
-					Title:     "MapStringList",
 					FieldName: "MapStringList",
 				},
+				{
+					FieldName: "Map",
+				},
 			},
 		},
 		data: &Struct{
@@ -188,32 +190,34 @@ func TestMarshal(t *testing.T) {
 			Bytes:       []byte{0, 1},
 		},
 		result: `
-			String                This is a string
-			Int                   42
-			Bool                  true
-			Strings.0             s1
-			Strings.1             s2
-			Time                  ` + humanDate + `
-			Struct.String         -
-			Struct.Int            0
-			Struct.Bool           false
-			Struct.Time           a long while ago
-			Struct.Stringer       a stringer
-			Structs.0.String      Nested string
-			Structs.0.Int         0
-			Structs.0.Bool        false
-			Structs.0.Time        a long while ago
-			Structs.0.Stringer    a stringer
-			Map.key1              v1
-			Map.key2              v2
-			Stringer              a stringer
-			StringerPtr           a stringer
-			Size                  13 kB
-			Bytes                 AAE=
+			String              This is a string
+			Int                 42
+			Bool                true
+			Strings.0           s1
+			Strings.1           s2
+			Time                34 years ago
+			Struct.String       -
+			Struct.Int          0
+			Struct.Bool         false
+			Struct.Time         a long while ago
+			Struct.Stringer     a stringer
+			Structs.0.String    Nested string
+			Structs.0.Int       0
+			Structs.0.Bool      false
+			Structs.0.Time      a long while ago
+			Structs.0.Stringer  a stringer
+			Stringer            a stringer
+			StringerPtr         a stringer
+			Size                13 kB
+			Bytes               AAE=
 
-			MapStringList:
+			Map String List:
 			key1  v1 v2
 			key2  v3 v4
+
+			Map:
+			key1  v1
+			key2  v2
 		`,
 	}))