feat: add GetSuffleLines, add read file to Yaml.

Author: coghost

content_operation.go

@@ -6,9 +6,11 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"math/rand"
 	"os"
 	"strings"
 
+	"github.com/goccy/go-yaml"
 	"github.com/spf13/afero"
 )
 
@@ -128,6 +130,21 @@ func (p *FsPath) MustGetLines() []string {
 	return lines
 }
 
+// GetShuffleLines reads the file return its contents as a slice of shuffled strings
+func (p *FsPath) GetShuffleLines() ([]string, error) {
+	lines, err := p.GetLines()
+	if err != nil {
+		return nil, err
+	}
+
+	for i := range lines {
+		j := rand.Intn(i + 1)
+		lines[i], lines[j] = lines[j], lines[i]
+	}
+
+	return lines, nil
+}
+
 // GetJSON reads the file and unmarshals its content into the provided interface.
 //
 // This method reads the entire file content using GetBytes, then uses json.Unmarshal
@@ -155,13 +172,13 @@ func (p *FsPath) MustGetLines() []string {
 //
 // Note: This method reads the entire file into memory. For very large files,
 // consider using a streaming JSON parser instead.
-func (p *FsPath) GetJSON(raw interface{}) error {
+func (p *FsPath) GetJSON(v any) error {
 	data, err := p.GetBytes()
 	if err != nil {
 		return err
 	}
 
-	return json.Unmarshal(data, raw)
+	return json.Unmarshal(data, v)
 }
 
 // MustGetJSON reads the file, unmarshals its content into the provided interface, and panics on error.
@@ -184,10 +201,24 @@ func (p *FsPath) GetJSON(raw interface{}) error {
 //
 // Note: Use this method only when you're sure the file exists and contains valid JSON,
 // or if you want to halt execution on error.
-func (p *FsPath) MustGetJSON(v interface{}) {
+func (p *FsPath) MustGetJSON(v any) {
 	p.e(p.GetJSON(v))
 }
 
+// GetYaml similar as GetJSON, but unmarshal with Yaml
+func (p *FsPath) GetYaml(v any) error {
+	data, err := p.GetBytes()
+	if err != nil {
+		return err
+	}
+
+	return yaml.Unmarshal(data, &v)
+}
+
+func (p *FsPath) MustGetYaml(v any) {
+	p.e(p.GetYaml(v))
+}
+
 // Reader returns an io.Reader for the file
 func (p *FsPath) Reader() (io.Reader, error) {
 	return p.fs.Open(p.absPath)

go.mod

@@ -1,8 +1,9 @@
 module github.com/coghost/pathlib
 
-go 1.22.5
+go 1.24
 
 require (
+	github.com/goccy/go-yaml v1.17.1
 	github.com/spf13/afero v1.11.0
 	github.com/stretchr/testify v1.9.0
 )

go.sum

@@ -1,6 +1,8 @@
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/goccy/go-yaml v1.17.1 h1:LI34wktB2xEE3ONG/2Ar54+/HJVBriAGJ55PHls4YuY=
+github.com/goccy/go-yaml v1.17.1/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
 github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
 github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=

path.go

@@ -194,7 +194,7 @@ func (p *FsPath) Suffixes() []string {
 // Example:
 //
 //	p.e(someFunction())  // panics if someFunction returns an error
-func (p *FsPath) e(args ...interface{}) {
+func (p *FsPath) e(args ...any) {
 	err, ok := args[len(args)-1].(error)
 	if ok {
 		panic(err)

util.go

@@ -245,14 +245,14 @@ func IsJSON(data []byte) bool {
 //
 // Note: This function will only include fields that would be marshaled to JSON.
 // Unexported fields and fields with `json:"-"` tags will be omitted.
-func StructToJSONMap(src interface{}) (map[string]interface{}, error) {
+func StructToJSONMap(src any) (map[string]any, error) {
 	jsonData, err := json.Marshal(src)
 	if err != nil {
 		return nil, fmt.Errorf("failed to marshal struct to JSON: %w", err)
 	}
 
 	// Then unmarshal the JSON to a map
-	var result map[string]interface{}
+	var result map[string]any
 
 	err = json.Unmarshal(jsonData, &result)
 	if err != nil {
@@ -290,7 +290,7 @@ func StructToJSONMap(src interface{}) (map[string]interface{}, error) {
 //
 // Note: This function relies on the `omitempty` tag for fields that should be
 // removed when empty. Make sure your struct is properly tagged for the desired behavior.
-func SanitizeJSON(rawJSON string, template interface{}) ([]byte, error) {
+func SanitizeJSON(rawJSON string, template any) ([]byte, error) {
 	// Unmarshal raw JSON into the provided struct template
 	if err := json.Unmarshal([]byte(rawJSON), template); err != nil {
 		return nil, fmt.Errorf("failed to unmarshal JSON: %w", err)