Merge pull request #2 from NicklasWallgren/support-filesystem

Added support for filesystem and embedded files.

Author: NicklasWallgren

README.md

@@ -30,6 +30,7 @@ We support the two major Go versions, which are 1.17 and 1.18 at the moment.
 - Keeps the templated query as close as possible to the actual SQL query.
 - Extensible template language with support for https://github.com/Masterminds/sprig
 - No third party dependencies
+- Support for embedded filesystem
 
 # API
 ```go
@@ -50,8 +51,11 @@ Register(namespace string, templateRoot string, extensions string) error
 
 ## Register a namespace and parse a template
 ```go
+//go:embed queries/users/*.tsql
+var fs embed.FS
+
 sqlt := sqlTemplate.NewQueryTemplateEngine()
-sqlt.Register("users", "queries/users", ".tsql");
+sqlt.Register("users", fs, ".tsql");
 
 criteria := map[string]interface{}{"Name": "Bill", "Order": "id"}
 tmpl, _ := sqlt.ParseWithValuesFromMap("users", "findByName", criteria)

examples/embedded_files/main.go

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"embed"
+	"fmt"
+
+	sqlTemplate "github.com/NicklasWallgren/sqlTemplate/pkg"
+)
+
+//go:embed queries/users/*.tsql
+var fs embed.FS
+
+func main() {
+	sqlT := sqlTemplate.NewQueryTemplateEngine()
+	if err := sqlT.Register("users", fs, ".tsql"); err != nil {
+		panic(err)
+	}
+
+	criteria := map[string]interface{}{"Id": "1", "Order": "id"}
+
+	tmpl, err := sqlT.ParseWithValuesFromMap("users", "findById", criteria)
+	if err != nil {
+		panic(err)
+	}
+
+	// nolint:forbidigo
+	fmt.Printf("query %v\n", tmpl.GetQuery())
+	// nolint:forbidigo
+	fmt.Printf("query parameters %v\n", tmpl.GetParams())
+}

examples/embedded_files/queries/users/users.tsql

@@ -0,0 +1,6 @@
+{{define "findById"}}
+    SELECT *
+    FROM users
+    WHERE id={{bind .Id}}
+    {{if .Order}}ORDER BY {{.Order}}{{end}}
+{{end}}

examples/map_as_param/go.mod

@@ -2,13 +2,17 @@ package main
 
 import (
 	"fmt"
+	"os"
 
 	sqlTemplate "github.com/NicklasWallgren/sqlTemplate/pkg"
 )
 
 func main() {
+	wd, _ := os.Getwd()
+	fs := os.DirFS(wd + "/examples/map_as_param/queries/users")
+
 	sqlT := sqlTemplate.NewQueryTemplateEngine()
-	if err := sqlT.Register("users", "queries/users", ".tsql"); err != nil {
+	if err := sqlT.Register("users", fs, ".tsql"); err != nil {
 		panic(err)
 	}
 

examples/map_as_param/go.sum

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+	"os"
 
 	sqlTemplate "github.com/NicklasWallgren/sqlTemplate/pkg"
 )
@@ -13,8 +14,11 @@ type searchCriteria struct {
 }
 
 func main() {
+	wd, _ := os.Getwd()
+	fs := os.DirFS(wd + "/examples/struct_as_param/queries/users")
+
 	sqlT := sqlTemplate.NewQueryTemplateEngine()
-	if err := sqlT.Register("users", "queries/users", ".tsql"); err != nil {
+	if err := sqlT.Register("users", fs, ".tsql"); err != nil {
 		panic(err)
 	}
 

examples/map_as_param/main.go

@@ -2,6 +2,7 @@ package pkg
 
 import (
 	"fmt"
+	"io/fs"
 	"text/template"
 )
 
@@ -13,8 +14,8 @@ type QueryTemplateEngine interface {
 	ParseWithValuesFromMap(namespace string, templateName string, parameters map[string]interface{}) (QueryTemplate, error)
 	// ParseWithValuesFromStruct parses a sql template with values from a struct and returns the 'QueryTemplate'
 	ParseWithValuesFromStruct(namespace string, templateName string, parameters interface{}) (QueryTemplate, error)
-	// Register registers a new namespace by template root and extension
-	Register(namespace string, templateRoot string, extensions string) error
+	// Register registers a new namespace by template filesystem and extension
+	Register(namespace string, filesystem fs.FS, extensions string) error
 }
 
 // QueryTemplate is the interface implemented by types that holds the parsed template sql query context.
@@ -29,7 +30,6 @@ type QueryTemplate interface {
 type Option func(*queryTemplateEngine)
 
 type queryTemplateEngine struct {
-	data       interface{}
 	repository *repository
 }
 
@@ -66,8 +66,8 @@ func NewQueryTemplateEngine(options ...Option) QueryTemplateEngine {
 	return templateEngine
 }
 
-func (q queryTemplateEngine) Register(namespace string, templateRoot string, ext string) error {
-	err := q.repository.add(namespace, templateRoot, ext)
+func (q queryTemplateEngine) Register(namespace string, filesystem fs.FS, ext string) error {
+	err := q.repository.add(namespace, filesystem, ext)
 	if err != nil {
 		return fmt.Errorf("could not register the namespace %s %w", namespace, err)
 	}