Extract FileManager for better credit memo file management

Author: Zales0123

.travis.yml

@@ -2,7 +2,7 @@ language: php
 
 dist: trusty
 
-sudo: false
+sudo: required
 
 php:
     - 7.2
@@ -70,6 +70,8 @@ script:
     - composer validate --strict
     - bin/phpstan.phar analyse -c phpstan.neon -l max src/
 
+    - bin/phpspec run
+    - bin/phpunit
     - bin/behat -vvv --no-interaction || bin/behat -vvv --no-interaction --rerun
 
 after_failure:

phpunit.xml.dist

@@ -6,7 +6,7 @@
          colors="true"
          bootstrap="vendor/autoload.php">
     <testsuites>
-        <testsuite name="AcmeSyliusExamplePlugin Test Suite">
+        <testsuite name="SyliusRefundPlugin Test Suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>

spec/Sender/CreditMemoEmailSenderSpec.php

@@ -7,19 +7,19 @@
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Mailer\Sender\SenderInterface;
 use Sylius\RefundPlugin\Entity\CreditMemoInterface;
+use Sylius\RefundPlugin\File\FileManagerInterface;
 use Sylius\RefundPlugin\Generator\CreditMemoPdfFileGeneratorInterface;
 use Sylius\RefundPlugin\Model\CreditMemoPdf;
 use Sylius\RefundPlugin\Sender\CreditMemoEmailSenderInterface;
-use Symfony\Component\Filesystem\Filesystem;
 
 final class CreditMemoEmailSenderSpec extends ObjectBehavior
 {
     function let(
         CreditMemoPdfFileGeneratorInterface $creditMemoPdfFileGenerator,
-        Filesystem $filesystem,
-        SenderInterface $sender
+        SenderInterface $sender,
+        FileManagerInterface $fileManager
     ): void {
-        $this->beConstructedWith($creditMemoPdfFileGenerator, $filesystem, $sender, '/web/media/temp/credit-memos/');
+        $this->beConstructedWith($creditMemoPdfFileGenerator, $sender, $fileManager);
     }
 
     function it_implements_credit_memo_email_sender_interface()
@@ -29,26 +29,25 @@ function it_implements_credit_memo_email_sender_interface()
 
     function it_sends_email_with_credit_memo_to_customer(
         CreditMemoPdfFileGeneratorInterface $creditMemoPdfFileGenerator,
-        Filesystem $filesystem,
         SenderInterface $sender,
+        FileManagerInterface $fileManager,
         CreditMemoInterface $creditMemo
     ): void {
         $creditMemo->getId()->willReturn(1);
 
         $creditMemoPdf = new CreditMemoPdf('credit-memo.pdf', 'I am credit memo number #2018/10/000444');
         $creditMemoPdfFileGenerator->generate(1)->willReturn($creditMemoPdf);
 
-        $filesystem
-            ->dumpFile('/web/media/temp/credit-memos/credit-memo.pdf', 'I am credit memo number #2018/10/000444')
-            ->shouldBeCalled()
-        ;
+        $fileManager->createWithContent('credit-memo.pdf', 'I am credit memo number #2018/10/000444')->shouldBeCalled();
+
+        $fileManager->getBaseDirectory()->willReturn('/base/directory/');
 
         $sender
-            ->send('units_refunded', ['[email protected]'], ['creditMemo' => $creditMemo], ['/web/media/temp/credit-memos/credit-memo.pdf'])
+            ->send('units_refunded', ['[email protected]'], ['creditMemo' => $creditMemo], ['/base/directory/credit-memo.pdf'])
             ->shouldBeCalled()
         ;
 
-        $filesystem->remove('/web/media/temp/credit-memos/credit-memo.pdf')->shouldBeCalled();
+        $fileManager->remove('credit-memo.pdf')->shouldBeCalled();
 
         $this->send($creditMemo, '[email protected]');
     }

src/File/FileManager.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\RefundPlugin\File;
+
+final class FileManager implements FileManagerInterface
+{
+    /** @var string */
+    private $baseDirectory;
+
+    public function __construct(string $baseDirectory = '')
+    {
+        $this->baseDirectory = $baseDirectory;
+    }
+
+    public function createWithContent(string $fileName, string $content): void
+    {
+        file_put_contents($this->baseDirectory . $fileName, $content);
+    }
+
+    public function remove(string $fileName): void
+    {
+        unlink($this->baseDirectory . $fileName);
+    }
+
+    public function getBaseDirectory(): string
+    {
+        return $this->baseDirectory;
+    }
+}

src/File/FileManagerInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\RefundPlugin\File;
+
+interface FileManagerInterface
+{
+    public function createWithContent(string $fileName, string $content): void;
+
+    public function remove(string $fileName): void;
+
+    public function getBaseDirectory(): string;
+}

src/Listener/CreditMemoGeneratedEventListener.php

@@ -48,6 +48,8 @@ public function __invoke(CreditMemoGenerated $event): void
             throw OrderNotFound::withOrderNumber($event->orderNumber());
         }
 
