Refactor names in the result package

The change in approach in the result package resulted in some of the use of the term "report" in that package becoming
less intuitive, since reports are only one use of the results.

Author: per1234

check/check.go

@@ -39,18 +39,18 @@ func RunChecks(project project.Type) {
 			fmt.Printf("Running check %s: ", checkConfiguration.ID)
 		}
 		checkResult, checkOutput := checkConfiguration.CheckFunction()
-		reportText := result.Report.Record(project, checkConfiguration, checkResult, checkOutput)
+		reportText := result.Results.Record(project, checkConfiguration, checkResult, checkOutput)
 		if configuration.OutputFormat() == "text" {
 			fmt.Print(reportText)
 		}
 	}
 
 	// Checks are finished for this project, so summarize its check results in the report.
-	result.Report.AddProjectSummaryReport(project)
+	result.Results.AddProjectSummary(project)
 
 	if configuration.OutputFormat() == "text" {
 		// Print the project check results summary.
-		fmt.Print(result.Report.ProjectSummaryText(project))
+		fmt.Print(result.Results.ProjectSummaryText(project))
 	}
 }
 

main.go

@@ -15,7 +15,7 @@ import (
 func main() {
 	configuration.Initialize()
 	// Must be called after configuration.Initialize()
-	result.Report.Initialize()
+	result.Results.Initialize()
 
 	projects, err := project.FindProjects()
 	if err != nil {
@@ -28,24 +28,24 @@ func main() {
 	}
 
 	// All projects have been checked, so summarize their check results in the report.
-	result.Report.AddSummaryReport()
+	result.Results.AddSummary()
 
 	if configuration.OutputFormat() == "text" {
 		if len(projects) > 1 {
 			// There are multiple projects, print the summary of check results for all projects.
-			fmt.Print(result.Report.SummaryText())
+			fmt.Print(result.Results.SummaryText())
 		}
 	} else {
 		// Print the complete JSON formatted report.
-		fmt.Println(result.Report.JSONReport())
+		fmt.Println(result.Results.JSONReport())
 	}
 
 	if configuration.ReportFilePath() != nil {
 		// Write report file.
-		result.Report.WriteReport()
+		result.Results.WriteReport()
 	}
 
-	if !result.Report.Passed() {
+	if !result.Results.Passed() {
 		os.Exit(errorcodes.ErrGeneric)
 	}
 }

result/result.go

@@ -19,11 +19,11 @@ import (
 	"github.com/arduino/go-paths-helper"
 )
 
-// Report is the global instance of the check results ReportType struct
-var Report ReportType
+// Results is the global instance of the check results result.Type struct
+var Results Type
 
-// ReportType is the type for the check results report
-type ReportType struct {
+// Type is the type for the check results data
+type Type struct {
 	Configuration toolConfigurationReportType `json:"configuration"`
 	Projects      []projectReportType         `json:"projects"`
 	Summary       summaryReportType           `json:"summary"`
@@ -67,17 +67,17 @@ type summaryReportType struct {
 	ErrorCount   int  `json:"errorCount"`
 }
 
-// Initialize adds the tool configuration data to the report.
-func (report *ReportType) Initialize() {
-	report.Configuration = toolConfigurationReportType{
+// Initialize adds the tool configuration data to the results data.
+func (results *Type) Initialize() {
+	results.Configuration = toolConfigurationReportType{
 		Paths:       []*paths.Path{configuration.TargetPath()},
 		ProjectType: configuration.SuperprojectTypeFilter().String(),
 		Recursive:   configuration.Recursive(),
 	}
 }
 
 // Record records the result of a check and returns a text summary for it.
-func (report *ReportType) Record(checkedProject project.Type, checkConfiguration checkconfigurations.Type, checkResult checkresult.Type, checkOutput string) string {
+func (results *Type) Record(checkedProject project.Type, checkConfiguration checkconfigurations.Type, checkResult checkresult.Type, checkOutput string) string {
 	checkMessage := message(checkConfiguration.MessageTemplate, checkOutput)
 
 	checkLevel, err := checklevel.CheckLevel(checkConfiguration)
@@ -106,11 +106,11 @@ func (report *ReportType) Record(checkedProject project.Type, checkConfiguration
 		Message:     checkMessage,
 	}
 
-	reportExists, projectReportIndex := report.getProjectReportIndex(checkedProject.Path)
+	reportExists, projectReportIndex := results.getProjectReportIndex(checkedProject.Path)
 	if !reportExists {
 		// There is no existing report for this project.
-		report.Projects = append(
-			report.Projects,
+		results.Projects = append(
+			results.Projects,
 			projectReportType{
 				Path:        checkedProject.Path,
 				ProjectType: checkedProject.ProjectType.String(),
@@ -125,23 +125,23 @@ func (report *ReportType) Record(checkedProject project.Type, checkConfiguration
 		)
 	} else {
 		// There's already a report for this project, just add the checks report to it
-		report.Projects[projectReportIndex].Checks = append(report.Projects[projectReportIndex].Checks, checkReport)
+		results.Projects[projectReportIndex].Checks = append(results.Projects[projectReportIndex].Checks, checkReport)
 	}
 
 	return summaryText
 }
 
-// AddProjectSummaryReport summarizes the results of all checks on the given project and adds it to the report.
-func (report *ReportType) AddProjectSummaryReport(checkedProject project.Type) {
-	reportExists, projectReportIndex := report.getProjectReportIndex(checkedProject.Path)
+// AddProjectSummary summarizes the results of all checks on the given project and adds it to the report.
+func (results *Type) AddProjectSummary(checkedProject project.Type) {
+	reportExists, projectReportIndex := results.getProjectReportIndex(checkedProject.Path)
 	if !reportExists {
 		panic(fmt.Sprintf("Unable to find report for %v when generating report summary", checkedProject.Path))
 	}
 
 	pass := true
 	warningCount := 0
 	errorCount := 0
-	for _, checkReport := range report.Projects[projectReportIndex].Checks {
+	for _, checkReport := range results.Projects[projectReportIndex].Checks {
 		if checkReport.Result == checkresult.Fail.String() {
 			if checkReport.Level == checklevel.Warning.String() {
 				warningCount += 1
@@ -152,56 +152,56 @@ func (report *ReportType) AddProjectSummaryReport(checkedProject project.Type) {
 		}
 	}
 
-	report.Projects[projectReportIndex].Summary = summaryReportType{
+	results.Projects[projectReportIndex].Summary = summaryReportType{
 		Pass:         pass,
 		WarningCount: warningCount,
 		ErrorCount:   errorCount,
 	}
 }
 
 // ProjectSummaryText returns a text summary of the check results for the given project.
-func (report ReportType) ProjectSummaryText(checkedProject project.Type) string {
-	reportExists, projectReportIndex := report.getProjectReportIndex(checkedProject.Path)
+func (results Type) ProjectSummaryText(checkedProject project.Type) string {
+	reportExists, projectReportIndex := results.getProjectReportIndex(checkedProject.Path)
 	if !reportExists {
 		panic(fmt.Sprintf("Unable to find report for %v when generating report summary text", checkedProject.Path))
 	}
 
-	projectSummaryReport := report.Projects[projectReportIndex].Summary
+	projectSummaryReport := results.Projects[projectReportIndex].Summary
 	return fmt.Sprintf("\nFinished checking project. Results:\nWarning count: %v\nError count: %v\nChecks passed: %v\n\n", projectSummaryReport.WarningCount, projectSummaryReport.ErrorCount, projectSummaryReport.Pass)
 }
 
-// AddSummaryReport summarizes the check results for all projects and adds it to the report.
-func (report *ReportType) AddSummaryReport() {
+// AddSummary summarizes the check results for all projects and adds it to the report.
+func (results *Type) AddSummary() {
 	pass := true
 	warningCount := 0
 	errorCount := 0
-	for _, projectReport := range report.Projects {
+	for _, projectReport := range results.Projects {
 		if !projectReport.Summary.Pass {
 			pass = false
 		}
 		warningCount += projectReport.Summary.WarningCount
 		errorCount += projectReport.Summary.ErrorCount
 	}
 
-	report.Summary = summaryReportType{
+	results.Summary = summaryReportType{
 		Pass:         pass,
 		WarningCount: warningCount,
 		ErrorCount:   errorCount,
 	}
 }
 
 // SummaryText returns a text summary of the cumulative check results.
-func (report ReportType) SummaryText() string {
-	return fmt.Sprintf("Finished checking projects. Results:\nWarning count: %v\nError count: %v\nChecks passed: %v\n", report.Summary.WarningCount, report.Summary.ErrorCount, report.Summary.Pass)
+func (results Type) SummaryText() string {
+	return fmt.Sprintf("Finished checking projects. Results:\nWarning count: %v\nError count: %v\nChecks passed: %v\n", results.Summary.WarningCount, results.Summary.ErrorCount, results.Summary.Pass)
 }
 
-// Report returns a JSON formatted report of checks on all projects.
-func (report ReportType) JSONReport() string {
-	return string(report.jsonReportRaw())
+// JSONReport returns a JSON formatted report of checks on all projects.
+func (results Type) JSONReport() string {
+	return string(results.jsonReportRaw())
 }
 
-func (report ReportType) jsonReportRaw() []byte {
-	reportJSON, err := json.MarshalIndent(report, "", "  ")
+func (results Type) jsonReportRaw() []byte {
+	reportJSON, err := json.MarshalIndent(results, "", "  ")
 	if err != nil {
 		panic(fmt.Sprintf("Error while formatting checks report: %v", err))
 	}
@@ -210,24 +210,24 @@ func (report ReportType) jsonReportRaw() []byte {
 }
 
 // WriteReport writes a report for all projects to the specified file.
-func (report ReportType) WriteReport() {
+func (results Type) WriteReport() {
 	// Write report file
-	err := configuration.ReportFilePath().WriteFile(report.jsonReportRaw())
+	err := configuration.ReportFilePath().WriteFile(results.jsonReportRaw())
 	if err != nil {
 		feedback.Errorf("Error while writing report: %v", err)
 		os.Exit(errorcodes.ErrGeneric)
 	}
 }
 
 // Passed returns whether the checks passed cumulatively.
-func (report ReportType) Passed() bool {
-	return report.Summary.Pass
+func (results Type) Passed() bool {
+	return results.Summary.Pass
 }
 
-func (report ReportType) getProjectReportIndex(projectPath *paths.Path) (bool, int) {
+func (results Type) getProjectReportIndex(projectPath *paths.Path) (bool, int) {
 	var index int
 	var projectReport projectReportType
-	for index, projectReport = range report.Projects {
+	for index, projectReport = range results.Projects {
 		if projectReport.Path == projectPath {
 			return true, index
 		}