wip v8

changelog.md

@@ -1,13 +1,15 @@
-# WeasyPrint for Laravel – Release Notes
+# WeasyPrint for Laravel — Changelog
 
 ## 8.0.0 (Breaking Release) `current`
 
 This release drops support for WeasyPrint < v59. Going forward, compatibility of this package against a particular WeasyPrint version will be based solely on CLI flags available the *latest* version of WeasyPrint. If a CLI property is added or removed in a WeasyPrint release, then it will become unsupported in a new version of the package.
 
-## Changes:
+### Changes:
 
 - The `optimizeSize` configuration option has been removed.
-- WIP
+- Default config is now class-based to introduce some type-safety.
+- Config may now only be tapped or overridden.
+- …
 - All tests have been moved to Pest 2. Coverage removed for the time being.
 
 ## 7.1.0 `maintenance`, `minor`
@@ -20,6 +22,11 @@ This release adds support for WeasyPrint 58, along with two new configuration pr
 
 This release adds support for Laravel 10 and drops support for Laravel 8. The minimum-required version of PHP is now 8.1. As there have been no significant API changes to WeasyPrint, this package continues to support v53+.
 
+<hr />
+
+<details>
+<summary>Unsupported Versions</summary>
+
 ## 6.1.0 `no support`, `minor`
 
 This release adds support for Laravel 9, and works just fine with WeasyPrint v54.
@@ -152,3 +159,5 @@ Given that v5 is a paradigm release, the following changes are considered breaki
 ## 1.0.0 `no support`
 
 - Initial Release
+
+</details>

config/weasyprint.php

@@ -16,7 +16,7 @@
   /**
    * The amount of seconds to allow a conversion to run for.
    */
-  timeout: (int) env('WEASYPRINT_TIMEOUT', 120),
+  timeout: (int) env('WEASYPRINT_TIMEOUT', '120'),
 
   /**
    * Force the input character encoding. utf-8 is recommended.
@@ -26,7 +26,7 @@
   /**
    * Enable or disable HTML Presentational Hints.
    */
