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.
90 lines
3.4 KiB
PHP
90 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\CommunicationDevice;
|
|
use ProPresenter\Parser\CommunicationDevicesFileReader;
|
|
use ProPresenter\Parser\CommunicationDevicesFileWriter;
|
|
use ProPresenter\Parser\CommunicationDevicesLibrary;
|
|
|
|
class CommunicationDevicesFileReaderTest extends TestCase
|
|
{
|
|
private const REFERENCE_PATH = __DIR__ . '/../doc/reference_samples/CommunicationDevices';
|
|
|
|
#[Test]
|
|
public function readThrowsOnMissingFile(): void
|
|
{
|
|
$this->expectException(InvalidArgumentException::class);
|
|
CommunicationDevicesFileReader::read(__DIR__ . '/../doc/reference_samples/does-not-exist-communication-devices');
|
|
}
|
|
|
|
#[Test]
|
|
public function readReturnsLibraryWithExpectedCount(): void
|
|
{
|
|
$library = CommunicationDevicesFileReader::read(self::REFERENCE_PATH);
|
|
$this->assertInstanceOf(CommunicationDevicesLibrary::class, $library);
|
|
$this->assertCount(0, $library->getDevices());
|
|
$this->assertSame(0, $library->count());
|
|
}
|
|
|
|
#[Test]
|
|
public function emptyListCanAddDevice(): void
|
|
{
|
|
$library = CommunicationDevicesFileReader::read(self::REFERENCE_PATH);
|
|
$device = (new CommunicationDevice())
|
|
->setId('device-1')
|
|
->setName('Lighting Console')
|
|
->setType('network')
|
|
->setAddress('192.0.2.10');
|
|
$library->addDevice($device);
|
|
$this->assertSame(1, $library->count());
|
|
$this->assertSame('Lighting Console', $library->getDevices()[0]->getName());
|
|
$this->assertSame('device-1', $library->getDevices()[0]->getId());
|
|
}
|
|
|
|
#[Test]
|
|
public function writeReadRoundTripPreservesDeviceSemantics(): void
|
|
{
|
|
$library = new CommunicationDevicesLibrary();
|
|
$library->addDevice((new CommunicationDevice())->setId('device-1')->setName('Stage Router')->setType('tcp')->setAddress('10.0.0.5'));
|
|
$tmp = tempnam(sys_get_temp_dir(), 'devices_');
|
|
try {
|
|
CommunicationDevicesFileWriter::write($library, $tmp);
|
|
$roundTrip = CommunicationDevicesFileReader::read($tmp);
|
|
$this->assertSame($library->getDocument(), $roundTrip->getDocument());
|
|
} finally {
|
|
@unlink($tmp ?: '');
|
|
}
|
|
}
|
|
|
|
#[Test]
|
|
public function addAndRemoveDeviceRoundTrip(): void
|
|
{
|
|
$library = CommunicationDevicesFileReader::read(self::REFERENCE_PATH);
|
|
$library->addDevice((new CommunicationDevice())->setId('device-1')->setName('Stage Router'));
|
|
$this->assertSame(1, $library->count());
|
|
$this->assertTrue($library->removeDevice('device-1'));
|
|
$this->assertSame(0, $library->count());
|
|
}
|
|
|
|
#[Test]
|
|
public function writerProducesByteIdenticalRoundTrip(): void
|
|
{
|
|
$first = tempnam(sys_get_temp_dir(), 'devices_');
|
|
$second = tempnam(sys_get_temp_dir(), 'devices_');
|
|
try {
|
|
CommunicationDevicesFileWriter::write(CommunicationDevicesFileReader::read(self::REFERENCE_PATH), $first);
|
|
CommunicationDevicesFileWriter::write(CommunicationDevicesFileReader::read($first), $second);
|
|
$this->assertSame(json_decode((string) file_get_contents($first), true), json_decode((string) file_get_contents($second), true));
|
|
} finally {
|
|
@unlink($first ?: '');
|
|
@unlink($second ?: '');
|
|
}
|
|
}
|
|
}
|