feat(core): implement frontends for all backends

Author: PedroTroller

.gitignore

@@ -1,2 +1,4 @@
+/.php-cs-fixer.cache
+/.phpunit.result.cache
 /composer.lock
 /vendor

.phpunit.result.cache

@@ -13,17 +13,11 @@
   </php>
 
   <testsuites>
-    <testsuite name="Snappy Dompdf backend">
-      <directory>./src/Backend/Dompdf</directory>
-    </testsuite>
-    <testsuite name="Snappy WkHtmlToPdf backend">
-      <directory>./src/Backend/WkHtmlToPdf</directory>
-    </testsuite>
     <testsuite name="Snappy core">
-      <directory>./src/Core/</directory>
+        <directory>./src/Core/Tests/</directory>
     </testsuite>
     <testsuite name="Snappy Symfony framework integration">
-      <directory>./src/Framework/Symfony/</directory>
+        <directory>./src/Framework/Symfony/Tests/</directory>
     </testsuite>
   </testsuites>
 </phpunit>

phpunit.xml.dist

@@ -32,10 +32,10 @@ public function __construct(
         $this->options = $options;
     }
 
-    public function generateFromDOMDocument(DOMDocument $DOMDocument): StreamInterface
+    public function generateFromDOMDocument(DOMDocument $document): StreamInterface
     {
         $dompdf = $this->buildDompdf();
-        $dompdf->loadDOM($DOMDocument);
+        $dompdf->loadDOM($document);
 
         return $this->createStream($dompdf);
     }

src/Backend/Dompdf/DompdfAdapter.php

@@ -7,7 +7,7 @@
 interface Adapter
 {
     /**
-     * @param Options|(callable(Options $options): Options) $options
+     * @param (callable(Options $options): Options)|Options $options
      */
-    public function withOptions(Options|callable $options): static;
+    public function withOptions(callable|Options $options): static;
 }

src/Core/Backend/Adapter.php

@@ -21,7 +21,7 @@ trait Reconfigurable
     /**
      * @return TAdapter
      */