-  presentationalHints: (bool) env('WEASYPRINT_PRESENTATIONAL_HINTS', true),
+  presentationalHints: env('WEASYPRINT_PRESENTATIONAL_HINTS', 'true'),
 
   /**
    * Optionally set the media type to use for CSS @media.

readme.md

@@ -88,7 +88,7 @@ class GeneratePDF
 }
 ```
 
-**Global Helpers**
+**Global Helpers:**
 
 ```php
 use WeasyPrint\Contracts\Factory;

src/Contracts/Factory.php

@@ -12,12 +12,14 @@ interface Factory
 {
   public function getWeasyPrintVersion(): string;
 
-  public function tapConfig(callable $callback): self;
+  public function setConfig(Config $config): self;
 
-  public function prepareSource(Source|Renderable|string $source): self;
+  public function tapConfig(callable $callback): self;
 
   public function getConfig(): Config;
 
+  public function prepareSource(Source|Renderable|string $source): self;
+
   public function getSource(): Source;
 
   public function addAttachment(string $pathToAttachment): Factory;

src/Facade.php

@@ -6,12 +6,12 @@
 
 use Illuminate\Support\Facades\Facade as SupportFacade;
 use WeasyPrint\Contracts\Factory;
-use WeasyPrint\Objects\Config;
 
 /**
- * @method static Factory mergeConfig(mixed ...$config)
- * @method static Factory prepareSource(Source|Renderable|string $source)
- * @method static Config getConfig()
+ * @method static string getWeasyPrintVersion()
+ * @method static Factory setConfig(Objects\Config $config)
+ * @method static Factory tapConfig(callable $callback)
+ * @method static Factory prepareSource(Objects\Source|\Illuminate\Contracts\Support\Renderable|string $source)
  */
 class Facade extends SupportFacade
 {

src/Objects/Output.php

@@ -7,12 +7,11 @@
 use Illuminate\Support\Facades\{Response, Storage};
 use Symfony\Component\HttpFoundation\StreamedResponse;
 
-class Output
+final class Output
 {
   public function __construct(
     protected string $data
-  ) {
-  }
+  ) {}
 
   public function download(string $filename, array $headers = [], bool $inline = false): StreamedResponse
   {

src/Objects/Source.php

@@ -7,14 +7,13 @@
 use Illuminate\Contracts\Support\Renderable;
 use WeasyPrint\Exceptions\TemporaryFileException;
 
-class Source
+final class Source
 {
   private array $attachments = [];
 
   public function __construct(
     protected Renderable|string $source
-  ) {
-  }
+  ) {}
 
   public function get(): Renderable|string
   {

src/Pipeline/BuildStage.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WeasyPrint\Pipeline;
+
+interface BuildStage
+{
+  public function __invoke(BuildTraveler $container): BuildTraveler;
+}

src/Pipeline/BuilderContainer.php → src/Pipeline/BuildTraveler.php

@@ -8,7 +8,7 @@
 use WeasyPrint\Objects\Output;
 use WeasyPrint\Service;
 
-class BuilderContainer
+class BuildTraveler
 {
   private string $inputPath;
   private string $outputPath;
@@ -17,8 +17,7 @@ class BuilderContainer
 
   public function __construct(
     public Service $service
-  ) {
-  }
+  ) {}
 
   public function makeTemporaryFilename(): string|false
   {

src/Pipeline/Stages/EnsureSourceIsSet.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WeasyPrint\Pipeline\Stages;
+
+use WeasyPrint\Exceptions\SourceNotSetException;
+use WeasyPrint\Pipeline\{BuildStage, BuildTraveler};
+
+class EnsureSourceIsSet implements BuildStage
+{
+  public function __invoke(BuildTraveler $container): BuildTraveler
+  {
+    if (!$container->service->sourceIsSet()) {
+      throw new SourceNotSetException();
+    }
+
+    return $container;
+  }
+}

src/Pipeline/Stages/Execute.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WeasyPrint\Pipeline\Stages;
+
+use WeasyPrint\Pipeline\{BuildStage, BuildTraveler};
+
+class Execute implements BuildStage
+{
+  public function __invoke(BuildTraveler $container): BuildTraveler
+  {
+    $container->getCommand()->execute();
+
+    return $container;
+  }
+}

src/Pipeline/Stages/PersistTemporaryInput.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WeasyPrint\Pipeline\Stages;
+
+use WeasyPrint\Pipeline\{BuildStage, BuildTraveler};
+
+class PersistTemporaryInput implements BuildStage
+{
+  public function __invoke(BuildTraveler $container): BuildTraveler
+  {
+    $container->service
+      ->getSource()
+      ->persistTemporaryFile($container->getInputPath());
+
+    return $container;
+  }
+}

src/Pipeline/BuilderPipes/PrepareBuildCommand.php → src/Pipeline/Stages/PrepareBuildCommand.php

@@ -2,14 +2,14 @@
 
 declare(strict_types=1);
 
-namespace WeasyPrint\Pipeline\BuilderPipes;
+namespace WeasyPrint\Pipeline\Stages;
 
 use WeasyPrint\Commands\BuildCommand;
-use WeasyPrint\Pipeline\{BuilderContainer, BuilderPipelineStage};
+use WeasyPrint\Pipeline\{BuildStage, BuildTraveler};
 
-class PrepareBuildCommand implements BuilderPipelineStage
+class PrepareBuildCommand implements BuildStage
 {
-  public function __invoke(BuilderContainer $container): BuilderContainer
+  public function __invoke(BuildTraveler $container): BuildTraveler
   {
     $service = $container->service;
 

src/Pipeline/BuilderPipes/PrepareOutput.php → src/Pipeline/Stages/PrepareOutput.php

@@ -2,15 +2,15 @@
 
 declare(strict_types=1);
 
-namespace WeasyPrint\Pipeline\BuilderPipes;
+namespace WeasyPrint\Pipeline\Stages;
 
 use WeasyPrint\Exceptions\{MissingOutputFileException, OutputReadFailedException};
 use WeasyPrint\Objects\Output;
-use WeasyPrint\Pipeline\{BuilderContainer, BuilderPipelineStage};
+use WeasyPrint\Pipeline\{BuildStage, BuildTraveler};
 
-class PrepareOutput implements BuilderPipelineStage
+class PrepareOutput implements BuildStage
 {
-  public function __invoke(BuilderContainer $container): BuilderContainer
+  public function __invoke(BuildTraveler $container): BuildTraveler
   {
     if (!is_file($outputPath = $container->getOutputPath())) {
       throw new MissingOutputFileException($outputPath);

src/Pipeline/BuilderPipes/SetInputPath.php → src/Pipeline/Stages/SetInputPath.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace WeasyPrint\Pipeline\BuilderPipes;
+namespace WeasyPrint\Pipeline\Stages;
 
-use WeasyPrint\Pipeline\{BuilderContainer, BuilderPipelineStage};
+use WeasyPrint\Pipeline\{BuildStage, BuildTraveler};
 
-class SetInputPath implements BuilderPipelineStage
+class SetInputPath implements BuildStage
 {
-  public function __invoke(BuilderContainer $container): BuilderContainer
+  public function __invoke(BuildTraveler $container): BuildTraveler
   {
     $container->setInputPath(
       match (($source = $container->service->getSource())->isUrl()) {