From 941a7300e157f62b251900f5ce912521254c8c6e Mon Sep 17 00:00:00 2001
From: Sebastian Fellner <hey@sebastianfellner.de>
Date: Sat, 15 Jun 2024 12:56:50 +0200
Subject: [PATCH 1/3] added the possibility to filter the wordcloud as an user
 requested it

---
 components/charts/WordCloud.vue | 91 ++++++++++++++++++++++++++++-----
 functions/transformChatData.js  |  5 +-
 utils/translations.js           |  2 +
 3 files changed, 82 insertions(+), 16 deletions(-)

diff --git a/components/charts/WordCloud.vue b/components/charts/WordCloud.vue
index 933f517a..2cc6d1c3 100644
--- a/components/charts/WordCloud.vue
+++ b/components/charts/WordCloud.vue
@@ -1,5 +1,24 @@
 <template>
-  <div ref="chartdiv"></div>
+  <div>
+    <div ref="chartdiv"></div>
+    <v-row data-html2canvas-ignore
+           remove-height-in-html2-canvas>
+      <v-text-field
+        v-model="additionalExcludes"
+        :label='$t("excludeWords")'
+        :hint='$t("excludeWordsHint")'
+        clearable
+        @keydown.enter.prevent="updateGraph"
+        @click:clear="updateGraph"
+      ></v-text-field>
+      <v-btn class="btn-color"
+             dark
+             @click="updateGraph">
+        <v-icon>mdi-arrow-right</v-icon>
+      </v-btn>
+    </v-row>
+
+  </div>
 </template>
 
 <script>
@@ -13,39 +32,35 @@ export default {
     chartdata: new Chat(),
     minWordLength: {
       type: Number,
-      default: 3,
+      default: 3
     },
     minFontSize: {
       type: Number,
-      default: 6,
+      default: 6
     },
     randomness: {
       type: Number,
-      default: 0.1,
+      default: 0.1
     },
     stopWords: {
       type: Array,
-      default: () => stopwords,
-    },
+      default: () => stopwords
+    }
   },
   data() {
     return {
       chart: null,
       series: null,
+      additionalExcludes: ""
     };
   },
-  methods: {
-    updateGraph() {
-      this.chartdata.getAllWords().then((x) => (this.series.data = x));
-    },
-  },
   watch: {
     chartdata: {
       handler() {
         this.updateGraph();
       },
-      deep: true,
-    },
+      deep: true
+    }
   },
   mounted() {
     let { am4core, am4themes_animated, am4plugins_wordCloud } = this.$am4core();
@@ -65,9 +80,57 @@ export default {
     this.series.accuracy = 5;
     this.updateGraph();
   },
-  beforeDestroy: function () {
+  beforeDestroy: function() {
     this.chart.dispose();
   },
+  methods: {
+    async updateGraph() {
+      // this is a list of [{word: String, freq: String}, ...]
+      const allWords = await this.chartdata.getAllWords();
+
+      if(!this.additionalExcludes){
+        this.series.data = allWords
+        return
+      }
+
+      const regex = this.buildRegex()
+
+      //remove everything from all words, that matches
+      this.series.data = allWords.filter(item => !regex.test(item.word));
+    },
+    buildRegex() {
+      // Regex to detect if a string contains regex metacharacters
+      const regexMetaChars = /[.*+?^${}()|[\]\\]/;
+
+      function isValidRegex(pattern) {
+        if( regexMetaChars.test(pattern)) {
+          try {
+            new RegExp(pattern);
+            return true;
+          } catch (e) {
+            return false;
+          }
+        }
+        else{
+          return false
+        }
+      }
+
+      // Function to escape regex special characters if the string is intended to be a literal
+      function escapeRegexCharacters(string) {
+        // Escape only if the string does not contain regex metacharacters
+        // otherwise it needs to be an exact match
+        return isValidRegex(string) ? string : `^${string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}$`;
+      }
+
+      // Filter out empty strings and escape regex special characters if needed
+      const regexParts = this.additionalExcludes.split(" ").filter(s => s !== '').map(escapeRegexCharacters);
+
+      // Join the parts to create a single regex pattern
+      const regexPattern = regexParts.join('|');
+      return new RegExp(regexPattern);
+    }
+  }
 };
 </script>
 
diff --git a/functions/transformChatData.js b/functions/transformChatData.js
index 7689724f..ceccb6d2 100644
--- a/functions/transformChatData.js
+++ b/functions/transformChatData.js
@@ -452,7 +452,8 @@ export class Chat {
       });
   }
 
