Replace bad-words with obscenity (#21)

Fixes #12

Author: eltoder

package-lock.json

@@ -11,12 +11,12 @@
     "@material-ui/icons": "^4.11.2",
     "@react-spring/web": "^9.4.4",
     "@stripe/stripe-js": "^1.25.0",
-    "bad-words": "^3.0.4",
     "chart.js": "^3.7.1",
     "clone-deep": "^4.0.1",
     "clsx": "^1.1.1",
     "firebase": "^9.6.9",
     "moment": "^2.29.1",
+    "obscenity": "^0.4.0",
     "project-name-generator": "^2.1.9",
     "react": "^17.0.2",
     "react-chartjs-2": "^4.0.1",

package.json

@@ -15,7 +15,7 @@ import Scrollbox from "./Scrollbox";
 import ChatCards from "./ChatCards";
 import ElapsedTime from "./ElapsedTime";
 import firebase from "../firebase";
-import { filter } from "../util";
+import { badWords } from "../util";
 import autoscroll from "../utils/autoscroll";
 import useFirebaseQuery from "../hooks/useFirebaseQuery";
 import useMoment from "../hooks/useMoment";
@@ -97,7 +97,7 @@ function Chat({
   function handleSubmit(event) {
     event.preventDefault();
     if (input) {
-      if (filter.isProfane(input)) {
+      if (badWords.hasMatch(input)) {
         alert(
           "We detected that your message contains profane language. If you think this was a mistake, please let us know!"
         );

src/components/Chat.js

@@ -8,7 +8,7 @@ import DialogContent from "@material-ui/core/DialogContent";
 import DialogContentText from "@material-ui/core/DialogContentText";
 import DialogTitle from "@material-ui/core/DialogTitle";
 
-import { filter } from "../util";
+import { badWords } from "../util";
 import { UserContext } from "../context";
 
 function PromptDialog(props) {
@@ -22,7 +22,7 @@ function PromptDialog(props) {
   }
 
   function handleSubmit() {
-    if (filter.isProfane(value)) {
+    if (badWords.hasMatch(value)) {
       alert(
         "We detected that your input contains profane language. If you think this was a mistake, please let us know!"
       );

src/components/PromptDialog.js

@@ -1,6 +1,10 @@
 import animals from "./utils/animals.json";
 import moment from "moment";
-import Filter from "bad-words";
+import {
+  RegExpMatcher,
+  englishDataset,
+  englishRecommendedTransformers,
+} from "obscenity";
 import red from "@material-ui/core/colors/red";
 import pink from "@material-ui/core/colors/pink";
 import purple from "@material-ui/core/colors/purple";
@@ -17,18 +21,10 @@ import amber from "@material-ui/core/colors/amber";
 import orange from "@material-ui/core/colors/orange";
 import deepOrange from "@material-ui/core/colors/deepOrange";
 
-export const filter = new Filter();
-
-filter.addWords("cunting");
-
-// See: https://github.com/ekzhang/setwithfriends/issues/117
-filter.addWords("retard", "retarded");
-
-// See: https://github.com/ekzhang/setwithfriends/issues/49
-filter.removeWords("queer", "queers", "queerz", "qweers", "qweerz", "lesbian");
-
-// See: https://github.com/ekzhang/setwithfriends/issues/71
-filter.removeWords("wang");
+export const badWords = new RegExpMatcher({
+  ...englishDataset.build(),
+  ...englishRecommendedTransformers,
+});
 
 export const colors = {
   red,

src/util.js

@@ -3,7 +3,7 @@ import {
   checkSet,
   checkSetUltra,
   findSet,
-  filter,
+  badWords,
 } from "./util";
 
 it("computes conjugate cards", () => {
@@ -74,9 +74,14 @@ describe("findSet()", () => {
   });
 });
 
-describe("bad-words filter", () => {
-  it("does not trigger on 'wang'", () => {
-    expect(filter.isProfane("Rona Wang")).toBe(false);
-    expect(filter.isProfane("wang")).toBe(false);
+describe("bad words filter", () => {
+  it("sort of works", () => {
+    expect(badWords.hasMatch("Rona Wang")).toBe(false);
+    expect(badWords.hasMatch("queer")).toBe(false);
+    expect(badWords.hasMatch("lesbian")).toBe(false);
+    expect(badWords.hasMatch("gay")).toBe(false);
+    expect(badWords.hasMatch("fuck")).toBe(true);
+    expect(badWords.hasMatch("cunting")).toBe(true);
+    expect(badWords.hasMatch("retard")).toBe(true);
   });
 });