Skip to content

Commit bddd9a7

Browse files
AydinHassanAydinHassan
authored
Merge pull request #226 from php-school/file-comparison-regex-strip
2 parents 0c3a11b + e826bf5 commit bddd9a7

File tree

3 files changed

+65
-21
lines changed

3 files changed

+65
-21
lines changed

‎src/Check/FileComparisonCheck.php‎

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ public function check(ExerciseInterface $exercise, Input $input): ResultInterfac
4444
throw new InvalidArgumentException();
4545
}
4646

47-
foreach ($exercise->getFilesToCompare() as $file) {
47+
foreach ($exercise->getFilesToCompare() as $key => $file) {
48+
[$options, $file] = $this->getOptionsAndFile($key, $file);
49+
4850
$studentFile = Path::join(dirname($input->getRequiredArgument('program')), $file);
4951
$referenceFile = Path::join($exercise->getSolution()->getBaseDirectory(), $file);
5052

@@ -56,17 +58,40 @@ public function check(ExerciseInterface $exercise, Input $input): ResultInterfac
5658
return Failure::fromCheckAndReason($this, sprintf('File: "%s" does not exist', $file));
5759
}
5860

59-
$actual = (string) file_get_contents($studentFile);
60-
$expected = (string) file_get_contents($referenceFile);
61+
$actualOriginal = (string) file_get_contents($studentFile);
62+
$expectedOriginal = (string) file_get_contents($referenceFile);
63+
64+
$actual = isset($options['strip'])
65+
? preg_replace($options['strip'], '', $actualOriginal)
66+
: $actualOriginal;
67+
68+
$expected = isset($options['strip'])
69+
? preg_replace($options['strip'], '', $expectedOriginal)
70+
: $expectedOriginal;
6171

6272
if ($expected !== $actual) {
63-
return new FileComparisonFailure($this, $file, $expected, $actual);
73+
return new FileComparisonFailure($this, $file, $expectedOriginal, $actualOriginal);
6474
}
6575
}
6676

6777
return Success::fromCheck($this);
6878
}
6979

80+
/**
81+
* @param int|string $key
82+
* @param string|array<string, string> $file
83+
* @return array{0: array, 1:string}
84+
*/
85+
private function getOptionsAndFile($key, $file): array
86+
{
87+
if (!is_array($file) && is_int($key)) {
88+
return [[], $file];
89+
}
90+
/** @var array $file */
91+
/** @var string $key */
92+
return [$file, $key];
93+
}
94+
7095
/**
7196
* This check can run on any exercise type.
7297
*

‎src/ExerciseCheck/FileComparisonExerciseCheck.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
interface FileComparisonExerciseCheck
1212
{
1313
/**
14-
* @return array<string>
14+
* @return array<int|string, string|array{strip: string}>
1515
*/
1616
public function getFilesToCompare(): array;
1717
}

‎test/Check/FileComparisonCheckTest.php‎

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@ public function testExceptionIsThrownIfReferenceFileDoesNotExist(): void
4646

