Put the creation and sorting of sectioned Value Rows in its own functions

This looks better, because we shouldn't create a table in a sorting function

Author: Constantin

pkg/document/model.go

@@ -40,43 +40,14 @@ type section struct {
 	SectionItems []valueRow
 }
 
-func sortValueRows(valueRows []valueRow) ([]valueRow, []section) {
+func sortValueRows(valueRows []valueRow) {
 	sortOrder := viper.GetString("sort-values-order")
 
 	if sortOrder != FileSortOrder && sortOrder != AlphaNumSortOrder {
 		log.Warnf("Invalid sort order provided %s, defaulting to %s", sortOrder, AlphaNumSortOrder)
 		sortOrder = AlphaNumSortOrder
 	}
 
-	var valueRowsSectionSorted []section
-	valueRowsSectionSorted = append(valueRowsSectionSorted, section{
-		SectionName:  "General",
-		SectionItems: []valueRow{},
-	})
-
-	for _, row := range valueRows {
-		if row.Section == "" {
-			valueRowsSectionSorted[0].SectionItems = append(valueRowsSectionSorted[0].SectionItems, row)
-			continue
-		}
-
-		containsSection := false
-		for i, section := range valueRowsSectionSorted {
-			if section.SectionName == row.Section {
-				containsSection = true
-				valueRowsSectionSorted[i].SectionItems = append(valueRowsSectionSorted[i].SectionItems, row)
-				break
-			}
-		}
-
-		if !containsSection {
-			valueRowsSectionSorted = append(valueRowsSectionSorted, section{
-				SectionName:  row.Section,
-				SectionItems: []valueRow{row},
-			})
-		}
-	}
-
 	sort.Slice(valueRows, func(i, j int) bool {
 		// Globals sort above non-globals.
 		if valueRows[i].IsGlobal != valueRows[j].IsGlobal {
@@ -109,8 +80,17 @@ func sortValueRows(valueRows []valueRow) ([]valueRow, []section) {
 			panic("cannot get here")
 		}
 	})
+}
+
+func sortSectionedValueRows(sectionedValueRows []section) {
+	sortOrder := viper.GetString("sort-values-order")
+
+	if sortOrder != FileSortOrder && sortOrder != AlphaNumSortOrder {
+		log.Warnf("Invalid sort order provided %s, defaulting to %s", sortOrder, AlphaNumSortOrder)
+		sortOrder = AlphaNumSortOrder
+	}
 
-	for _, section := range valueRowsSectionSorted {
+	for _, section := range sectionedValueRows {
 		sort.Slice(section.SectionItems, func(i, j int) bool {
 			// Globals sort above non-globals.
 			if section.SectionItems[i].IsGlobal != section.SectionItems[j].IsGlobal {
@@ -144,7 +124,6 @@ func sortValueRows(valueRows []valueRow) ([]valueRow, []section) {
 			}
 		})
 	}
-	return valueRows, valueRowsSectionSorted
 }
 
 func getUnsortedValueRows(document *yaml.Node, descriptions map[string]helm.ChartValueDescription) ([]valueRow, error) {
@@ -164,6 +143,39 @@ func getUnsortedValueRows(document *yaml.Node, descriptions map[string]helm.Char
 	return createValueRowsFromField("", nil, document.Content[0], descriptions, true)
 }
 
+func getUnsortedSectionedValueRows(valueRows []valueRow) []section {
+	var valueRowsSectionSorted []section
+	valueRowsSectionSorted = append(valueRowsSectionSorted, section{
+		SectionName:  "General",
+		SectionItems: []valueRow{},
+	})
+
+	for _, row := range valueRows {
+		if row.Section == "" {
+			valueRowsSectionSorted[0].SectionItems = append(valueRowsSectionSorted[0].SectionItems, row)
+			continue
+		}
+
+		containsSection := false
+		for i, section := range valueRowsSectionSorted {
+			if section.SectionName == row.Section {
+				containsSection = true
+				valueRowsSectionSorted[i].SectionItems = append(valueRowsSectionSorted[i].SectionItems, row)
+				break
+			}
+		}
+
+		if !containsSection {
+			valueRowsSectionSorted = append(valueRowsSectionSorted, section{
+				SectionName:  row.Section,
+				SectionItems: []valueRow{row},
+			})
+		}
+	}
+
+	return valueRowsSectionSorted
+}
+
 func getChartTemplateData(info helm.ChartDocumentationInfo, helmDocsVersion string, dependencyValues []DependencyValues) (chartTemplateData, error) {
 	valuesTableRows, err := getUnsortedValueRows(info.ChartValues, info.ChartValuesDescriptions)
 	if err != nil {
@@ -206,7 +218,9 @@ func getChartTemplateData(info helm.ChartDocumentationInfo, helmDocsVersion stri
 		}
 	}
 
-	valueRowsSorted, valueRowsSectionSorted := sortValueRows(valuesTableRows)
+	sortValueRows(valuesTableRows)
+	valueRowsSectionSorted := getUnsortedSectionedValueRows(valuesTableRows)
+	sortSectionedValueRows(valueRowsSectionSorted)
 
 	files, err := getFiles(info.ChartDirectory)
 	if err != nil {
@@ -216,7 +230,7 @@ func getChartTemplateData(info helm.ChartDocumentationInfo, helmDocsVersion stri
 	return chartTemplateData{
 		ChartDocumentationInfo: info,
 		HelmDocsVersion:        helmDocsVersion,
-		Values:                 valueRowsSorted,
+		Values:                 valuesTableRows,
 		Sections:               valueRowsSectionSorted,
 		Files:                  files,
 	}, nil

pkg/document/values_test.go

@@ -19,9 +19,9 @@ func getSortedValuesTableRows(helmValues *yaml.Node, descriptions map[string]hel
 		return nil, err
 	}
 
-	valueRowsSorted, _ := sortValueRows(valueRows)
+	sortValueRows(valueRows)
 
-	return valueRowsSorted, nil
+	return valueRows, nil
 }
 
 func parseYamlValues(yamlValues string) *yaml.Node {