Rework services to allow future changes towards profiler

.phpstorm.meta.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace PHPSTORM_META {
+ expectedArguments(
+ \Sensiolabs\GotenbergBundle\Builder\AbstractPdfBuilder::fileName(),
+ 1,
+ \Symfony\Component\HttpFoundation\HeaderUtils::DISPOSITION_INLINE,
+ \Symfony\Component\HttpFoundation\HeaderUtils::DISPOSITION_ATTACHMENT,
+ );
+}

config/services.php

@@ -1,5 +1,9 @@
 <?php
 
+use Sensiolabs\GotenbergBundle\Builder\HtmlPdfBuilder;
+use Sensiolabs\GotenbergBundle\Builder\LibreOfficePdfBuilder;
+use Sensiolabs\GotenbergBundle\Builder\MarkdownPdfBuilder;
+use Sensiolabs\GotenbergBundle\Builder\UrlPdfBuilder;
 use Sensiolabs\GotenbergBundle\Client\GotenbergClient;
 use Sensiolabs\GotenbergBundle\Client\GotenbergClientInterface;
 use Sensiolabs\GotenbergBundle\Formatter\AssetBaseDirFormatter;
@@ -12,29 +16,16 @@
 use function Symfony\Component\DependencyInjection\Loader\Configurator\abstract_arg;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\param;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
+use function Symfony\Component\DependencyInjection\Loader\Configurator\tagged_locator;
 
 return function (ContainerConfigurator $container): void {
  $services = $container->services();
 
- $services->set('sensiolabs_gotenberg', Gotenberg::class)
- ->args([
- service('sensiolabs_gotenberg.client'),
- abstract_arg('html configuration options'),
- abstract_arg('url configuration options'),
- abstract_arg('markdown configuration options'),
- abstract_arg('office configuration options'),
- service('sensiolabs_gotenberg.asset.base_dir_formatter'),
- service('twig')->nullOnInvalid(),
- ])
- ->public()
- ->alias(GotenbergInterface::class, 'sensiolabs_gotenberg');
-
  $services->set('sensiolabs_gotenberg.client', GotenbergClient::class)
  ->args([
  abstract_arg('base_uri to gotenberg API'),
  service(HttpClientInterface::class),
  ])
- ->public()
  ->alias(GotenbergClientInterface::class, 'sensiolabs_gotenberg.client');
 
  $services->set('sensiolabs_gotenberg.asset.base_dir_formatter', AssetBaseDirFormatter::class)
@@ -49,4 +40,50 @@
  $services->set('sensiolabs_gotenberg.twig.asset_extension', GotenbergAssetExtension::class)
  ->tag('twig.extension')
  ;
+
+ $services->set('.sensiolabs_gotenberg.builder.html', HtmlPdfBuilder::class)
+ ->share(false)
+ ->args([
+ service('sensiolabs_gotenberg.client'),
+ service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+ service('twig')->nullOnInvalid(),
+ ])
+ ->tag('sensiolabs_gotenberg.builder')
+ ;
+
+ $services->set('.sensiolabs_gotenberg.builder.url', UrlPdfBuilder::class)
+ ->share(false)
+ ->args([
+ service('sensiolabs_gotenberg.client'),
+ service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+ service('twig')->nullOnInvalid(),
+ ])
+ ->tag('sensiolabs_gotenberg.builder')
+ ;
+
+ $services->set('.sensiolabs_gotenberg.builder.markdown', MarkdownPdfBuilder::class)
+ ->share(false)
+ ->args([
+ service('sensiolabs_gotenberg.client'),
+ service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+ service('twig')->nullOnInvalid(),
+ ])
+ ->tag('sensiolabs_gotenberg.builder')
+ ;
+
+ $services->set('.sensiolabs_gotenberg.builder.office', LibreOfficePdfBuilder::class)
+ ->share(false)
+ ->args([
+ service('sensiolabs_gotenberg.client'),
+ service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+ ])
+ ->tag('sensiolabs_gotenberg.builder')
+ ;
+
+ $services->set('sensiolabs_gotenberg', Gotenberg::class)
+ ->args([
+ tagged_locator('sensiolabs_gotenberg.builder'),
+ ])
+ ->alias(GotenbergInterface::class, 'sensiolabs_gotenberg')
+ ;
 };

phpstan.neon

@@ -1,5 +1,11 @@
 parameters:
  level: 8
  paths:
+ - 'config'
  - 'src'
  - 'tests'