-    public function withOptions(Options|callable $options): static
+    public function withOptions(callable|Options $options): static
     {
         if (is_callable($options)) {
             $options = $options($this->options);

src/Core/Backend/Adapter/Reconfigurable.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Core\Backend\Adapter;
+
+use KNPLabs\Snappy\Core\Backend\Adapter;
+use Psr\Http\Message\StreamInterface;
+
+interface StreamToPdf extends Adapter
+{
+    public function generateFromStream(StreamInterface $stream): StreamInterface;
+}

src/Core/Backend/Adapter/StreamToPdf.php

@@ -14,8 +14,7 @@ final class Options
     public function __construct(
         public readonly ?PageOrientation $pageOrientation,
         public readonly array $extraOptions
-    ) {
-    }
+    ) {}
 
     public static function create(): self
     {

src/Core/Backend/Options.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Core;
+
+abstract class Exception extends \Exception {}

src/Core/Bridge/FromHtmlFileToHtmlToPdf.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Core\Exception;
+
+use KNPLabs\Snappy\Core\Exception;
+
+final class DOMDocumentException extends Exception {}

src/Core/Bridge/FromHtmlToHtmlFileToPdf.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Core\Exception;
+
+use KNPLabs\Snappy\Core\Exception;
+
+final class FileNotFoundException extends Exception {}

src/Core/Exception.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Core\Exception;
+
+use KNPLabs\Snappy\Core\Exception;
+
+final class FileReadException extends Exception
+{
+    public function __construct(\SplFileInfo $file)
+    {
+        file_exists($file->getPathname())
+            ? parent::__construct("File {$file->getPathname()} can't be read.")
+            : parent::__construct("File {$file->getPathname()} not found.");
+    }
+}

src/Core/Exception/DOMDocumentException.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Core\Exception;
+
+use KNPLabs\Snappy\Core\Exception;
+
+final class FrontendUnsupportedBackendException extends Exception
+{
+    public function __construct(string $frontendClass, string $backendClass)
+    {
+        parent::__construct(
+            sprintf(
+                'Snappy frontend "%s" does not support backend "%s"',
+                $frontendClass,
+                $backendClass,
+            )
+        );
+    }
+}

src/Core/Exception/FileNotFoundException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Core\Exception;
+
+use KNPLabs\Snappy\Core\Exception;
+
+final class StreamDetachedException extends Exception
+{
+    public function __construct()
+    {
+        parent::__construct('Stream is detached.');
+    }
+}

src/Core/Exception/FileReadException.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Core\Filesystem;
+
+final class SplResourceInfo extends \SplFileInfo
+{
+    /**
+     * @param resource $resource
+     */
+    public function __construct(public readonly mixed $resource)
+    {
+        parent::__construct(stream_get_meta_data($this->resource)['uri']);
+    }
+
+    public static function fromTmpFile(): self
+    {
+        return new self(tmpfile());
+    }
+}

src/Core/Exception/FrontendUnsupportedBackendException.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Core\Frontend;
+
+use KNPLabs\Snappy\Core\Backend\Adapter;
+use KNPLabs\Snappy\Core\Backend\Options;
+use KNPLabs\Snappy\Core\Exception\DOMDocumentException;
+use KNPLabs\Snappy\Core\Exception\FrontendUnsupportedBackendException;
+use KNPLabs\Snappy\Core\Filesystem\SplResourceInfo;
+use Psr\Http\Message\StreamFactoryInterface;
+use Psr\Http\Message\StreamInterface;
+
+final class DOMDocumentToPdf implements Adapter\DOMDocumentToPdf
+{
+    public function __construct(private readonly Adapter $adapter, private readonly StreamFactoryInterface $streamFactory) {}
+
+    public function withOptions(callable|Options $options): static
+    {
+        return new self(
+            $this->adapter->withOptions($options),
+            $this->streamFactory,
+        );
+    }
+
+    public function generateFromDOMDocument(\DOMDocument $document): StreamInterface
+    {
+        if ($this->adapter instanceof Adapter\DOMDocumentToPdf) {
+            return $this->adapter->generateFromDOMDocument($document);
+        }
+
+        $html = $document->saveHTML();
+
+        if (false === $html) {
+            throw new DOMDocumentException('Unable to read HTML from DOMDocument.');
+        }
+
+        if ($this->adapter instanceof Adapter\HtmlToPdf) {
+            return $this->adapter->generateFromHtml($html);
+        }
+
+        if ($this->adapter instanceof Adapter\StreamToPdf) {
+            return $this->adapter->generateFromStream(
+                $this->streamFactory->createStream($html)
+            );
+        }
+
+        if ($this->adapter instanceof Adapter\HtmlFileToPdf) {
+            $file = SplResourceInfo::fromTmpFile();
+
+            fwrite($file->resource, $html);
+
+            return $this->adapter->generateFromHtmlFile($file);
+        }
+
+        throw new FrontendUnsupportedBackendException(
+            self::class,
+            $this->adapter::class,
+        );
+    }
+}

src/Core/Exception/StreamDetachedException.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Core\Frontend;
+
+use KNPLabs\Snappy\Core\Backend\Adapter;
+use KNPLabs\Snappy\Core\Backend\Options;
+use KNPLabs\Snappy\Core\Exception\FileReadException;
+use KNPLabs\Snappy\Core\Exception\FrontendUnsupportedBackendException;
+use KNPLabs\Snappy\Core\Stream\FileStream;
+use Psr\Http\Message\StreamFactoryInterface;
+use Psr\Http\Message\StreamInterface;
+
+final class HtmlFileToPdf implements Adapter\HtmlFileToPdf
+{
+    public function __construct(private readonly Adapter $adapter, private readonly StreamFactoryInterface $streamFactory) {}
+
+    public function withOptions(callable|Options $options): static
+    {
+        return new self(
+            $this->adapter->withOptions($options),
+            $this->streamFactory
+        );
+    }
+
+    public function generateFromHtmlFile(\SplFileInfo $file): StreamInterface
+    {
+        if ($this->adapter instanceof Adapter\HtmlFileToPdf) {
+            return $this->adapter->generateFromHtmlFile($file);
+        }
+
+        if ($this->adapter instanceof Adapter\StreamToPdf) {
+            return $this->adapter->generateFromStream(
+                new FileStream(
+                    $file,
+                    $this->streamFactory->createStreamFromFile($file->getPathname()),
+                ),
+            );
+        }
+
+        if ($this->adapter instanceof Adapter\HtmlToPdf) {
+            $html = file_get_contents($file->getPathname());
+
+            if (false === $html) {
+                throw new FileReadException($file);
+            }
+
+            return $this->adapter->generateFromHtml($html);
+        }
+
+        if ($this->adapter instanceof Adapter\DOMDocumentToPdf) {
+            $document = new \DOMDocument();
+            $document->loadHTMLFile($file->getPathname());
+
+            return $this->adapter->generateFromDOMDocument($document);
+        }
+
+        throw new FrontendUnsupportedBackendException(
+            self::class,
+            $this->adapter::class,
+        );
+    }
+}