9e3e719806
Add full IO support for every global ProPresenter library file plus theme folders, and extend the existing Labels/Macros readers with exporters and editable accessors so every supported document is now a round-trippable, mutable object. New library readers/writers (each: FileReader, FileWriter, Library wrapper, element wrapper where applicable, CLI tool, tests, doc/api/*.md): - Groups (ProGroupsDocument) + GroupDefinition - ClearGroups (ClearGroupsDocument) + ClearGroupDefinition - CCLI (CCLIDocument) - Messages (MessageDocument) + Message - Timers (TimersDocument + Clock) + Timer - Stage (Stage.Document) + StageLayout - Workspace (ProPresenterWorkspace) + Screen - Props (PropDocument) + Prop - TestPatterns (TestPatternDocument) - Calendar (new CalendarDocument) + CalendarEvent - KeyMappings (new KeyMappingsDocument) + KeyMapping - CommunicationDevices (JSON file) + CommunicationDevice - Theme bundles (Template.Document folder + Assets/) + ThemeBundle/Slide/Asset Extensions to existing modules: - LabelsFileWriter; Label and LabelLibrary gain setters, addLabel, removeLabel, setColor / setColorHex helpers - MacrosFileWriter; Macro/MacroCollection/MacroLibrary gain UUID, name, color, image_type, image_data, trigger_on_startup setters plus add/remove for macros and collections Two new minimal proto schemas were defined for documents that lacked upstream definitions: - proto/calendar.proto - CalendarDocument with Event entries, raw bytes for the action/macro sub-messages so the schema can evolve - proto/keyMappings.proto - KeyMappingsDocument with ApplicationInfo and a forward-looking Mapping message (sample only carries the info) The Theme file turned out to be a regular Rv\Data\Template\Document, so no new proto was required for theme content; ThemeBundle layers folder + Assets/ handling on top in the same spirit as PresentationBundle. GroupDefinition is intentionally distinct from the existing Group class (which wraps song-level CueGroup) to avoid breaking song APIs. Verified with the full PHPUnit suite: 370 tests, 9200 assertions, all green; LSP diagnostics clean across src/. The unmodified reference samples for Labels, Groups, ClearGroups, TestPatterns, Calendar and KeyMappings round-trip byte-for-byte; the others round-trip with the same byte length (PHP protobuf is not canonically deterministic but re-write-after-write stabilises). doc/INDEX.md, doc/keywords.md and AGENTS.md updated so every new module is discoverable from the top level.
95 lines
3.4 KiB
PHP
95 lines
3.4 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace ProPresenter\Parser\Tests;
|
|
|
|
use InvalidArgumentException;
|
|
use PHPUnit\Framework\Attributes\Test;
|
|
use PHPUnit\Framework\TestCase;
|
|
use ProPresenter\Parser\Timer;
|
|
use ProPresenter\Parser\TimersFileReader;
|
|
use ProPresenter\Parser\TimersFileWriter;
|
|
use ProPresenter\Parser\TimersLibrary;
|
|
|
|
class TimersFileReaderTest extends TestCase
|
|
{
|
|
private const REFERENCE_PATH = __DIR__ . '/../doc/reference_samples/Timers';
|
|
|
|
#[Test]
|
|
public function readThrowsOnMissingFile(): void
|
|
{
|
|
$this->expectException(InvalidArgumentException::class);
|
|
TimersFileReader::read(__DIR__ . '/../doc/reference_samples/does-not-exist-timers');
|
|
}
|
|
|
|
#[Test]
|
|
public function readReturnsLibraryWithExpectedCount(): void
|
|
{
|
|
$library = TimersFileReader::read(self::REFERENCE_PATH);
|
|
$this->assertInstanceOf(TimersLibrary::class, $library);
|
|
$this->assertCount(5, $library->getTimers());
|
|
$this->assertSame(5, $library->count());
|
|
}
|
|
|
|
#[Test]
|
|
public function timersExposeNameAndUuid(): void
|
|
{
|
|
$first = TimersFileReader::read(self::REFERENCE_PATH)->getTimers()[0];
|
|
$this->assertInstanceOf(Timer::class, $first);
|
|
$this->assertSame('Gottesdienst (10:02)', $first->getName());
|
|
$this->assertSame('0E45D0AF-BCC2-4A31-BCFD-0F5A3358E225', $first->getUuid());
|
|
}
|
|
|
|
#[Test]
|
|
public function lookupByUuidIsCaseInsensitiveAndClockFormatIsExposed(): void
|
|
{
|
|
$library = TimersFileReader::read(self::REFERENCE_PATH);
|
|
$upper = $library->getTimerByUuid('0E45D0AF-BCC2-4A31-BCFD-0F5A3358E225');
|
|
$lower = $library->getTimerByUuid('0e45d0af-bcc2-4a31-bcfd-0f5a3358e225');
|
|
$this->assertNotNull($upper);
|
|
$this->assertSame($upper, $lower);
|
|
$this->assertSame('HH:mm', $library->getClockFormat());
|
|
}
|
|
|
|
#[Test]
|
|
public function timerTypesAreIdentified(): void
|
|
{
|
|
$library = TimersFileReader::read(self::REFERENCE_PATH);
|
|
$service = $library->getTimerByName('Gottesdienst (10:02)');
|
|
$five = $library->getTimerByName('5 Minuten Countdown');
|
|
$this->assertNotNull($service);
|
|
$this->assertTrue($service->isCountdownToTime());
|
|
$this->assertFalse($service->isCountdown());
|
|
$this->assertNotNull($five);
|
|
$this->assertTrue($five->isCountdown());
|
|
$this->assertSame(300, $five->getDurationSeconds());
|
|
}
|
|
|
|
#[Test]
|
|
public function addAndRemoveTimerRoundTrip(): void
|
|
{
|
|
$library = TimersFileReader::read(self::REFERENCE_PATH);
|
|
$library->addTimer('Test Timer', '11111111-1111-1111-1111-111111111111');
|
|
$this->assertSame(6, $library->count());
|
|
$this->assertNotNull($library->getTimerByUuid('11111111-1111-1111-1111-111111111111'));
|
|
$this->assertTrue($library->removeTimer('11111111-1111-1111-1111-111111111111'));
|
|
$this->assertSame(5, $library->count());
|
|
}
|
|
|
|
#[Test]
|
|
public function writerProducesByteIdenticalRoundTrip(): void
|
|
{
|
|
$first = tempnam(sys_get_temp_dir(), 'timers_');
|
|
$second = tempnam(sys_get_temp_dir(), 'timers_');
|
|
try {
|
|
TimersFileWriter::write(TimersFileReader::read(self::REFERENCE_PATH), $first);
|
|
TimersFileWriter::write(TimersFileReader::read($first), $second);
|
|
$this->assertSame(file_get_contents($first), file_get_contents($second));
|
|
} finally {
|
|
@unlink($first ?: '');
|
|
@unlink($second ?: '');
|
|
}
|
|
}
|
|
}
|