Merge pull request #170

Chesterking

src/pages/tools/string/censor/index.tsx

@@ -0,0 +1,158 @@
+import { Box } from '@mui/material';
+import { useState } from 'react';
+import ToolTextResult from '@components/result/ToolTextResult';
+import { GetGroupsType } from '@components/options/ToolOptions';
+import { censorText } from './service';
+import ToolTextInput from '@components/input/ToolTextInput';
+import { InitialValuesType } from './types';
+import ToolContent from '@components/ToolContent';
+import { CardExampleType } from '@components/examples/ToolExamples';
+import { ToolComponentProps } from '@tools/defineTool';
+import TextFieldWithDesc from '@components/options/TextFieldWithDesc';
+import SelectWithDesc from '@components/options/SelectWithDesc';
+import CheckboxWithDesc from '@components/options/CheckboxWithDesc';
+
+const initialValues: InitialValuesType = {
+  wordsToCensor: '',
+  censoredBySymbol: true,
+  censorSymbol: '█',
+  eachLetter: true,
+  censorWord: 'CENSORED'
+};
+
+const exampleCards: CardExampleType<InitialValuesType>[] = [
+  {
+    title: 'Censor a Word in a Quote',
+    description: `In this example, we hide the unpleasant word "idiot" from Jim Rohn's quote. We specify this word in the words-to-censor option and mask it with a neat smiling face character "☺".`,
+    sampleText:
+      'Motivation alone is not enough. If you have an idiot and you motivate him, now you have a motivated idiot. Jim Rohn',
+    sampleResult:
+      'Motivation alone is not enough. If you have an ☺ and you motivate him, now you have a motivated ☺. Jim Rohn',
+    sampleOptions: {
+      ...initialValues,
+      wordsToCensor: 'idiot',
+      censorSymbol: '☺',
+      eachLetter: false
+    }
+  },
+  {
+    title: 'Censor an Excerpt',
+    description: `In this example, we censor multiple words from an excerpt from the novel "The Guns of Avalon" by Roger Zelazny. To do this, we write out all unnecessary words in the multi-line text option and select the "Use a Symbol to Censor" censoring mode. We activate the "Mask Each Letter" option so that in place of each word exactly as many block characters "█" appeared as there are letters in that word.`,
+    sampleText:
+      '“In the mirrors of the many judgments, my hands are the color of blood. I sometimes fancy myself an evil which exists to oppose other evils; and on that great Day of which the prophets speak but in which they do not truly believe, on the day the world is utterly cleansed of evil, then I too will go down into darkness, swallowing curses. Until then, I will not wash my hands nor let them hang useless.” ― Roger Zelazny, The Guns of Avalon',
+    sampleResult:
+      '“In the mirrors of the many judgments, my hands are the color of █████. I sometimes fancy myself an ████ which exists to oppose other █████; and on that great Day of which the prophets speak but in which they do not truly believe, on the day the world is utterly cleansed of ████, then I too will go down into ████████, swallowing ██████. Until then, I will not wash my hands nor let them hang useless.” ― Roger Zelazny, The Guns of Avalon',
+    sampleOptions: {
+      ...initialValues,
+      wordsToCensor: 'blood\nevil\ndarkness\ncurses',
+      eachLetter: true
+    }
+  },
+  {
+    title: "Censor Agent's Name",
+    description: `In this example, we hide the name of an undercover FBI agent. We replace two words at once (first name and last name) with the code name "Agent 007"`,
+    sampleText:
+      'My name is John and I am an undercover FBI agent. I usually write my name in lowercase as "john" because I find uppercase letters scary. Unfortunately, in documents, my name is properly capitalized as John and it makes me upset.',
+    sampleResult:
+      'My name is Agent 007 and I am an undercover FBI agent. I usually write my name in lowercase as "Agent 007" because I find uppercase letters scary. Unfortunately, in documents, my name is properly capitalized as Agent 007 and it makes me upset.',
+    sampleOptions: {
+      ...initialValues,
+      censoredBySymbol: false,
+      wordsToCensor: 'john',
+      censorWord: 'Agent 007'
+    }
+  }
+];
+
+export default function CensorText({
+  title,
+  longDescription
+}: ToolComponentProps) {
+  const [input, setInput] = useState<string>('');
+  const [result, setResult] = useState<string>('');
+
+  function compute(initialValues: InitialValuesType, input: string) {
+    setResult(censorText(input, initialValues));
+  }
+
+  const getGroups: GetGroupsType<InitialValuesType> = ({
+    values,
+    updateField
+  }) => [
+    {
+      title: 'Words to Censor',
+      component: (
+        <Box>
+          <TextFieldWithDesc
+            multiline
+            rows={3}
+            value={values.wordsToCensor}
+            onOwnChange={(val) => updateField('wordsToCensor', val)}
+            description={`Specify all unwanted words that
+                 you want to hide in text (separated by a new line)`}
+          />
+        </Box>
+      )
+    },
+    {
+      title: 'Censor Mode',
+      component: (
+        <Box>
+          <SelectWithDesc
+            selected={values.censoredBySymbol}
+            options={[
+              { label: 'Censor by Symbol', value: true },
+              { label: 'Censor by Word', value: false }
+            ]}
+            onChange={(value) => updateField('censoredBySymbol', value)}
+            description={'Select the censoring mode.'}
+          />
+
+          {values.censoredBySymbol && (
+            <TextFieldWithDesc
+              value={values.censorSymbol}
+              onOwnChange={(val) => updateField('censorSymbol', val)}
+              description={`A symbol, character, or pattern to use for censoring.`}
+            />
+          )}
+
+          {values.censoredBySymbol && (
+            <CheckboxWithDesc
+              checked={values.eachLetter}
+              onChange={(value) => updateField('eachLetter', value)}
+              title="Mask each letter"
+              description="Put a masking symbol in place of each letter of the censored word."
+            />
+          )}
+
+          {!values.censoredBySymbol && (
+            <TextFieldWithDesc
+              value={values.censorWord}
+              onOwnChange={(val) => updateField('censorWord', val)}
+              description={`Replace all censored words with this word.`}
+            />
+          )}
+        </Box>
+      )
+    }
+  ];
+
+  return (
+    <ToolContent
+      title={title}
+      initialValues={initialValues}
+      getGroups={getGroups}
+      compute={compute}
+      input={input}
+      setInput={setInput}
+      inputComponent={
+        <ToolTextInput title={'Input text'} value={input} onChange={setInput} />
+      }
+      resultComponent={
+        <ToolTextResult title={'Censored text'} value={result} />
+      }
+      toolInfo={{ title: `What is a ${title}?`, description: longDescription }}
+      exampleCards={exampleCards}
+    />
+  );
+}