+ ignoreErrors:
+ -
+ message: "#^Method Sensiolabs\\\\GotenbergBundle\\\\Tests\\\\Kernel\\:\\:configureContainer\\(\\) is unused\\.$#"
+ count: 1
+ path: tests/Kernel.php

phpunit.xml

@@ -9,6 +9,10 @@
  beStrictAboutOutputDuringTests="true"
  failOnRisky="true"
  failOnWarning="true">
+ <php>
+ <env name="KERNEL_CLASS" value="Sensiolabs\GotenbergBundle\Tests\Kernel"/>
+ </php>
+
  <testsuites>
  <testsuite name="default">
  <directory>tests</directory>

src/Builder/AbstractChromiumPdfBuilder.php

@@ -194,6 +194,7 @@ public function nativePageRanges(string $range): static
  }
 
  /**
+ * @param string $template #Template
  * @param array<string, mixed> $context
  *
  * @throws PdfPartRenderingException if the template could not be rendered
@@ -204,6 +205,7 @@ public function header(string $template, array $context = []): static
  }
 
  /**
+ * @param string $template #Template
  * @param array<string, mixed> $context
  *
  * @throws PdfPartRenderingException if the template could not be rendered
@@ -439,6 +441,7 @@ protected function withPdfPartFile(PdfPart $pdfPart, string $path): static
  }
 
  /**
+ * @param string $template #Template
  * @param array<string, mixed> $context
  *
  * @throws PdfPartRenderingException if the template could not be rendered

src/Builder/AbstractPdfBuilder.php

@@ -4,9 +4,9 @@
 
 use Sensiolabs\GotenbergBundle\Client\GotenbergClientInterface;
 use Sensiolabs\GotenbergBundle\Client\PdfResponse;
-use Sensiolabs\GotenbergBundle\Exception\MissingRequiredFieldException;
 use Sensiolabs\GotenbergBundle\Formatter\AssetBaseDirFormatter;
 use Symfony\Component\HttpFoundation\File\File;
+use Symfony\Component\HttpFoundation\HeaderUtils;
 
 abstract class AbstractPdfBuilder implements PdfBuilderInterface
 {
@@ -15,6 +15,10 @@ abstract class AbstractPdfBuilder implements PdfBuilderInterface
  */
  protected array $formFields = [];
 