+        assert($order->getCustomer() !== null);
+
         $this->creditMemoEmailSender->send($creditMemo, $order->getCustomer()->getEmail());
     }
 }

src/Resources/config/services.xml

@@ -74,8 +74,11 @@
 
         <service id="Sylius\RefundPlugin\Sender\CreditMemoEmailSender">
             <argument type="service" id="Sylius\RefundPlugin\Generator\CreditMemoPdfFileGenerator" />
-            <argument type="service" id="filesystem" />
             <argument type="service" id="sylius.email_sender" />
+            <argument type="service" id="Sylius\RefundPlugin\File\FileManager" />
+        </service>
+
+        <service id="Sylius\RefundPlugin\File\FileManager">
             <argument type="string">%kernel.project_dir%/web/media/credit-memos/</argument>
         </service>
     </services>

src/Sender/CreditMemoEmailSender.php

@@ -6,44 +6,46 @@
 
 use Sylius\Component\Mailer\Sender\SenderInterface;
 use Sylius\RefundPlugin\Entity\CreditMemoInterface;
+use Sylius\RefundPlugin\File\FileManagerInterface;
 use Sylius\RefundPlugin\Generator\CreditMemoPdfFileGeneratorInterface;
-use Symfony\Component\Filesystem\Filesystem;
 
 final class CreditMemoEmailSender implements CreditMemoEmailSenderInterface
 {
+    private const UNITS_REFUNDED = 'units_refunded';
+
     /** @var CreditMemoPdfFileGeneratorInterface */
     private $creditMemoPdfFileGenerator;
 
-    /** @var Filesystem */
-    private $filesystem;
-
     /** @var SenderInterface */
     private $sender;
 
-    /** @var string */
-    private $temporaryCreditMemoPath;
+    /** @var FileManagerInterface */
+    private $fileManager;
 
     public function __construct(
         CreditMemoPdfFileGeneratorInterface $creditMemoPdfFileGenerator,
-        Filesystem $filesystem,
         SenderInterface $sender,
-        string $temporaryCreditMemoPath
+        FileManagerInterface $fileManager
     ) {
         $this->creditMemoPdfFileGenerator = $creditMemoPdfFileGenerator;
-        $this->filesystem = $filesystem;
         $this->sender = $sender;
-        $this->temporaryCreditMemoPath = $temporaryCreditMemoPath;
+        $this->fileManager = $fileManager;
     }
 
     public function send(CreditMemoInterface $creditMemo, string $recipient): void
     {
         $creditMemoPdfFile = $this->creditMemoPdfFileGenerator->generate($creditMemo->getId());
 
-        $filePath = $this->temporaryCreditMemoPath.$creditMemoPdfFile->filename();
-        $this->filesystem->dumpFile($filePath, $creditMemoPdfFile->content() );
+        $filePath = $creditMemoPdfFile->filename();
+        $this->fileManager->createWithContent($filePath, $creditMemoPdfFile->content());
 
-        $this->sender->send('units_refunded', [$recipient], ['creditMemo' => $creditMemo], [$filePath]);
+        $this->sender->send(
+            self::UNITS_REFUNDED,
+            [$recipient],
+            ['creditMemo' => $creditMemo],
+            [$this->fileManager->getBaseDirectory() . $filePath]
+        );
 
-        $this->filesystem->remove($filePath);
+        $this->fileManager->remove($filePath);
     }
 }

tests/Application/.gitignore

@@ -7,3 +7,4 @@
 !/web/app.php
 !/web/app_dev.php
 !/web/app_test.php
+!/web/media/credit-memos/

tests/Application/app/config/config_test.yml

@@ -4,3 +4,7 @@ imports:
 doctrine:
     dbal:
         path: "%kernel.project_dir%/var/db_test.sql"
+
+knp_snappy:
+    pdf:
+        binary: "%kernel.project_dir%/app/etc/wkhtmltopdf"