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.
104 lines
3.7 KiB
PHP
104 lines
3.7 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\KeyMapping;
|
|
use ProPresenter\Parser\KeyMappingsFileReader;
|
|
use ProPresenter\Parser\KeyMappingsFileWriter;
|
|
use ProPresenter\Parser\KeyMappingsLibrary;
|
|
|
|
class KeyMappingsFileReaderTest extends TestCase
|
|
{
|
|
private const REFERENCE_PATH = __DIR__ . '/../doc/reference_samples/KeyMappings';
|
|
|
|
#[Test]
|
|
public function readThrowsOnMissingFile(): void
|
|
{
|
|
$this->expectException(InvalidArgumentException::class);
|
|
KeyMappingsFileReader::read(__DIR__ . '/../doc/reference_samples/does-not-exist-key-mappings');
|
|
}
|
|
|
|
#[Test]
|
|
public function readReturnsLibraryWithExpectedCount(): void
|
|
{
|
|
$library = KeyMappingsFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$this->assertInstanceOf(KeyMappingsLibrary::class, $library);
|
|
$this->assertCount(0, $library->getMappings());
|
|
$this->assertSame(0, $library->count());
|
|
$this->assertNotNull($library->getApplicationInfo());
|
|
}
|
|
|
|
#[Test]
|
|
public function mappingsExposeNameAndUuid(): void
|
|
{
|
|
$library = KeyMappingsFileReader::read(self::REFERENCE_PATH);
|
|
$mapping = $library->addMapping('Test Mapping', 'ABCDEFAB-1111-1111-1111-111111111111', 'target');
|
|
|
|
$this->assertInstanceOf(KeyMapping::class, $mapping);
|
|
$this->assertSame('Test Mapping', $mapping->getName());
|
|
$this->assertSame('ABCDEFAB-1111-1111-1111-111111111111', $mapping->getUuid());
|
|
$this->assertSame('target', $mapping->getTarget());
|
|
}
|
|
|
|
#[Test]
|
|
public function lookupByUuidIsCaseInsensitive(): void
|
|
{
|
|
$library = KeyMappingsFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$library->addMapping('Test Mapping', 'ABCDEFAB-1111-1111-1111-111111111111');
|
|
$upper = $library->getMappingByUuid('ABCDEFAB-1111-1111-1111-111111111111');
|
|
$lower = $library->getMappingByUuid('abcdefab-1111-1111-1111-111111111111');
|
|
|
|
$this->assertNotNull($upper);
|
|
$this->assertSame($upper, $lower);
|
|
$this->assertSame('Test Mapping', $upper->getName());
|
|
}
|
|
|
|
#[Test]
|
|
public function lookupByNameSucceeds(): void
|
|
{
|
|
$library = KeyMappingsFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$library->addMapping('Test Mapping', 'ABCDEFAB-1111-1111-1111-111111111111');
|
|
$mapping = $library->getMappingByName('Test Mapping');
|
|
|
|
$this->assertNotNull($mapping);
|
|
$this->assertSame('ABCDEFAB-1111-1111-1111-111111111111', $mapping->getUuid());
|
|
}
|
|
|
|
#[Test]
|
|
public function addAndRemoveMappingRoundTrip(): void
|
|
{
|
|
$library = KeyMappingsFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$library->addMapping('Test Mapping', 'ABCDEFAB-1111-1111-1111-111111111111');
|
|
$this->assertNotNull($library->getMappingByUuid('ABCDEFAB-1111-1111-1111-111111111111'));
|
|
$this->assertSame(1, $library->count());
|
|
|
|
$this->assertTrue($library->removeMapping('abcdefab-1111-1111-1111-111111111111'));
|
|
$this->assertNull($library->getMappingByUuid('ABCDEFAB-1111-1111-1111-111111111111'));
|
|
$this->assertSame(0, $library->count());
|
|
}
|
|
|
|
#[Test]
|
|
public function writerProducesByteIdenticalRoundTrip(): void
|
|
{
|
|
$original = file_get_contents(self::REFERENCE_PATH);
|
|
$library = KeyMappingsFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$tmp = tempnam(sys_get_temp_dir(), 'key_mappings_');
|
|
try {
|
|
KeyMappingsFileWriter::write($library, $tmp);
|
|
$this->assertSame($original, file_get_contents($tmp));
|
|
} finally {
|
|
@unlink($tmp);
|
|
}
|
|
}
|
|
}
|