+ private string|null $fileName = null;
+
+ private string $headerDisposition = HeaderUtils::DISPOSITION_INLINE;
+
  public function __construct(
  protected readonly GotenbergClientInterface $gotenbergClient,
  protected readonly AssetBaseDirFormatter $asset,
@@ -24,9 +28,7 @@ public function __construct(
  /**
  * Compiles the form values into a multipart form data array to send to the HTTP client.
  *
- * @return array<int, array<string, string>>
- *
- * @throws MissingRequiredFieldException
+ * @return list<array<string, string>>
  */
  abstract public function getMultipartFormData(): array;
 
@@ -40,13 +42,37 @@ abstract protected function getEndpoint(): string;
  */
  abstract public function setConfigurations(array $configurations): self;
 
+ /**
+ * @param HeaderUtils::DISPOSITION_* $headerDisposition
+ */
+ public function fileName(string $fileName, string $headerDisposition = HeaderUtils::DISPOSITION_INLINE): static
+ {
+ $this->fileName = $fileName;
+ $this->headerDisposition = $headerDisposition;
+
+ return $this;
+ }
+
  public function generate(): PdfResponse
  {
- return $this->gotenbergClient->call($this->getEndpoint(), $this->getMultipartFormData());
+ $pdfResponse = $this->gotenbergClient->call($this->getEndpoint(), $this->getMultipartFormData());
+
+ if (null !== $this->fileName) {
+ $disposition = HeaderUtils::makeDisposition(
+ $this->headerDisposition,
+ $this->fileName
+ );
+
+ $pdfResponse
+ ->headers->set('Content-Disposition', $disposition)
+ ;
+ }
+
+ return $pdfResponse;
  }
 
  /**
- * @param string[] $validExtensions
+ * @param non-empty-list<string> $validExtensions
  */
  protected function assertFileExtension(string $path, array $validExtensions): void
  {

src/Builder/HtmlPdfBuilder.php

@@ -11,6 +11,7 @@ final class HtmlPdfBuilder extends AbstractChromiumPdfBuilder
  private const ENDPOINT = '/forms/chromium/convert/html';
 
  /**
+ * @param string $template #Template
  * @param array<string, mixed> $context
  *
  * @throws PdfPartRenderingException if the template could not be rendered

src/Builder/MarkdownPdfBuilder.php

@@ -15,6 +15,7 @@ final class MarkdownPdfBuilder extends AbstractChromiumPdfBuilder
  /**
  * The HTML file that wraps the markdown content, rendered from a Twig template.
  *
+ * @param string $template #Template
  * @param array<string, mixed> $context
  *
  * @throws PdfPartRenderingException if the template could not be rendered

src/Client/PdfResponse.php

@@ -2,9 +2,7 @@
 
 namespace Sensiolabs\GotenbergBundle\Client;
 
-use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Exception\HttpException;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
 class PdfResponse extends Response
@@ -13,17 +11,4 @@ public function __construct(public ResponseInterface $response)
  {
  parent::__construct($response->getContent(), $response->getStatusCode(), $response->getHeaders());
  }
-
- public function saveTo(string $filename): string
- {
- $file = new Filesystem();
-
- try {
- $file->dumpFile($filename, $this->response->getContent());
- } catch (\Exception $exception) {
- throw new HttpException(500, $exception->getMessage());
- }
-
- return $filename;
- }
 }

src/DependencyInjection/Configuration.php

@@ -21,18 +21,10 @@ public function getConfigTreeBuilder(): TreeBuilder
  ->scalarNode('base_uri')
  ->info('Host of your local Gotenberg API')
  ->defaultValue('http://localhost:3000')
- ->cannotBeEmpty()
- ->validate()
- ->ifTrue(static function ($option): bool {
- return preg_match('/^(http|https):\/\//', $option) !== 1;
- })
- ->thenInvalid('Invalid API Gotenberg host.')
- ->end()
  ->end()
  ->scalarNode('base_directory')
  ->info('Base directory will be used for assets, files, markdown')
  ->defaultValue('%kernel.project_dir%')
- ->cannotBeEmpty()
  ->end()
  ->arrayNode('default_options')
  ->addDefaultsIfNotSet()

src/DependencyInjection/SensiolabsGotenbergExtension.php

@@ -2,6 +2,7 @@
 
 namespace Sensiolabs\GotenbergBundle\DependencyInjection;
 
+use Sensiolabs\GotenbergBundle\Builder\PdfBuilderInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
@@ -19,23 +20,35 @@ public function load(array $configs, ContainerBuilder $container): void
  /** @var array{base_uri: string, base_directory: string, default_options: array{html: array<string, mixed>, url: array<string, mixed>, markdown: array<string, mixed>, office: array<string, mixed>}} $config */
  $config = $this->processConfiguration($configuration, $configs);
 
+ $container->registerForAutoconfiguration(PdfBuilderInterface::class)
+ ->addTag('sensiolabs_gotenberg.builder')
+ ;
+
  $definition = $container->getDefinition('sensiolabs_gotenberg.client');
  $definition->replaceArgument(0, $config['base_uri']);
 
- $definition = $container->getDefinition('sensiolabs_gotenberg');
- $definition->replaceArgument(1, $this->cleanUserOptions($config['default_options']['html']));
- $definition->replaceArgument(2, $this->cleanUserOptions($config['default_options']['url']));
- $definition->replaceArgument(3, $this->cleanUserOptions($config['default_options']['markdown']));
- $definition->replaceArgument(4, $this->cleanUserOptions($config['default_options']['office']));
+ $definition = $container->getDefinition('.sensiolabs_gotenberg.builder.html');
+ $definition->addMethodCall('setConfigurations', [$this->cleanUserOptions($config['default_options']['html'])]);
+
+ $definition = $container->getDefinition('.sensiolabs_gotenberg.builder.url');
+ $definition->addMethodCall('setConfigurations', [$this->cleanUserOptions($config['default_options']['url'])]);
+
+ $definition = $container->getDefinition('.sensiolabs_gotenberg.builder.markdown');
+ $definition->addMethodCall('setConfigurations', [$this->cleanUserOptions($config['default_options']['markdown'])]);
+
+ $definition = $container->getDefinition('.sensiolabs_gotenberg.builder.office');
+ $definition->addMethodCall('setConfigurations', [$this->cleanUserOptions($config['default_options']['office'])]);
 
  $definition = $container->getDefinition('sensiolabs_gotenberg.asset.base_dir_formatter');
  $definition->replaceArgument(2, $config['base_directory']);
  }
 
  /**
- * @param array<string, mixed> $userConfigurations
+ * @template T of array<string, mixed>
+ *
+ * @param T $userConfigurations
  *
- * @return array<string, mixed>
+ * @return array<key-of<T>, value-of<T>>
  */
  private function cleanUserOptions(array $userConfigurations): array
  {