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.
84 lines
2.9 KiB
PHP
84 lines
2.9 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\Prop;
|
|
use ProPresenter\Parser\PropLibrary;
|
|
use ProPresenter\Parser\PropsFileReader;
|
|
use ProPresenter\Parser\PropsFileWriter;
|
|
use Rv\Data\Cue;
|
|
|
|
class PropsFileReaderTest extends TestCase
|
|
{
|
|
private const REFERENCE_PATH = __DIR__ . '/../doc/reference_samples/Props';
|
|
|
|
#[Test]
|
|
public function readThrowsOnMissingFile(): void
|
|
{
|
|
$this->expectException(InvalidArgumentException::class);
|
|
PropsFileReader::read(__DIR__ . '/../doc/reference_samples/does-not-exist-props');
|
|
}
|
|
|
|
#[Test]
|
|
public function readReturnsLibraryWithExpectedCount(): void
|
|
{
|
|
$library = PropsFileReader::read(self::REFERENCE_PATH);
|
|
$this->assertInstanceOf(PropLibrary::class, $library);
|
|
$this->assertCount(13, $library->getProps());
|
|
$this->assertSame(13, $library->count());
|
|
}
|
|
|
|
#[Test]
|
|
public function propExposesNameAndUuid(): void
|
|
{
|
|
$prop = PropsFileReader::read(self::REFERENCE_PATH)->getProps()[0];
|
|
$this->assertInstanceOf(Prop::class, $prop);
|
|
$this->assertSame('Props #1', $prop->getName());
|
|
$this->assertSame('1FB23674-4341-4257-A376-E7E7318E84EF', $prop->getUuid());
|
|
$this->assertTrue($prop->isEnabled());
|
|
}
|
|
|
|
#[Test]
|
|
public function lookupByUuidIsCaseInsensitive(): void
|
|
{
|
|
$library = PropsFileReader::read(self::REFERENCE_PATH);
|
|
$upper = $library->getPropByUuid('1FB23674-4341-4257-A376-E7E7318E84EF');
|
|
$lower = $library->getPropByUuid('1fb23674-4341-4257-a376-e7e7318e84ef');
|
|
$this->assertNotNull($upper);
|
|
$this->assertSame($upper, $lower);
|
|
}
|
|
|
|
#[Test]
|
|
public function writerProducesStableRoundTrip(): void
|
|
{
|
|
$tmp = tempnam(sys_get_temp_dir(), 'props_');
|
|
$second = tempnam(sys_get_temp_dir(), 'props_');
|
|
try {
|
|
PropsFileWriter::write(PropsFileReader::read(self::REFERENCE_PATH), $tmp);
|
|
PropsFileWriter::write(PropsFileReader::read($tmp), $second);
|
|
$this->assertSame(file_get_contents($tmp), file_get_contents($second));
|
|
} finally {
|
|
@unlink($tmp);
|
|
@unlink($second);
|
|
}
|
|
}
|
|
|
|
#[Test]
|
|
public function addAndRemovePropRoundTrip(): void
|
|
{
|
|
$library = PropsFileReader::read(self::REFERENCE_PATH);
|
|
$prop = new Prop(new Cue());
|
|
$prop->setName('Test Prop')->setUuid('11111111-1111-1111-1111-111111111111')->setEnabled(true);
|
|
$library->addProp($prop);
|
|
$this->assertSame(14, $library->count());
|
|
$this->assertSame('Test Prop', $library->getPropByUuid('11111111-1111-1111-1111-111111111111')?->getName());
|
|
$this->assertTrue($library->removeProp('11111111-1111-1111-1111-111111111111'));
|
|
$this->assertSame(13, $library->count());
|
|
}
|
|
}
|