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.
72 lines
2.2 KiB
PHP
72 lines
2.2 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace ProPresenter\Parser\Tests;
|
|
|
|
use PHPUnit\Framework\Attributes\Test;
|
|
use PHPUnit\Framework\TestCase;
|
|
use ProPresenter\Parser\LabelsFileReader;
|
|
use ProPresenter\Parser\LabelsFileWriter;
|
|
|
|
class LabelsFileWriterTest extends TestCase
|
|
{
|
|
private const REFERENCE_PATH = __DIR__ . '/../doc/reference_samples/Labels';
|
|
|
|
#[Test]
|
|
public function writeProducesByteIdenticalRoundTrip(): void
|
|
{
|
|
$original = file_get_contents(self::REFERENCE_PATH);
|
|
$library = LabelsFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$tmp = tempnam(sys_get_temp_dir(), 'labels_');
|
|
try {
|
|
LabelsFileWriter::write($library, $tmp);
|
|
$this->assertSame($original, file_get_contents($tmp));
|
|
} finally {
|
|
@unlink($tmp);
|
|
}
|
|
}
|
|
|
|
#[Test]
|
|
public function addLabelPersistsThroughWriteRead(): void
|
|
{
|
|
$library = LabelsFileReader::read(self::REFERENCE_PATH);
|
|
$library->addLabel('CustomLabel', ['r' => 0.5, 'g' => 0.5, 'b' => 0.5, 'a' => 1.0]);
|
|
|
|
$tmp = tempnam(sys_get_temp_dir(), 'labels_');
|
|
try {
|
|
LabelsFileWriter::write($library, $tmp);
|
|
|
|
$reload = LabelsFileReader::read($tmp);
|
|
$custom = $reload->getLabelByName('CustomLabel');
|
|
$this->assertNotNull($custom);
|
|
$this->assertSame('#808080', $custom->getColorHex());
|
|
} finally {
|
|
@unlink($tmp);
|
|
}
|
|
}
|
|
|
|
#[Test]
|
|
public function setColorHexAcceptsRrggbb(): void
|
|
{
|
|
$library = LabelsFileReader::read(self::REFERENCE_PATH);
|
|
$beamer = $library->getLabelByName('KeyVisual Beamer');
|
|
$this->assertNotNull($beamer);
|
|
|
|
$beamer->setColorHex('#FF8800');
|
|
$this->assertSame('#FF8800', $beamer->getColorHex());
|
|
}
|
|
|
|
#[Test]
|
|
public function removeLabelRemovesFromDocument(): void
|
|
{
|
|
$library = LabelsFileReader::read(self::REFERENCE_PATH);
|
|
$countBefore = $library->count();
|
|
|
|
$this->assertTrue($library->removeLabel('Leere Folie'));
|
|
$this->assertSame($countBefore - 1, $library->count());
|
|
$this->assertNull($library->getLabelByName('Leere Folie'));
|
|
}
|
|
}
|