feat: expose simple API to generate PDFs

BuddhiLW · BuddhiLW · commit 6388a3f63fa3 · 2025-04-04T17:02:37.000-03:00
diff --git a/go.mod b/go.mod
@@ -6,6 +6,7 @@ require (
 	github.com/rwxrob/bonzai v0.56.6
 	github.com/rwxrob/bonzai/cmds/help v0.8.2
 	github.com/rwxrob/bonzai/comp v0.10.0
+	github.com/rwxrob/bonzai/futil v0.4.0
 	github.com/rwxrob/bonzai/persisters/inyaml v0.3.0
 	github.com/rwxrob/bonzai/vars v0.12.0
 	gopkg.in/yaml.v3 v3.0.1
@@ -31,7 +32,6 @@ require (
 	github.com/rwxrob/bonzai/ds v0.1.1 // indirect
 	github.com/rwxrob/bonzai/edit v0.1.1 // indirect
 	github.com/rwxrob/bonzai/fn v0.9.0 // indirect
-	github.com/rwxrob/bonzai/futil v0.4.0 // indirect
 	github.com/rwxrob/bonzai/is v0.3.0 // indirect
 	github.com/rwxrob/bonzai/mark v0.12.0 // indirect
 	github.com/rwxrob/bonzai/mark/funcs v0.8.6 // indirect
diff --git a/internal/autopdf/cmd.go b/internal/autopdf/cmd.go
@@ -7,9 +7,9 @@ package autopdf
 import (
 	"fmt"
 
-	"github.com/BuddhiLW/AutoPDF/internal/config"
 	"github.com/BuddhiLW/AutoPDF/internal/converter"
 	"github.com/BuddhiLW/AutoPDF/internal/tex"
+	"github.com/BuddhiLW/AutoPDF/pkg/config"
 	"github.com/rwxrob/bonzai"
 	"github.com/rwxrob/bonzai/cmds/help"
 	"github.com/rwxrob/bonzai/comp"
diff --git a/internal/converter/converter.go b/internal/converter/converter.go
@@ -7,8 +7,8 @@ import (
 	"os/exec"
 	"path/filepath"
 	"strings"
-	
-	"github.com/BuddhiLW/AutoPDF/internal/config"
+
+	"github.com/BuddhiLW/AutoPDF/pkg/config"
 )
 
 // Converter handles PDF to image conversion
@@ -53,18 +53,18 @@ func (c *Converter) ConvertPDFToImages(pdfFile string) ([]string, error) {
 		// ImageMagick approach
 		for _, format := range formats {
 			outputPath := filepath.Join(dir, fmt.Sprintf("%s.%s", baseName, format))
-			cmd := exec.Command("convert", 
-				"-density", "300", 
-				pdfFile, 
+			cmd := exec.Command("convert",
+				"-density", "300",
+				pdfFile,
 				outputPath)
-			
+
 			if err := cmd.Run(); err != nil {
 				return outputFiles, fmt.Errorf("image conversion failed for %s: %w", format, err)
 			}
-			
+
 			outputFiles = append(outputFiles, outputPath)
 		}
-		
+
 		return outputFiles, nil
 	}
 
@@ -75,7 +75,7 @@ func (c *Converter) ConvertPDFToImages(pdfFile string) ([]string, error) {
 			// pdftoppm has specific flags for different formats
 			var outputPrefix string
 			var args []string
-			
+
 			switch format {
 			case "png":
 				outputPrefix = filepath.Join(dir, baseName)
@@ -86,20 +86,20 @@ func (c *Converter) ConvertPDFToImages(pdfFile string) ([]string, error) {
 			default:
 				continue // Skip unsupported formats
 			}
-			
+
 			cmd := exec.Command("pdftoppm", args...)
-			
+
 			if err := cmd.Run(); err != nil {
 				return outputFiles, fmt.Errorf("image conversion failed for %s: %w", format, err)
 			}
-			
+
 			// pdftoppm adds numeric suffixes to outputs for multi-page documents
 			// For simplicity, we'll just note the base name
 			outputFiles = append(outputFiles, fmt.Sprintf("%s-*.%s", outputPrefix, format))
 		}
-		
+
 		return outputFiles, nil
 	}
 
 	return nil, errors.New("no suitable conversion tool found (tried 'convert' and 'pdftoppm')")
-}
+}
diff --git a/internal/converter/converter_test.go b/internal/converter/converter_test.go
@@ -8,7 +8,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/BuddhiLW/AutoPDF/internal/config"
+	"github.com/BuddhiLW/AutoPDF/pkg/config"
 )
 
 func TestNewConverter(t *testing.T) {
diff --git a/internal/template/engine.go b/internal/template/engine.go
@@ -6,7 +6,7 @@ import (
 	"os"
 	"text/template"
 
-	"github.com/BuddhiLW/AutoPDF/internal/config"
+	"github.com/BuddhiLW/AutoPDF/pkg/config"
 )
 
 // Engine represents the template processing engine
diff --git a/internal/template/engine_test.go b/internal/template/engine_test.go
@@ -8,7 +8,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/BuddhiLW/AutoPDF/internal/config"
+	"github.com/BuddhiLW/AutoPDF/pkg/config"
 )
 
 // TestProcess creates a temporary LaTeX template with custom delimiters, processes
diff --git a/internal/tex/build.go b/internal/tex/build.go
@@ -7,9 +7,9 @@ import (
 	"path/filepath"
 
 	"github.com/BuddhiLW/AutoPDF/configs"
-	"github.com/BuddhiLW/AutoPDF/internal/config"
 	"github.com/BuddhiLW/AutoPDF/internal/converter"
 	"github.com/BuddhiLW/AutoPDF/internal/template"
+	"github.com/BuddhiLW/AutoPDF/pkg/config"
 	"github.com/rwxrob/bonzai"
 	"github.com/rwxrob/bonzai/cmds/help"
 	"github.com/rwxrob/bonzai/comp"
diff --git a/internal/tex/compile.go b/internal/tex/compile.go
@@ -12,7 +12,7 @@ import (
 	"strings"
 
 	"github.com/BuddhiLW/AutoPDF/configs"
-	"github.com/BuddhiLW/AutoPDF/internal/config"
+	"github.com/BuddhiLW/AutoPDF/pkg/config"
 	"github.com/rwxrob/bonzai"
 	"github.com/rwxrob/bonzai/futil"
 )
diff --git a/internal/tex/compile_test.go b/internal/tex/compile_test.go
@@ -6,7 +6,7 @@ import (
 	"path/filepath"
 	"testing"
 
-	"github.com/BuddhiLW/AutoPDF/internal/config"
+	"github.com/BuddhiLW/AutoPDF/pkg/config"
 )
 
 func TestReplaceExt(t *testing.T) {
diff --git a/internal/tex/default.go b/internal/tex/default.go
@@ -6,7 +6,7 @@ import (
 	"path/filepath"
 
 	"github.com/BuddhiLW/AutoPDF/configs"
-	"github.com/BuddhiLW/AutoPDF/internal/config"
+	"github.com/BuddhiLW/AutoPDF/pkg/config"
 )
 
 func Default(texFilePath string) error {
diff --git a/pkg/api/autopdf_template.tex b/pkg/api/autopdf_template.tex
@@ -0,0 +1,6 @@
+\documentclass{article}
+\title{Test Title: api call}
+\begin{document}
+\maketitle
+Test Content: api call
+\end{document}
diff --git a/pkg/api/funcs.go b/pkg/api/funcs.go
@@ -0,0 +1,73 @@
+package api
+
+import (
+	"log"
+	"os"
+	"path/filepath"
+
+	"github.com/BuddhiLW/AutoPDF/internal/tex"
+	"github.com/BuddhiLW/AutoPDF/pkg/config"
+	"github.com/rwxrob/bonzai/futil"
+	"gopkg.in/yaml.v3"
+)
+
+func GeneratePDF(cfg *config.Config, template config.Template) ([]byte, error) {
+	defaultCfg := config.GetDefaultConfig()
+	if cfg.Template == "" {
+		cfg.Template = template
+	}
+	if cfg.Variables == nil {
+		cfg.Variables = defaultCfg.Variables
+	}
+	if cfg.Output == "" {
+		cfg.Output = defaultCfg.Output
+	}
+	if cfg.Engine == "" {
+		cfg.Engine = defaultCfg.Engine
+	}
+
+	// Create a temporary directory for out build process
+	tmpDir := os.TempDir()
+
+	// Create a temporary output-directory for the pdf
+	outputFile := filepath.Join(tmpDir, "out/output.pdf")
+	log.Println("Output file:", outputFile)
+	cfg.Output = config.Output(outputFile)
+	log.Println("Final merged config:", cfg)
+
+	// Create a temporary config.yaml file, with the merged config
+	writer, err := os.Create(filepath.Join(tmpDir, "config.yaml"))
+	if err != nil {
+		return nil, err
+	}
+	defer writer.Close()
+
+	log.Println("cfg:", cfg)
+	// Encode the merged config to the temporary config.yaml file
+	err = yaml.NewEncoder(writer).Encode(cfg)
+	if err != nil {
+		return nil, err
+	}
+
+	// Build the pdf using the merged config
+	err = tex.BuildCmd.Do(nil, cfg.Template.String(), writer.Name())
+	if err != nil {
+		if futil.FileIsEmpty(outputFile) {
+			return nil, err
+		}
+		// Normal to LaTeX to send build verbose info to stderr
+		// so we need to return the error only if the output file is empty
+		//
+		// To print the verbose "error" info, we need to print the stderr
+		// log.Println("Stderr while building pdf:", err)
+	}
+
+	// Read the generated pdf
+	pdfBytes, err := os.ReadFile(outputFile)
+	if err != nil {
+		return nil, err
+	}
+
+	// Return the generated pdf
+	return pdfBytes, nil
+}
diff --git a/pkg/api/funcs_test.go b/pkg/api/funcs_test.go
@@ -0,0 +1,38 @@
+package api
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/BuddhiLW/AutoPDF/pkg/config"
+)
+
+func TestGeneratePDF(t *testing.T) {
+	// Setup test data
+	defaultCfg := config.GetDefaultConfig()
+	testCfg := &config.Config{
+		Template: "./test_data/template.tex",
+		Variables: map[string]string{
+			"title":   "Test Title: api call",
+			"content": "Test Content: api call",
+		},
+	}
+
+	// Call the function
+	pdfBytes, err := GeneratePDF(testCfg, defaultCfg.Template)
+	if err != nil {
+		t.Fatalf("Expected no error, got %v", err)
+	}
+
+	// Check if the PDF bytes are not nil or empty
+	if len(pdfBytes) == 0 {
+		t.Fatal("Expected non-empty PDF bytes")
+	}
+
+	// Clean up any generated files if necessary
+	outputFile := filepath.Join(os.TempDir(), "out/output.pdf")
+	if err := os.Remove(outputFile); err != nil && !os.IsNotExist(err) {
+		t.Fatalf("Failed to clean up output file: %v", err)
+	}
+}
diff --git a/pkg/api/test_data/template.tex b/pkg/api/test_data/template.tex
@@ -0,0 +1,6 @@
+\documentclass{article}
+\title{delim[[.title]]}
+\begin{document}
+\maketitle
+delim[[.content]]
+\end{document}
diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -69,7 +69,7 @@ func GetConfig(persister *inyaml.Persister) (*Config, error) {
 
 	if configStr == "" {
 		// Return default config
-		return getDefaultConfig(), nil
+		return GetDefaultConfig(), nil
 	}
 
 	var config Config
@@ -95,8 +95,8 @@ func SaveConfig(persister *inyaml.Persister, config *Config) error {
 	return nil
 }
 
-// getDefaultConfig returns a default configuration
-func getDefaultConfig() *Config {
+// GetDefaultConfig returns a default configuration
+func GetDefaultConfig() *Config {
 	return &Config{
 		Template: "",
 		Output:   "",
@@ -136,3 +136,11 @@ func NewConfigFromYAML(yamlData []byte) (*Config, error) {
 
 	return &config, nil
 }
+
+func (c *Config) Marshal() ([]byte, error) {
+	return yaml.Marshal(c)
+}
+
+func (c *Config) Unmarshal(data []byte) error {
+	return yaml.Unmarshal(data, c)
+}
diff --git a/pkg/config/config_test.go b/pkg/config/config_test.go
diff --git a/pkg/util/deepmerge.go b/pkg/util/deepmerge.go
@@ -0,0 +1,56 @@
+package util
+
+import (
+	"errors"
+	"reflect"
+)
+
+func DeepMerge[T any](a, b T) (T, error) {
+	aVal := reflect.ValueOf(a)
+	bVal := reflect.ValueOf(b)
+
+	if aVal.Kind() == reflect.Ptr && bVal.Kind() == reflect.Ptr {
+		aVal = aVal.Elem()
+		bVal = bVal.Elem()
+	} else {
+		return a, errors.New("both arguments must be pointers to structs")
+	}
+
+	// Create a new object of the same type to store the merge
+	merged := reflect.New(aVal.Type()).Elem()
+
+	for i := 0; i < aVal.NumField(); i++ {
+		aField := aVal.Field(i)
+		bField := bVal.Field(i)
+
+		if !aField.CanSet() {
+			continue
+		}
+
+		// If bField is not zero, it takes precedence
+		if !isZeroValue(bField) {
+			if aField.Kind() == reflect.Struct {
+				deeperMerged, err := DeepMerge(aField.Interface(), bField.Interface())
+				if err != nil {
+					return a, err
+				}
+				merged.Field(i).Set(reflect.ValueOf(deeperMerged))
+			} else if aField.Kind() == reflect.Map {
+				// Handle merging of maps
+				for _, key := range bField.MapKeys() {
+					merged.Field(i).SetMapIndex(key, bField.MapIndex(key))
+				}
+			} else {
+				merged.Field(i).Set(bField)
+			}
+		} else {
+			merged.Field(i).Set(aField)
+		}
+	}
+
+	return merged.Interface().(T), nil
+}
+
+func isZeroValue(v reflect.Value) bool {
+	return v.Interface() == reflect.Zero(v.Type()).Interface()
+}
diff --git a/test/model_letter/main.pdf b/test/model_letter/main.pdf

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import (`
`8`	`8`	`"strings"`
`9`	`9`	`"testing"`
`10`	`10`
`11`		`- "github.com/BuddhiLW/AutoPDF/internal/config"`
	`11`	`+ "github.com/BuddhiLW/AutoPDF/pkg/config"`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`func TestNewConverter(t *testing.T) {`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import (`
`6`	`6`	`"os"`
`7`	`7`	`"text/template"`
`8`	`8`
`9`		`- "github.com/BuddhiLW/AutoPDF/internal/config"`
	`9`	`+ "github.com/BuddhiLW/AutoPDF/pkg/config"`
`10`	`10`	`)`
`11`	`11`
`12`	`12`	`// Engine represents the template processing engine`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ import (`
`12`	`12`	`"strings"`
`13`	`13`
`14`	`14`	`"github.com/BuddhiLW/AutoPDF/configs"`
`15`		`- "github.com/BuddhiLW/AutoPDF/internal/config"`
	`15`	`+ "github.com/BuddhiLW/AutoPDF/pkg/config"`
`16`	`16`	`"github.com/rwxrob/bonzai"`
`17`	`17`	`"github.com/rwxrob/bonzai/futil"`
`18`	`18`	`)`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import (`
`6`	`6`	`"path/filepath"`
`7`	`7`	`"testing"`
`8`	`8`
`9`		`- "github.com/BuddhiLW/AutoPDF/internal/config"`
	`9`	`+ "github.com/BuddhiLW/AutoPDF/pkg/config"`
`10`	`10`	`)`
`11`	`11`
`12`	`12`	`func TestReplaceExt(t *testing.T) {`