Skip to content

Commit 00873b1

Browse files
Refactors project specific method names to adhere to standardized naming convention defined in google#3761
1 parent c2f8bfa commit 00873b1

3 files changed

Lines changed: 40 additions & 40 deletions

File tree

‎github/projects.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,12 @@ type ProjectV2Field struct {
100100
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
101101
}
102102

103-
// ListProjectsForOrg lists Projects V2 for an organization.
103+
// ListOrganizationProjects lists Projects V2 for an organization.
104104
//
105105
// GitHub API docs: https://docs.github.com/rest/projects/projects#list-projects-for-organization
106106
//
107107
//meta:operation GET /orgs/{org}/projectsV2
108-
func (s *ProjectsService) ListProjectsForOrg(ctx context.Context, org string, opts *ListProjectsOptions) ([]*ProjectV2, *Response, error) {
108+
func (s *ProjectsService) ListOrganizationProjects(ctx context.Context, org string, opts *ListProjectsOptions) ([]*ProjectV2, *Response, error) {
109109
u := fmt.Sprintf("orgs/%v/projectsV2", org)
110110
u, err := addOptions(u, opts)
111111
if err != nil {
@@ -125,12 +125,12 @@ func (s *ProjectsService) ListProjectsForOrg(ctx context.Context, org string, op
125125
return projects, resp, nil
126126
}
127127

128-
// GetProjectForOrg gets a Projects V2 project for an organization by ID.
128+
// GetOrganizationProject gets a Projects V2 project for an organization by ID.
129129
//
130130
// GitHub API docs: https://docs.github.com/rest/projects/projects#get-project-for-organization
131131
//
132132
//meta:operation GET /orgs/{org}/projectsV2/{project_number}
133-
func (s *ProjectsService) GetProjectForOrg(ctx context.Context, org string, projectNumber int) (*ProjectV2, *Response, error) {
133+
func (s *ProjectsService) GetOrganizationProject(ctx context.Context, org string, projectNumber int) (*ProjectV2, *Response, error) {
134134
u := fmt.Sprintf("orgs/%v/projectsV2/%v", org, projectNumber)
135135
req, err := s.client.NewRequest("GET", u, nil)
136136
if err != nil {
@@ -145,12 +145,12 @@ func (s *ProjectsService) GetProjectForOrg(ctx context.Context, org string, proj
145145
return project, resp, nil
146146
}
147147

148-
// ListProjectsForUser lists Projects V2 for a user.
148+
// ListUserProjects lists Projects V2 for a user.
149149
//
150150
// GitHub API docs: https://docs.github.com/rest/projects/projects#list-projects-for-user
151151
//
152152
//meta:operation GET /users/{username}/projectsV2
153-
func (s *ProjectsService) ListProjectsForUser(ctx context.Context, username string, opts *ListProjectsOptions) ([]*ProjectV2, *Response, error) {
153+
func (s *ProjectsService) ListUserProjects(ctx context.Context, username string, opts *ListProjectsOptions) ([]*ProjectV2, *Response, error) {
154154
u := fmt.Sprintf("users/%v/projectsV2", username)
155155
u, err := addOptions(u, opts)
156156
if err != nil {
@@ -169,12 +169,12 @@ func (s *ProjectsService) ListProjectsForUser(ctx context.Context, username stri
169169
return projects, resp, nil
170170
}
171171

172-
// GetProjectForUser gets a Projects V2 project for a user by ID.
172+
// GetUserProject gets a Projects V2 project for a user by ID.
173173
//
174174
// GitHub API docs: https://docs.github.com/rest/projects/projects#get-project-for-user
175175
//
176176
//meta:operation GET /users/{username}/projectsV2/{project_number}
177-
func (s *ProjectsService) GetProjectForUser(ctx context.Context, username string, projectNumber int) (*ProjectV2, *Response, error) {
177+
func (s *ProjectsService) GetUserProject(ctx context.Context, username string, projectNumber int) (*ProjectV2, *Response, error) {
178178
u := fmt.Sprintf("users/%v/projectsV2/%v", username, projectNumber)
179179
req, err := s.client.NewRequest("GET", u, nil)
180180
if err != nil {

‎github/projects_test.go‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func TestProjectsService_ListProjectsForOrg(t *testing.T) {
3232

3333
opts := &ListProjectsOptions{Query: Ptr("alpha"), ListProjectsPaginationOptions: ListProjectsPaginationOptions{After: Ptr("2"), Before: Ptr("1")}}
3434
ctx := t.Context()
35-
projects, _, err := client.Projects.ListProjectsForOrg(ctx, "o", opts)
35+
projects, _, err := client.Projects.ListOrganizationProjects(ctx, "o", opts)
3636
if err != nil {
3737
t.Fatalf("Projects.ListProjectsForOrg returned error: %v", err)
3838
}
@@ -42,12 +42,12 @@ func TestProjectsService_ListProjectsForOrg(t *testing.T) {
4242

4343
const methodName = "ListProjectsForOrg"
4444
testBadOptions(t, methodName, func() (err error) {
45-
_, _, err = client.Projects.ListProjectsForOrg(ctx, "\n", opts)
45+
_, _, err = client.Projects.ListOrganizationProjects(ctx, "\n", opts)
4646
return err
4747
})
4848

4949
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
50-
got, resp, err := client.Projects.ListProjectsForOrg(ctx, "o", opts)
50+
got, resp, err := client.Projects.ListOrganizationProjects(ctx, "o", opts)
5151
if got != nil {
5252
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
5353
}
@@ -56,12 +56,12 @@ func TestProjectsService_ListProjectsForOrg(t *testing.T) {
5656

5757
// still allow both set (no validation enforced) – ensure it does not error
5858
ctxBypass := context.WithValue(t.Context(), BypassRateLimitCheck, true)
59-
if _, _, err = client.Projects.ListProjectsForOrg(ctxBypass, "o", &ListProjectsOptions{ListProjectsPaginationOptions: ListProjectsPaginationOptions{Before: Ptr("b"), After: Ptr("a")}}); err != nil {
59+
if _, _, err = client.Projects.ListOrganizationProjects(ctxBypass, "o", &ListProjectsOptions{ListProjectsPaginationOptions: ListProjectsPaginationOptions{Before: Ptr("b"), After: Ptr("a")}}); err != nil {
6060
t.Fatalf("unexpected error when both before/after set: %v", err)
6161
}
6262
}
6363

64-
func TestProjectsService_GetProjectForOrg(t *testing.T) {
64+
func TestProjectsService_GetOrganizationProject(t *testing.T) {
6565
t.Parallel()
6666
client, mux, _ := setup(t)
6767

@@ -71,7 +71,7 @@ func TestProjectsService_GetProjectForOrg(t *testing.T) {
7171
})
7272

7373
ctx := t.Context()
74-
project, _, err := client.Projects.GetProjectForOrg(ctx, "o", 1)
74+
project, _, err := client.Projects.GetOrganizationProject(ctx, "o", 1)
7575
if err != nil {
7676
t.Fatalf("Projects.GetProjectForOrg returned error: %v", err)
7777
}
@@ -81,7 +81,7 @@ func TestProjectsService_GetProjectForOrg(t *testing.T) {
8181

8282
const methodName = "GetProjectForOrg"
8383
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
84-
got, resp, err := client.Projects.GetProjectForOrg(ctx, "o", 1)
84+
got, resp, err := client.Projects.GetOrganizationProject(ctx, "o", 1)
8585
if got != nil {
8686
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
8787
}
@@ -108,7 +108,7 @@ func TestProjectsService_ListUserProjects(t *testing.T) {
108108
opts := &ListProjectsOptions{Query: Ptr("beta"), ListProjectsPaginationOptions: ListProjectsPaginationOptions{Before: Ptr("1"), After: Ptr("2"), PerPage: Ptr(2)}}
109109
ctx := t.Context()
110110
var ctxBypass context.Context
111-
projects, _, err := client.Projects.ListProjectsForUser(ctx, "u", opts)
111+
projects, _, err := client.Projects.ListUserProjects(ctx, "u", opts)
112112
if err != nil {
113113
t.Fatalf("Projects.ListProjectsForUser returned error: %v", err)
114114
}
@@ -118,12 +118,12 @@ func TestProjectsService_ListUserProjects(t *testing.T) {
118118

119119
const methodName = "ListProjectsForUser"
120120
testBadOptions(t, methodName, func() (err error) {
121-
_, _, err = client.Projects.ListProjectsForUser(ctx, "\n", opts)
121+
_, _, err = client.Projects.ListUserProjects(ctx, "\n", opts)
122122
return err
123123
})
124124

125125
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
126-
got, resp, err := client.Projects.ListProjectsForUser(ctx, "u", opts)
126+
got, resp, err := client.Projects.ListUserProjects(ctx, "u", opts)
127127
if got != nil {
128128
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
129129
}
@@ -132,12 +132,12 @@ func TestProjectsService_ListUserProjects(t *testing.T) {
132132

133133
// still allow both set (no validation enforced) – ensure it does not error
134134
ctxBypass = context.WithValue(t.Context(), BypassRateLimitCheck, true)
135-
if _, _, err = client.Projects.ListProjectsForUser(ctxBypass, "u", &ListProjectsOptions{ListProjectsPaginationOptions: ListProjectsPaginationOptions{Before: Ptr("b"), After: Ptr("a")}}); err != nil {
135+
if _, _, err = client.Projects.ListUserProjects(ctxBypass, "u", &ListProjectsOptions{ListProjectsPaginationOptions: ListProjectsPaginationOptions{Before: Ptr("b"), After: Ptr("a")}}); err != nil {
136136
t.Fatalf("unexpected error when both before/after set: %v", err)
137137
}
138138
}
139139

140-
func TestProjectsService_GetProjectForUser(t *testing.T) {
140+
func TestProjectsService_GetUserProject(t *testing.T) {
141141
t.Parallel()
142142
client, mux, _ := setup(t)
143143

@@ -147,7 +147,7 @@ func TestProjectsService_GetProjectForUser(t *testing.T) {
147147
})
148148

149149
ctx := t.Context()
150-
project, _, err := client.Projects.GetProjectForUser(ctx, "u", 3)
150+
project, _, err := client.Projects.GetUserProject(ctx, "u", 3)
151151
if err != nil {
152152
t.Fatalf("Projects.GetProjectForUser returned error: %v", err)
153153
}
@@ -157,7 +157,7 @@ func TestProjectsService_GetProjectForUser(t *testing.T) {
157157

158158
const methodName = "GetProjectForUser"
159159
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
160-
got, resp, err := client.Projects.GetProjectForUser(ctx, "u", 3)
160+
got, resp, err := client.Projects.GetUserProject(ctx, "u", 3)
161161
if got != nil {
162162
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
163163
}
@@ -385,7 +385,7 @@ func TestProjectsService_GetUserProjectField(t *testing.T) {
385385
})
386386
}
387387

388-
func TestProjectsService_ListProjectsForUser_pagination(t *testing.T) {
388+
func TestProjectsService_ListUserProjects_pagination(t *testing.T) {
389389
t.Parallel()
390390
client, mux, _ := setup(t)
391391
mux.HandleFunc("/users/u/projectsV2", func(w http.ResponseWriter, r *http.Request) {
@@ -405,7 +405,7 @@ func TestProjectsService_ListProjectsForUser_pagination(t *testing.T) {
405405
http.Error(w, "unexpected query", http.StatusBadRequest)
406406
})
407407
ctx := t.Context()
408-
first, resp, err := client.Projects.ListProjectsForUser(ctx, "u", nil)
408+
first, resp, err := client.Projects.ListUserProjects(ctx, "u", nil)
409409
if err != nil {
410410
t.Fatalf("first page error: %v", err)
411411
}
@@ -417,7 +417,7 @@ func TestProjectsService_ListProjectsForUser_pagination(t *testing.T) {
417417
}
418418

419419
opts := &ListProjectsOptions{ListProjectsPaginationOptions: ListProjectsPaginationOptions{After: Ptr(resp.After)}}
420-
second, resp2, err := client.Projects.ListProjectsForUser(ctx, "u", opts)
420+
second, resp2, err := client.Projects.ListUserProjects(ctx, "u", opts)
421421
if err != nil {
422422
t.Fatalf("second page error: %v", err)
423423
}
@@ -439,15 +439,15 @@ func TestProjectsService_ListProjectsForUser_error(t *testing.T) {
439439
ctx := t.Context()
440440
const methodName = "ListProjectsForUser"
441441
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
442-
got, resp, err := client.Projects.ListProjectsForUser(ctx, "u", nil)
442+
got, resp, err := client.Projects.ListUserProjects(ctx, "u", nil)
443443
if got != nil {
444444
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
445445
}
446446
return resp, err
447447
})
448448
// bad options (bad username) should error
449449
testBadOptions(t, methodName, func() (err error) {
450-
_, _, err = client.Projects.ListProjectsForUser(ctx, "\n", nil)
450+
_, _, err = client.Projects.ListUserProjects(ctx, "\n", nil)
451451
return err
452452
})
453453
}
@@ -502,7 +502,7 @@ func TestProjectsService_ListOrganizationProjectFields_pagination(t *testing.T)
502502
}
503503
}
504504

505-
func TestProjectsService_ListProjectsForOrg_pagination(t *testing.T) {
505+
func TestProjectsService_ListOrganizationProjects_pagination(t *testing.T) {
506506
t.Parallel()
507507
client, mux, _ := setup(t)
508508

@@ -524,7 +524,7 @@ func TestProjectsService_ListProjectsForOrg_pagination(t *testing.T) {
524524
})
525525

526526
ctx := t.Context()
527-
first, resp, err := client.Projects.ListProjectsForOrg(ctx, "o", nil)
527+
first, resp, err := client.Projects.ListOrganizationProjects(ctx, "o", nil)
528528
if err != nil {
529529
t.Fatalf("first page error: %v", err)
530530
}
@@ -536,7 +536,7 @@ func TestProjectsService_ListProjectsForOrg_pagination(t *testing.T) {
536536
}
537537

538538
opts := &ListProjectsOptions{ListProjectsPaginationOptions: ListProjectsPaginationOptions{After: Ptr(resp.After)}}
539-
second, resp2, err := client.Projects.ListProjectsForOrg(ctx, "o", opts)
539+
second, resp2, err := client.Projects.ListOrganizationProjects(ctx, "o", opts)
540540
if err != nil {
541541
t.Fatalf("second page error: %v", err)
542542
}

‎test/integration/projects_test.go‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ func TestProjectsV2_Org(t *testing.T) {
4141

4242
opts := &github.ListProjectsOptions{}
4343
// List projects for org; pick the first available project we can read.
44-
projects, _, err := client.Projects.ListProjectsForOrg(ctx, org, opts)
44+
projects, _, err := client.Projects.ListOrganizationProjects(ctx, org, opts)
4545
if err != nil {
4646
// If listing itself fails, abort this test.
47-
t.Fatalf("Projects.ListProjectsForOrg returned error: %v", err)
47+
t.Fatalf("Projects.ListOrganizationProjects returned error: %v", err)
4848
}
4949
if len(projects) == 0 {
5050
t.Skipf("no Projects V2 found for org %s", org)
@@ -56,14 +56,14 @@ func TestProjectsV2_Org(t *testing.T) {
5656
projectNumber := *project.Number
5757

5858
// Re-fetch via Get to exercise endpoint explicitly.
59-
proj, _, err := client.Projects.GetProjectForOrg(ctx, org, projectNumber)
59+
proj, _, err := client.Projects.GetOrganizationProject(ctx, org, projectNumber)
6060
if err != nil {
6161
// Permission mismatch? Skip CRUD while still reporting failure would make the test fail;
6262
// we want correctness so treat as fatal here.
63-
t.Fatalf("Projects.GetProjectForOrg returned error: %v", err)
63+
t.Fatalf("Projects.GetOrganizationProject returned error: %v", err)
6464
}
6565
if proj.Number == nil || *proj.Number != projectNumber {
66-
t.Fatalf("GetProjectForOrg returned unexpected project number: got %+v want %d", proj.Number, projectNumber)
66+
t.Fatalf("GetOrganizationProject returned unexpected project number: got %+v want %d", proj.Number, projectNumber)
6767
}
6868

6969
_, _, err = client.Projects.ListOrganizationProjectFields(ctx, org, projectNumber, nil)
@@ -81,9 +81,9 @@ func TestProjectsV2_User(t *testing.T) {
8181

8282
ctx := t.Context()
8383
opts := &github.ListProjectsOptions{}
84-
projects, _, err := client.Projects.ListProjectsForUser(ctx, user, opts)
84+
projects, _, err := client.Projects.ListUserProjects(ctx, user, opts)
8585
if err != nil {
86-
t.Fatalf("Projects.ListProjectsForUser returned error: %v. This indicates API or permission issue", err)
86+
t.Fatalf("Projects.ListUserProjects returned error: %v. This indicates API or permission issue", err)
8787
}
8888
if len(projects) == 0 {
8989
t.Skipf("no Projects V2 found for user %s", user)
@@ -93,12 +93,12 @@ func TestProjectsV2_User(t *testing.T) {
9393
t.Skip("selected user project has nil Number field")
9494
}
9595

96-
proj, _, err := client.Projects.GetProjectForUser(ctx, user, *project.Number)
96+
proj, _, err := client.Projects.GetUserProject(ctx, user, *project.Number)
9797
if err != nil {
9898
// can't fetch specific project; treat as fatal
99-
t.Fatalf("Projects.GetProjectForUser returned error: %v", err)
99+
t.Fatalf("Projects.GetUserProject returned error: %v", err)
100100
}
101101
if proj.Number == nil || *proj.Number != *project.Number {
102-
t.Fatalf("GetProjectForUser returned unexpected project number: got %+v want %d", proj.Number, *project.Number)
102+
t.Fatalf("GetUserProject returned unexpected project number: got %+v want %d", proj.Number, *project.Number)
103103
}
104104
}

0 commit comments

Comments
 (0)