Setono / SyliusStockMovementPlugin

src/Writer/ReportWriter.php

<?php

declare(strict_types=1);

namespace Setono\SyliusStockMovementPlugin\Writer;

use InvalidArgumentException;
use League\Flysystem\FilesystemInterface;
use RuntimeException;
use Safe\Exceptions\FilesystemException;
use Safe\Exceptions\OutcontrolException;
use Safe\Exceptions\StringsException;
use function Safe\fclose;
use function Safe\fopen;
use function Safe\fwrite;
use function Safe\ob_end_clean;
use function Safe\sprintf;
use function Safe\unlink;
use Setono\SyliusStockMovementPlugin\Exception\BlockNotPresentException;
use Setono\SyliusStockMovementPlugin\Model\ReportConfigurationInterface;
use Setono\SyliusStockMovementPlugin\Model\ReportInterface;
use Setono\SyliusStockMovementPlugin\Resolver\ReportPathResolverInterface;
use Throwable;
use Twig\Environment;
use Twig\Error\LoaderError;
use Twig\Error\RuntimeError;
use Twig\Error\SyntaxError;
use Twig\TemplateWrapper;

class ReportWriter implements ReportWriterInterface
{
    /** @var Environment */
    private $twig;

    /** @var FilesystemInterface */
    private $filesystem;

    /** @var ReportPathResolverInterface */
    private $reportPathResolver;

    public function __construct(Environment $twig, FilesystemInterface $filesystem, ReportPathResolverInterface $reportPathResolver)
    {
        $this->filesystem = $filesystem;
        $this->twig = $twig;
        $this->reportPathResolver = $reportPathResolver;
    }

    /**
     * @throws FilesystemException
     * @throws OutcontrolException
     * @throws StringsException
     * @throws Throwable
     * @throws LoaderError
     * @throws RuntimeError
     * @throws SyntaxError
     */
    public function write(ReportInterface $report): string
    {
        $key = $this->reportPathResolver->resolve($report);
        if ($this->filesystem->has($key)) {
            return $key;
        }

        $reportConfiguration = $this->getReportConfiguration($report);

        $template = $this->twig->load($reportConfiguration->getTemplate());

        $this->validateTemplate($template, (string) $reportConfiguration->getTemplate());

        $path = $this->generateTempPath();

        $fp = fopen($path, 'w+b'); // needs to be w+ since we use the same stream later to read from

        ob_start(static function ($buffer) use ($fp) {
            fwrite($fp, $buffer);
        }, 1024);

        $template->displayBlock('body', [
            'stockMovements' => $report->getStockMovements(),
        ]);

        ob_end_clean();

        $res = $this->filesystem->writeStream($key, $fp);

        try {
            // tries to close the file pointer although it may already have been closed by flysystem
            fclose($fp);

            unlink($path);
        } catch (FilesystemException $e) {

Consider adding a comment why this CATCH block is empty.

        }

        if (false === $res) {
            throw new RuntimeException(sprintf('An error occurred when trying to write the report %s', $key));
        }

        return $key;
    }

    /**
     * @throws StringsException
     */
    private function getReportConfiguration(ReportInterface $report): ReportConfigurationInterface
    {
        $reportConfiguration = $report->getReportConfiguration();
        if (null === $reportConfiguration) {
            throw new InvalidArgumentException(sprintf('No report configuration associated with report %s', $report->getId()));
        }

        return $reportConfiguration;
    }

    /**
     * @throws StringsException
     */
    private function validateTemplate(TemplateWrapper $template, string $templateName): void
    {
        $definedBlocks = $template->getBlockNames();
        foreach (['extension', 'body'] as $block) {
            if (!in_array($block, $definedBlocks, true)) {
                throw new BlockNotPresentException($block, $definedBlocks, $templateName);
            }
        }
    }

    private function generateTempPath(): string
    {
        do {
            $path = sys_get_temp_dir() . '/' . uniqid('stock-movement-report-', true);
        } while (file_exists($path));

        return $path;
    }
}