From 68ccfabb319139fc4ffaf7fe89a81b286109ffa8 Mon Sep 17 00:00:00 2001
From: Kamil <lumnn@mailfence.com>
Date: Wed, 25 May 2022 23:29:45 +0200
Subject: [PATCH] Add graphviz support

---
 Plugin/View/LayoutHints.php                  |   4 +
 README.md                                    |   5 +
 view/base/web/js/debug/MageLayoutDebugger.js | 104 +++++++++++++++++++
 3 files changed, 113 insertions(+)

diff --git a/Plugin/View/LayoutHints.php b/Plugin/View/LayoutHints.php
index c808ce7..5cd7153 100644
--- a/Plugin/View/LayoutHints.php
+++ b/Plugin/View/LayoutHints.php
@@ -71,6 +71,10 @@ private function getRootScript(): string
                     if (!window.layout) {
                         window.layout = layoutHints.inspect.bind(layoutHints)
                     }
+
+                    if (!window.lh) {
+                        window.lh = layoutHints
+                    }
                 });
             </script>
         HTML;
diff --git a/README.md b/README.md
index b20d82d..9270d5d 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,7 @@ Features:
 - Uses dev-tools like **element picker** to select elements 🔫
 - Prints **browseable structure** and internal informations in console 👀
 - Adds a button to open edit page for CMS Blocks 🖊️
+- Generates Graphviz visualization for Layout
 
 ## Installation
 
@@ -36,6 +37,10 @@ Open your Magento page with an extra GET parameter `?ath=1`. For example:
 
 Use `layout()` function to investigate any HTML element. To inspect currently selected element in inspector use `layout($0)`
 
+**Graphviz Layout**
+
+Run `lh.debuggers.mageLayout.graph()` in developer tools console. Graph will be copied into clipboard. You can visualise it online here - http://magjac.com/graphviz-visual-editor/ or using this command `echo 'GRAPH_OUTPUT' | dot -Tsvg > output.svg`
+
 ## Credits
 
 https://github.com/ho-nl/magento2-Ho_Templatehints
diff --git a/view/base/web/js/debug/MageLayoutDebugger.js b/view/base/web/js/debug/MageLayoutDebugger.js
index 5bc5983..6ef49cf 100644
--- a/view/base/web/js/debug/MageLayoutDebugger.js
+++ b/view/base/web/js/debug/MageLayoutDebugger.js
@@ -237,5 +237,109 @@ define(['../highlights'], function (highlights) {
 
             console.groupEnd()
         }
+
+        graph (el) {
+            var inspectable = this.getInspectable(el || document.body)
+
+            var graph = this.graphLayout(inspectable.layout)
+
+            var fullGraph = `
+digraph {
+    rankdir="LR"
+    splines=polyline
+
+    graph [autosize=false]
+
+    graph [fontname = "Courier"]
+    node [fontname = "Courier"]
+    edge [fontname = "Courier"]
+
+    ${graph}
+}
+`
+
+            navigator.clipboard.writeText(fullGraph)
+                .then(() => console.log("Written to clipboard"))
+
+            return `http://magjac.com/graphviz-visual-editor/?dot=${encodeURIComponent(fullGraph)}`
+        }
+
+        graphLayout (layout, parentName) {
+            var name = layout.handles ? "root" : layout.name
+
+            var attributes = {
+                shape: "box",
+                // label: `${name}`,
+                label: `<tr><td align="left" width="100%"><b>${name}</b></td></tr>`,
+                style: [],
+            }
+
+            if (layout.block) {
+                var className = layout.block.class.replace(/\\/g, "\\\\")
+                // attributes.label += `\\l${className}`
+                attributes.label += `<tr><td align="left" width="100%">${className}</td></tr>`
+                attributes.style.push('rounded')
+
+                if (layout.block.template) {
+                    var template = layout.block.template.replace(/^([a-zA-Z\/\-\_]+(\/app\/code|\/vendor\/))/, "$2")
+
+                    // attributes.label += `\\l${template}`
+                    attributes.label += `<tr><td align="left" width="100%">${template}</td></tr>`
+                }
+
+                if (layout.blockId) {
+                    attributes.style.push('filled')
+                    attributes.fillcolor = "gray90"
+                    attributes.color = "gray40"
+                    attributes.fontcolor = "gray40"
+                }
+            } else {
+                attributes.style.push('filled')
+                attributes.fillcolor = "lightyellow"
+            }
+
+            attributes.label = `<table border="0">${attributes.label}</table>`
+            // attributes.label += '\\l'
+
+            if (layout.alias) {
+                attributes.color = "blue"
+            }
+
+            var graph = `"${name}" [${this.objectToDotAttributes(attributes, { htmlLabel: true })}];` + "\n"
+
+            if (parentName) {
+                graph += `"${parentName}" -> "${name}";` + "\n"
+            }
+
+            if (layout.children) {
+                for (let childName in layout.children) {
+                    graph += this.graphLayout(layout.children[childName], name)
+                }
+            }
+
+            return graph
+        }
+
+        objectToDotAttributes (object, { htmlLabel = false } = {}) {
+            var attributes = []
+
+            for (let key in object) {
+                let value = object[key]
+
+                if (Array.isArray(value)) {
+                    value = value.join(",")
+                }
+
+                if (key === 'label' && htmlLabel) {
+                    value = `<${value}>`
+                } else if (typeof value === 'string') {
+                    value = `"${value}"`
+                }
+
+                attributes.push(`${key}=${value}`)
+            }
+
+            return attributes.join(', ')
+        }
     }
 })