From 781b89d51a33baf2e9dc844fa0bf8da36ef01f7e Mon Sep 17 00:00:00 2001
From: o98k <63107263+o98k-ok@users.noreply.github.com>
Date: Sat, 23 Sep 2023 13:45:02 +0800
Subject: [PATCH] feat(fileutil): add ReadFile func (#140)

---
 docs/api/packages/fileutil.md    | 39 ++++++++++++++++++++++++++++++++
 docs/en/api/packages/fileutil.md | 39 ++++++++++++++++++++++++++++++++
 fileutil/file.go                 | 23 +++++++++++++++++++
 fileutil/file_example_test.go    | 18 +++++++++++++++
 fileutil/file_test.go            | 19 ++++++++++++++++
 5 files changed, 138 insertions(+)

diff --git a/docs/api/packages/fileutil.md b/docs/api/packages/fileutil.md
index bb6d2d1..bc8d530 100644
--- a/docs/api/packages/fileutil.md
+++ b/docs/api/packages/fileutil.md
@@ -47,6 +47,7 @@ import (
 -   [WriteCsvFile](#WriteCsvFile)
 -   [WriteStringToFile](#WriteStringToFile)
 -   [WriteBytesToFile](#WriteBytesToFile)
+-   [ReadFile](#ReadFile)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -839,3 +840,41 @@ func main() {
     // hello
 }
 ```
+
+### <span id="ReadFile">ReadFile</span>
+
+<p>读取文件或者URL</p>
+
+<b>函数签名:</b>
+
+```go
+func ReadFile(path string) (reader io.ReadCloser, closeFn func(), err error) 
+```
+
+<b>示例:<span style="float:right;display:inline-block;"></span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/fileutil"
+)
+
+func main() {
+   reader, fn, err := ReadFile("https://httpbin.org/robots.txt")
+	if err != nil {
+		return
+	}
+	defer fn()
+
+	dat, err := io.ReadAll(reader)
+	if err != nil {
+		return
+	}
+	fmt.Println(string(dat))
+	// Output:
+	// User-agent: *
+	// Disallow: /deny
+}
+```
\ No newline at end of file
diff --git a/docs/en/api/packages/fileutil.md b/docs/en/api/packages/fileutil.md
index a4d4fd4..48fbb70 100644
--- a/docs/en/api/packages/fileutil.md
+++ b/docs/en/api/packages/fileutil.md
@@ -47,6 +47,7 @@ import (
 -   [WriteCsvFile](#WriteCsvFile)
 -   [WriteStringToFile](#WriteStringToFile)
 -   [WriteBytesToFile](#WriteBytesToFile)
+-   [ReadFile](#ReadFile)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -839,3 +840,41 @@ func main() {
     // hello
 }
 ```
+
+### <span id="ReadFile">ReadFile</span>
+
+<p>Read File/URL</p>
+
+<b>Signature:</b>
+
+```go
+func ReadFile(path string) (reader io.ReadCloser, closeFn func(), err error) 
+```
+
+<b>Example:<span style="float:right;display:inline-block;"> </span></b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/fileutil"
+)
+
+func main() {
+   reader, fn, err := ReadFile("https://httpbin.org/robots.txt")
+	if err != nil {
+		return
+	}
+	defer fn()
+
+	dat, err := io.ReadAll(reader)
+	if err != nil {
+		return
+	}
+	fmt.Println(string(dat))
+	// Output:
+	// User-agent: *
+	// Disallow: /deny
+}
+```
diff --git a/fileutil/file.go b/fileutil/file.go
index 3a043dc..66cdd10 100644
--- a/fileutil/file.go
+++ b/fileutil/file.go
@@ -22,6 +22,8 @@ import (
 	"path/filepath"
 	"runtime"
 	"strings"
+
+	"github.com/duke-git/lancet/v2/validator"
 )
 
 // IsExist checks if a file or directory exists.
@@ -624,3 +626,24 @@ func WriteBytesToFile(filepath string, content []byte) error {
 	_, err = f.Write(content)
 	return err
 }
+
+// ReadFile get file reader by a url or a local file
+// Play: todo
+func ReadFile(path string) (reader io.ReadCloser, closeFn func(), err error) {
+	switch {
+	case validator.IsUrl(path):
+		resp, err := http.Get(path)
+		if err != nil {
+			return nil, func() {}, err
+		}
+		return resp.Body, func() { resp.Body.Close() }, nil
+	case IsExist(path):
+		reader, err := os.Open(path)
+		if err != nil {
+			return nil, func() {}, err
+		}
+		return reader, func() { reader.Close() }, nil
+	default:
+		return nil, func() {}, errors.New("unknown file type")
+	}
+}
diff --git a/fileutil/file_example_test.go b/fileutil/file_example_test.go
index 9bca78b..3f08528 100644
--- a/fileutil/file_example_test.go
+++ b/fileutil/file_example_test.go
@@ -2,6 +2,7 @@ package fileutil
 
 import (
 	"fmt"
+	"io"
 	"os"
 )
 
@@ -385,3 +386,20 @@ func ExampleWriteBytesToFile() {
 	// Output:
 	// hello
 }
+
+func ExampleReadFile() {
+	reader, fn, err := ReadFile("https://httpbin.org/robots.txt")
+	if err != nil {
+		return
+	}
+	defer fn()
+
+	dat, err := io.ReadAll(reader)
+	if err != nil {
+		return
+	}
+	fmt.Println(string(dat))
+	// Output:
+	// User-agent: *
+	// Disallow: /deny
+}
diff --git a/fileutil/file_test.go b/fileutil/file_test.go
index a4ae7a7..44d9784 100644
--- a/fileutil/file_test.go
+++ b/fileutil/file_test.go
@@ -1,6 +1,7 @@
 package fileutil
 
 import (
+	"io"
 	"os"
 	"testing"
 
@@ -457,3 +458,21 @@ func TestWriteBytesToFile(t *testing.T) {
 
 	os.Remove(filepath)
 }
+
+func TestReadFile(t *testing.T) {
+	reader, close, err := ReadFile("https://httpbin.org/robots.txt")
+	if err != nil {
+		t.Fail()
+	}
+	defer close()
+
+	dat, err := io.ReadAll(reader)
+	if err != nil {
+		t.Fail()
+	}
+
+	want := `User-agent: *
+Disallow: /deny
+`
+	internal.NewAssert(t, "TestReadFile").Equal(want, string(dat))
+}