refactor: redesign whhtmltopdf extra options and add tests

Author: PedroTroller

src/Backend/WkHtmlToPdf/ExtraOption.php

@@ -4,10 +4,26 @@
 
 namespace KNPLabs\Snappy\Backend\WkHtmlToPdf;
 
-interface ExtraOption
+/**
+ * @see https://wkhtmltopdf.org/usage/wkhtmltopdf.txt
+ */
+abstract class ExtraOption
 {
-    public function isRepeatable(): bool;
+    /**
+     * @param non-empty-array<string> $command
+     */
+    public function __construct(private readonly bool $repeatable, private readonly array $command) {}
 
-    /** @return array<float|int|string> */
-    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/Allow.php

@@ -6,17 +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) {}
-
-    public function isRepeatable(): bool
-    {
-        return true;
-    }
-
-    public function compile(): array
+    /**
+     * @param non-empty-string $path
+     */
+    public function __construct(string $path)
     {
-        return ['--allow', $this->path];
+        parent::__construct(
+            repeatable: true,
+            command: ['--allow', $path]
+        );
     }
 }

src/Backend/WkHtmlToPdf/ExtraOption/BypassProxyFor.php

@@ -6,17 +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) {}
-
-    public function isRepeatable(): bool
-    {
-        return true;
-    }
-
-    public function compile(): array
+    /**
+     * @param non-empty-string $value
+     */
+    public function __construct(string $value)
     {
-        return ['--bypass-proxy-for', $this->value];
+        parent::__construct(
+            repeatable: true,
+            command: ['--bypass-proxy-for', $value],
+        );
     }
 }

src/Backend/WkHtmlToPdf/ExtraOption/CacheDir.php

@@ -6,17 +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) {}
-
-    public function isRepeatable(): bool
-    {
-        return false;
-    }
-
-    public function compile(): array
+    /**
+     * @param non-empty-string $path
+     */
+    public function __construct(string $path)
     {
-        return ['--cache-dir', $this->path];
+        parent::__construct(
+            repeatable: false,
+            command: ['--cache-dir', $path],
+        );
     }
 }

src/Backend/WkHtmlToPdf/ExtraOption/CheckBoxSvg.php

@@ -6,17 +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) {}
-
-    public function isRepeatable(): bool
-    {
-        return false;
-    }
-
-    public function compile(): array
+    /**
+     * @param non-empty-string $path
+     */
+    public function __construct(string $path)
     {
-        return ['--checkbox-svg', $this->path];
+        parent::__construct(
+            repeatable: false,
+            command: ['--checkbox-svg', $path],
+        );
     }
 }

src/Backend/WkHtmlToPdf/ExtraOption/CheckboxCheckedSvg.php

@@ -6,17 +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) {}
-
-    public function isRepeatable(): bool
-    {
-        return false;
-    }
-
-    public function compile(): array
+    /**
+     * @param non-empty-string $path
+     */
+    public function __construct(string $path)
     {
-        return ['--checkbox-checked-svg', $this->path];
+        parent::__construct(
+            repeatable: false,
+            command: ['--checkbox-checked-svg', $path],
+        );
     }
 }

src/Backend/WkHtmlToPdf/ExtraOption/Cookie.php

@@ -6,17 +6,19 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-class Cookie implements ExtraOption
+/**
+ * Set an additional cookie.
+ */
+final class Cookie extends ExtraOption
 {
-    public function __construct(private readonly string $name, private readonly string $value) {}
-
-    public function isRepeatable(): bool
-    {
-        return true;
-    }
-
-    public function compile(): array
+    /**
+     * @param non-empty-string $name
+     */
+    public function __construct(string $name, string $value)
     {
-        return ['--cookie', $this->name, $this->value];
+        parent::__construct(
+            repeatable: true,
+            command: ['--cookie', $name, urlencode($value)],
+        );
     }
 }

src/Backend/WkHtmlToPdf/ExtraOption/CookieJar.php

