Clean up the option names.

Author: schmidtw

githubfs.go

@@ -82,15 +82,15 @@ type FS struct {
 type Option func(gfs *FS)
 
 // WithURL provides a way to set the URL for the specific github instance to use.
-func WithURL(url string) Option {
+func WithGithubURL(url string) Option {
 	return func(gfs *FS) {
 		gfs.githubUrl = url
 	}
 }
 
 // WithRawURL provides a way to set the URL for downloading files via the web
 // interface vs. a tarball.
-func WithRawURL(url string) Option {
+func WithRawDownloadURL(url string) Option {
 	return func(gfs *FS) {
 		gfs.rawUrl = url
 	}
@@ -103,9 +103,12 @@ func WithHttpClient(c *http.Client) Option {
 	}
 }
 
-// WithFullOrg instructs the filesystem to include all the repositories owned
+// WithOrg instructs the filesystem to include all the repositories owned
 // by an organization or user and the default branches of each repo.
-func WithFullOrg(org string, allowArchivedrepos ...bool) Option {
+//
+// Repos marked as archived are filtered unless allowArchivedrepos is set to
+// true.
+func WithOrg(org string, allowArchivedrepos ...bool) Option {
 	with := false
 	if len(allowArchivedrepos) > 0 {
 		with = allowArchivedrepos[len(allowArchivedrepos)-1]
@@ -116,7 +119,8 @@ func WithFullOrg(org string, allowArchivedrepos ...bool) Option {
 }
 
 // WithRepo configures a specific owner, repository and branchs to include.  If
-// no branch is specified the default branch is selected.
+// no branch is specified the default branch is selected.  Multiple branches may
+// be specified in one call.
 func WithRepo(org string, repo string, branches ...string) Option {
 	if len(branches) == 0 {
 		return func(gfs *FS) {
@@ -142,6 +146,8 @@ func WithRepo(org string, repo string, branches ...string) Option {
 
 // WithThresholdInKB sets the maximum size to download the entire repository vs.
 // downloading the individual files.
+//
+// Defaults to downloading a repo snapshot if the repo is less than 10MB.
 func WithThresholdInKB(max int) Option {
 	return func(gfs *FS) {
 		gfs.threshold = max

githubfs_test.go

@@ -30,11 +30,11 @@ func TestNew(t *testing.T) {
 		}, {
 			description: "different github url",
 			ghUrl:       "https://example.com",
-			opts:        []Option{WithURL("https://example.com")},
+			opts:        []Option{WithGithubURL("https://example.com")},
 		}, {
 			description: "different http url",
 			rawUrl:      "https://example.com",
-			opts:        []Option{WithRawURL("https://example.com")},
+			opts:        []Option{WithRawDownloadURL("https://example.com")},
 		}, {
 			description:   "different http client",
 			nilHttpClient: true,
@@ -45,8 +45,8 @@ func TestNew(t *testing.T) {
 			opts:        []Option{WithThresholdInKB(10)},
 		}, {
 			description: "specify orgs and repos.",
-			opts: []Option{WithFullOrg("foo"),
-				WithFullOrg("bar", true),
+			opts: []Option{WithOrg("foo"),
+				WithOrg("bar", true),
 				WithRepo("org", "repo"),
 				WithRepo("cat", "repo", "branch1", "branch2"),
 			},
@@ -149,22 +149,22 @@ func TestMostThings(t *testing.T) {
 			expectErr:   true,
 		}, {
 			description: "fetch a few of repos test",
-			opts:        []Option{WithFullOrg("org")},
+			opts:        []Option{WithOrg("org")},
 			payload:     []string{twoReposResponse},
 			expect:      []string{"org/.github/git", "org/.go-template/git"},
 		}, {
 			description: "fetch a few of repos spread across requests test",
-			opts:        []Option{WithFullOrg("org")},
+			opts:        []Option{WithOrg("org")},
 			payload:     []string{twoReposOneAtATimeResponse001, twoReposOneAtATimeResponse002},
 			expect:      []string{"org/.github/git", "org/.go-template/git"},
 		}, {
 			description: "fetch a disabled and archived repo.",
-			opts:        []Option{WithFullOrg("org")},
+			opts:        []Option{WithOrg("org")},
 			payload:     []string{twoReposOneDisabledResponse},
 			unexpected:  []string{"org/.github/git", "org/.go-template/git"},
 		}, {
 			description: "get an invalid response during fetching a single repo",
-			opts:        []Option{WithFullOrg("org")},
+			opts:        []Option{WithOrg("org")},
 			payload:     []string{invalidJsonResponse},
 			expect:      []string{"org/repo/git", "org/moved/git"},
 			expectErr:   true,
@@ -292,7 +292,7 @@ func TestMostThings(t *testing.T) {
 
 			server.Start()
 
-			tc.opts = append(tc.opts, WithURL(server.URL), WithRawURL(server.URL))
+			tc.opts = append(tc.opts, WithGithubURL(server.URL), WithRawDownloadURL(server.URL))
 			gfs := New(tc.opts...)
 			require.NotNil(gfs)