#558: Content Types Output Style Attribute Removal

bluemwhitew · bluemwhitew · commit 3dffe71d47f5 · 2020-09-09T15:25:19.000+01:00
- Refactoring Using DOMDocument
- Adding `generateDataAttribute` Method
- Adding `generateInternalStyles` Method
- Modifying Ordering of Expected vs. Actual in PageBuilderStripStylesTest
diff --git a/app/code/Magento/PageBuilder/Setup/Converters/PageBuilderStripStyles.php b/app/code/Magento/PageBuilder/Setup/Converters/PageBuilderStripStyles.php
@@ -8,47 +8,108 @@
 
 namespace Magento\PageBuilder\Setup\Converters;
 
+use DOMDocument;
+use DOMElement;
+use DOMException;
+use DOMNode;
+use DOMXPath;
+use Exception;
 use Magento\Framework\DB\DataConverter\DataConverterInterface;
-use Magento\PageBuilder\Model\Dom\Adapter\ElementInterface;
-use Magento\PageBuilder\Model\Dom\HtmlDocumentFactory;
 
 /**
  * ...
  */
 class PageBuilderStripStyles implements DataConverterInterface
 {
     /**
-     * @var HtmlDocumentFactory
+     * @var DOMDocument
      */
-    private $htmlDocumentFactory;
+    private $domDocument;
 
     /**
-     * @param HtmlDocumentFactory $htmlDocumentFactory
+     * @param DOMDocument $domDocument
      */
-    public function __construct(HtmlDocumentFactory $htmlDocumentFactory)
+    public function __construct(DOMDocument $domDocument)
     {
-        $this->htmlDocumentFactory = $htmlDocumentFactory;
+        $this->domDocument = $domDocument;
+    }
+
+    /**
+     * Generates `mageUtils.uniqueid()` Naming Convention
+     *
+     * @param int $length
+     * @param string $prefix
+     * @return string
+     */
+    private function generateDataAttribute(int $length = 7, string $prefix = 'style-'): string
+    {
+        return $prefix . substr(strtoupper(uniqid()), 0, $length); // @todo: Fix RNGesus...
+    }
+
+    /**
+     * Converts Inline Styles to Internal Styles
+     *
+     * @param array $styleMap
+     * @return string
+     */
+    private function generateInternalStyles(array $styleMap): string
+    {
+        $output = '';
+
+        foreach ($styleMap as $selector => $styles) {
+            $output .= '[data-pb-style="' . $selector . '"] { ';
+            $output .= $styles;
+            $output .= ' }';
+        }
+
+        return $output;
     }
 
     /**
      * @inheritDoc
      */
     public function convert($value)
     {
-        $document = $this->htmlDocumentFactory->create(['document' => $value]);
-        $queryPageBuilderElements = $document->querySelectorAll('[style]'); // @todo: Match Types
+        $document = new DOMDocument();
+        $document->loadHTML($value);
+        $xpath = new DOMXPath($document);
+
+        // Query for Inline Styles
+        $nodes = $xpath->query('//*[@style]');
 
-        /** @var ElementInterface $element */
-        foreach ($queryPageBuilderElements as $element) {
-            $style = $element->getAttribute('style');
+        $styleMap = array();
 
-            if ($style) {
-                // @todo: Convert to Inline
+        foreach ($nodes as $node) {
+            /* @var DOMElement $node */
+            $styleAttr = $node->getAttribute('style');
 
-                $element->removeAttribute('style');
+            if ($styleAttr) {
+                $generatedDataAttribute = $this->generateDataAttribute();
+                $node->setAttribute('data-pb-style', $this->generateDataAttribute());
+
+                // Add for Internal Style Generation
+                $styleMap[$generatedDataAttribute] = $styleAttr;
+
+                // Strip Inline Styles
+                $node->removeAttribute('style');
             }
         }
 
-        return $queryPageBuilderElements->count() > 0 ? $document->stripHtmlWrapperTags() : $value;
+        // Style Block Generation
+        $style = $document->createElement(
+            'style',
+            $this->generateInternalStyles($styleMap)
+        );
+        $style->setAttribute('type', 'text/css');
+        $xpath->query('//body')[0]->appendChild($style); // @todo: Refactor
+
+        // @todo: Refactor
+        preg_match(
+            '/<html><body>(.+)<\/body><\/html>$/si',
+            $document->saveHTML(),
+            $matches
+        );
+
+        return $matches && $nodes->count() > 0 ? $matches[1] : $value;
     }
 }
diff --git a/dev/tests/integration/testsuite/Magento/PageBuilder/Setup/Converters/PageBuilderStripStylesTest.php b/dev/tests/integration/testsuite/Magento/PageBuilder/Setup/Converters/PageBuilderStripStylesTest.php
@@ -33,7 +33,7 @@ public function testConversion(string $htmlString, string $expectedResult)
     {
         $converterPageBuilderStripStyles = $this->objectManager->create(PageBuilderStripStyles::class);
         $result = $converterPageBuilderStripStyles->convert($htmlString);
-        $this->assertEquals($result, $expectedResult);
+        $this->assertEquals($expectedResult, $result);
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public function testConversion(string $htmlString, string $expectedResult)`
`33`	`33`	`{`
`34`	`34`	`$converterPageBuilderStripStyles = $this->objectManager->create(PageBuilderStripStyles::class);`
`35`	`35`	`$result = $converterPageBuilderStripStyles->convert($htmlString);`
`36`		`- $this->assertEquals($result, $expectedResult);`
	`36`	`+ $this->assertEquals($expectedResult, $result);`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`/**`