Merge pull request sdinteractive#41 from subbu1993/feature/EmailTemplateCheck

Add ability to check for email templates

Author: mpchadwick

Console/UpgradeHelperCommand.php

@@ -41,6 +41,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $result = [];
         $result['preferences'] = [];
         $result['overrides'] = [];
+        $result['email_template'] = [];
 
         $output->writeln('Populating file override index...');
         $this->fileIndex->populateIndex();

Model/Checker/EmailTemplate.php

@@ -0,0 +1,110 @@
+<?php
+
+namespace SomethingDigital\UpgradeHelper\Model\Checker;
+
+use SomethingDigital\UpgradeHelper\Model\FileIndex;
+use Magento\Email\Model\TemplateFactory as CoreEmailTemplateFactory;
+use Magento\Email\Model\Template\Config;
+use Magento\Framework\App\State as AppState;
+
+class EmailTemplate
+{
+    private $fileIndex;
+
+    private $emailTemplateFactory;
+
+    private $config;
+
+    private $templateMappings = [];
+
+    private $appState;
+
+    public function __construct(
+        CoreEmailTemplateFactory $emailTemplateFactory,
+        Config $config,
+        AppState $appState
+    ) {
+        $this->appState = $appState;
+        $this->emailTemplateFactory = $emailTemplateFactory;
+        $this->config = $config;
+    }
+
+    public function mapEmailTemplates()
+    {
+        $this->appState->setAreaCode(\Magento\Framework\App\Area::AREA_FRONTEND);
+        $emailTemplateCollection = $this->emailTemplateFactory->create()->getCollection();
+
+        foreach ($emailTemplateCollection as $template) {
+            $templateOriginalCode = $template->getOrigTemplateCode();
+            if (!$templateOriginalCode) {
+                continue;
+            }
+            $templatePath = $this->config->getTemplateFileName($templateOriginalCode);
+            $templateCode = $template->getTemplateCode();
+            $this->templateMappings[$templateOriginalCode] = ['templatePath' => $templatePath, 'templateCode' => $templateCode];
+        }
+    }
+
+    public function check($pathInfo)
+    {
+        if (empty($this->templateMappings)) {
+            $this->mapEmailTemplates();
+        }
+        $path = $pathInfo['fullpath'];
+
+        if (!$this->shouldCheck($pathInfo)) {
+            return [];
+        }
+
+        $output = [];
+        $customized = $this->hasBeenCustomized($path);
+
+        if (!empty($customized)) {
+            $output = [
+                'patched' => $path,
+                'customized' => $customized
+            ];
+        }
+
+        return $output;
+    }
+
+    private function shouldCheck($pathInfo)
+    {
+        if (!isset($pathInfo['extension'])) {
+            return false;
+        }
+
+        if (!in_array($pathInfo['extension'], FileIndex::EMAIL_EXTENSIONS)) {
+            return false;
+        }
+
+        $ignored = ['dev/tests', 'setup/view/magento'];
+        foreach ($ignored as $needle) {
+            if (strpos($pathInfo['fullpath'], $needle) !== false) {
+                return false;
+            }
+        }
+
+        $mustMatch = ['/email/'];
+        foreach ($mustMatch as $needle) {
+            if (strpos($pathInfo['fullpath'], $needle) === false) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    private function hasBeenCustomized($path)
+    {
+        foreach ($this->templateMappings as $templateOriginalCode => $templateInfo) {
+            $templatePath = $templateInfo['templatePath'];
+            $templateCode = $templateInfo['templateCode'];
+            if(strpos($templatePath, $path) !== false) {
+                return [$templateCode];
+            }
+        }
+        return false;
+    }
+}

Model/FileIndex.php

@@ -15,6 +15,10 @@ class FileIndex
             'less'
     ];
 
+    const EMAIL_EXTENSIONS = [
+            'html',
+    ];
+
     const WHITELISTED_BASENAMES = [
         'requirejs-config.js'
     ];

Model/Runner.php

@@ -4,6 +4,7 @@
 
 use SomethingDigital\UpgradeHelper\Model\Checker\Preferences as PreferenceChecker;
 use SomethingDigital\UpgradeHelper\Model\Checker\Overrides as OverrideChecker;
+use SomethingDigital\UpgradeHelper\Model\Checker\EmailTemplate as EmailTemplateChecker;
 
 class Runner
 {
@@ -13,20 +14,25 @@ class Runner
 
     private $overrideChecker;
 
+    private $emailTemplateChecker;
+
     private $checkers;
 
     public function __construct(
         LineProcessor $lineProcessor,
         PreferenceChecker $preferenceChecker,
-        OverrideChecker $overrideChecker
+        OverrideChecker $overrideChecker,
+        EmailTemplateChecker $emailTemplateChecker
     ) {
         $this->lineProcessor = $lineProcessor;
         $this->preferenceChecker = $preferenceChecker;
         $this->overrideChecker = $overrideChecker;
+        $this->emailTemplateChecker = $emailTemplateChecker;
 
         $this->checkers = [
             'preferences' => $this->preferenceChecker,
-            'overrides' => $this->overrideChecker
+            'overrides' => $this->overrideChecker,
+            'email_template' => $this->emailTemplateChecker,
         ];
     }
 

Test/Unit/Model/RunnerTest.php

@@ -9,6 +9,7 @@
 use SomethingDigital\UpgradeHelper\Model\LineProcessor;
 use SomethingDigital\UpgradeHelper\Model\Checker\Preferences as PreferenceChecker;
 use SomethingDigital\UpgradeHelper\Model\Checker\Overrides as OverrideChecker;
+use SomethingDigital\UpgradeHelper\Model\Checker\EmailTemplate as EmailTemplateChecker;
 use SomethingDigital\UpgradeHelper\Model\FileIndex;
 
 class RunnerTest extends TestCase
@@ -48,15 +49,24 @@ protected function setUp(): void
             ]
         );
 
