Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add :branch placeholder for API calls #1515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 12, 2020
Merged

Add :branch placeholder for API calls #1515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0c10f67
add branch placeholder for api calls
fsmiamoto Aug 11, 2020
9ebcec9
handle a detached head
fsmiamoto Aug 11, 2020
b833428
use factory method for branch
fsmiamoto Aug 12, 2020
bba2d6d
improve test cases
fsmiamoto Aug 12, 2020
800be37
propagate error from closure
fsmiamoto Aug 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions pkg/cmd/api/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,15 @@ type ApiOptions struct {

HttpClient func() (*http.Client, error)
BaseRepo func() (ghrepo.Interface, error)
Branch func() (string, error)
}

func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command {
opts := ApiOptions{
IO: f.IOStreams,
HttpClient: f.HttpClient,
BaseRepo: f.BaseRepo,
Branch: f.Branch,
}

cmd := &cobra.Command{
Expand Down Expand Up @@ -285,7 +287,7 @@ func processResponse(resp *http.Response, opts *ApiOptions, headersOutputStream
return
}

var placeholderRE = regexp.MustCompile(`\:(owner|repo)\b`)
var placeholderRE = regexp.MustCompile(`\:(owner|repo|branch)\b`)

// fillPlaceholders populates `:owner` and `:repo` placeholders with values from the current repository
func fillPlaceholders(value string, opts *ApiOptions) (string, error) {
Expand All @@ -298,18 +300,28 @@ func fillPlaceholders(value string, opts *ApiOptions) (string, error) {
return value, err
}

value = placeholderRE.ReplaceAllStringFunc(value, func(m string) string {
filled := placeholderRE.ReplaceAllStringFunc(value, func(m string) string {
switch m {
case ":owner":
return baseRepo.RepoOwner()
case ":repo":
return baseRepo.RepoName()
case ":branch":
branch, e := opts.Branch()
if e != nil {
err = e
}
return branch
default:
panic(fmt.Sprintf("invalid placeholder: %q", m))
}
})

return value, nil
if err != nil {
return value, err
}

return filled, nil
}

func printHeaders(w io.Writer, headers http.Header, colorize bool) {
Expand Down
33 changes: 33 additions & 0 deletions pkg/cmd/api/api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"os"
"testing"

"github.com/cli/cli/git"
"github.com/cli/cli/internal/ghrepo"
"github.com/cli/cli/pkg/cmdutil"
"github.com/cli/cli/pkg/iostreams"
Expand Down Expand Up @@ -753,6 +754,38 @@ func Test_fillPlaceholders(t *testing.T) {
want: "repos/hubot/robot-uprising/releases",
wantErr: false,
},
{
name: "has branch placeholder",
args: args{
value: "repos/cli/cli/branches/:branch/protection/required_status_checks",
opts: &ApiOptions{
BaseRepo: func() (ghrepo.Interface, error) {
return ghrepo.New("cli", "cli"), nil
},
Branch: func() (string, error) {
return "trunk", nil
},
},
},
want: "repos/cli/cli/branches/trunk/protection/required_status_checks",
wantErr: false,
},
{
name: "has branch placeholder and git is in detached head",
args: args{
value: "repos/:owner/:repo/branches/:branch",
opts: &ApiOptions{
BaseRepo: func() (ghrepo.Interface, error) {
return ghrepo.New("cli", "cli"), nil
},
Branch: func() (string, error) {
return "", git.ErrNotOnAnyBranch
},
},
},
want: "repos/:owner/:repo/branches/:branch",
wantErr: true,
},
{
name: "no greedy substitutes",
args: args{
Expand Down