refactor variables to be context-aware and provider based

Author: ayoisaiah

app/app_test/app_test.go

@@ -51,7 +51,7 @@ func run(
 
 	var outBuf, errBuf bytes.Buffer
 
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(t.Context(), 10*time.Second)
 	defer cancel()
 
 	cmd := exec.CommandContext(ctx, bin, args...)

f2.go

@@ -47,7 +47,7 @@ func execute(ctx context.Context, cmd *cli.Command) error {
 		slog.Any("config", appConfig),
 	)
 
-	matches, err := find.Find(appConfig)
+	matches, err := find.Find(ctx, appConfig)
 	if err != nil {
 		return err
 	}
@@ -65,7 +65,7 @@ func execute(ctx context.Context, cmd *cli.Command) error {
 	}
 
 	if !appConfig.Revert {
-		matches, err = replace.Replace(appConfig, matches)
+		matches, err = replace.Replace(ctx, appConfig, matches)
 		if err != nil {
 			return err
 		}

find/find.go

@@ -1,6 +1,7 @@
 package find
 
 import (
+	"context"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -114,14 +115,15 @@ func isMaxDepth(rootPath, currentPath string, maxDepth int) bool {
 }
 
 func extractCustomSort(
+	ctx context.Context,
 	conf *config.Config,
 	ch *file.Change,
 	vars *variables.Variables,
 ) error {
 	// Temporarily set Target to SortVariable due to how variables.Replace() works
 	ch.Target = conf.SortVariable
 
-	err := variables.Replace(conf, ch, vars)
+	err := variables.Replace(ctx, conf, ch, vars)
 	if err != nil {
 		return err
 	}
@@ -178,6 +180,7 @@ func createFileChange(
 }
 
 func evaluateSearchCondition(
+	ctx context.Context,
 	conf *config.Config,
 	match *file.Change,
 	searchVars *variables.Variables,
@@ -187,7 +190,7 @@ func evaluateSearchCondition(
 		return false, nil
 	}
 
-	err = variables.Replace(conf, match, searchVars)
+	err = variables.Replace(ctx, conf, match, searchVars)
 	if err != nil {
 		return true, err
 	}
@@ -207,6 +210,7 @@ func evaluateSearchCondition(
 }
 
 func checkIfMatch(
+	ctx context.Context,
 	conf *config.Config,
 	path string,
 	entry fs.DirEntry,
@@ -257,7 +261,7 @@ func checkIfMatch(
 	}
 
 	if conf.SortVariable != "" {
-		err = extractCustomSort(conf, match, sortVars)
+		err = extractCustomSort(ctx, conf, match, sortVars)
 		if err != nil {
 			return nil, false, err
 		}
@@ -267,6 +271,7 @@ func checkIfMatch(
 }
 
 func walkDirectory(
+	ctx context.Context,
 	conf *config.Config,
 	rootPath string,
 	processedPaths map[string]bool,
@@ -330,6 +335,7 @@ func walkDirectory(
 			}
 
 			match, isMatch, err := checkIfMatch(
+				ctx,
 				conf,
 				currentPath,
 				entry,
@@ -361,6 +367,7 @@ func shouldSkipExcludedDir(conf *config.Config, entry fs.DirEntry) bool {
 // searchPaths walks through the filesystem and finds matches for the provided
 // search pattern or variables comparison.
 func searchPaths(
+	ctx context.Context,
 	conf *config.Config,
 	sortVars, searchVars *variables.Variables,
 ) (file.Changes, error) {
@@ -382,6 +389,7 @@ func searchPaths(
 			}
 
 			match, isMatch, matchErr := checkIfMatch(
+				ctx,
 				conf,
 				rootPath,
 				fs.FileInfoToDirEntry(fileInfo),
@@ -401,6 +409,7 @@ func searchPaths(
 		}
 
 		dirMatches, err := walkDirectory(
+			ctx,
 			conf,
 			rootPath,
 			processedPaths,
@@ -416,7 +425,7 @@ func searchPaths(
 	if conf.Search.FindCond != nil {
 		var err error
 
-		matches, err = processFindExpression(conf, matches, searchVars)
+		matches, err = processFindExpression(ctx, conf, matches, searchVars)
 		if err != nil {
 			return nil, err
 		}
@@ -426,6 +435,7 @@ func searchPaths(
 }
 
 func processFindExpression(
+	ctx context.Context,
 	conf *config.Config,
 	matches file.Changes,
 	searchVars *variables.Variables,
@@ -466,7 +476,12 @@ func processFindExpression(
 	}
 
 	matches = slices.DeleteFunc(matches, func(match *file.Change) bool {
-		removeMatch, err := evaluateSearchCondition(conf, match, searchVars)
+		removeMatch, err := evaluateSearchCondition(
+			ctx,
+			conf,
+			match,
+			searchVars,
+		)
 		if err != nil {
 			if conf.Verbose {
 				report.SearchEvalFailed(
@@ -566,7 +581,10 @@ func loadFromBackup(conf *config.Config) (file.Changes, error) {
 
 // Find returns a collection of files and directories that match the search
 // pattern or explicitly included as command-line arguments.
-func Find(conf *config.Config) (matches file.Changes, err error) {
+func Find(
+	ctx context.Context,
+	conf *config.Config,
+) (matches file.Changes, err error) {
 	if conf.Revert {
 		return loadFromBackup(conf)
 	}
@@ -589,7 +607,7 @@ func Find(conf *config.Config) (matches file.Changes, err error) {
 	if conf.CSVFilename != "" {
 		matches, err = handleCSV(conf)
 	} else {
-		matches, err = searchPaths(conf, &sortVars, &searchVars)
+		matches, err = searchPaths(ctx, conf, &sortVars, &searchVars)
 		if err != nil {
 			return nil, err
 		}

find/find_test/find_test.go

@@ -264,7 +264,7 @@ func findTest(t *testing.T, cases []testutil.TestCase, testDir string) {
 			// directory argument
 			config := testutil.GetConfig(t, &tc, testDir)
 
-			changes, err := find.Find(config)
+			changes, err := find.Find(t.Context(), config)
 			if err == nil {
 				testutil.CompareSourcePath(t, tc.Want, changes)
 				return

internal/testutil/testutil.go

@@ -296,7 +296,7 @@ func GetConfig(tb testing.TB, tc *TestCase, testDir string) *config.Config {
 	}
 
 	// Initialize the config
-	err = f2App.Run(context.Background(), args)
+	err = f2App.Run(tb.Context(), args)
 	if err != nil {
 		tb.Fatal(err)
 	}

replace/replace.go

@@ -39,6 +39,7 @@ func replaceString(conf *config.Config, originalName string) string {
 // applyReplacements applies the configured replacement patterns to the source
 // filename.
 func applyReplacement(
+	ctx context.Context,
 	conf *config.Config,
 	vars *variables.Variables,
 	change *file.Change,
@@ -53,7 +54,7 @@ func applyReplacement(
 	change.Target = replaceString(conf, originalName)
 
 	// Replace any variables present with their corresponding values
-	err := variables.Replace(conf, change, vars)
+	err := variables.Replace(ctx, conf, change, vars)
 	if err != nil {
 		return err
 	}
@@ -73,6 +74,7 @@ func applyReplacement(
 // replaceMatches handles the replacement of matches in each file with the
 // replacement string.
 func replaceMatches(
+	ctx context.Context,
 	conf *config.Config,
 	matches file.Changes,
 ) (file.Changes, error) {
@@ -116,7 +118,7 @@ func replaceMatches(
 
 		change.Position = i - pairs
 
-		err := applyReplacement(conf, &vars, change)
+		err := applyReplacement(ctx, conf, &vars, change)
 		if err != nil {
 			return nil, err
 		}
@@ -135,6 +137,7 @@ func replaceMatches(
 }
 
 func handleReplacementChain(
+	ctx context.Context,
 	conf *config.Config,
 	matches file.Changes,
 ) (file.Changes, error) {
@@ -149,7 +152,7 @@ func handleReplacementChain(
 
 		var err error
 
-		matches, err = replaceMatches(conf, matches)
+		matches, err = replaceMatches(ctx, conf, matches)
 		if err != nil {
 			return nil, err
 		}
@@ -163,7 +166,7 @@ func handleReplacementChain(
 			return nil, err
 		}
 
-		err = prepNextChain(conf, matches)
+		err = prepNextChain(ctx, conf, matches)
 		if err != nil {
 			return nil, err
 		}
@@ -173,6 +176,7 @@ func handleReplacementChain(
 }
 
 func prepNextChain(
+	ctx context.Context,
 	conf *config.Config,
 	matches file.Changes,
 ) (err error) {
@@ -187,7 +191,7 @@ func prepNextChain(
 		}
 	}
 
-	g, _ := errgroup.WithContext(context.Background())
+	g, _ := errgroup.WithContext(ctx)
 	g.SetLimit(runtime.NumCPU())
 
 	for j := range matches {
@@ -217,7 +221,7 @@ func prepNextChain(
 		g.Go(func() error {
 			change.Target = conf.Search.FindCond.String()
 
-			err := variables.Replace(conf, change, &findVars)
+			err := variables.Replace(ctx, conf, change, &findVars)
 			if err != nil {
 				return err
 			}
@@ -262,6 +266,7 @@ func prepNextChain(
 // preExtractMetadata parallelizes the extraction of ID3 and Hashing metadata
 // to speed up the replacement process.
 func preExtractMetadata(
+	ctx context.Context,
 	conf *config.Config,
 	matches file.Changes,
 ) error {
@@ -298,7 +303,7 @@ func preExtractMetadata(
 		return nil
 	}
 
-	g, _ := errgroup.WithContext(context.Background())
+	g, _ := errgroup.WithContext(ctx)
 	g.SetLimit(runtime.NumCPU())
 
 	for i := range matches {
@@ -313,14 +318,14 @@ func preExtractMetadata(
 				rv := &rvars[i]
 
 				if rv.id3Present && change.ID3Data == nil {
-					err := variables.Replace(conf, change, &rv.vars)
+					err := variables.Replace(ctx, conf, change, &rv.vars)
 					if err != nil {
 						return err
 					}
 				}
 
 				if rv.hashPresent && change.HashData == nil {
-					err := variables.Replace(conf, change, &rv.vars)
+					err := variables.Replace(ctx, conf, change, &rv.vars)
 					if err != nil {
 						return err
 					}
@@ -337,10 +342,11 @@ func preExtractMetadata(
 // Replace applies the file name replacements according to the --replace
 // argument.
 func Replace(
+	ctx context.Context,
 	conf *config.Config,
 	matches file.Changes,
 ) (file.Changes, error) {
-	err := preExtractMetadata(conf, matches)
+	err := preExtractMetadata(ctx, conf, matches)
 	if err != nil {
 		return matches, err
 	}
@@ -385,14 +391,14 @@ func Replace(
 				return nil, extractErr
 			}
 
-			err = applyReplacement(conf, &vars, ch)
+			err = applyReplacement(ctx, conf, &vars, ch)
 			if err != nil {
 				return nil, err
 			}
 		}
 	}
 
-	matches, err = handleReplacementChain(conf, matches)
+	matches, err = handleReplacementChain(ctx, conf, matches)
 	if err != nil {
 		return nil, err
 	}

replace/replace_test/replace_test.go

@@ -31,7 +31,7 @@ func replaceTest(t *testing.T, cases []testutil.TestCase) {
 
 				conf := testutil.GetConfig(t, tc, ".")
 
-				changes, err := replace.Replace(conf, tc.Changes)
+				changes, err := replace.Replace(t.Context(), conf, tc.Changes)
 				if err == nil {
 					testutil.CompareTargetPath(t, tc.Want, changes)
 					return