+        $this->emailTemplateChecker = $this->createMock(EmailTemplateChecker::class);
+
+        $mockOutput = [
+            'patched' => 'vendor/magento/module-sales/view/frontend/email/order_new.html',
+            'customized' => ['New Pickup Order']
+        ];
+
+        $this->emailTemplateChecker->expects($this->any())->method('check')->willReturn($mockOutput);
+
         $this->runner = $objectManager->getObject(
             Runner::class,
             [
                 'lineProcessor' => $this->lineProcessor,
                 'overrideChecker' => $this->overrideChecker,
                 'preferenceChecker' => $this->preferenceChecker,
+                'emailTemplateChecker' => $this->emailTemplateChecker
             ]
         );
-
     }
 
     public function testRun()
@@ -69,17 +79,20 @@ public function testRun()
             'diff -r Magento-EE-2.3.1/vendor/magento/module-bundle/view/frontend/templates/js/components.phtml Magento-EE-2.3.3/vendor/magento/module-bundle/view/frontend/templates/js/components.phtml',
             'diff -r Magento-EE-2.3.1/vendor/magento/module-checkout/view/frontend/web/template/billing-address/details.html Magento-EE-2.3.3/vendor/magento/module-checkout/view/frontend/web/template/billing-address/details.html',
             'diff -r Magento-EE-2.3.1/vendor/magento/module-customer/view/frontend/templates/form/forgotpassword.phtml Magento-EE-2.3.3/vendor/magento/module-customer/view/frontend/templates/form/forgotpassword.phtml',
-            'diff -r Magento-EE-2.3.1/vendor/magento/module-catalog-rule/Controller/Adminhtml/Promo/Catalog/Save.php Magento-EE-2.3.3/vendor/magento/module-catalog-rule/Controller/Adminhtml/Promo/Catalog/Save.php'
+            'diff -r Magento-EE-2.3.1/vendor/magento/module-catalog-rule/Controller/Adminhtml/Promo/Catalog/Save.php Magento-EE-2.3.3/vendor/magento/module-catalog-rule/Controller/Adminhtml/Promo/Catalog/Save.php',
+            'diff -r Magento-EE-2.3.1/vendor/magento/module-sales/view/frontend/email/order_new.html Magento-EE-2.3.3/vendor/magento/module-sales/view/frontend/email/order_new.html'
         ];
 
         $result = [];
         $result['preferences'] = [];
         $result['overrides'] = [];
+        $result['email_template'] = [];
         foreach ($diff as $line) {
             // Extract will populate: $type, $path, $items
             extract($this->runner->run($line));
             $result[$type][$path] = $items;
         }
+
         // Theme (app/design) .js override
         $this->assertTrue(
             $this->arrays_are_similar(
@@ -139,6 +152,13 @@ public function testRun()
             )
         );
 
+        $this->assertTrue(
+            $this->arrays_are_similar(
+                $result['email_template']['vendor/magento/module-sales/view/frontend/email/order_new.html'],
+                ['New Pickup Order']
+            )
+        );
+
         // TODO
         // - Line in diff that doesn't match override OR preference
     }