Stabilized render of REST HTML (#1896)

* Stabilized render of REST HTML
* raml2html: Upgrade to PHP 7.4 (#1898)

Author: Steveb-p

tools/raml2html/composer.json

@@ -15,7 +15,7 @@
         }
     ],
     "require": {
-        "php": "^7.2",
+        "php": "^7.4",
         "symfony/console": "^4.2",
         "raml-org/raml-php-parser": "dev-master",
         "twig/twig": "^2.0",

tools/raml2html/src/Application.php

@@ -9,9 +9,14 @@
 use EzSystems\Raml2Html\Command\LintTypesCommand;
 use EzSystems\Raml2Html\Generator\Generator;
 use EzSystems\Raml2Html\RAML\ParserFactory;
+use EzSystems\Raml2Html\Twig\Extension\HashExtension;
 use EzSystems\Raml2Html\Twig\Extension\RenderExtension;
 use Symfony\Component\Console\Application as BaseApplication;
 use Twig as Twig;
+use Twig\Extra\Markdown\DefaultMarkdown;
+use Twig\Extra\Markdown\MarkdownExtension;
+use Twig\Extra\Markdown\MarkdownRuntime;
+use Twig\RuntimeLoader\RuntimeLoaderInterface;
 
 final class Application extends BaseApplication
 {
@@ -49,6 +54,17 @@ public function getTwig(): Twig\Environment
 
             $this->twig = new Twig\Environment($loader, $options);
             $this->twig->addExtension(new RenderExtension());
+            $this->twig->addExtension(new MarkdownExtension());
+            $this->twig->addRuntimeLoader(new class implements RuntimeLoaderInterface {
+                public function load($class): ?MarkdownRuntime {
+                    if (MarkdownRuntime::class === $class) {
+                        return new MarkdownRuntime(new DefaultMarkdown());
+                    }
+
+                    return null;
+                }
+            });
+            $this->twig->addExtension(new HashExtension());
         }
 
         return $this->twig;

tools/raml2html/src/Twig/Extension/HashExtension.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace EzSystems\Raml2Html\Twig\Extension;
+
+use RuntimeException;
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFunction;
+
+class HashExtension extends AbstractExtension
+{
+    private $hashes = [];
+
+    public function getFunctions(): array
+    {
+        return [
+            new TwigFunction('hash', function (string ...$values): string {
+                $hash = hash('sha256', json_encode($values));
+
+                if (isset($this->hashes[$hash])) {
+                    throw new RuntimeException('Hash is generated twice for ' . json_encode($values));
+                }
+
+                $this->hashes[$hash] = $hash;
+
+                return $hash;
+            }),
+        ];
+    }
+}

tools/raml2html/src/Twig/Extension/RenderExtension.php

@@ -68,8 +68,7 @@ public function getExamplesTabs(array $responseBodies): array
 
         /** @var \Raml\Body $body */
         foreach ($responseBodies as $body) {
-
-            if (!empty($body->getExample())) {
+            if (!empty($body->getExamples()) && !empty($body->getExample())) {
                 $tabs[] = $this->getSchemaFormat($body->getMediaType());
             }
         }
@@ -85,7 +84,7 @@ public function getExamplesBody(array $responseBodies): array
         foreach ($responseBodies as $body) {
             $schemaFormat = $this->getSchemaFormat($body->getMediaType());
 
-            if (!empty($body->getExample())) {
+            if (!empty($body->getExamples()) && !empty($body->getExample())) {
                 $examples[$schemaFormat][] = $body->getExample();
             }
         }

tools/raml2html/themes/default/example-modal.html.twig

@@ -52,11 +52,12 @@
                                 {% for body in example %}
                                     {% set margin = example|length > 1 and loop.index ==  1 ? 'mb-4' : '' %}
                                     {% set border = loop.index > 1 ? 'border-top' : '' %}
+                                    {% set outer_loop = loop %}
                                     {% for body in example %}
                                         {% set margin = example|length > 1 and loop.index ==  1 ? 'mb-4' : '' %}
                                         {% set border = loop.index > 1 ? 'border-top' : '' %}
                                         <div class="position-relative {{ margin }} {{ border }}">
-                                            {% set clipboardId = type ~ '_' ~ uuid() %}
+                                            {% set clipboardId = hash(type, outer_loop.index, loop.index, tabId) %}
                                             <p class="mb-0 icon icon--copy-clipboard">
                                                 <i class="material-icons-outlined clipboard"
                                                    data-toggle="tooltip"

tools/raml2html/themes/default/example.html.twig

@@ -10,7 +10,7 @@
                         {% set margin = example|length > 1 and loop.index ==  1 ? 'mb-4' : '' %}
                         {% set border = loop.index > 1 ? 'border-top' : '' %}
                         <div class="position-relative {{ margin }} {{ border }}">
-                            {% set clipboardId = type ~ '_' ~ uuid() %}
+                            {% set clipboardId = hash(type, tabId, loop.index) %}
                             <p class="mb-0 icon icon--copy-clipboard">
                                 <i class="material-icons-outlined clipboard"
                                    data-toggle="tooltip"