release v1.4.2

README.md

@@ -4,7 +4,7 @@
 <br/>
 
 ![Go version](https://img.shields.io/badge/go-v1.16-9cf)
-[![Release](https://img.shields.io/badge/release-1.4.1-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-1.4.2-green.svg)](https://github.com/duke-git/lancet/releases)
 [![GoDoc](https://godoc.org/github.com//duke-git/lancet?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet)
 [![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet)](https://goreportcard.com/report/github.com/duke-git/lancet)
 [![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
@@ -154,7 +154,9 @@ import "github.com/duke-git/lancet/cryptor"
 -   [GenerateRsaKey](https://github.com/duke-git/lancet/blob/v1/docs/cryptor.md#GenerateRsaKey)
 -   [RsaEncrypt](https://github.com/duke-git/lancet/blob/v1/docs/cryptor.md#RsaEncrypt)
 -   [RsaDecrypt](https://github.com/duke-git/lancet/blob/v1/docs/cryptor.md#RsaDecrypt)
-
+-   [GenerateRsaKeyPair](https://github.com/duke-git/lancet/blob/v1/docs/cryptor.md#GenerateRsaKeyPair)
+-   [RsaEncryptOAEP](https://github.com/duke-git/lancet/blob/v1/docs/cryptor.md#RsaEncryptOAEP)
+-   [RsaDecryptOAEP](https://github.com/duke-git/lancet/blob/v1/docs/cryptor.md#RsaDecryptOAEP)
 ### 4. Datetime package supports date and time format and compare.
 
 ```go
@@ -237,6 +239,7 @@ import "github.com/duke-git/lancet/fileutil"
 -   [WriteCsvFile](https://github.com/duke-git/lancet/blob/v1/docs/fileutil.md#WriteCsvFile)
 -   [WriteStringToFile](https://github.com/duke-git/lancet/blob/v1/docs/fileutil.md#WriteStringToFile)
 -   [WriteBytesToFile](https://github.com/duke-git/lancet/blob/v1/docs/fileutil.md#WriteBytesToFile)
+-   [ReadFile](https://github.com/duke-git/lancet/blob/v1/docs/fileutil.md#ReadFile)
 
 ### 6. Formatter contains some functions for data formatting.
 
@@ -510,6 +513,16 @@ import "github.com/duke-git/lancet/validator"
 -   [IsGBK](https://github.com/duke-git/lancet/blob/v1/docs/validator.md#IsGBK)
 -   [IsASCII](https://github.com/duke-git/lancet/blob/v1/docs/validator.md#IsASCII)
 -   [IsPrintable](https://github.com/duke-git/lancet/blob/v1/docs/validator.md#IsPrintable)
+-   [IsBin](https://github.com/duke-git/lancet/blob/v1/docs/validator.md#IsBin)
+-   [IsHex](https://github.com/duke-git/lancet/blob/v1/docs/validator.md#IsHex)
+-   [IsBase64URL](https://github.com/duke-git/lancet/blob/v1/docs/validator.md#IsBase64URL)
+-   [IsJWT](https://github.com/duke-git/lancet/blob/v1/docs/validator.md#IsJWT)
+-   [IsVisa](https://github.com/duke-git/lancet/blob/v1/docs/validator.md#IsVisa)
+-   [IsMasterCard](https://github.com/duke-git/lancet/blob/v1/docs/validator.md#IsMasterCard)
+-   [IsAmericanExpress](https://github.com/duke-git/lancet/blob/v1/docs/validator.md#IsAmericanExpress)
+-   [IsUnionPay](https://github.com/duke-git/lancet/blob/v1/docs/validator.md#IsUnionPay)
+-   [IsChinaUnionPay](https://github.com/duke-git/lancet/blob/v1/docs/validator.md#IsChinaUnionPay)
+
 
 ## How to Contribute
 

README_zh-CN.md

@@ -4,7 +4,7 @@
 <br/>
 
 ![Go version](https://img.shields.io/badge/go-v1.16-9cf)
-[![Release](https://img.shields.io/badge/release-1.4.1-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-1.4.2-green.svg)](https://github.com/duke-git/lancet/releases)
 [![GoDoc](https://godoc.org/github.com//duke-git/lancet?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet)
 [![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet)](https://goreportcard.com/report/github.com/duke-git/lancet)
 [![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
@@ -153,6 +153,10 @@ md#HmacSha256WithBase64)
 -   [GenerateRsaKey](https://github.com/duke-git/lancet/blob/v1/docs/cryptor_zh-CN.md#GenerateRsaKey)
 -   [RsaEncrypt](https://github.com/duke-git/lancet/blob/v1/docs/cryptor_zh-CN.md#RsaEncrypt)
 -   [RsaDecrypt](https://github.com/duke-git/lancet/blob/v1/docs/cryptor_zh-CN.md#RsaDecrypt)
+-   [GenerateRsaKeyPair](https://github.com/duke-git/lancet/blob/v1/docs/cryptor_zh-CN.md#GenerateRsaKeyPair)
+-   [RsaEncryptOAEP](https://github.com/duke-git/lancet/blob/v1/docs/cryptor_zh-CN.md#RsaEncryptOAEP)
+-   [RsaDecryptOAEP](https://github.com/duke-git/lancet/blob/v1/docs/cryptor_zh-CN.md#RsaDecryptOAEP)
+
 
 ### 4. datetime 日期时间处理包，格式化日期，比较日期。
 
@@ -236,6 +240,7 @@ import "github.com/duke-git/lancet/fileutil"
 -   [WriteCsvFile](https://github.com/duke-git/lancet/blob/v1/docs/fileutil_zh-CN.md#WriteCsvFile)
 -   [WriteStringToFile](https://github.com/duke-git/lancet/blob/v1/docs/fileutil_zh-CN.md#WriteStringToFile)
 -   [WriteBytesToFile](https://github.com/duke-git/lancet/blob/v1/docs/fileutil_zh-CN.md#WriteBytesToFile)
+-   [ReadFile](https://github.com/duke-git/lancet/blob/v1/docs/fileutil_zh-CN.md#ReadFile)
 
 ### 6. formatter 格式化器包含一些数据格式化处理方法。
 
@@ -509,6 +514,15 @@ import "github.com/duke-git/lancet/validator"
 -   [IsGBK](https://github.com/duke-git/lancet/blob/v1/docs/validator_zh-CN.md#IsGBK)
 -   [IsASCII](https://github.com/duke-git/lancet/blob/v1/docs/validator_zh-CN.md#IsASCII)
 -   [IsPrintable](https://github.com/duke-git/lancet/blob/v1/docs/validator_zh-CN.md#IsPrintable)
+-   [IsBin](https://github.com/duke-git/lancet/blob/v1/docs/validator_zh-CN.md#IsBin)
+-   [IsHex](https://github.com/duke-git/lancet/blob/v1/docs/validator_zh-CN.md#IsHex)
+-   [IsBase64URL](https://github.com/duke-git/lancet/blob/v1/docs/validator_zh-CN.md#IsBase64URL)
+-   [IsJWT](https://github.com/duke-git/lancet/blob/v1/docs/validator_zh-CN.md#IsJWT)
+-   [IsVisa](https://github.com/duke-git/lancet/blob/v1/docs/validator_zh-CN.md#IsVisa)
+-   [IsMasterCard](https://github.com/duke-git/lancet/blob/v1/docs/validator_zh-CN.md#IsMasterCard)
+-   [IsAmericanExpress](https://github.com/duke-git/lancet/blob/v1/docs/validator_zh-CN.md#IsAmericanExpress)
+-   [IsUnionPay](https://github.com/duke-git/lancet/blob/v1/docs/validator_zh-CN.md#IsUnionPay)
+-   [IsChinaUnionPay](https://github.com/duke-git/lancet/blob/v1/docs/validator_zh-CN.md#IsChinaUnionPay)
 
 ## 如何贡献代码
 

docs/fileutil.md

@@ -47,6 +47,7 @@ import (
 -   [WriteCsvFile](#WriteCsvFile)
 -   [WriteStringToFile](#WriteStringToFile)
 -   [WriteBytesToFile](#WriteBytesToFile)
+-   [ReadFile](#ReadFile)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -827,3 +828,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
+}
+```

docs/fileutil_zh-CN.md

@@ -47,6 +47,7 @@ import (
 -   [WriteCsvFile](#WriteCsvFile)
 -   [WriteStringToFile](#WriteStringToFile)
 -   [WriteBytesToFile](#WriteBytesToFile)
+-   [ReadFile](#ReadFile)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -827,3 +828,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
+}
+```

docs/validator.md

@@ -54,7 +54,7 @@ import (
 -   [IsZeroValue](#IsZeroValue)
 -   [IsGBK](#IsGBK)
 -   [IsASCII](#IsASCII)
--   [IsAIsPrintableSCII](#IsPrintable)
+-   [IsPrintable](#IsPrintable)
 -   [IsBin](#IsBin)
 -   [IsHex](#IsHex)
 -   [IsBase64URL](#IsBase64URL)

fileutil/file.go

@@ -19,10 +19,11 @@ import (
 	"io/ioutil"
 	"net/http"
 	"os"
-	"path"
 	"path/filepath"
 	"runtime"
 	"strings"
+
+	"github.com/duke-git/lancet/validator"
 )
 
 // IsExist checks if a file or directory exists
@@ -449,7 +450,7 @@ func CurrentPath() string {
 	var absPath string
 	_, filename, _, ok := runtime.Caller(1)
 	if ok {
-		absPath = path.Dir(filename)
+		absPath = filepath.Dir(filename)
 	}
 
 	return absPath
@@ -589,3 +590,23 @@ func WriteBytesToFile(filepath string, content []byte) error {
 	_, err = f.Write(content)
 	return err
 }
+
+// ReadFile get file reader by a url or a local file.
+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")
+	}
+}

fileutil/file_test.go

@@ -1,6 +1,7 @@
 package fileutil
 
 import (
+	"io"
 	"os"
 	"testing"
 
@@ -294,7 +295,11 @@ func TestSha(t *testing.T) {
 	assert := internal.NewAssert(t, "TestSha")
 
 	sha1, err := Sha("./testdata/test.txt", 1)
+	assert.IsNil(err)
+
 	sha256, err := Sha("./testdata/test.txt", 256)
+	assert.IsNil(err)
+
 	sha512, err := Sha("./testdata/test.txt", 512)
 
 	assert.IsNil(err)
@@ -401,3 +406,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))
+}