-  getAllWords() {
-    return this._allWords.then((x) => x.slice(0, this._maxWordsWordCloud));
+  async getAllWords() {
+    let x = await this._allWords;
+    return x.slice(0, this._maxWordsWordCloud);
   }
 }
diff --git a/utils/translations.js b/utils/translations.js
index d0659f0d..ac59e387 100644
--- a/utils/translations.js
+++ b/utils/translations.js
@@ -194,6 +194,8 @@ export const messages = {
     downloadResults: "Download Results",
     lookingFor: "Looking for",
     pdfDownload: "PDF download",
+    excludeWords: "Exclude Words",
+    excludeWordsHint: "Should be space separated list. RegEx is also supported."
   },
   de: {
     titleGoogle: "WhatsAnalyze - The WhatsApp Chat Analyzer",

From 7c8e1823435e7827b277789a467b6a44670cceca Mon Sep 17 00:00:00 2001
From: "sebastian.fellner.extern@joyn.de" <sebastian.fellner.extern@seven.one>
Date: Tue, 25 Jun 2024 09:54:35 +0200
Subject: [PATCH 2/3] run prettier again locallay, and add it to pipeline

---
 .github/workflows/husky.yml     |  2 +-
 .prettierignore                 |  1 +
 components/FeedbackBtn.vue      | 14 ++++----
 components/charts/WordCloud.vue | 62 ++++++++++++++++-----------------
 utils/translations.js           |  3 +-
 5 files changed, 42 insertions(+), 40 deletions(-)

diff --git a/.github/workflows/husky.yml b/.github/workflows/husky.yml
index d291a53f..587254ca 100644
--- a/.github/workflows/husky.yml
+++ b/.github/workflows/husky.yml
@@ -28,5 +28,5 @@ jobs:
           node-version: 16
       - name: install dependencies
         run: pnpm install
-      - run: pnpm exec prettier --write .
+      - run: pnpm exec prettier -c .
       - run: pnpm exec eslint .
diff --git a/.prettierignore b/.prettierignore
index 5e32d445..3baac928 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -3,3 +3,4 @@
 node_modules
 coverage
 pnpm-lock.yaml
+nuxt.config.js
diff --git a/components/FeedbackBtn.vue b/components/FeedbackBtn.vue
index f0fb2a04..5ea03682 100644
--- a/components/FeedbackBtn.vue
+++ b/components/FeedbackBtn.vue
@@ -116,14 +116,14 @@ export default {
       email: "",
       emailRules: [
         (v) => !!v || this.$t("email"),
-        (v) => /.+@.+\..+/.test(v) || this.$t("email")
+        (v) => /.+@.+\..+/.test(v) || this.$t("email"),
       ],
       text: "",
       starValue: 0,
       starRules: [(v) => !!v || this.$t("rating")],
       select: null,
       dialog: false,
-      message: null
+      message: null,
     };
   },
 
@@ -144,10 +144,10 @@ export default {
               text: this.text,
               rating: this.starValue,
               locale: this.$i18n.locale,
-              email: this.email
+              email: this.email,
             },
-            created: this.$fireModule.firestore.FieldValue.serverTimestamp()
-          }
+            created: this.$fireModule.firestore.FieldValue.serverTimestamp(),
+          },
         };
         this.$fire.firestore
           .collection("mail")
@@ -157,8 +157,8 @@ export default {
             this.message = this.$t("messageReceived");
           });
       }
-    }
-  }
+    },
+  },
 };
 </script>
 <style scoped>
diff --git a/components/charts/WordCloud.vue b/components/charts/WordCloud.vue
index 2cc6d1c3..fab488c9 100644
--- a/components/charts/WordCloud.vue
+++ b/components/charts/WordCloud.vue
@@ -1,23 +1,19 @@
 <template>
   <div>
     <div ref="chartdiv"></div>
-    <v-row data-html2canvas-ignore
-           remove-height-in-html2-canvas>
+    <v-row data-html2canvas-ignore remove-height-in-html2-canvas>
       <v-text-field
         v-model="additionalExcludes"
-        :label='$t("excludeWords")'
-        :hint='$t("excludeWordsHint")'
+        :label="$t('excludeWords')"
+        :hint="$t('excludeWordsHint')"
         clearable
         @keydown.enter.prevent="updateGraph"
         @click:clear="updateGraph"
       ></v-text-field>
-      <v-btn class="btn-color"
-             dark
-             @click="updateGraph">
+      <v-btn class="btn-color" dark @click="updateGraph">
         <v-icon>mdi-arrow-right</v-icon>
       </v-btn>
     </v-row>
-
   </div>
 </template>
 
