Files
gibidify/templates/engine.go
Ismo Vuorinen 95b7ef6dd3 chore: modernize workflows, security scanning, and linting configuration (#50)
* build: update Go 1.25, CI workflows, and build tooling

- Upgrade to Go 1.25
- Add benchmark targets to Makefile
- Implement parallel gosec execution
- Lock tool versions for reproducibility
- Add shellcheck directives to scripts
- Update CI workflows with improved caching

* refactor: migrate from golangci-lint to revive

- Replace golangci-lint with revive for linting
- Configure comprehensive revive rules
- Fix all EditorConfig violations
- Add yamllint and yamlfmt support
- Remove deprecated .golangci.yml

* refactor: rename utils to shared and deduplicate code

- Rename utils package to shared
- Add shared constants package
- Deduplicate constants across packages
- Address CodeRabbit review feedback

* fix: resolve SonarQube issues and add safety guards

- Fix all 73 SonarQube OPEN issues
- Add nil guards for resourceMonitor, backpressure, metricsCollector
- Implement io.Closer for headerFileReader
- Propagate errors from processing helpers
- Add metrics and templates packages
- Improve error handling across codebase

* test: improve test infrastructure and coverage

- Add benchmarks for cli, fileproc, metrics
- Improve test coverage for cli, fileproc, config
- Refactor tests with helper functions
- Add shared test constants
- Fix test function naming conventions
- Reduce cognitive complexity in benchmark tests

* docs: update documentation and configuration examples

- Update CLAUDE.md with current project state
- Refresh README with new features
- Add usage and configuration examples
- Add SonarQube project configuration
- Consolidate config.example.yaml

* fix: resolve shellcheck warnings in scripts

- Use ./*.go instead of *.go to prevent dash-prefixed filenames
  from being interpreted as options (SC2035)
- Remove unreachable return statement after exit (SC2317)
- Remove obsolete gibidiutils/ directory reference

* chore(deps): upgrade go dependencies

* chore(lint): megalinter fixes

* fix: improve test coverage and fix file descriptor leaks

- Add defer r.Close() to fix pipe file descriptor leaks in benchmark tests
- Refactor TestProcessorConfigureFileTypes with helper functions and assertions
- Refactor TestProcessorLogFinalStats with output capture and keyword verification
- Use shared constants instead of literal strings (TestFilePNG, FormatMarkdown, etc.)
- Reduce cognitive complexity by extracting helper functions

* fix: align test comments with function names

Remove underscores from test comments to match actual function names:
- benchmark/benchmark_test.go (2 fixes)
- fileproc/filetypes_config_test.go (4 fixes)
- fileproc/filetypes_registry_test.go (6 fixes)
- fileproc/processor_test.go (6 fixes)
- fileproc/resource_monitor_types_test.go (4 fixes)
- fileproc/writer_test.go (3 fixes)

* fix: various test improvements and bug fixes

- Remove duplicate maxCacheSize check in filetypes_registry_test.go
- Shorten long comment in processor_test.go to stay under 120 chars
- Remove flaky time.Sleep in collector_test.go, use >= 0 assertion
- Close pipe reader in benchmark_test.go to fix file descriptor leak
- Use ContinueOnError in flags_test.go to match ResetFlags behavior
- Add nil check for p.ui in processor_workers.go before UpdateProgress
- Fix resource_monitor_validation_test.go by setting hardMemoryLimitBytes directly

* chore(yaml): add missing document start markers

Add --- document start to YAML files to satisfy yamllint:
- .github/workflows/codeql.yml
- .github/workflows/build-test-publish.yml
- .github/workflows/security.yml
- .github/actions/setup/action.yml

* fix: guard nil resourceMonitor and fix test deadlock

- Guard resourceMonitor before CreateFileProcessingContext call
- Add ui.UpdateProgress on emergency stop and path error returns
- Fix potential deadlock in TestProcessFile using wg.Go with defer close
2025-12-10 19:07:11 +02:00

390 lines
11 KiB
Go

// Package templates provides templating engine functionality for output formatting.
package templates
import (
"bytes"
"fmt"
"path/filepath"
"strings"
"text/template"
"time"
"golang.org/x/text/cases"
"golang.org/x/text/language"
"github.com/ivuorinen/gibidify/shared"
)
// bufferBuilder wraps bytes.Buffer with error accumulation for robust error handling.
type bufferBuilder struct {
buf *bytes.Buffer
err error
}
// newBufferBuilder creates a new buffer builder.
func newBufferBuilder() *bufferBuilder {
return &bufferBuilder{buf: &bytes.Buffer{}}
}
// writeString writes a string, accumulating any errors.
func (bb *bufferBuilder) writeString(s string) {
if bb.err != nil {
return
}
_, bb.err = bb.buf.WriteString(s)
}
// String returns the accumulated string, or empty string if there was an error.
func (bb *bufferBuilder) String() string {
if bb.err != nil {
return ""
}
return bb.buf.String()
}
// Engine handles template processing and output generation.
type Engine struct {
template OutputTemplate
context TemplateContext
}
// NewEngine creates a new template engine with the specified template.
func NewEngine(templateName string, context TemplateContext) (*Engine, error) {
tmpl, exists := BuiltinTemplates[templateName]
if !exists {
return nil, fmt.Errorf("template '%s' not found", templateName)
}
// Apply custom variables to context
if context.Variables == nil {
context.Variables = make(map[string]string)
}
// Merge template variables with context variables
for k, v := range tmpl.Variables {
if _, exists := context.Variables[k]; !exists {
context.Variables[k] = v
}
}
return &Engine{
template: tmpl,
context: context,
}, nil
}
// NewEngineWithCustomTemplate creates a new template engine with a custom template.
func NewEngineWithCustomTemplate(customTemplate OutputTemplate, context TemplateContext) *Engine {
if context.Variables == nil {
context.Variables = make(map[string]string)
}
// Merge template variables with context variables
for k, v := range customTemplate.Variables {
if _, exists := context.Variables[k]; !exists {
context.Variables[k] = v
}
}
return &Engine{
template: customTemplate,
context: context,
}
}
// RenderHeader renders the template header.
func (e *Engine) RenderHeader() (string, error) {
return e.renderTemplate(e.template.Header, e.context)
}
// RenderFooter renders the template footer.
func (e *Engine) RenderFooter() (string, error) {
return e.renderTemplate(e.template.Footer, e.context)
}
// RenderFileHeader renders the file header for a specific file.
func (e *Engine) RenderFileHeader(fileCtx FileContext) (string, error) {
return e.renderTemplate(e.template.FileHeader, fileCtx)
}
// RenderFileFooter renders the file footer for a specific file.
func (e *Engine) RenderFileFooter(fileCtx FileContext) (string, error) {
return e.renderTemplate(e.template.FileFooter, fileCtx)
}
// RenderFileContent renders file content according to template options.
func (e *Engine) RenderFileContent(fileCtx FileContext) (string, error) {
content := fileCtx.Content
// Apply markdown-specific formatting if needed
if e.template.Format == shared.FormatMarkdown && e.template.Markdown.UseCodeBlocks {
// Content is wrapped in code blocks via FileHeader/FileFooter
return content, nil
}
// Apply line length limits if specified
if e.template.Markdown.MaxLineLength > 0 {
content = e.wrapLongLines(content, e.template.Markdown.MaxLineLength)
}
// Apply folding for long files if enabled
if e.template.Markdown.FoldLongFiles && len(strings.Split(content, "\n")) > 100 {
lines := strings.Split(content, "\n")
if len(lines) > 100 {
content = strings.Join(lines[:50], "\n") + "\n\n<!-- ... " +
fmt.Sprintf("%d lines truncated", len(lines)-100) + " ... -->\n\n" +
strings.Join(lines[len(lines)-50:], "\n")
}
}
return content, nil
}
// RenderMetadata renders metadata based on template options.
func (e *Engine) RenderMetadata() (string, error) {
if !e.hasAnyMetadata() {
return "", nil
}
buf := newBufferBuilder()
if e.template.Format == shared.FormatMarkdown {
buf.writeString("## Metadata\n\n")
}
if e.template.Metadata.IncludeTimestamp {
buf.writeString(fmt.Sprintf("**Generated**: %s\n", e.context.Timestamp.Format(shared.TemplateFmtTimestamp)))
}
if e.template.Metadata.IncludeSourcePath {
buf.writeString(fmt.Sprintf("**Source**: %s\n", e.context.SourcePath))
}
if e.template.Metadata.IncludeFileCount {
buf.writeString(
fmt.Sprintf(
"**Files**: %d total (%d processed, %d skipped, %d errors)\n",
e.context.TotalFiles, e.context.ProcessedFiles, e.context.SkippedFiles, e.context.ErrorFiles,
),
)
}
if e.template.Metadata.IncludeTotalSize {
buf.writeString(fmt.Sprintf("**Total Size**: %d bytes\n", e.context.TotalSize))
}
if e.template.Metadata.IncludeProcessingTime {
buf.writeString(fmt.Sprintf("**Processing Time**: %s\n", e.context.ProcessingTime))
}
if e.template.Metadata.IncludeMetrics && e.context.FilesPerSecond > 0 {
buf.writeString(
fmt.Sprintf(
"**Performance**: %.1f files/sec, %.1f MB/sec\n",
e.context.FilesPerSecond, e.context.BytesPerSecond/float64(shared.BytesPerMB),
),
)
}
if e.template.Metadata.IncludeFileTypes && len(e.context.FileTypes) > 0 {
buf.writeString("**File Types**:\n")
for fileType, count := range e.context.FileTypes {
buf.writeString(fmt.Sprintf("- %s: %d files\n", fileType, count))
}
}
buf.writeString("\n")
return buf.String(), nil
}
// RenderTableOfContents renders a table of contents if enabled.
func (e *Engine) RenderTableOfContents(files []FileContext) (string, error) {
if !e.template.Markdown.TableOfContents {
return "", nil
}
buf := newBufferBuilder()
buf.writeString("## Table of Contents\n\n")
for _, file := range files {
// Create markdown anchor from file path
anchor := strings.ToLower(strings.ReplaceAll(file.RelativePath, "/", "-"))
anchor = strings.ReplaceAll(anchor, ".", "")
anchor = strings.ReplaceAll(anchor, " ", "-")
buf.writeString(fmt.Sprintf("- [%s](#%s)\n", file.RelativePath, anchor))
}
buf.writeString("\n")
return buf.String(), nil
}
// Template returns the current template.
func (e *Engine) Template() OutputTemplate {
return e.template
}
// Context returns the current context.
func (e *Engine) Context() TemplateContext {
return e.context
}
// renderTemplate renders a template string with the given context.
func (e *Engine) renderTemplate(templateStr string, data any) (string, error) {
if templateStr == "" {
return "", nil
}
tmpl, err := template.New("template").Funcs(e.getTemplateFunctions()).Parse(templateStr)
if err != nil {
return "", fmt.Errorf("failed to parse template: %w", err)
}
var buf bytes.Buffer
if err := tmpl.Execute(&buf, data); err != nil {
return "", fmt.Errorf("failed to execute template: %w", err)
}
return buf.String(), nil
}
// getTemplateFunctions returns custom functions available in templates.
func (e *Engine) getTemplateFunctions() template.FuncMap {
return template.FuncMap{
"formatSize": func(size int64) string {
return e.formatBytes(size)
},
"formatTime": func(t time.Time) string {
return t.Format(shared.TemplateFmtTimestamp)
},
"basename": filepath.Base,
"ext": filepath.Ext,
"dir": filepath.Dir,
"upper": strings.ToUpper,
"lower": strings.ToLower,
"title": func(s string) string {
return cases.Title(language.English).String(s)
},
"trim": strings.TrimSpace,
"replace": func(old, replacement, str string) string {
return strings.ReplaceAll(str, old, replacement)
},
"join": strings.Join,
"split": func(sep, str string) []string {
return strings.Split(str, sep)
},
}
}
// formatBytes formats byte counts in human-readable format.
func (e *Engine) formatBytes(byteCount int64) string {
if byteCount == 0 {
return "0B"
}
if byteCount < shared.BytesPerKB {
return fmt.Sprintf(shared.MetricsFmtBytesShort, byteCount)
}
exp := 0
for n := byteCount / shared.BytesPerKB; n >= shared.BytesPerKB; n /= shared.BytesPerKB {
exp++
}
divisor := int64(1)
for i := 0; i < exp+1; i++ {
divisor *= shared.BytesPerKB
}
return fmt.Sprintf(shared.MetricsFmtBytesHuman, float64(byteCount)/float64(divisor), "KMGTPE"[exp])
}
// wrapLongLines wraps lines that exceed the specified length.
func (e *Engine) wrapLongLines(content string, maxLength int) string {
lines := strings.Split(content, "\n")
var wrappedLines []string
for _, line := range lines {
wrappedLines = append(wrappedLines, e.wrapSingleLine(line, maxLength)...)
}
return strings.Join(wrappedLines, "\n")
}
// wrapSingleLine wraps a single line if it exceeds maxLength.
func (e *Engine) wrapSingleLine(line string, maxLength int) []string {
if len(line) <= maxLength {
return []string{line}
}
return e.wrapLongLineWithWords(line, maxLength)
}
// wrapLongLineWithWords wraps a long line by breaking it into words.
func (e *Engine) wrapLongLineWithWords(line string, maxLength int) []string {
words := strings.Fields(line)
var wrappedLines []string
var currentLine strings.Builder
for _, word := range words {
if e.wouldExceedLength(&currentLine, word, maxLength) {
if currentLine.Len() > 0 {
wrappedLines = append(wrappedLines, currentLine.String())
currentLine.Reset()
}
}
e.addWordToLine(&currentLine, word)
}
if currentLine.Len() > 0 {
wrappedLines = append(wrappedLines, currentLine.String())
}
return wrappedLines
}
// wouldExceedLength checks if adding a word would exceed the maximum length.
func (e *Engine) wouldExceedLength(currentLine *strings.Builder, word string, maxLength int) bool {
return currentLine.Len()+len(word)+1 > maxLength
}
// addWordToLine adds a word to the current line with appropriate spacing.
func (e *Engine) addWordToLine(currentLine *strings.Builder, word string) {
if currentLine.Len() > 0 {
// These errors are highly unlikely and would only occur in extreme memory conditions
// We intentionally ignore them as recovering would be complex and the impact minimal
_ = currentLine.WriteByte(' ')
}
// Similar rationale - memory exhaustion is the only realistic failure case
_, _ = currentLine.WriteString(word)
}
// hasAnyMetadata checks if any metadata options are enabled.
func (e *Engine) hasAnyMetadata() bool {
m := e.template.Metadata
return m.IncludeStats || m.IncludeTimestamp || m.IncludeFileCount ||
m.IncludeSourcePath || m.IncludeFileTypes || m.IncludeProcessingTime ||
m.IncludeTotalSize || m.IncludeMetrics
}
// ListBuiltinTemplates returns a list of available builtin templates.
func ListBuiltinTemplates() []string {
names := make([]string, 0, len(BuiltinTemplates))
for name := range BuiltinTemplates {
names = append(names, name)
}
return names
}
// BuiltinTemplate returns a builtin template by name.
func BuiltinTemplate(name string) (OutputTemplate, bool) {
tmpl, exists := BuiltinTemplates[name]
return tmpl, exists
}