Support editing gist description

SteadBytes · SteadBytes · commit f30e76aab8a1 · 2021-11-16T20:18:53.000Z
Add a --desc flag to gh gist edit to support editing gist
descriptions. This flag can be used in combination with the other gist
editing flags to edit the description whilst also adding/editing files.

Signed-off-by: Ben Steadman &lt;steadmanben1@gmail.com&gt;
diff --git a/pkg/cmd/gist/edit/edit.go b/pkg/cmd/gist/edit/edit.go
@@ -32,6 +32,7 @@ type EditOptions struct {
 	Selector     string
 	EditFilename string
 	AddFilename  string
+	Description  string
 }
 
 func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Command {
@@ -64,6 +65,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman
 	}
 
 	cmd.Flags().StringVarP(&opts.AddFilename, "add", "a", "", "Add a new file to the gist")
+	cmd.Flags().StringVarP(&opts.Description, "desc", "d", "", "New description for the gist")
 	cmd.Flags().StringVarP(&opts.EditFilename, "filename", "f", "", "Select a file to edit")
 
 	return cmd
@@ -114,6 +116,12 @@ func editRun(opts *EditOptions) error {
 		return fmt.Errorf("You do not own this gist.")
 	}
 
+	shouldUpdate := false
+	if opts.Description != "" {
+		shouldUpdate = true
+		gist.Description = opts.Description
+	}
+
 	if opts.AddFilename != "" {
 		files, err := getFilesToAdd(opts.AddFilename)
 		if err != nil {
@@ -166,7 +174,6 @@ func editRun(opts *EditOptions) error {
 			return err
 		}
 		text, err := opts.Edit(editorCommand, filename, gistFile.Content, opts.IO)
-
 		if err != nil {
 			return err
 		}
@@ -215,16 +222,15 @@ func editRun(opts *EditOptions) error {
 		}
 	}
 
-	if len(filesToUpdate) == 0 {
-		return nil
+	if len(filesToUpdate) > 0 {
+		shouldUpdate = true
 	}
 
-	err = updateGist(apiClient, host, gist)
-	if err != nil {
-		return err
+	if !shouldUpdate {
+		return nil
 	}
 
-	return nil
+	return updateGist(apiClient, host, gist)
 }
 
 func updateGist(apiClient *api.Client, hostname string, gist *shared.Gist) error {
diff --git a/pkg/cmd/gist/edit/edit_test.go b/pkg/cmd/gist/edit/edit_test.go
@@ -65,6 +65,14 @@ func TestNewCmdEdit(t *testing.T) {
 				AddFilename: "cool.md",
 			},
 		},
+		{
+			name: "description",
+			cli:  `123 --desc "my new description"`,
+			wants: EditOptions{
+				Selector:    "123",
+				Description: "my new description",
+			},
+		},
 	}
 
 	for _, tt := range tests {
@@ -262,6 +270,39 @@ func Test_editRun(t *testing.T) {
 				AddFilename: fileToAdd,
 			},
 		},
+		{
+			name: "change description",
+			gist: &shared.Gist{
+				ID:          "1234",
+				Description: "my old description",
+				Files: map[string]*shared.GistFile{
+					"sample.txt": {
+						Filename: "sample.txt",
+						Type:     "text/plain",
+					},
+				},
+				Owner: &shared.GistOwner{Login: "octocat"},
+			},
+			httpStubs: func(reg *httpmock.Registry) {
+				reg.Register(httpmock.REST("POST", "gists/1234"),
+					httpmock.StatusStringResponse(201, "{}"))
+			},
+			wantParams: map[string]interface{}{
+				"description": "my new description",
+				"updated_at":  "0001-01-01T00:00:00Z",
+				"public":      false,
+				"files": map[string]interface{}{
+					"sample.txt": map[string]interface{}{
+						"content":  "new file content",
+						"filename": "sample.txt",
+						"type":     "text/plain",
+					},
+				},
+			},
+			opts: &EditOptions{
+				Description: "my new description",
+			},
+		},
 	}
 
 	for _, tt := range tests {

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ type EditOptions struct {`
`32`	`32`	`Selector string`
`33`	`33`	`EditFilename string`
`34`	`34`	`AddFilename string`
	`35`	`+ Description string`
`35`	`36`	`}`
`36`	`37`
`37`	`38`	`func NewCmdEdit(f cmdutil.Factory, runF func(EditOptions) error) *cobra.Command {`
`@@ -64,6 +65,7 @@ func NewCmdEdit(f cmdutil.Factory, runF func(EditOptions) error) *cobra.Comman`
`64`	`65`	`}`
`65`	`66`
`66`	`67`	`cmd.Flags().StringVarP(&opts.AddFilename, "add", "a", "", "Add a new file to the gist")`
	`68`	`+ cmd.Flags().StringVarP(&opts.Description, "desc", "d", "", "New description for the gist")`
`67`	`69`	`cmd.Flags().StringVarP(&opts.EditFilename, "filename", "f", "", "Select a file to edit")`
`68`	`70`
`69`	`71`	`return cmd`
`@@ -114,6 +116,12 @@ func editRun(opts *EditOptions) error {`
`114`	`116`	`return fmt.Errorf("You do not own this gist.")`
`115`	`117`	`}`
`116`	`118`
	`119`	`+ shouldUpdate := false`
	`120`	`+ if opts.Description != "" {`
	`121`	`+ shouldUpdate = true`
	`122`	`+ gist.Description = opts.Description`
	`123`	`+ }`
	`124`	`+`
`117`	`125`	`if opts.AddFilename != "" {`
`118`	`126`	`files, err := getFilesToAdd(opts.AddFilename)`
`119`	`127`	`if err != nil {`
`@@ -166,7 +174,6 @@ func editRun(opts *EditOptions) error {`
`166`	`174`	`return err`
`167`	`175`	`}`
`168`	`176`	`text, err := opts.Edit(editorCommand, filename, gistFile.Content, opts.IO)`
`169`		`-`
`170`	`177`	`if err != nil {`
`171`	`178`	`return err`
`172`	`179`	`}`
`@@ -215,16 +222,15 @@ func editRun(opts *EditOptions) error {`
`215`	`222`	`}`
`216`	`223`	`}`
`217`	`224`
`218`		`- if len(filesToUpdate) == 0 {`
`219`		`- return nil`
	`225`	`+ if len(filesToUpdate) > 0 {`
	`226`	`+ shouldUpdate = true`
`220`	`227`	`}`
`221`	`228`
`222`		`- err = updateGist(apiClient, host, gist)`
`223`		`- if err != nil {`
`224`		`- return err`
	`229`	`+ if !shouldUpdate {`
	`230`	`+ return nil`
`225`	`231`	`}`
`226`	`232`
`227`		`- return nil`
	`233`	`+ return updateGist(apiClient, host, gist)`
`228`	`234`	`}`
`229`	`235`
`230`	`236`	`func updateGist(apiClient api.Client, hostname string, gist shared.Gist) error {`