From 47314a6bbcaf99439301564f07aeab196ddf22c8 Mon Sep 17 00:00:00 2001 From: bchadwic Date: Sat, 3 Jul 2021 17:09:25 -0700 Subject: [PATCH] modified HexToRGB to check whether terminal and gh have color enabled, as well as created tests for HexToRGB --- pkg/cmd/issue/shared/display.go | 6 ++-- pkg/cmd/issue/view/view.go | 8 ++--- pkg/cmd/pr/view/view.go | 8 ++--- pkg/iostreams/color.go | 6 +++- pkg/iostreams/color_test.go | 53 +++++++++++++++++++++++++++++++++ 5 files changed, 69 insertions(+), 12 deletions(-) diff --git a/pkg/cmd/issue/shared/display.go b/pkg/cmd/issue/shared/display.go index 983f22e16..f75e445b1 100644 --- a/pkg/cmd/issue/shared/display.go +++ b/pkg/cmd/issue/shared/display.go @@ -22,7 +22,7 @@ func PrintIssues(io *iostreams.IOStreams, prefix string, totalCount int, issues issueNum = "#" + issueNum } issueNum = prefix + issueNum - labels := IssueLabelList(issue) + labels := IssueLabelList(issue, cs) if labels != "" && table.IsTTY() { labels = fmt.Sprintf("(%s)", labels) } @@ -56,14 +56,14 @@ func truncateLabels(w int, t string) string { return fmt.Sprintf("(%s)", truncated) } -func IssueLabelList(issue api.Issue) string { +func IssueLabelList(issue api.Issue, cs *iostreams.ColorScheme) string { if len(issue.Labels.Nodes) == 0 { return "" } labelNames := make([]string, 0, len(issue.Labels.Nodes)) for _, label := range issue.Labels.Nodes { - labelNames = append(labelNames, iostreams.HexToRGB(label.Color, label.Name)) + labelNames = append(labelNames, cs.HexToRGB(label.Color, label.Name)) } return strings.Join(labelNames, ", ") diff --git a/pkg/cmd/issue/view/view.go b/pkg/cmd/issue/view/view.go index d4f96bbd8..a2a75e4b7 100644 --- a/pkg/cmd/issue/view/view.go +++ b/pkg/cmd/issue/view/view.go @@ -125,7 +125,7 @@ func viewRun(opts *ViewOptions) error { return nil } - return printRawIssuePreview(opts.IO.Out, issue) + return printRawIssuePreview(opts.IO.Out, issue, opts.IO.ColorScheme()) } func findIssue(client *http.Client, baseRepoFn func() (ghrepo.Interface, error), selector string, loadComments bool) (*api.Issue, error) { @@ -141,9 +141,9 @@ func findIssue(client *http.Client, baseRepoFn func() (ghrepo.Interface, error), return issue, err } -func printRawIssuePreview(out io.Writer, issue *api.Issue) error { +func printRawIssuePreview(out io.Writer, issue *api.Issue, cs *iostreams.ColorScheme) error { assignees := issueAssigneeList(*issue) - labels := shared.IssueLabelList(*issue) + labels := shared.IssueLabelList(*issue, cs) projects := issueProjectList(*issue) // Print empty strings for empty values so the number of metadata lines is consistent when @@ -193,7 +193,7 @@ func printHumanIssuePreview(opts *ViewOptions, issue *api.Issue) error { fmt.Fprint(out, cs.Bold("Assignees: ")) fmt.Fprintln(out, assignees) } - if labels := shared.IssueLabelList(*issue); labels != "" { + if labels := shared.IssueLabelList(*issue, cs); labels != "" { fmt.Fprint(out, cs.Bold("Labels: ")) fmt.Fprintln(out, labels) } diff --git a/pkg/cmd/pr/view/view.go b/pkg/cmd/pr/view/view.go index 7cc9e0193..2c390d412 100644 --- a/pkg/cmd/pr/view/view.go +++ b/pkg/cmd/pr/view/view.go @@ -139,7 +139,7 @@ func printRawPrPreview(io *iostreams.IOStreams, pr *api.PullRequest) error { reviewers := prReviewerList(*pr, cs) assignees := prAssigneeList(*pr) - labels := prLabelList(*pr) + labels := prLabelList(*pr, cs) projects := prProjectList(*pr) fmt.Fprintf(out, "title:\t%s\n", pr.Title) @@ -197,7 +197,7 @@ func printHumanPrPreview(opts *ViewOptions, pr *api.PullRequest) error { fmt.Fprint(out, cs.Bold("Assignees: ")) fmt.Fprintln(out, assignees) } - if labels := prLabelList(*pr); labels != "" { + if labels := prLabelList(*pr, cs); labels != "" { fmt.Fprint(out, cs.Bold("Labels: ")) fmt.Fprintln(out, labels) } @@ -367,14 +367,14 @@ func prAssigneeList(pr api.PullRequest) string { return list } -func prLabelList(pr api.PullRequest) string { +func prLabelList(pr api.PullRequest, cs *iostreams.ColorScheme) string { if len(pr.Labels.Nodes) == 0 { return "" } labelNames := make([]string, 0, len(pr.Labels.Nodes)) for _, label := range pr.Labels.Nodes { - labelNames = append(labelNames, iostreams.HexToRGB(label.Color, label.Name)) + labelNames = append(labelNames, cs.HexToRGB(label.Color, label.Name)) } list := strings.Join(labelNames, ", ") diff --git a/pkg/iostreams/color.go b/pkg/iostreams/color.go index b8d64fffc..72c4643a5 100644 --- a/pkg/iostreams/color.go +++ b/pkg/iostreams/color.go @@ -204,7 +204,11 @@ func (c *ColorScheme) ColorFromString(s string) func(string) string { return fn } -func HexToRGB(hex string, x string) string { +func (c *ColorScheme) HexToRGB(hex string, x string) string { + if !c.enabled || !c.is256enabled { + return x + } + r, _ := strconv.ParseInt(hex[0:2], 16, 64) g, _ := strconv.ParseInt(hex[2:4], 16, 64) b, _ := strconv.ParseInt(hex[4:6], 16, 64) diff --git a/pkg/iostreams/color_test.go b/pkg/iostreams/color_test.go index 90b3ae024..7923bf912 100644 --- a/pkg/iostreams/color_test.go +++ b/pkg/iostreams/color_test.go @@ -3,6 +3,8 @@ package iostreams import ( "os" "testing" + + "github.com/stretchr/testify/assert" ) func TestEnvColorDisabled(t *testing.T) { @@ -143,3 +145,54 @@ func TestEnvColorForced(t *testing.T) { }) } } + +func Test_HextoRGB(t *testing.T) { + tests := []struct { + name string + hex string + arg string + expectedOutput string + expectedError bool + cs *ColorScheme + }{ + { + name: "Colored red enabled color", + hex: "fc0303", + arg: "red", + expectedOutput: "\033[38;2;252;3;3mred\033[0m", + cs: NewColorScheme(true, true), + }, + { + name: "Failed colored red enabled color", + hex: "fc0303", + arg: "red", + expectedOutput: "\033[38;2;252;2;3mred\033[0m", + expectedError: true, + cs: NewColorScheme(true, true), + }, + { + name: "Colored red disabled color", + hex: "fc0303", + arg: "red", + expectedOutput: "red", + cs: NewColorScheme(false, false), + }, + { + name: "Failed colored red disabled color", + hex: "fc0303", + arg: "red", + expectedOutput: "\033[38;2;252;3;3mred\033[0m", + expectedError: true, + cs: NewColorScheme(false, false), + }, + } + + for _, tt := range tests { + output := tt.cs.HexToRGB(tt.hex, tt.arg) + if tt.expectedError { + assert.NotEqual(t, tt.expectedOutput, output) + } else { + assert.Equal(t, tt.expectedOutput, output) + } + } +}