@@ -6,17 +6,19 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-final class CookieJar implements ExtraOption
+/**
+ * Read and write cookies from and to the supplied cookie jar file.
+ */
+final class CookieJar extends ExtraOption
 {
-    public function __construct(public readonly string $path) {}
-
-    public function isRepeatable(): bool
-    {
-        return false;
-    }
-
-    public function compile(): array
+    /**
+     * @param non-empty-string $path
+     */
+    public function __construct(string $path)
     {
-        return ['--no-collate'];
+        parent::__construct(
+            repeatable: false,
+            command: ['--cookie-jar', $path],
+        );
     }
 }

src/Backend/WkHtmlToPdf/ExtraOption/Copies.php

@@ -6,20 +6,21 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-final class Copies implements ExtraOption
+/**
+ * Number of copies to print into the pdf file.
+ *
+ * Default: 1
+ */
+final class Copies extends ExtraOption
 {
     /**
      * @param positive-int $number
      */
-    public function __construct(private readonly int $number) {}
-
-    public function isRepeatable(): bool
-    {
-        return false;
-    }
-
-    public function compile(): array
+    public function __construct(int $number)
     {
-        return ['--copies', $this->number];
+        parent::__construct(
+            repeatable: false,
+            command: ['--copies', (string) $number],
+        );
     }
 }

src/Backend/WkHtmlToPdf/ExtraOption/CustomHeader.php

@@ -6,17 +6,19 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-class CustomHeader implements ExtraOption
+/**
+ * Set an additional HTTP header.
+ */
+final class CustomHeader extends ExtraOption
 {
-    public function __construct(private readonly string $name, private readonly string $value) {}
-
-    public function isRepeatable(): bool
-    {
-        return true;
-    }
-
-    public function compile(): array
+    /**
+     * @param non-empty-string $name
+     */
+    public function __construct(string $name, string $value)
     {
-        return ['--custom-header', $this->name, $this->value];
+        parent::__construct(
+            repeatable: true,
+            command: ['--custom-header', $name, $value],
+        );
     }
 }

src/Backend/WkHtmlToPdf/ExtraOption/CustomHeaderPropagation.php

@@ -6,15 +6,16 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-class CustomHeaderPropagation implements ExtraOption
+/**
+ * Add HTTP headers specified by CustomHeader for each resource request.
+ */
+final class CustomHeaderPropagation extends ExtraOption
 {
-    public function isRepeatable(): bool
+    public function __construct()
     {
-        return false;
-    }
-
-    public function compile(): array
-    {
-        return ['--custom-header-propagation'];
+        parent::__construct(
+            repeatable: false,
+            command: ['--custom-header-propagation'],
+        );
     }
 }

src/Backend/WkHtmlToPdf/ExtraOption/DefaultHeader.php

@@ -6,15 +6,16 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-class DefaultHeader implements ExtraOption
+/**
+ * Add a default header, with the name of the page to the left, and the page number to the right.
+ */
+final class DefaultHeader extends ExtraOption
 {
-    public function isRepeatable(): bool
+    public function __construct()
     {
-        return false;
-    }
-
-    public function compile(): array
-    {
-        return ['--default-header'];
+        parent::__construct(
+            repeatable: false,
+            command: ['--default-header'],
+        );
     }
 }

src/Backend/WkHtmlToPdf/ExtraOption/DisableDottedLines.php

@@ -6,15 +6,16 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-final class DisableDottedLines implements ExtraOption
+/**
+ * Do not use dotted lines in the toc.
+ */
+final class DisableDottedLines extends ExtraOption
 {
-    public function isRepeatable(): bool
+    public function __construct()
     {
-        return false;
-    }
-
-    public function compile(): array
-    {
-        return ['--disable-dotted-lines'];
+        parent::__construct(
+            repeatable: false,
+            command: ['--disable-dotted-lines'],
+        );
     }
 }