From 22d8f5a0bcc99d326d91125e52af67516cb524e5 Mon Sep 17 00:00:00 2001
From: Bruce Weirdan <weirdan@gmail.com>
Date: Sun, 16 Aug 2020 23:26:54 +0300
Subject: [PATCH] Fixed duplicate shortcodes (#3996)

Also added an utility to help assign new shortcodes and a test to
prevent duplicate shortcodes.
---
 bin/max_used_shortcode.php             | 16 +++++++++++++++
 src/Psalm/Issue/InvalidExtendClass.php |  2 +-
 tests/DocumentationTest.php            | 28 ++++++++++++++++++++++++++
 3 files changed, 45 insertions(+), 1 deletion(-)
 create mode 100644 bin/max_used_shortcode.php

diff --git a/bin/max_used_shortcode.php b/bin/max_used_shortcode.php
new file mode 100644
index 000000000..cc15b7d72
--- /dev/null
+++ b/bin/max_used_shortcode.php
@@ -0,0 +1,16 @@
+<?php
+
+require_once(dirname(__DIR__) . '/vendor/autoload.php');
+
+$issue_types = \Psalm\Config\IssueHandler::getAllIssueTypes();
+
+$shortcodes = array_map(
+    function ($issue_type): int {
+        $issue_class = '\\Psalm\\Issue\\' . $issue_type;
+        /** @var int */
+        return $issue_class::SHORTCODE;
+    },
+    $issue_types
+);
+
+echo 'Max used shortcode: ' . max($shortcodes) . PHP_EOL;
diff --git a/src/Psalm/Issue/InvalidExtendClass.php b/src/Psalm/Issue/InvalidExtendClass.php
index 9009b363e..023f5d732 100644
--- a/src/Psalm/Issue/InvalidExtendClass.php
+++ b/src/Psalm/Issue/InvalidExtendClass.php
@@ -4,5 +4,5 @@ namespace Psalm\Issue;
 class InvalidExtendClass extends ClassIssue
 {
     const ERROR_LEVEL = -1;
-    const SHORTCODE = 7;    // to be updated
+    const SHORTCODE = 232;
 }
diff --git a/tests/DocumentationTest.php b/tests/DocumentationTest.php
index 1f647aa87..e878c2561 100644
--- a/tests/DocumentationTest.php
+++ b/tests/DocumentationTest.php
@@ -25,6 +25,8 @@ use function array_shift;
 use DOMDocument;
 use DOMXPath;
 use DOMAttr;
+use function array_filter;
+use function var_export;
 
 class DocumentationTest extends TestCase
 {
@@ -265,4 +267,30 @@ class DocumentationTest extends TestCase
 
         return $invalid_code_data;
     }
+
+    public function testShortcodesAreUnique(): void
+    {
+        $all_issues = \Psalm\Config\IssueHandler::getAllIssueTypes();
+        $all_shortcodes = [];
+
+        foreach ($all_issues as $issue_type) {
+            $issue_class = '\\Psalm\\Issue\\' . $issue_type;
+            /** @var int $shortcode */
+            $shortcode = $issue_class::SHORTCODE;
+            $all_shortcodes[$shortcode][] = $issue_type;
+        }
+
+        $duplicate_shortcodes = array_filter(
+            $all_shortcodes,
+            function ($issues) {
+                return count($issues) > 1;
+            }
+        );
+
+        $this->assertEquals(
+            [],
+            $duplicate_shortcodes,
+            "Duplicate shortcodes found: \n" . var_export($duplicate_shortcodes, true)
+        );
+    }
 }