<?phpnamespace Tests;use App\Model\Marks;use App\Model\Stats;use PHPUnit\Framework\TestCase;/** What the user thinks of each song (var/stats.json): listens, skips, stars, the marks that come of them. */final class StatsTest extends TestCase{ private string $dir; protected function setUp(): void { $this->dir = sys_get_temp_dir() . '/wz-stats-' . bin2hex(random_bytes(4)); } protected function tearDown(): void { @unlink($this->dir . '/stats.json'); @unlink($this->dir . '/marks.json'); @rmdir($this->dir); } public function testASongNeverHeardHasNoMarkAndNothingIsWritten(): void { $stats = new Stats($this->dir . '/stats.json'); self::assertSame(0, $stats->score('/m/a.mp3')); self::assertSame(0, $stats->rating('/m/a.mp3')); self::assertSame(0.0, $stats->preference('/m/a.mp3')); $stats->save(); self::assertFileDoesNotExist($this->dir . '/stats.json', 'nothing changed: no file'); } public function testTheListeningMarkRisesWithTheListensAndFallsWithTheSkips(): void { $stats = new Stats($this->dir . '/stats.json'); $stats->listened('/m/a.mp3'); $once = $stats->score('/m/a.mp3'); for ($i = 0; $i < 9; $i++) { $stats->listened('/m/a.mp3'); } $ten = $stats->score('/m/a.mp3'); self::assertGreaterThan($once, $ten); self::assertSame(92, $ten, '10 listens, never skipped: (11/12) of its full weight'); $stats->skipped('/m/a.mp3'); self::assertLessThan($ten, $stats->score('/m/a.mp3')); for ($i = 0; $i < 50; $i++) { $stats->listened('/m/b.mp3'); $stats->skipped('/m/c.mp3'); } self::assertGreaterThan(95, $stats->score('/m/b.mp3')); self::assertLessThan(3, $stats->score('/m/c.mp3'), 'skipped every time: low'); self::assertSame(50, $stats->plays('/m/b.mp3')); self::assertSame(50, $stats->skips('/m/c.mp3')); foreach (['/m/a.mp3', '/m/b.mp3', '/m/c.mp3'] as $song) { self::assertGreaterThanOrEqual(0, $stats->score($song)); self::assertLessThanOrEqual(100, $stats->score($song)); } } public function testTheStarsComeBeforeTheListensInThePreference(): void { $stats = new Stats($this->dir . '/stats.json'); for ($i = 0; $i < 30; $i++) { $stats->listened('/m/often.mp3'); } $stats->rate('/m/starred.mp3', 1); $stats->rate('/m/best.mp3', 9); self::assertSame(5, $stats->rating('/m/best.mp3'), 'five stars at most'); $stats->rate('/m/none.mp3', -3); self::assertSame(0, $stats->rating('/m/none.mp3')); self::assertGreaterThan($stats->preference('/m/often.mp3'), $stats->preference('/m/starred.mp3')); self::assertGreaterThan($stats->preference('/m/starred.mp3'), $stats->preference('/m/best.mp3')); // the same stars and mark: the last heard first $stats->rate('/m/x.mp3', 3); $stats->rate('/m/y.mp3', 3); $stats->songs['/m/x.mp3']['l'] = 1_600_000_000; $stats->songs['/m/y.mp3']['l'] = 1_700_000_000; self::assertGreaterThan($stats->preference('/m/x.mp3'), $stats->preference('/m/y.mp3')); self::assertLessThan($stats->preference('/m/x.mp3') + 1, $stats->preference('/m/y.mp3'), 'never more than a point of the mark'); } public function testTheStatsAreSavedOnlyWhenTheyChangedAndReadBack(): void { $file = $this->dir . '/stats.json'; $stats = new Stats($file); $stats->listened('/m/Hélène é.mp3'); $stats->rate('/m/Hélène é.mp3', 4); $stats->skipped('C:\\Musique\\b.mp3'); $stats->save(); self::assertFileExists($file, 'its folder made'); self::assertStringContainsString('Hélène', (string)file_get_contents($file), 'unicode kept as it is'); file_put_contents($file, 'touched'); $stats->save(); self::assertSame('touched', file_get_contents($file), 'not dirty: not written again'); $stats->skipped('/m/z.mp3'); $stats->save(); $back = new Stats($file); self::assertSame(1, $back->plays('/m/Hélène é.mp3')); self::assertSame(4, $back->rating('/m/Hélène é.mp3')); self::assertSame(1, $back->skips('C:\\Musique\\b.mp3')); self::assertSame(1, $back->skips('/m/z.mp3')); self::assertSame($stats->score('/m/Hélène é.mp3'), $back->score('/m/Hélène é.mp3')); } public function testABrokenFileGivesEmptyStatsAndNoError(): void { $file = $this->dir . '/stats.json'; @mkdir($this->dir, 0777, true); foreach (['{"a": ', 'null', '"text"', '[1, 2]', '', "\xff\xfe"] as $broken) { file_put_contents($file, $broken); $stats = new Stats($file); self::assertSame([], $stats->songs, var_export($broken, true)); } // a song half broken: what can be read is kept, the stars back in 0..5 file_put_contents($file, json_encode(['/m/a.mp3' => ['p' => '3', 'r' => 42], '/m/b.mp3' => 'oops', '/m/c.mp3' => []])); $stats = new Stats($file); self::assertSame(3, $stats->plays('/m/a.mp3')); self::assertSame(5, $stats->rating('/m/a.mp3')); self::assertArrayNotHasKey('/m/b.mp3', $stats->songs); self::assertSame(['p' => 0, 's' => 0, 'l' => 0, 'r' => 0], $stats->songs['/m/c.mp3']); } public function testALatin1FileNameKeepsItsListensAndItsMarks(): void { $latin1 = "/m/\xC9t\xE9 caf\xE9.mp3"; // "Été café" written by an old disk in Latin-1: not UTF-8 self::assertFalse(mb_check_encoding($latin1, 'UTF-8')); $stats = new Stats($this->dir . '/stats.json'); $stats->listened('/m/a.mp3'); $stats->listened($latin1); $stats->rate($latin1, 4); $stats->save(); $again = new Stats($this->dir . '/stats.json'); self::assertSame(1, $again->plays($latin1), 'the Latin-1 name comes back with its bytes'); self::assertSame(4, $again->rating($latin1)); self::assertSame(1, $again->plays('/m/a.mp3'), 'the other songs are not lost with it'); $marks = new Marks($this->dir . '/marks.json'); $marks->set($latin1, 1.5, 200.0, 'manual'); $marks->set('/m/a.mp3', 2.0, 100.0, 'auto'); $marks->save(); $back = new Marks($this->dir . '/marks.json'); self::assertSame(['s' => 1.5, 'e' => 200.0, 'src' => 'manual'], $back->get($latin1)); self::assertSame(2.0, $back->get('/m/a.mp3')['s']); } public function testAValueJsonCannotHoldNeverEmptiesTheFile(): void { $marks = new Marks($this->dir . '/marks.json'); $marks->set('/m/a.mp3', 2.0, 100.0, 'manual'); $marks->save(); $before = (string)file_get_contents($this->dir . '/marks.json'); $marks->set('/m/b.mp3', 0.0, INF, 'manual'); // INF: json_encode refuses it $marks->save(); self::assertSame($before, (string)file_get_contents($this->dir . '/marks.json'), 'the file of before stays whole'); self::assertSame(2.0, (new Marks($this->dir . '/marks.json'))->get('/m/a.mp3')['s']); }}