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.
94 lines
3 KiB
PHP
94 lines
3 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\CCLIFileReader;
|
|
use ProPresenter\Parser\CCLIFileWriter;
|
|
use ProPresenter\Parser\CCLILibrary;
|
|
|
|
class CCLIFileReaderTest extends TestCase
|
|
{
|
|
private const REFERENCE_PATH = __DIR__ . '/../doc/reference_samples/CCLI';
|
|
|
|
#[Test]
|
|
public function readThrowsOnMissingFile(): void
|
|
{
|
|
$this->expectException(InvalidArgumentException::class);
|
|
CCLIFileReader::read(__DIR__ . '/../doc/reference_samples/does-not-exist-ccli');
|
|
}
|
|
|
|
#[Test]
|
|
public function readReturnsLibraryWithExpectedCount(): void
|
|
{
|
|
$library = CCLIFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$this->assertInstanceOf(CCLILibrary::class, $library);
|
|
$this->assertSame(1, $library->count());
|
|
}
|
|
|
|
#[Test]
|
|
public function documentExposesLicenseAndDisplaySettings(): void
|
|
{
|
|
$library = CCLIFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$this->assertTrue($library->isCCLIDisplayEnabled());
|
|
$this->assertSame('', $library->getCCLILicense());
|
|
$this->assertSame(0, $library->getDisplayType());
|
|
$this->assertNotNull($library->getTemplate());
|
|
}
|
|
|
|
#[Test]
|
|
public function settersUpdateDocument(): void
|
|
{
|
|
$library = CCLIFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$library->setCCLILicense('1234567');
|
|
$library->setDisplayType(3);
|
|
$library->setCCLIDisplayEnabled(false);
|
|
|
|
$this->assertSame('1234567', $library->getCCLILicense());
|
|
$this->assertSame(3, $library->getDisplayType());
|
|
$this->assertFalse($library->isCCLIDisplayEnabled());
|
|
}
|
|
|
|
#[Test]
|
|
public function addAndRemoveRoundTrip(): void
|
|
{
|
|
$library = CCLIFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$template = $library->getTemplate();
|
|
$this->assertNotNull($template);
|
|
|
|
$library->setTemplate(null);
|
|
$this->assertNull($library->getTemplate());
|
|
|
|
$library->setTemplate($template);
|
|
$this->assertNotNull($library->getTemplate());
|
|
}
|
|
|
|
#[Test]
|
|
public function writerProducesByteIdenticalRoundTrip(): void
|
|
{
|
|
$original = file_get_contents(self::REFERENCE_PATH);
|
|
$library = CCLIFileReader::read(self::REFERENCE_PATH);
|
|
|
|
$tmp = tempnam(sys_get_temp_dir(), 'ccli_');
|
|
try {
|
|
CCLIFileWriter::write($library, $tmp);
|
|
$roundTrip = CCLIFileReader::read($tmp);
|
|
$this->assertSame(strlen((string) $original), strlen((string) file_get_contents($tmp)));
|
|
$this->assertSame($library->isCCLIDisplayEnabled(), $roundTrip->isCCLIDisplayEnabled());
|
|
$this->assertSame($library->getCCLILicense(), $roundTrip->getCCLILicense());
|
|
$this->assertSame($library->getDisplayType(), $roundTrip->getDisplayType());
|
|
$this->assertSame($library->getTemplate() !== null, $roundTrip->getTemplate() !== null);
|
|
} finally {
|
|
@unlink($tmp);
|
|
}
|
|
}
|
|
}
|