Merge pull request #82 from codecrafters-io/ryan-gang-patch-1

fix: update regex replacer to keep Newline

Author: ryan-gang

internal/stage10.go

@@ -22,10 +22,10 @@ func testWhitespace(stageHarness *test_case_harness.TestCaseHarness) error {
 	ws4 := "{" + strings.Join(random.RandomElementsFromArray(WHITESPACES, 5), "") + "}" + LF + "((" + strings.Join(random.RandomElementsFromArray(slices.Concat(SINGLE_CHAR_OPERATORS, RELATIONALS, WHITESPACES), 5), "") + "))"
 	tokenizeTestCases := testcases.MultiTestCase{
 		TestCases: []testcases.TestCase{
-			&testcases.TokenizeTestCase{FileContents: ws1, ExpectsError: false},
-			&testcases.TokenizeTestCase{FileContents: ws2, ExpectsError: false},
-			&testcases.TokenizeTestCase{FileContents: ws3, ExpectsError: false},
-			&testcases.TokenizeTestCase{FileContents: ws4, ExpectsError: false},
+			&testcases.TokenizeTestCase{FileContents: ws1, ExpectsError: false, HighlightWhitespaceWhileLogging: true},
+			&testcases.TokenizeTestCase{FileContents: ws2, ExpectsError: false, HighlightWhitespaceWhileLogging: true},
+			&testcases.TokenizeTestCase{FileContents: ws3, ExpectsError: false, HighlightWhitespaceWhileLogging: true},
+			&testcases.TokenizeTestCase{FileContents: ws4, ExpectsError: false, HighlightWhitespaceWhileLogging: true},
 		},
 	}
 	return tokenizeTestCases.RunAll(b, logger)

internal/stage11.go

@@ -16,7 +16,7 @@ func testErrorsMulti(stageHarness *test_case_harness.TestCaseHarness) error {
 
 	logger := stageHarness.Logger
 
-	multiLineErrors1 := `() 
+	multiLineErrors1 := `()
 	@`
 	// A test string of length 4 is longer than the length of WHITESPACES (3), making sure the test case raises error.
 	multiLineErrors2 := strings.Join(random.RandomElementsFromArray(slices.Concat(LEXICAL_ERRORS, WHITESPACES), 4), "")

internal/test_cases/tokenize_test_case.go

@@ -16,9 +16,12 @@ import (
 // It is sent to the "tokenize" command of the executable,
 // the expected outputs are generated using the lox.ScanTokens function,
 // With that the output of the executable is matched.
+// Default value for HighlightWhitespaceWhileLogging is false.
+// We explicitly set it to true in the tests involving whitespace.
 type TokenizeTestCase struct {
-	FileContents string
-	ExpectsError bool
+	FileContents                    string
+	ExpectsError                    bool
+	HighlightWhitespaceWhileLogging bool
 }
 
 func (t *TokenizeTestCase) Run(executable *interpreter_executable.InterpreterExecutable, logger *logger.Logger) error {
@@ -28,7 +31,11 @@ func (t *TokenizeTestCase) Run(executable *interpreter_executable.InterpreterExe
 	}
 	defer os.Remove(tmpFileName)
 
-	logReadableFileContents(logger, t.FileContents)
+	if t.HighlightWhitespaceWhileLogging {
+		logReadableFileContentsPreservingWhitespace(logger, t.FileContents)
+	} else {
+		logReadableFileContents(logger, t.FileContents)
+	}
 
 	result, err := executable.Run("tokenize", tmpFileName)
 	if err != nil {

internal/test_cases/utils.go

@@ -45,7 +45,7 @@ func logReadableFileContents(logger *logger.Logger, fileContents string) {
 
 	regex1 := regexp.MustCompile("[ ]+\n")
 	regex2 := regexp.MustCompile("[ ]+$")
-	printableFileContents = regex1.ReplaceAllString(printableFileContents, "<|SPACE|>")
+	printableFileContents = regex1.ReplaceAllString(printableFileContents, "\n")
 	printableFileContents = regex2.ReplaceAllString(printableFileContents, "<|SPACE|>")
 
 	// This is of the form "test-N"
@@ -70,6 +70,30 @@ func logReadableFileContents(logger *logger.Logger, fileContents string) {
 	}
 }
 
+func logReadableFileContentsPreservingWhitespace(logger *logger.Logger, fileContents string) {
+	logger.Infof("Writing contents to ./test.lox:")
+
+	// If the file contents contain a single %, it will be decoded as a format specifier
+	// And it will add a `(MISSING)` to the log line
+	printableFileContents := strings.ReplaceAll(fileContents, "%", "%%")
+	printableFileContents = strings.ReplaceAll(printableFileContents, "\t", "<|TAB|>")
+	printableFileContents = strings.ReplaceAll(printableFileContents, " ", "<|SPACE|>")
+
+	// This is of the form "test-N"
+	oldPrefix := logger.GetSecondaryPrefix()
+	testNumber := strings.TrimPrefix(oldPrefix, "test-")
+	logger.UpdateSecondaryPrefix(fmt.Sprintf("test-%s.lox", testNumber))
+	defer logger.UpdateSecondaryPrefix(oldPrefix)
+
+	if len(printableFileContents) == 0 {
+		logger.Plainf("<|EMPTY FILE|>")
+	} else {
+		for _, line := range strings.Split(printableFileContents, "\n") {
+			logger.Plainf(line)
+		}
+	}
+}
+
 var exitCodeToErrorTypeMapping = map[int]string{
 	0:  "no error",
 	65: "compile error",

internal/test_helpers/fixtures/pass_scanning

@@ -321,7 +321,8 @@ Debug = true
 [stage-11] Running tests for Stage #11: tz7
 [stage-11] [test-1] Running test case: 1
 [stage-11] [test-1] Writing contents to ./test.lox:
-[stage-11] [test-1.lox] ()<|SPACE|><|TAB|>@
+[stage-11] [test-1.lox] ()
+[stage-11] [test-1.lox] <|TAB|>@
 [stage-11] [test-1] $ ./your_program.sh tokenize test.lox
 [your_program] [line 2] Error: Unexpected character: @
 [your_program] LEFT_PAREN ( null
@@ -394,7 +395,7 @@ Debug = true
 [stage-10] [test-1] ✓ Received exit code 0.
 [stage-10] [test-2] Running test case: 2
 [stage-10] [test-2] Writing contents to ./test.lox:
-[stage-10] [test-2.lox]  <|TAB|>
+[stage-10] [test-2.lox] <|SPACE|><|TAB|>
 [stage-10] [test-2.lox] <|SPACE|>
 [stage-10] [test-2] $ ./your_program.sh tokenize test.lox
 [your_program] EOF  null
@@ -423,7 +424,7 @@ Debug = true
 [stage-10] [test-4] Running test case: 4
 [stage-10] [test-4] Writing contents to ./test.lox:
 [stage-10] [test-4.lox] {<|TAB|>
-[stage-10] [test-4.lox]   <|TAB|>}
+[stage-10] [test-4.lox] <|SPACE|><|SPACE|><|TAB|>}
 [stage-10] [test-4.lox] ((
 [stage-10] [test-4.lox] <=<>-))
 [stage-10] [test-4] $ ./your_program.sh tokenize test.lox