copy local images mentioned in pages to output folder, this closes #1

nexendrie · Oct 5, 2017 · 7ff9ca0 · 7ff9ca0
1 parent 206165c
commit 7ff9ca0
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 2 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -3,8 +3,9 @@ Version 0.2.0+dev
 - added dependency on symfony/options-resolver
 - it is now possible to include stylesheets and scripts in generated pages
 - Generator no longer tries to guess source and output folders
-- added events onBeforeGenerate and onAfterGenerate to Generator
+- added events onBeforeGenerate, onAfterGenerate and onCreatePage to Generator
 - introduced meta normalizers for Generator
+- local image mentioned in pages are now copied to output folder
 
 Version 0.2.0
 - raised minimal version of PHP to 7

diff --git a/docs/index.md b/docs/index.md
@@ -62,3 +62,5 @@ styles:
 scripts:
     - script.js
 ```
+
+If you mention a local image in your page, the file will be copied to output folder.
diff --git a/src/Generator.php b/src/Generator.php
@@ -17,6 +17,7 @@
  * @property string $source
  * @property string $output
  * @method void onBeforeGenerate()
+ * @method void onCreatePage(string $html, Generator $generator, string $filename)
  * @method void onAfterGenerate()
  */
 class Generator {
@@ -35,6 +36,8 @@ class Generator {
   /** @var callable[] */
   public $onBeforeGenerate = [];
   /** @var callable[] */
+  public $onCreatePage = [];
+  /** @var callable[] */
   public $onAfterGenerate = [];
 
   public function __construct(string $source, string $output) {
@@ -43,6 +46,7 @@ public function __construct(string $source, string $output) {
     $this->setOutput($output);
     $this->templateFile = __DIR__ . "/template.html";
     $this->onBeforeGenerate[] = [$this, "clearOutputFolder"];
+    $this->onCreatePage[] = [$this, "processImages"];
     $this->onAfterGenerate[] = [$this, "copyAssets"];
     $this->addMetaNormalizer([$this, "normalizeTitle"]);
     $this->addMetaNormalizer([$this, "normalizeStyles"]);
@@ -185,6 +189,22 @@ public function copyAssets(): void {
     }
   }
 
+  /**
+   * @internal
+   */
+  public function processImages(string $html, self $generator, string $filename): void {
+    $dom = new \DOMDocument();
+    $dom->loadHTML($html);
+    $images = $dom->getElementsByTagName("img");
+    /** @var \DOMElement $image */
+    foreach($images as $image) {
+      $path = dirname($filename) . "/" . $image->getAttribute("src");
+      if(file_exists($path)) {
+        $generator->addAsset($path);
+      }
+    }
+  }
+
   /**
    * Generate the site
    */
@@ -206,6 +226,7 @@ public function generate(): void {
       $filename = "$this->output$path/$basename";
       FileSystem::write($filename, $html);
       echo "Created $path/$basename\n";
+      $this->onCreatePage($html, $this, $file->getRealPath());
     }
     $this->onAfterGenerate();
   }

diff --git a/tests/Nexendrie/SiteGenerator/GeneratorTest.phpt b/tests/Nexendrie/SiteGenerator/GeneratorTest.phpt
@@ -88,6 +88,8 @@ class GeneratorTest extends \Tester\TestCase {
     }
     Assert::true(file_exists("{$this->generator->output}/style.css"));
     Assert::true(file_exists("{$this->generator->output}/script.js"));
+    Assert::true(file_exists("{$this->generator->output}/blank.jpg"));
+    Assert::false(file_exists("{$this->generator->output}/nonexisting.png"));
   }
 }
 

diff --git a/tests/Nexendrie/SiteGenerator/pageAssets.html b/tests/Nexendrie/SiteGenerator/pageAssets.html
@@ -9,5 +9,7 @@
 </head>
 <body>
 <h1>Assets</h1>
+<p><img src="blank.jpg" alt="blank"><br>
+<img src="nonexisting.png" alt="non existing"></p>
 </body>
 </html>
diff --git a/tests/sources/assets.md b/tests/sources/assets.md
@@ -1,2 +1,5 @@
 Assets
-======
+======
+
+![blank](blank.jpg)
+![non existing](nonexisting.png)
diff --git a/tests/sources/blank.jpg b/tests/sources/blank.jpg