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.6 KiB
PHP
84 lines
2.6 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace ProPresenter\Parser\Tests;
|
|
|
|
use PHPUnit\Framework\Attributes\Test;
|
|
use PHPUnit\Framework\TestCase;
|
|
use ProPresenter\Parser\MacrosFileReader;
|
|
use ProPresenter\Parser\MacrosFileWriter;
|
|
|
|
class MacrosFileWriterTest extends TestCase
|
|
{
|
|
private const REFERENCE_PATH = __DIR__ . '/../doc/reference_samples/Macros';
|
|
|
|
#[Test]
|
|
public function writeProducesSameByteCount(): void
|
|
{
|
|
$original = file_get_contents(self::REFERENCE_PATH);
|
|
$library = MacrosFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$tmp = tempnam(sys_get_temp_dir(), 'macros_');
|
|
try {
|
|
MacrosFileWriter::write($library, $tmp);
|
|
$written = file_get_contents($tmp);
|
|
$this->assertSame(strlen($original), strlen($written));
|
|
} finally {
|
|
@unlink($tmp);
|
|
}
|
|
}
|
|
|
|
#[Test]
|
|
public function readBackPreservesMacrosAndCollections(): void
|
|
{
|
|
$library = MacrosFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$tmp = tempnam(sys_get_temp_dir(), 'macros_');
|
|
try {
|
|
MacrosFileWriter::write($library, $tmp);
|
|
$reload = MacrosFileReader::read($tmp);
|
|
|
|
$this->assertCount(24, $reload->getMacros());
|
|
$this->assertCount(3, $reload->getCollections());
|
|
$this->assertNotNull($reload->getMacroByName('Gottesdienst START'));
|
|
} finally {
|
|
@unlink($tmp);
|
|
}
|
|
}
|
|
|
|
#[Test]
|
|
public function addMacroPersistsThroughWriteRead(): void
|
|
{
|
|
$library = MacrosFileReader::read(self::REFERENCE_PATH);
|
|
$library->addMacro('TestMacro', '11111111-1111-1111-1111-111111111111');
|
|
|
|
$tmp = tempnam(sys_get_temp_dir(), 'macros_');
|
|
try {
|
|
MacrosFileWriter::write($library, $tmp);
|
|
$reload = MacrosFileReader::read($tmp);
|
|
|
|
$found = $reload->getMacroByUuid('11111111-1111-1111-1111-111111111111');
|
|
$this->assertNotNull($found);
|
|
$this->assertSame('TestMacro', $found->getName());
|
|
} finally {
|
|
@unlink($tmp);
|
|
}
|
|
}
|
|
|
|
#[Test]
|
|
public function setColorHexUpdatesMacro(): void
|
|
{
|
|
$library = MacrosFileReader::read(self::REFERENCE_PATH);
|
|
$macro = $library->getMacroByName('Gottesdienst START');
|
|
$this->assertNotNull($macro);
|
|
|
|
$macro->setColor(['r' => 0.5, 'g' => 0.0, 'b' => 1.0]);
|
|
$color = $macro->getColor();
|
|
$this->assertNotNull($color);
|
|
$this->assertEqualsWithDelta(0.5, $color['r'], 0.001);
|
|
$this->assertEqualsWithDelta(0.0, $color['g'], 0.001);
|
|
$this->assertEqualsWithDelta(1.0, $color['b'], 0.001);
|
|
}
|
|
}
|