From 7eeb5d064d22f67cbf365ee6547c30a0e3d5de18 Mon Sep 17 00:00:00 2001
From: Brad Kotsopoulos <brad.kotsopoulos@gmail.com>
Date: Sun, 24 Feb 2019 13:02:03 -0500
Subject: [PATCH] Add config to preserve IDs based on prefix matching (#1060)

add parameter to preserve IDs based on prefix matching
---
 plugins/cleanupIDs.js          | 22 +++++++++++++++++++---
 test/plugins/cleanupIDs.12.svg | 19 +++++++++++++++++++
 test/plugins/cleanupIDs.13.svg | 22 ++++++++++++++++++++++
 test/plugins/cleanupIDs.14.svg | 34 ++++++++++++++++++++++++++++++++++
 test/plugins/cleanupIDs.15.svg | 19 +++++++++++++++++++
 5 files changed, 113 insertions(+), 3 deletions(-)
 create mode 100644 test/plugins/cleanupIDs.12.svg
 create mode 100644 test/plugins/cleanupIDs.13.svg
 create mode 100644 test/plugins/cleanupIDs.14.svg
 create mode 100644 test/plugins/cleanupIDs.15.svg

diff --git a/plugins/cleanupIDs.js b/plugins/cleanupIDs.js
index 2b61b93f..f1fdc9f3 100644
--- a/plugins/cleanupIDs.js
+++ b/plugins/cleanupIDs.js
@@ -11,6 +11,7 @@ exports.params = {
     minify: true,
     prefix: '',
     preserve: [],
+    preservePrefixes: [],
     force: false
 };
 
@@ -41,6 +42,7 @@ exports.fn = function(data, params) {
         referencesIDs = new Map(),
         hasStyleOrScript = false,
         preserveIDs = new Set(Array.isArray(params.preserve) ? params.preserve : params.preserve ? [params.preserve] : []),
+        preserveIDPrefixes = new Set(Array.isArray(params.preservePrefixes) ? params.preservePrefixes : (params.preservePrefixes ? [params.preservePrefixes] : [])),
         idValuePrefix = '#',
         idValuePostfix = '.';
 
@@ -54,7 +56,7 @@ exports.fn = function(data, params) {
         for (var i = 0; i < items.content.length && !hasStyleOrScript; i++) {
             var item = items.content[i];
 
-            // quit if <style> of <script> presents ('force' param prevents quitting)
+            // quit if <style> or <script> present ('force' param prevents quitting)
             if (!params.force) {
                 if (item.isElem(styleOrScript)) {
                     hasStyleOrScript = true;
@@ -124,7 +126,7 @@ exports.fn = function(data, params) {
 
         if (IDs.has(key)) {
             // replace referenced IDs with the minified ones
-            if (params.minify && !preserveIDs.has(key)) {
+            if (params.minify && !preserveIDs.has(key) && !idMatchesPrefix(preserveIDPrefixes, key)) {
                 currentIDstring = getIDstring(currentID = generateID(currentID), params);
                 IDs.get(key).attr('id').value = currentIDstring;
 
@@ -141,7 +143,7 @@ exports.fn = function(data, params) {
     // remove non-referenced IDs attributes from elements
     if (params.remove) {
         for(var keyElem of IDs) {
-            if (!preserveIDs.has(keyElem[0])) {
+            if (!preserveIDs.has(keyElem[0]) && !idMatchesPrefix(preserveIDPrefixes, keyElem[0])) {
                 keyElem[1].removeAttr('id');
             }
         }
@@ -149,6 +151,20 @@ exports.fn = function(data, params) {
     return data;
 };
 
+/**
+ * Check if an ID starts with any one of a list of strings.
+ *
+ * @param {Array} of prefix strings
+ * @param {String} current ID
+ * @return {Boolean} if currentID starts with one of the strings in prefixArray
+ */
+function idMatchesPrefix(prefixArray, currentID) {
+    if (!currentID) return false;
+
+    for (var prefix of prefixArray) if (currentID.startsWith(prefix)) return true;
+    return false;
+}
+
 /**
  * Generate unique minimal ID.
  *
diff --git a/test/plugins/cleanupIDs.12.svg b/test/plugins/cleanupIDs.12.svg
new file mode 100644
index 00000000..1cb08f3f
--- /dev/null
+++ b/test/plugins/cleanupIDs.12.svg
@@ -0,0 +1,19 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 230 120">
+    <circle id="garbage1" fill="red" cx="60" cy="60" r="50"/>
+    <rect id="garbage2" fill="blue" x="120" y="10" width="100" height="100"/>
+    <view id="xyzgarbage1" viewBox="0 0 120 120"/>
+    <view id="xyzgarbage2" viewBox="110 0 120 120"/>
+</svg>
+
+@@@
+
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 230 120">
+    <circle fill="red" cx="60" cy="60" r="50"/>
+    <rect fill="blue" x="120" y="10" width="100" height="100"/>
+    <view id="xyzgarbage1" viewBox="0 0 120 120"/>
+    <view id="xyzgarbage2" viewBox="110 0 120 120"/>
+</svg>
+
+@@@
+
+{"preservePrefixes": ["xyz"]}
diff --git a/test/plugins/cleanupIDs.13.svg b/test/plugins/cleanupIDs.13.svg
new file mode 100644
index 00000000..43496779
--- /dev/null
+++ b/test/plugins/cleanupIDs.13.svg
@@ -0,0 +1,22 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 120 120">
+    <style>
+        svg .hidden { display: none; }
+        svg .hidden:target { display: inline; }
+    </style>
+    <circle id="pre1_circle" class="hidden" fill="red" cx="60" cy="60" r="50"/>
+    <rect id="pre2_rect" class="hidden" fill="blue" x="10" y="10" width="100" height="100"/>
+</svg>
+
+@@@
+
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 120 120">
+    <style>
+        svg .hidden { display: none; } svg .hidden:target { display: inline; }
+    </style>
+    <circle id="pre1_circle" class="hidden" fill="red" cx="60" cy="60" r="50"/>
+    <rect id="pre2_rect" class="hidden" fill="blue" x="10" y="10" width="100" height="100"/>
+</svg>
+
+@@@
+
+{"force": true, "preservePrefixes": ["pre1_", "pre2_"]}
diff --git a/test/plugins/cleanupIDs.14.svg b/test/plugins/cleanupIDs.14.svg
new file mode 100644
index 00000000..ae8d80c9
--- /dev/null
+++ b/test/plugins/cleanupIDs.14.svg
@@ -0,0 +1,34 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 120 120">
+    <style>
+        svg .hidden { display: none; }
+        svg .hidden:target { display: inline; }
+    </style>
+    <defs>
+        <circle id="circle" fill="red" cx="60" cy="60" r="50"/>
+        <rect id="rect" fill="blue" x="10" y="10" width="100" height="100"/>
+    </defs>
+    <g id="pre1_figure" class="hidden">
+        <use xlink:href="#circle"/>
+        <use href="#rect"/>
+    </g>
+</svg>
+
+@@@
+
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 120 120">
+    <style>
+        svg .hidden { display: none; } svg .hidden:target { display: inline; }
+    </style>
+    <defs>
+        <circle id="a" fill="red" cx="60" cy="60" r="50"/>
+        <rect id="b" fill="blue" x="10" y="10" width="100" height="100"/>
+    </defs>
+    <g id="pre1_figure" class="hidden">
+        <use xlink:href="#a"/>
+        <use href="#b"/>
+    </g>
+</svg>
+
+@@@
+
+{"force": true, "preservePrefixes": "pre1_"}
diff --git a/test/plugins/cleanupIDs.15.svg b/test/plugins/cleanupIDs.15.svg
new file mode 100644
index 00000000..ec0534fc
--- /dev/null
+++ b/test/plugins/cleanupIDs.15.svg
@@ -0,0 +1,19 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 230 120">
+    <circle id="circle" fill="red" cx="60" cy="60" r="50"/>
+    <rect id="rect" fill="blue" x="120" y="10" width="100" height="100"/>
+    <view id="circle-suffix" viewBox="0 0 120 120"/>
+    <view id="rect-suffix" viewBox="110 0 120 120"/>
+</svg>
+
+@@@
+
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 230 120">
+    <circle id="circle" fill="red" cx="60" cy="60" r="50"/>
+    <rect id="rect" fill="blue" x="120" y="10" width="100" height="100"/>
+    <view viewBox="0 0 120 120"/>
+    <view id="rect-suffix" viewBox="110 0 120 120"/>
+</svg>
+
+@@@
+
+{"preserve": ["circle"], "preservePrefixes": ["suffix", "rect"]}