v2 unstable wkhtmltopdf options refactoring (#522)

* test: remove duplicated test case

* refactor: redesign whhtmltopdf extra options and add tests

Author: PedroTroller

.github/actions/install-ghostscript/action.yaml

@@ -0,0 +1,8 @@
+---
+runs:
+  using: 'composite'
+  steps:
+    - run: sudo apt-get update
+      shell: bash
+    - run: sudo apt-get install ghostscript --yes
+      shell: bash

.github/actions/install-wkhtmltopdf/action.yaml

@@ -0,0 +1,8 @@
+---
+runs:
+  using: 'composite'
+  steps:
+    - run: sudo apt-get update
+      shell: bash
+    - run: sudo apt-get install xvfb libfontconfig wkhtmltopdf --yes
+      shell: bash

.github/workflows/tests.yaml

@@ -66,8 +66,8 @@ jobs:
         # with:
         #   sparse-checkout: |
         #     ${{ matrix.path }}
-      - run: sudo apt-get update
-      - run: sudo apt-get install ghostscript --yes
+      - uses: ./.github/actions/install-ghostscript
+      - uses: ./.github/actions/install-wkhtmltopdf
       - uses: shivammathur/setup-php@v2
       - run: composer install
       - run: vendor/bin/phpunit

src/Backend/Dompdf/Tests/DompdfAdapterTest.php

@@ -4,9 +4,26 @@
 
 namespace KNPLabs\Snappy\Backend\WkHtmlToPdf;
 
-interface ExtraOption {
-    public function isRepeatable(): bool;
+/**
+ * @see https://wkhtmltopdf.org/usage/wkhtmltopdf.txt
+ */
+abstract class ExtraOption
+{
+    /**
+     * @param non-empty-array<string> $command
+     */
+    public function __construct(private bool $repeatable, private array $command) {}
 
-    /** @return array<string|int|float> */
-    public function compile(): array;
+    final public function isRepeatable(): bool
+    {
+        return $this->repeatable;
+    }
+
+    /**
+     * @return non-empty-array<string>
+     */
+    final public function getCommand(): array
+    {
+        return $this->command;
+    }
 }

src/Backend/WkHtmlToPdf/ExtraOption.php

@@ -6,19 +6,19 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-class Allow implements ExtraOption
+/**
+ *  Allow the file or files from the specified folder to be loaded.
+ */
+final class Allow extends ExtraOption
 {
-    public function __construct(private readonly string $path)
+    /**
+     * @param non-empty-string $path
+     */
+    public function __construct(string $path)
     {
+        parent::__construct(
+            repeatable: true,
+            command: ['--allow', $path]
+        );
     }
-
-    public function isRepeatable(): bool
-    {
-        return true;
-    }
-
-    public function compile(): array
-    {
-        return ['--allow', $this->path];
-    }
-}
+}

src/Backend/WkHtmlToPdf/ExtraOption/Allow.php

@@ -6,19 +6,19 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-class BypassProxyFor implements ExtraOption
+/**
+ * Bypass proxy for host.
+ */
+final class BypassProxyFor extends ExtraOption
 {
-    public function __construct(private readonly string $value)
+    /**
+     * @param non-empty-string $value
+     */
+    public function __construct(string $value)
     {
+        parent::__construct(
+            repeatable: true,
+            command: ['--bypass-proxy-for', $value],
+        );
     }
-
-    public function isRepeatable(): bool
-    {
-        return true;
-    }
-
-    public function compile(): array
-    {
-        return ['--bypass-proxy-for', $this->value];
-    }
-}
+}

src/Backend/WkHtmlToPdf/ExtraOption/BypassProxyFor.php

@@ -6,19 +6,19 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-class CacheDir implements ExtraOption
+/**
+ * Web cache directory.
+ */
+final class CacheDir extends ExtraOption
 {
-    public function __construct(private readonly string $path)
+    /**
+     * @param non-empty-string $path
+     */
+    public function __construct(string $path)
     {
+        parent::__construct(
+            repeatable: false,
+            command: ['--cache-dir', $path],
+        );
     }
-
-    public function isRepeatable(): bool
-    {
-        return false;
-    }
-
-    public function compile(): array
-    {
-        return ['--cache-dir', $this->path];
-    }
-}
+}

src/Backend/WkHtmlToPdf/ExtraOption/CacheDir.php

@@ -6,19 +6,19 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-class CheckBoxSvg implements ExtraOption
+/**
+ * Use this SVG file when rendering unchecked checkboxes.
+ */
+final class CheckBoxSvg extends ExtraOption
 {
-    public function __construct(private readonly string $path)
+    /**
+     * @param non-empty-string $path
+     */
+    public function __construct(string $path)
     {
+        parent::__construct(
+            repeatable: false,
+            command: ['--checkbox-svg', $path],
+        );
     }
-
-    public function isRepeatable(): bool
-    {
-        return false;
-    }
-
-    public function compile(): array
-    {
-        return ['--checkbox-svg', $this->path];
-    }
-}
+}

src/Backend/WkHtmlToPdf/ExtraOption/CheckBoxSvg.php

@@ -6,19 +6,19 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-class CheckboxCheckedSvg implements ExtraOption
+/**
+ * Use this SVG file when rendering checked checkboxes.
+ */
+final class CheckboxCheckedSvg extends ExtraOption
 {
-    public function __construct(private readonly string $path)
+    /**
+     * @param non-empty-string $path
+     */
+    public function __construct(string $path)
     {
+        parent::__construct(
+            repeatable: false,
+            command: ['--checkbox-checked-svg', $path],
+        );
     }
-
-    public function isRepeatable(): bool
-    {
-        return false;
-    }
-
-    public function compile(): array
-    {
-        return ['--checkbox-checked-svg', $this->path];
-    }
-}
+}