Refactor to use generics

Author: DanWlker

internal/data/data.go

@@ -9,28 +9,14 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/goccy/go-yaml"
 	"github.com/spf13/viper"
 
 	"github.com/DanWlker/remind/internal/config"
+	"github.com/DanWlker/remind/internal/shared"
 )
 
 type EditTextFunc func(todo string, index int) (string, error)
 
-func FGetTodoFromReader(r io.Reader) ([]TodoEntity, error) {
-	var items []TodoEntity
-	dec := yaml.NewDecoder(r)
-
-	err := dec.Decode(&items)
-	if errors.Is(err, io.EOF) {
-		return nil, nil
-	} else if err != nil {
-		return nil, fmt.Errorf("dec.Decode: %w", err)
-	}
-
-	return items, nil
-}
-
 // This does not create the file if it doesn't exist
 func GetTodoFromFile(fileFullPath string) (items []TodoEntity, err error) {
 	f, err := os.Open(fileFullPath)
@@ -43,22 +29,13 @@ func GetTodoFromFile(fileFullPath string) (items []TodoEntity, err error) {
 		}
 	}()
 
-	items, err = FGetTodoFromReader(f)
+	items, err = shared.FGetStructFromYaml[TodoEntity](f)
 	if err != nil {
-		return nil, fmt.Errorf("FGetTodoFromReader: %w", err)
+		return nil, fmt.Errorf("FGetStructFromYaml: %w", err)
 	}
 	return items, nil
 }
 
-func FWriteTodoToFile(w io.Writer, todoList []TodoEntity) error {
-	enc := yaml.NewEncoder(w)
-	if err := enc.Encode(todoList); err != nil {
-		return fmt.Errorf("enc.Encode: %w", err)
-	}
-
-	return nil
-}
-
 func WriteTodoToFile(fileFullPath string, todoList []TodoEntity) (err error) {
 	// Opens with
 	// Write - WRONLY
@@ -77,8 +54,8 @@ func WriteTodoToFile(fileFullPath string, todoList []TodoEntity) (err error) {
 		}
 	}()
 
-	if err = FWriteTodoToFile(f, todoList); err != nil {
-		return fmt.Errorf("FWriteTodoToFile: %w", err)
+	if err = shared.FWriteStructToYaml(f, todoList); err != nil {
+		return fmt.Errorf("FWriteStructToYaml: %w", err)
 	}
 
 	return nil

internal/data/data_test.go

@@ -4,43 +4,9 @@ import (
 	"bytes"
 	"fmt"
 	"strconv"
-	"strings"
 	"testing"
 )
 
-func TestFGetTodoFromReader(t *testing.T) {
-	t.Run("Test EOF returns without error", func(t *testing.T) {
-		reader := strings.NewReader("")
-
-		res, err := FGetTodoFromReader(reader)
-		if err != nil {
-			t.Errorf("Expected no error, got %v", err)
-		}
-
-		if len(res) != 0 {
-			t.Errorf("Expected empty array, got %v", res)
-		}
-	})
-}
-
-func TestFWriteTodoToFile(t *testing.T) {
-	t.Run("Test nil array encodes without error", func(t *testing.T) {
-		ex := "[]\n"
-
-		var b bytes.Buffer
-
-		err := FWriteTodoToFile(&b, nil)
-		if err != nil {
-			t.Errorf("Expected no error, got %v", err)
-		}
-
-		got := b.String()
-		if got != ex {
-			t.Errorf("Expected %v, got %v", strconv.Quote(ex), strconv.Quote(got))
-		}
-	})
-}
-
 func TestFPrettyPrintFile(t *testing.T) {
 	t.Run("Functionality test", func(t *testing.T) {
 		todoList := []TodoEntity{

internal/record/record.go

@@ -3,7 +3,6 @@ package record
 import (
 	"errors"
 	"fmt"
-	"io"
 	"os"
 	"path/filepath"
 
@@ -64,12 +63,9 @@ func GetFileContents() (items []RecordEntity, err error) {
 		}
 	}()
 
-	dec := yaml.NewDecoder(f)
-	err = dec.Decode(&items)
-	if errors.Is(err, io.EOF) {
-		return nil, nil
-	} else if err != nil {
-		return nil, fmt.Errorf("dec.Decode: %w", err)
+	items, err = shared.FGetStructFromYaml[RecordEntity](f)
+	if err != nil {
+		return nil, fmt.Errorf("FGetStructFromYaml: %w", err)
 	}
 
 	return items, nil

internal/shared/file_helpers.go

@@ -0,0 +1,32 @@
+package shared
+
+import (
+	"errors"
+	"fmt"
+	"io"
+
+	"github.com/goccy/go-yaml"
+)
+
+func FGetStructFromYaml[T any](r io.Reader) ([]T, error) {
+	var items []T
+	dec := yaml.NewDecoder(r)
+
+	err := dec.Decode(&items)
+	if errors.Is(err, io.EOF) {
+		return nil, nil
+	} else if err != nil {
+		return nil, fmt.Errorf("dec.Decode: %w", err)
+	}
+
+	return items, nil
+}
+
+func FWriteStructToYaml[T any](w io.Writer, todoList []T) error {
+	enc := yaml.NewEncoder(w)
+	if err := enc.Encode(todoList); err != nil {
+		return fmt.Errorf("enc.Encode: %w", err)
+	}
+
+	return nil
+}

internal/shared/file_helpers_test.go

@@ -0,0 +1,45 @@
+package shared
+
+import (
+	"bytes"
+	"strconv"
+	"strings"
+	"testing"
+)
+
+type SomeYamlStruct struct {
+	Text string
+}
+
+func TestFGetStructFromReader(t *testing.T) {
+	t.Run("Test EOF returns without error", func(t *testing.T) {
+		reader := strings.NewReader("")
+
+		res, err := FGetStructFromYaml[SomeYamlStruct](reader)
+		if err != nil {
+			t.Errorf("Expected no error, got %v", err)
+		}
+
+		if len(res) != 0 {
+			t.Errorf("Expected empty array, got %v", res)
+		}
+	})
+}
+
+func TestFWriteStructToFile(t *testing.T) {
+	t.Run("Test nil array encodes without error", func(t *testing.T) {
+		ex := "[]\n"
+
+		var b bytes.Buffer
+
+		err := FWriteStructToYaml[SomeYamlStruct](&b, nil)
+		if err != nil {
+			t.Errorf("Expected no error, got %v", err)
+		}
+
+		got := b.String()
+		if got != ex {
+			t.Errorf("Expected %v, got %v", strconv.Quote(ex), strconv.Quote(got))
+		}
+	})
+}