Refactor EpubChapter methods and update tests to use new getters

Author: ewilan-riviere

src/Formats/Epub/Parser/EpubChapter.php

@@ -55,16 +55,49 @@ private static function findByFilename(array $html, string $filename)
         return false;
     }
 
+    /**
+     * Get the chapter label, e.g. `Chapter 1`
+     */
+    public function getLabel(): string
+    {
+        return $this->label;
+    }
+
+    /**
+     * Get the source file name, e.g. `OEBPS/epub_c01_r1.htm`
+     */
+    public function getSource(): string
+    {
+        return $this->source;
+    }
+
+    /**
+     * Get the chapter content, e.g. `<h1>Chapter 1</h1><p>Content...</p>`
+     */
+    public function getContent(): string
+    {
+        return $this->content;
+    }
+
+    /**
+     * @deprecated Use `getLabel()` instead.
+     */
     public function label(): string
     {
         return $this->label;
     }
 
+    /**
+     * @deprecated Use `getSource()` instead.
+     */
     public function source(): string
     {
         return $this->source;
     }
 
+    /**
+     * @deprecated Use `getContent()` instead.
+     */
     public function content(): string
     {
         return $this->content;

tests/EpubChaptersTest.php

@@ -10,7 +10,7 @@
     expect($chapters)->toBeArray();
     expect($chapters)->toHaveCount(41);
     expect($chapters[0])->toBeInstanceOf(EpubChapter::class);
-    expect($chapters[0]->label())->toBe('Cover');
-    expect($chapters[0]->source())->toBe('titlepage.xhtml');
-    expect($chapters[0]->content())->toBeString();
+    expect($chapters[0]->getLabel())->toBe('Cover');
+    expect($chapters[0]->getSource())->toBe('titlepage.xhtml');
+    expect($chapters[0]->getContent())->toBeString();
 });

tests/EpubTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use Kiwilan\Ebook\Ebook;
+use Kiwilan\Ebook\Formats\Epub\EpubModule;
 use Kiwilan\Ebook\Formats\Epub\Parser\EpubChapter;
 use Kiwilan\Ebook\Formats\Epub\Parser\EpubContainer;
 use Kiwilan\Ebook\Formats\Epub\Parser\EpubHtml;
@@ -240,3 +241,18 @@
     expect($html)->toBeArray()
         ->each(fn (Pest\Expectation $expectation) => expect($expectation->value)->toBeInstanceOf(EpubHtml::class));
 });
+
+it('can get epub chapters', function () {
+    $ebook = Ebook::read(EPUB);
+
+    $epub = $ebook->getParser()->getEpub();
+    expect($epub)->toBeInstanceOf(EpubModule::class);
+    $chapters = $epub->getChapters();
+    expect($chapters)->toBeArray()
+        ->each(fn (Pest\Expectation $expectation) => expect($expectation->value)->toBeInstanceOf(EpubChapter::class));
+
+    $firstChapter = $chapters[0];
+    expect($firstChapter->getLabel())->toBe('Cover');
+    expect($firstChapter->getSource())->toBe('titlepage.xhtml');
+    expect($firstChapter->getContent())->toBeString();
+});