4747
public function testFailureIsReturnedIfStudentsFileDoesNotExist(): void
4848
{
49-
$file = $this->getTemporaryFile('solution/some-file.txt');
50-
file_put_contents($file, "name,age\nAydin,33\nMichael,29\n");
49+
$referenceFile = $this->getTemporaryFile('solution/some-file.txt', "name,age\nAydin,33\nMichael,29\n");
5150

5251
$exercise = new FileComparisonExercise(['some-file.txt']);
5352
$exercise->setSolution(new SingleFileSolution($this->getTemporaryFile('solution/solution.php')));
@@ -60,17 +59,15 @@ public function testFailureIsReturnedIfStudentsFileDoesNotExist(): void
6059

6160
public function testFailureIsReturnedIfStudentFileDosNotMatchReferenceFile(): void
6261
{
63-
$file = $this->getTemporaryFile('solution/some-file.txt');
64-
file_put_contents($file, "name,age\nAydin,33\nMichael,29\n");
65-
66-
$studentSolution = $this->getTemporaryFile('student/my-solution.php');
67-
$studentFile = $this->getTemporaryFile('student/some-file.txt');
68-
file_put_contents($studentFile, "somegibberish");
62+
$referenceFile = $this->getTemporaryFile('solution/some-file.txt', "name,age\nAydin,33\nMichael,29\n");
63+
$studentFile = $this->getTemporaryFile('student/some-file.txt', "somegibberish");
6964

7065
$exercise = new FileComparisonExercise(['some-file.txt']);
7166
$exercise->setSolution(new SingleFileSolution($this->getTemporaryFile('solution/solution.php')));
7267

73-
$failure = $this->check->check($exercise, new Input('app', ['program' => $studentSolution]));
68+
$failure = $this->check->check($exercise, new Input('app', [
69+
'program' => $this->getTemporaryFile('student/my-solution.php')
70+
]));
7471

7572
$this->assertInstanceOf(FileComparisonFailure::class, $failure);
7673
$this->assertEquals($failure->getFileName(), 'some-file.txt');
@@ -80,19 +77,41 @@ public function testFailureIsReturnedIfStudentFileDosNotMatchReferenceFile(): vo
8077

8178
public function testSuccessIsReturnedIfFilesMatch(): void
8279
{
83-
$file = $this->getTemporaryFile('solution/some-file.txt');
84-
file_put_contents($file, "name,age\nAydin,33\nMichael,29\n");
85-
86-
$studentSolution = $this->getTemporaryFile('student/my-solution.php');
87-
$studentFile = $this->getTemporaryFile('student/some-file.txt');
88-
file_put_contents($studentFile, "name,age\nAydin,33\nMichael,29\n");
80+
$referenceFile = $this->getTemporaryFile('solution/some-file.txt', "name,age\nAydin,33\nMichael,29\n");
81+
$studentFile = $this->getTemporaryFile('student/some-file.txt', "name,age\nAydin,33\nMichael,29\n");
8982

9083
$exercise = new FileComparisonExercise(['some-file.txt']);
9184
$exercise->setSolution(new SingleFileSolution($this->getTemporaryFile('solution/solution.php')));
9285

9386
$this->assertInstanceOf(
9487
Success::class,
95-
$this->check->check($exercise, new Input('app', ['program' => $studentSolution]))
88+
$this->check->check($exercise, new Input('app', [
89+
'program' => $this->getTemporaryFile('student/my-solution.php')
90+
]))
91+
);
92+
}
93+
94+
public function testFailureIsReturnedIfFileDoNotMatchUsingStrip(): void
95+
{
96+
$referenceFile = $this->getTemporaryFile(
97+
'solution/some-file.txt',
98+
"01:03name,age\n04:05Aydin,33\n17:21Michael,29\n"
99+
);
100+
$studentFile = $this->getTemporaryFile(
101+
'student/some-file.txt',
102+
"01:04name,age\n06:76Aydin,34\n99:00Michael,29\n"
96103
);
104+
105+
$exercise = new FileComparisonExercise(['some-file.txt' => ['strip' => '/\d{2}:\d{2}/']]);
106+
$exercise->setSolution(new SingleFileSolution($this->getTemporaryFile('solution/solution.php')));
107+
108+
$failure = $this->check->check($exercise, new Input('app', [
109+
'program' => $this->getTemporaryFile('student/my-solution.php')
110+
]));
111+
112+
$this->assertInstanceOf(FileComparisonFailure::class, $failure);
113+
$this->assertEquals($failure->getFileName(), 'some-file.txt');
114+
$this->assertEquals($failure->getExpectedValue(), "01:03name,age\n04:05Aydin,33\n17:21Michael,29\n");
115+
$this->assertEquals($failure->getActualValue(), "01:04name,age\n06:76Aydin,34\n99:00Michael,29\n");
97116
}
98117
}

0 commit comments

Comments
 (0)