Merge pull request #1945 from 6543-forks/File_ValueSource

Add File()
urfave · Jul 7, 2024 · 6d6416e · 6d6416e
2 parents c25f563 + bb1b3a9
commit 6d6416e
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/godoc-current.txt b/godoc-current.txt
@@ -979,6 +979,8 @@ type ValueSource interface {
 
 func EnvVar(key string) ValueSource
 
+func File(path string) ValueSource
+
 type ValueSourceChain struct {
 	Chain []ValueSource
 }

diff --git a/testdata/godoc-v3.x.txt b/testdata/godoc-v3.x.txt
@@ -979,6 +979,8 @@ type ValueSource interface {
 
 func EnvVar(key string) ValueSource
 
+func File(path string) ValueSource
+
 type ValueSourceChain struct {
 	Chain []ValueSource
 }

diff --git a/value_source.go b/value_source.go
@@ -128,6 +128,10 @@ func (f *fileValueSource) GoString() string {
 	return fmt.Sprintf("&fileValueSource{Path:%[1]q}", f.Path)
 }
 
+func File(path string) ValueSource {
+	return &fileValueSource{Path: path}
+}
+
 // Files is a helper function to encapsulate a number of
 // fileValueSource together as a ValueSourceChain
 func Files(paths ...string) ValueSourceChain {

diff --git a/value_source_test.go b/value_source_test.go
@@ -71,7 +71,7 @@ func TestFileValueSource(t *testing.T) {
 		r.Implements((*ValueSource)(nil), &fileValueSource{})
 
 		t.Run("not found", func(t *testing.T) {
-			src := &fileValueSource{Path: fmt.Sprintf("junk_file_name-%[1]v", rand.Int())}
+			src := File(fmt.Sprintf("junk_file_name-%[1]v", rand.Int()))
 			_, ok := src.Lookup()
 			r.False(ok)
 		})
@@ -82,23 +82,23 @@ func TestFileValueSource(t *testing.T) {
 		r.Nil(os.WriteFile(fileName, []byte("pita"), 0o644))
 
 		t.Run("found", func(t *testing.T) {
-			src := &fileValueSource{Path: fileName}
+			src := File(fileName)
 			str, ok := src.Lookup()
 			r.True(ok)
 			r.Equal("pita", str)
 		})
 	})
 
 	t.Run("implements fmt.Stringer", func(t *testing.T) {
-		src := &fileValueSource{Path: "/dev/null"}
+		src := File("/dev/null")
 		r := require.New(t)
 
 		r.Implements((*ValueSource)(nil), src)
 		r.Equal("file \"/dev/null\"", src.String())
 	})
 
 	t.Run("implements fmt.GoStringer", func(t *testing.T) {
-		src := &fileValueSource{Path: "/dev/null"}
+		src := File("/dev/null")
 		r := require.New(t)
 
 		r.Implements((*ValueSource)(nil), src)