Improving readability of benchmark scores

cmd/root.go

@@ -33,12 +33,12 @@ import (
 	"strings"
 	"time"
 
+	"github.com/k1LoW/octocov/badge"
 	"github.com/k1LoW/octocov/central"
 	"github.com/k1LoW/octocov/config"
 	"github.com/k1LoW/octocov/datastore"
 	"github.com/k1LoW/octocov/gh"
 	"github.com/k1LoW/octocov/internal"
-	"github.com/k1LoW/octocov/badge"
 	"github.com/k1LoW/octocov/report"
 	"github.com/k1LoW/octocov/version"
 	"github.com/spf13/cobra"
@@ -161,7 +161,7 @@ var rootCmd = &cobra.Command{
 			return nil
 		}
 
-		r, err := report.New(c.Repository)
+		r, err := report.New(c.Repository, report.Locale(c.Locale))
 		if err != nil {
 			return err
 		}
@@ -354,7 +354,7 @@ var rootCmd = &cobra.Command{
 				}
 			}
 			if c.Diff.Path != "" {
-				rt, err := report.New(c.Repository)
+				rt, err := report.New(c.Repository, report.Locale(c.Locale))
 				if err != nil {
 					return err
 				}
@@ -502,7 +502,7 @@ func printMetrics(cmd *cobra.Command) error {
 		c.CodeToTestRatio = nil
 		c.TestExecutionTime = nil
 	}
-	r, err := report.New(c.Repository)
+	r, err := report.New(c.Repository, report.Locale(c.Locale))
 	if err != nil {
 		return err
 	}

config/config.go

@@ -16,7 +16,7 @@ import (
 	"github.com/k1LoW/duration"
 	"github.com/k1LoW/expand"
 	"github.com/k1LoW/octocov/gh"
-	"github.com/k1LoW/octocov/report"
+	"golang.org/x/text/language"
 )
 
 const defaultBadgesDatastore = "local://reports"
@@ -48,6 +48,7 @@ type Config struct {
 	Body              *Body              `yaml:"body,omitempty"`
 	Diff              *Diff              `yaml:"diff,omitempty"`
 	Timeout           time.Duration      `yaml:"timeout,omitempty"`
+	Locale            *language.Tag      `yaml:"locale,omitempty"`
 	GitRoot           string             `yaml:"-"`
 	// working directory
 	wd string
@@ -190,34 +191,33 @@ func (c *Config) Loaded() bool {
 	return c.path != ""
 }
 
-func (c *Config) Acceptable(r, rPrev *report.Report) error {
+type Reporter interface {
+	CoveragePercent() float64
+	CodeToTestRatioRatio() float64
+	TestExecutionTimeNano() float64
+	IsMeasuredTestExecutionTime() bool
+}
+
+func (c *Config) Acceptable(r, rPrev Reporter) error {
 	var result *multierror.Error
 	if err := c.CoverageConfigReady(); err == nil {
-		prev := 0.0
-		if rPrev != nil {
-			prev = rPrev.CoveragePercent()
-		}
+		prev := rPrev.CoveragePercent()
 		if err := coverageAcceptable(r.CoveragePercent(), prev, c.Coverage.Acceptable); err != nil {
 			result = multierror.Append(result, err)
 		}
 	}
 
 	if err := c.CodeToTestRatioConfigReady(); err == nil {
-		prev := 0.0
-		if rPrev != nil {
-			prev = rPrev.CodeToTestRatioRatio()
-		}
+		prev := rPrev.CodeToTestRatioRatio()
 		if err := codeToTestRatioAcceptable(r.CodeToTestRatioRatio(), prev, c.CodeToTestRatio.Acceptable); err != nil {
 			result = multierror.Append(result, err)
 		}
 	}
 
 	if err := c.TestExecutionTimeConfigReady(); err == nil {
 		prev := largeEnoughTime
-		if rPrev != nil {
-			if rPrev.IsMeasuredTestExecutionTime() {
-				prev = rPrev.TestExecutionTimeNano()
-			}
+		if rPrev.IsMeasuredTestExecutionTime() {
+			prev = rPrev.TestExecutionTimeNano()
 		}
 
 		if err := testExecutionTimeAcceptable(r.TestExecutionTimeNano(), prev, c.TestExecutionTime.Acceptable); err != nil {

config/config_test.go

@@ -9,6 +9,7 @@ import (
 	"time"
 
 	"github.com/google/go-cmp/cmp"
+	"golang.org/x/text/language"
 )
 
 func TestMain(m *testing.M) {
@@ -92,6 +93,40 @@ func TestLoadCentralPush(t *testing.T) {
 	}
 }
 
+func TestLoadLocale(t *testing.T) {
+	tests := []struct {
+		path      string
+		want      *language.Tag
+		wantError bool
+	}{
+		{"locale_nothing.yml", nil, false},
+		{"locale_empty.yml", nil, false},
+		{"locale_ja.yml", &language.Japanese, false},
+		{"locale_ja_uppercase.yml", &language.Japanese, false},
+		{"locale_fr.yml", &language.French, false},
+		{"locale_unkown.yml", nil, true},
+	}
+	for _, tt := range tests {
+		c := New()
+		t.Run(fmt.Sprintf("%v", tt.path), func(t *testing.T) {
+			p := filepath.Join(testdataDir(t), tt.path)
+			if err := c.Load(p); err != nil {
+				if tt.wantError {
+					return
+				}
+				t.Fatal(err)
+			}
+			got := c.Locale
+			if tt.want == nil && got == nil {
+				return
+			}
+			if diff := cmp.Diff(got.String(), tt.want.String(), nil); diff != "" {
+				t.Error(diff)
+			}
+		})
+	}
+}
+
 func TestCoveragePaths(t *testing.T) {
 	tests := []struct {
 		paths      []string

config/testdata/locale_empty.yml

@@ -0,0 +1 @@
+locale:

config/testdata/locale_fr.yml

@@ -0,0 +1 @@
+locale: "fr"

config/testdata/locale_ja.yml

@@ -0,0 +1 @@
+locale: "ja"

config/testdata/locale_ja_uppercase.yml

@@ -0,0 +1 @@
+locale: "JA"

config/testdata/locale_unknown.yml

@@ -0,0 +1 @@
+locale: "unknown"

config/yaml.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/goccy/go-yaml"
 	"github.com/k1LoW/duration"
+	"golang.org/x/text/language"
 )
 
 var commentRe = regexp.MustCompile(`(?m)^comment:`)
@@ -25,6 +26,7 @@ func (c *Config) UnmarshalYAML(data []byte) error {
 		Body              *Body              `yaml:"body,omitempty"`
 		Diff              *Diff              `yaml:"diff,omitempty"`
 		Timeout           string             `yaml:"timeout,omitempty"`
+		Locale            string             `yaml:"locale,omitempty"`
 	}{}
 	err := yaml.Unmarshal(data, &s)
 	if err != nil {
@@ -85,6 +87,15 @@ func (c *Config) UnmarshalYAML(data []byte) error {
 		c.Push = v
 	}
 
+	if s.Locale != "" {
+		l, err := language.Parse(s.Locale)
+		if err != nil {
+			return err
+		}
+
+		c.Locale = &l
+	}
+
 	return nil
 }
 

go.mod

@@ -46,6 +46,7 @@ require (
 	golang.org/x/exp v0.0.0-20230213192124-5e25df0256eb
 	golang.org/x/image v0.10.0
 	golang.org/x/oauth2 v0.7.0
+	golang.org/x/text v0.14.0
 	golang.org/x/tools v0.13.0
 	google.golang.org/api v0.114.0
 	gopkg.in/ini.v1 v1.67.0
@@ -115,7 +116,6 @@ require (
 	golang.org/x/net v0.19.0 // indirect
 	golang.org/x/sync v0.3.0 // indirect
 	golang.org/x/sys v0.15.0 // indirect
-	golang.org/x/text v0.14.0 // indirect
 	golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/genproto v0.0.0-20230410155749-daa745c078e1 // indirect

report/custom.go

@@ -64,19 +64,17 @@ func (s *CustomMetricSet) Table() string {
 	if len(s.Metrics) >= swapXYMin {
 		return s.tableSwaped()
 	}
+	report := s.report
+	if report == nil {
+		report = &Report{}
+	}
 	var (
 		h []string
 		d []string
 	)
 	for _, m := range s.Metrics {
 		h = append(h, m.Name)
-		var v string
-		if isInt(m.Value) {
-			v = fmt.Sprintf("%d%s", int(m.Value), m.Unit)
-		} else {
-			v = fmt.Sprintf("%.1f%s", m.Value, m.Unit)
-		}
-		d = append(d, v)
+		d = append(d, fmt.Sprintf("%s%s", report.convertFormat(m.Value), m.Unit))
 	}
 	buf := new(bytes.Buffer)
 	_, _ = buf.WriteString(fmt.Sprintf("## %s\n\n", s.Name)) //nostyle:handlerrors
@@ -100,14 +98,10 @@ func (s *CustomMetricSet) tableSwaped() string {
 	table.SetBorders(tablewriter.Border{Left: true, Top: false, Right: true, Bottom: false})
 	table.SetCenterSeparator("|")
 	table.SetHeader([]string{"", makeHeadTitleWithLink(s.report.Ref, s.report.Commit, nil)})
+
+	report := s.report
 	for _, m := range s.Metrics {
-		var v string
-		if isInt(m.Value) {
-			v = fmt.Sprintf("%d%s", int(m.Value), m.Unit)
-		} else {
-			v = fmt.Sprintf("%.1f%s", m.Value, m.Unit)
-		}
-		table.Append([]string{m.Name, v})
+		table.Append([]string{m.Name, fmt.Sprintf("%s%s", report.convertFormat(m.Value), m.Unit)})
 	}
 	table.Render()
 	return strings.Replace(buf.String(), "---|", "--:|", len(s.Metrics))
@@ -159,17 +153,16 @@ func (s *CustomMetricSet) Out(w io.Writer) error {
 	table.SetBorder(false)
 	table.SetColumnAlignment([]int{tablewriter.ALIGN_LEFT, tablewriter.ALIGN_RIGHT})
 
+	report := s.report
+	if report == nil {
+		report = &Report{}
+	}
+
 	for _, m := range s.Metrics {
 		if m.Name == "" {
 			m.Name = m.Key
 		}
-		var v string
-		if isInt(m.Value) {
-			v = fmt.Sprintf("%d%s", int(m.Value), m.Unit)
-		} else {
-			v = fmt.Sprintf("%.1f%s", m.Value, m.Unit)
-		}
-		table.Rich([]string{m.Name, v}, []tablewriter.Colors{tablewriter.Colors{tablewriter.Bold}, tablewriter.Colors{}})
+		table.Rich([]string{m.Name, fmt.Sprintf("%s%s", report.convertFormat(m.Value), m.Unit)}, []tablewriter.Colors{tablewriter.Colors{tablewriter.Bold}, tablewriter.Colors{}})
 	}
 
 	table.Render()
@@ -276,37 +269,29 @@ func (d *DiffCustomMetricSet) Table() string {
 	table.SetCenterSeparator("|")
 	table.SetColumnAlignment([]int{tablewriter.ALIGN_LEFT, tablewriter.ALIGN_RIGHT, tablewriter.ALIGN_RIGHT, tablewriter.ALIGN_RIGHT})
 	table.SetHeader([]string{"", makeHeadTitleWithLink(d.B.report.Ref, d.B.report.Commit, nil), makeHeadTitleWithLink(d.A.report.Ref, d.A.report.Commit, nil), "+/-"})
+	report := d.report()
+
 	for _, m := range d.Metrics {
 		var va, vb, diff string
 		switch {
 		case m.A == nil && m.B == nil:
 			continue
 		case m.A != nil && m.B == nil:
 			vb = ""
-			if isInt(*m.A) {
-				va = fmt.Sprintf("%d%s", int(*m.A), m.customMetricA.Unit)
-				diff = fmt.Sprintf("%d%s", int(m.Diff), m.customMetricA.Unit)
-			} else {
-				va = fmt.Sprintf("%.1f%s", *m.A, m.customMetricA.Unit)
-				diff = fmt.Sprintf("%.1f%s", m.Diff, m.customMetricA.Unit)
-			}
+			va = fmt.Sprintf("%s%s", report.convertFormat(*m.A), m.customMetricA.Unit)
+			diff = fmt.Sprintf("%s%s", report.convertFormat(m.Diff), m.customMetricA.Unit)
 		case m.A == nil && m.B != nil:
 			va = ""
-			if isInt(*m.B) {
-				vb = fmt.Sprintf("%d%s", int(*m.B), m.customMetricB.Unit)
-				diff = fmt.Sprintf("%d%s", int(m.Diff), m.customMetricB.Unit)
-			} else {
-				vb = fmt.Sprintf("%.1f%s", *m.B, m.customMetricB.Unit)
-				diff = fmt.Sprintf("%.1f%s", m.Diff, m.customMetricB.Unit)
-			}
+			vb = fmt.Sprintf("%s%s", report.convertFormat(*m.B), m.customMetricB.Unit)
+			diff = fmt.Sprintf("%s%s", report.convertFormat(m.Diff), m.customMetricB.Unit)
 		case isInt(*m.A) && isInt(*m.B):
-			va = fmt.Sprintf("%d%s", int(*m.A), m.customMetricA.Unit)
-			vb = fmt.Sprintf("%d%s", int(*m.B), m.customMetricB.Unit)
-			diff = fmt.Sprintf("%d%s", int(m.Diff), m.customMetricA.Unit)
+			va = fmt.Sprintf("%s%s", report.convertFormat(*m.A), m.customMetricA.Unit)
+			vb = fmt.Sprintf("%s%s", report.convertFormat(*m.B), m.customMetricB.Unit)
+			diff = fmt.Sprintf("%s%s", report.convertFormat(m.Diff), m.customMetricA.Unit)
 		default:
-			va = fmt.Sprintf("%.1f%s", *m.A, m.customMetricA.Unit)
-			vb = fmt.Sprintf("%.1f%s", *m.B, m.customMetricB.Unit)
-			diff = fmt.Sprintf("%.1f%s", m.Diff, m.customMetricA.Unit)
+			va = fmt.Sprintf("%s%s", report.convertFormat(*m.A), m.customMetricA.Unit)
+			vb = fmt.Sprintf("%s%s", report.convertFormat(*m.B), m.customMetricB.Unit)
+			diff = fmt.Sprintf("%s%s", report.convertFormat(m.Diff), m.customMetricA.Unit)
 		}
 		if m.Name == "" {
 			m.Name = m.Key
@@ -350,6 +335,17 @@ func (d *DiffCustomMetricSet) MetadataTable() string {
 	return strings.Replace(strings.Replace(buf.String(), "---|", "--:|", 4), "--:|", "---|", 1)
 }
 
+func (d *DiffCustomMetricSet) report() *Report {
+	if d.A != nil && d.A.report != nil {
+		return d.A.report
+	}
+	if d.B != nil && d.B.report != nil {
+		return d.B.report
+	}
+
+	return &Report{}
+}
+
 func isInt(v float64) bool {
 	return v == float64(int64(v))
 }