@@ -32,26 +28,26 @@ export default {
     chartdata: new Chat(),
     minWordLength: {
       type: Number,
-      default: 3
+      default: 3,
     },
     minFontSize: {
       type: Number,
-      default: 6
+      default: 6,
     },
     randomness: {
       type: Number,
-      default: 0.1
+      default: 0.1,
     },
     stopWords: {
       type: Array,
-      default: () => stopwords
-    }
+      default: () => stopwords,
+    },
   },
   data() {
     return {
       chart: null,
       series: null,
-      additionalExcludes: ""
+      additionalExcludes: "",
     };
   },
   watch: {
@@ -59,8 +55,8 @@ export default {
       handler() {
         this.updateGraph();
       },
-      deep: true
-    }
+      deep: true,
+    },
   },
   mounted() {
     let { am4core, am4themes_animated, am4plugins_wordCloud } = this.$am4core();
@@ -80,7 +76,7 @@ export default {
     this.series.accuracy = 5;
     this.updateGraph();
   },
-  beforeDestroy: function() {
+  beforeDestroy: function () {
     this.chart.dispose();
   },
   methods: {
@@ -88,31 +84,30 @@ export default {
       // this is a list of [{word: String, freq: String}, ...]
       const allWords = await this.chartdata.getAllWords();
 
-      if(!this.additionalExcludes){
-        this.series.data = allWords
-        return
+      if (!this.additionalExcludes) {
+        this.series.data = allWords;
+        return;
       }
 
-      const regex = this.buildRegex()
+      const regex = this.buildRegex();
 
       //remove everything from all words, that matches
-      this.series.data = allWords.filter(item => !regex.test(item.word));
+      this.series.data = allWords.filter((item) => !regex.test(item.word));
     },
     buildRegex() {
       // Regex to detect if a string contains regex metacharacters
       const regexMetaChars = /[.*+?^${}()|[\]\\]/;
 
       function isValidRegex(pattern) {
-        if( regexMetaChars.test(pattern)) {
+        if (regexMetaChars.test(pattern)) {
           try {
             new RegExp(pattern);
             return true;
           } catch (e) {
             return false;
           }
-        }
-        else{
-          return false
+        } else {
+          return false;
         }
       }
 
@@ -120,17 +115,22 @@ export default {
       function escapeRegexCharacters(string) {
         // Escape only if the string does not contain regex metacharacters
         // otherwise it needs to be an exact match
-        return isValidRegex(string) ? string : `^${string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}$`;
+        return isValidRegex(string)
+          ? string
+          : `^${string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}$`;
       }
 
       // Filter out empty strings and escape regex special characters if needed
-      const regexParts = this.additionalExcludes.split(" ").filter(s => s !== '').map(escapeRegexCharacters);
+      const regexParts = this.additionalExcludes
+        .split(" ")
+        .filter((s) => s !== "")
+        .map(escapeRegexCharacters);
 
       // Join the parts to create a single regex pattern
-      const regexPattern = regexParts.join('|');
+      const regexPattern = regexParts.join("|");
       return new RegExp(regexPattern);
-    }
-  }
+    },
+  },
 };
 </script>
 
diff --git a/utils/translations.js b/utils/translations.js
index ac59e387..d75d188c 100644
--- a/utils/translations.js
+++ b/utils/translations.js
@@ -195,7 +195,8 @@ export const messages = {
     lookingFor: "Looking for",
     pdfDownload: "PDF download",
     excludeWords: "Exclude Words",
-    excludeWordsHint: "Should be space separated list. RegEx is also supported."
+    excludeWordsHint:
+      "Should be space separated list. RegEx is also supported.",
   },
   de: {
     titleGoogle: "WhatsAnalyze - The WhatsApp Chat Analyzer",

From e441d887da17f1bf041ace4acdf46a9125e94192 Mon Sep 17 00:00:00 2001
From: "sebastian.fellner.extern@joyn.de" <sebastian.fellner.extern@seven.one>
Date: Tue, 25 Jun 2024 09:56:41 +0200
Subject: [PATCH 3/3] add comment to function

---
 components/charts/WordCloud.vue | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/components/charts/WordCloud.vue b/components/charts/WordCloud.vue
index fab488c9..0de3a0af 100644
--- a/components/charts/WordCloud.vue
+++ b/components/charts/WordCloud.vue
@@ -80,6 +80,10 @@ export default {
     this.chart.dispose();
   },
   methods: {
+    /** Updates graph by, getting data, and processing it
+     *
+     * filters out words from user input as well
+     * **/
     async updateGraph() {
       // this is a list of [{word: String, freq: String}, ...]
       const allWords = await this.chartdata.getAllWords();