src/pages/tools/string/censor/meta.ts

@@ -0,0 +1,16 @@
+import { defineTool } from '@tools/defineTool';
+import { lazy } from 'react';
+
+export const tool = defineTool('string', {
+  name: 'Text Censor',
+  path: 'censor',
+  shortDescription:
+    'Quickly mask bad words or replace them with alternative words.',
+  icon: 'hugeicons:text-footnote',
+  description:
+    "utility for censoring words in text. Load your text in the input form on the left, specify all the bad words in the options, and you'll instantly get censored text in the output area.",
+  longDescription:
+    'With this online tool, you can censor certain words in any text. You can specify a list of unwanted words (such as swear words or secret words) and the program will replace them with alternative words and create a safe-to-read text. The words can be specified in a multi-line text field in the options by entering one word per line.',
+  keywords: ['text', 'censor', 'words', 'characters'],
+  component: lazy(() => import('./index'))
+});

src/pages/tools/string/censor/service.ts

@@ -0,0 +1,49 @@
+import { InitialValuesType } from './types';
+
+export function censorText(input: string, options: InitialValuesType): string {
+  if (!input) return '';
+  if (!options.wordsToCensor) return input;
+
+  if (options.censoredBySymbol && !isSymbol(options.censorSymbol)) {
+    throw new Error('Enter a valid censor symbol (non-alphanumeric or emoji)');
+  }
+
+  const wordsToCensor = options.wordsToCensor
+    .split('\n')
+    .map((word) => word.trim())
+    .filter((word) => word.length > 0);
+
+  let censoredText = input;
+
+  for (const word of wordsToCensor) {
+    const escapedWord = escapeRegex(word);
+    const pattern = new RegExp(`\\b${escapedWord}\\b`, 'giu');
+
+    const replacement = options.censoredBySymbol
+      ? options.eachLetter
+        ? options.censorSymbol.repeat(word.length)
+        : options.censorSymbol
+      : options.censorWord;
+
+    censoredText = censoredText.replace(pattern, replacement);
+  }
+
+  return censoredText;
+}
+
+/**
+ * Escapes RegExp special characters in a string
+ */
+function escapeRegex(str: string): string {
+  return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
+/**
+ * Determines if a string is a valid symbol or emoji (multi-codepoint supported).
+ */
+function isSymbol(input: string): boolean {
+  return (
+    /^[^\p{L}\p{N}]+$/u.test(input) || // Not a letter or number
+    /\p{Extended_Pictographic}/u.test(input) // Emoji or pictographic symbol
+  );
+}

src/pages/tools/string/censor/types.ts

@@ -0,0 +1,7 @@
+export type InitialValuesType = {
+  wordsToCensor: string;
+  censoredBySymbol: boolean;
+  censorSymbol: string;
+  eachLetter: boolean;
+  censorWord: string;
+};

src/pages/tools/string/index.ts

@@ -16,6 +16,7 @@ import { tool as stringRepeat } from './repeat/meta';
 import { tool as stringTruncate } from './truncate/meta';
 import { tool as stringBase64 } from './base64/meta';
 import { tool as stringStatistic } from './statistic/meta';
+import { tool as stringCensor } from './censor/meta';
 
 export const stringTools = [
   stringSplit,
@@ -35,5 +36,6 @@ export const stringTools = [
   stringRotate,
   stringRot13,
   stringBase64,
-  stringStatistic
+  stringStatistic,
+  stringCensor
 ];