PB-370: Introduce upgrade mechanism for Page Builder content

cspruiell · cspruiell · commit 125bff7ef869 · 2020-02-04T15:32:09.000-06:00
- move utility function to Document class
 - replace usage of ObjectManager with Factory
diff --git a/app/code/Magento/PageBuilder/Model/Dom/Adapter/DocumentInterface.php b/app/code/Magento/PageBuilder/Model/Dom/Adapter/DocumentInterface.php
@@ -181,4 +181,11 @@ public function getContents(): string;
      *     value is found, or null if the key is not found.
      */
     public function getMetadata($key = null);
+
+    /**
+     * Strips the HTML doctype, body, etc. tags that are automatically wrapped around the content.
+     *
+     * @return string
+     */
+    public function stripHtmlWrapperTags(): string;
 }
diff --git a/app/code/Magento/PageBuilder/Model/Dom/Document.php b/app/code/Magento/PageBuilder/Model/Dom/Document.php
@@ -204,4 +204,13 @@ public function getMetadata($key = null)
     {
         return $this->document->getMetadata($key);
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function stripHtmlWrapperTags(): string
+    {
+        preg_match('/<body>(.*)<\/body>/', $this->getContents(), $matches);
+        return isset($matches[1]) ? $matches[1] : '';
+    }
 }
diff --git a/app/code/Magento/PageBuilder/Setup/Converters/FixFullWidthRowPadding.php b/app/code/Magento/PageBuilder/Setup/Converters/FixFullWidthRowPadding.php
@@ -8,32 +8,38 @@
 
 namespace Magento\PageBuilder\Setup\Converters;
 
-use Magento\Framework\App\ObjectManager;
 use Magento\Framework\DB\DataConverter\DataConverterInterface;
 use Magento\PageBuilder\Model\Dom\Adapter\ElementInterface;
-use Magento\PageBuilder\Model\Dom\Adapter\HtmlDocumentInterface;
 use Magento\PageBuilder\Model\Dom\HtmlDocument;
+use Magento\PageBuilder\Model\Dom\HtmlDocumentFactory;
 
 /**
  * Converter to move padding in full width columns from the main row element to the inner element
  */
 class FixFullWidthRowPadding implements DataConverterInterface
 {
+    /**
+     * @var HtmlDocumentFactory
+     */
+    private $htmlDocumentFactory;
+
+    /**
+     * @param HtmlDocumentFactory $htmlDocumentFactory
+     */
+    public function __construct(HtmlDocumentFactory $htmlDocumentFactory)
+    {
+        $this->htmlDocumentFactory = $htmlDocumentFactory;
+    }
+
     /**
      * @inheritDoc
      */
     public function convert($value)
     {
         /** @var HtmlDocument $document */
-        $document = ObjectManager::getInstance()->create(
-            HtmlDocumentInterface::class,
-            [ 'document' => $value ]
-        );
-        // remove padding from main row element
+        $document = $this->htmlDocumentFactory->create([ 'document' => $value ]);
         $fullWidthRows = $document->querySelectorAll("div[data-content-type='row'][data-appearance='full-width']");
-        /**
-         * @var ElementInterface $row
-         */
+        /** @var ElementInterface $row */
         foreach ($fullWidthRows as $row) {
             $style = $row->getAttribute("style");
             preg_match("/padding:(.*?);/", $style, $results);
@@ -44,18 +50,6 @@ public function convert($value)
             $innerDiv = $row->querySelector(".row-full-width-inner");
             $innerDiv->addStyle("padding", $padding);
         }
-        return $this->stripHtmlWrapperTags($document->getContents());
-    }
-
-    /**
-     * Strips the HTML doctype, body, etc. tags that are automatically wrapped around the content.
-     *
-     * @param string $content
-     * @return string
-     */
-    private function stripHtmlWrapperTags(string $content): string
-    {
-        preg_match('/<body>(.*)<\/body>/', $content, $matches);
-        return isset($matches[1]) ? $matches[1] : '';
+        return $document->stripHtmlWrapperTags();
     }
 }
diff --git a/app/code/Magento/PageBuilder/Setup/Patch/Data/UpdateContent.php b/app/code/Magento/PageBuilder/Setup/Patch/Data/UpdateContent.php
@@ -11,7 +11,7 @@
 use Magento\PageBuilder\Setup\UpgradeContentHelper;
 
 /**
- * Patch is mechanism that allows us to do atomic upgrade data changes
+ * Patch upgrade mechanism allows us to do atomic data changes
  */
 class UpdateContent implements DataPatchInterface
 {
diff --git a/app/code/Magento/PageBuilder/etc/di.xml b/app/code/Magento/PageBuilder/etc/di.xml
@@ -298,4 +298,9 @@
             </argument>
         </arguments>
     </type>
+    <virtualType name="pageBuilderHtmlDocumentFactory" type="Magento\PageBuilder\Model\Dom\HtmlDocumentFactory">
+        <arguments>
+            <argument name="instanceName" xsi:type="string">Magento\PageBuilder\Model\Dom\HtmlDocument</argument>
+        </arguments>
+    </virtualType>
 </config>

Original file line number	Diff line number	Diff line change
`@@ -204,4 +204,13 @@ public function getMetadata($key = null)`
`204`	`204`	`{`
`205`	`205`	`return $this->document->getMetadata($key);`
`206`	`206`	`}`
	`207`	`+`
	`208`	`+ /**`
	`209`	`+ * @inheritDoc`
	`210`	`+ */`
	`211`	`+ public function stripHtmlWrapperTags(): string`
	`212`	`+ {`
	`213`	`+ preg_match('/<body>(.*)<\/body>/', $this->getContents(), $matches);`
	`214`	`+ return isset($matches[1]) ? $matches[1] : '';`
	`215`	`+ }`
`207`	`216`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`use Magento\PageBuilder\Setup\UpgradeContentHelper;`
`12`	`12`
`13`	`13`	`/**`
`14`		`- * Patch is mechanism that allows us to do atomic upgrade data changes`
	`14`	`+ * Patch upgrade mechanism allows us to do atomic data changes`
`15`	`15`	`*/`
`16`	`16`	`class UpdateContent implements DataPatchInterface`
`17`	`17`	`{`