Merge pull request #19 from Seen-Arabic/development

rename `Panned` to `Banned`

Author: AbdelrahmanBayoumi

README.md

@@ -38,9 +38,9 @@ Can be used in Node.js and the browser.
 -   **Tashkeel Removal**: Easily remove Tashkeel from Arabic text.
 -   **Tatweel Removal**: Remove Tatweel character from Arabic phrases.
 -   **Convert To Old Arabic**: Transform Arabic text into old script.
--   **Convert To Old Arabic And Tashfeer Panned Words**: Transform Arabic text into old script and replace Panned Arabic text with visually similar characters for encoding purposes. (Panned words are words that considered as hate speech in social media)
+-   **Convert To Old Arabic And Tashfeer Banned Words**: Transform Arabic text into old script and replace Banned Arabic text with visually similar characters for encoding purposes. (Banned words are words that considered as hate speech in social media)
 -   **Tashfeer**: Replaces Arabic text with visually similar characters for encoding purposes.
--   **Tashfeer Panned Words**: Replaces Panned Arabic text with visually similar characters for encoding purposes. (Panned words are words that considered as hate speech in social media)
+-   **Tashfeer Banned Words**: Replaces Banned Arabic text with visually similar characters for encoding purposes. (Banned words are words that considered as hate speech in social media)
 -   **Remove Arabic Affixes**: Removes predefined affixes (prefixes and suffixes) from an Arabic word if it starts or ends with those affixes.
 -   **Word To Letters**: Convert Arabic word to its pronounced letters.
 
@@ -111,11 +111,11 @@ console.log(ArabicServices.toOldArabic('الخَيْلُ وَاللّيْلُ و
 // Output: 'الحىل واللىل والٮىدا ٮعرڡٮى'
 ```
 
-### Convert To Old Arabic And Tashfeer Panned Words
+### Convert To Old Arabic And Tashfeer Banned Words
 
 ```javascript
 const { ArabicServices } = require('arabic-services');
-console.log(ArabicServices.toOldArabicAndTashfeerPannedWords('جيش العدو يقتل الأطفال'));
+console.log(ArabicServices.toOldArabicAndTashfeerBannedWords('جيش العدو يقتل الأطفال'));
 // Output: 'چـێـݭ !ڵعـݚۉ ی۪ـڨـټل الاطڡال'
 ```
 
@@ -127,11 +127,11 @@ console.log(ArabicServices.tashfeer('هذا النص مشفر'));
 // Output: 'هـۮו اڵـݔص مـݭفـݛ'
 ```
 
-### Tashfeer Panned Words
+### Tashfeer Banned Words
 
 ```javascript
 const { ArabicServices } = require('arabic-services');
-console.log(ArabicServices.tashfeerPannedWords('جيش العدو يقتل الأطفال'));
+console.log(ArabicServices.tashfeerBannedWords('جيش العدو يقتل الأطفال'));
 // Output: 'چـێـݭ !ڵعـݚۉ ی۪ـڨـټل الأطفال'
 ```
 

README_AR.md

@@ -4,7 +4,6 @@
   </a>
 </div>
 
-
 <h1 align=center>خدمات اللغة العربية بلغة جافا سكريبت</h1>
 
 <p align=center>
@@ -32,6 +31,7 @@
 </div>
 
 ## 📋 الميزات
+
 -   **إزالة التشكيل:** إزالة التشكيل من النص العربي.
 -   **إزالة التطويل:** إزالة أحرف التطويل غير الضرورية من العبارات العربية.
 -   **التحويل إلى العربية القديمة:** تحويل النص العربي إلى الخط العربي القديم.
@@ -82,6 +82,7 @@ console.log(ArabicServices.removeTashkeel('الخَيْلُ وَاللّيْلُ
 ```
 
 ## 💻 الاستخدام
+
 ### إزالة التشكيل
 
 ```javascript
@@ -110,7 +111,7 @@ console.log(ArabicServices.toOldArabic('الخَيْلُ وَاللّيْلُ و
 
 ```javascript
 const { ArabicServices } = require('arabic-services');
-console.log(ArabicServices.toOldArabicAndTashfeerPannedWords('جيش العدو يقتل الأطفال'));
+console.log(ArabicServices.toOldArabicAndTashfeerBannedWords('جيش العدو يقتل الأطفال'));
 // Output: 'چـێـݭ !ڵعـݚۉ ی۪ـڨـټل الاطڡال'
 ```
 
@@ -126,7 +127,7 @@ console.log(ArabicServices.tashfeer('هذا النص مشفر'));
 
 ```javascript
 const { ArabicServices } = require('arabic-services');
-console.log(ArabicServices.tashfeerPannedWords('جيش العدو يقتل الأطفال'));
+console.log(ArabicServices.tashfeerBannedWords('جيش العدو يقتل الأطفال'));
 // Output: 'چـێـݭ !ڵعـݚۉ ی۪ـڨـټل الأطفال'
 ```
 
@@ -149,20 +150,20 @@ console.log(ArabicServices.removeAffixes('المدرسة'));
 <br>
 
 ## 💡 المساهمة
-إذا كنت ترغب في المساهمة في هذا المشروع وتحسينه بأفكار جديدة، فبإمكانك عمل pull request وطلبك مرحب به للغاية. إذا وجدت أي مشكلة، فقط ضعها في قسم الـIssues في المستودع، شكرًا لك.
-
-
 
+إذا كنت ترغب في المساهمة في هذا المشروع وتحسينه بأفكار جديدة، فبإمكانك عمل pull request وطلبك مرحب به للغاية. إذا وجدت أي مشكلة، فقط ضعها في قسم الـIssues في المستودع، شكرًا لك.
 
 <div align=center>
 <h2>🌟 ضع نجمة على هذا المستودع 🌟</h2>
 
 من فضلك ضع ⭐️ على هذا المستودع وشاركه مع الآخرين
+
 </div>
 
 <br>
 
 ## 📜 الرخصة
+
 هذا المشروع مرخص تحت رخصة GPL-3.0. انظر ملف [الرخصة](./LICENSE) لمزيد من التفاصيل.
 
 ## 💬 الاتصال

example.html

@@ -25,11 +25,11 @@
 				),
 			);
 			console.log(
-				'toOldArabicAndTashfeerPannedWords:',
-				ArabicServices.toOldArabicAndTashfeerPannedWords('جيش العدو يقتل الأطفال'),
+				'toOldArabicAndTashfeerBannedWords:',
+				ArabicServices.toOldArabicAndTashfeerBannedWords('جيش العدو يقتل الأطفال'),
 			);
 			console.log('Tashfeer:', ArabicServices.tashfeer('هذا النص مشفر'));
-			console.log('tashfeerPannedWords:', ArabicServices.tashfeerPannedWords('جيش العدو يقتل الأطفال'));
+			console.log('tashfeerBannedWords:', ArabicServices.tashfeerBannedWords('جيش العدو يقتل الأطفال'));
 			console.log('wordToLetters:', ArabicServices.wordToLetters('شجرة'));
 			console.log('removeArabicAffixes:', ArabicServices.removeArabicAffixes('موظفين'));
 
@@ -40,7 +40,7 @@
 			console.log('PRONOUNCED_LETTERS:', ArabicServices.constants.PRONOUNCED_LETTERS);
 			console.log('ARABIC_PREFIXES:', ArabicServices.constants.ARABIC_PREFIXES);
 			console.log('ARABIC_SUFFIXES:', ArabicServices.constants.ARABIC_SUFFIXES);
-			console.log('PANNED_WORDS:', ArabicServices.constants.PANNED_WORDS);
+			console.log('BANNED_WORDS:', ArabicServices.constants.BANNED_WORDS);
 		</script>
 	</body>
 </html>

src/constants/panned-words.ts src/constants/banned-words.tssrc/constants/panned-words.ts renamed to src/constants/banned-words.ts

@@ -1,4 +1,4 @@
-export const PANNED_WORDS = [
+export const BANNED_WORDS = [
 	'فلسطين',
 	'عرب',
 	'هود',

src/constants/index.ts

@@ -5,5 +5,5 @@ export {
 	PRONOUNCED_LETTERS,
 	STANDARD_LETTERS,
 } from './arabic-letters';
-export { PANNED_WORDS } from './panned-words';
+export { BANNED_WORDS } from './banned-words';
 export { TASHKEEL } from './tashkeel';

src/scripts/scripts.ts

@@ -1,4 +1,4 @@
-import { ARABIC_DOTLESS_DICT, PANNED_WORDS, TASHKEEL } from '../constants';
+import { ARABIC_DOTLESS_DICT, BANNED_WORDS, TASHKEEL } from '../constants';
 import {
 	ALEF,
 	ALONE_LETTERS,
@@ -59,10 +59,10 @@ export function toOldArabic(sentence: string): string {
 	return newSentence;
 }
 
-export function toOldArabicAndTashfeerPannedWords(sentence: string, levelOfTashfeer: number = 2): string {
+export function toOldArabicAndTashfeerBannedWords(sentence: string, levelOfTashfeer: number = 2): string {
 	let new_sentence = '';
 	for (const word of sentence.split(' ')) {
-		if (checkIfPannedWord(word)) {
+		if (checkIfBannedWord(word)) {
 			new_sentence += tashfeerHandler(word, levelOfTashfeer) + ' ';
 		} else {
 			new_sentence += toOldArabic(word) + ' ';
@@ -271,15 +271,15 @@ export function tashfeer(sentence: string, levelOfTashfeer: number = 1): string
 }
 
 /**
- * Calculates a ratio that likely represents the degree of similarity of a given string to elements in a 'panned' array.
+ * Calculates a ratio that likely represents the degree of similarity of a given string to elements in a 'banned' array.
  *
- * @param {string} string - The string to be compared against the elements in the 'panned' array.
- * @returns {number} The highest similarity ratio found between the string and elements in 'panned'.
+ * @param {string} string - The string to be compared against the elements in the 'banned' array.
+ * @returns {number} The highest similarity ratio found between the string and elements in 'banned'.
  */
-function pannedSimilarityRatio(string: string): number {
+function bannedSimilarityRatio(string: string): number {
 	let maximumSimilarity = -1;
-	for (const i in PANNED_WORDS) {
-		const calculatedSimilarity = similarityScore(string, PANNED_WORDS[i]);
+	for (const i in BANNED_WORDS) {
+		const calculatedSimilarity = similarityScore(string, BANNED_WORDS[i]);
 		if (calculatedSimilarity > maximumSimilarity) {
 			maximumSimilarity = calculatedSimilarity;
 		}
@@ -288,28 +288,28 @@ function pannedSimilarityRatio(string: string): number {
 }
 
 /**
- * Checks if a string is similar to any 'panned' words based on a predefined similarity ratio.
+ * Checks if a string is similar to any 'banned' words based on a predefined similarity ratio.
  *
  * @param {string} string - The string to be checked.
- * @returns {boolean} True if the string is similar to any 'panned' word, false otherwise.
+ * @returns {boolean} True if the string is similar to any 'banned' word, false otherwise.
  */
-function checkIfPannedWord(string: string): boolean {
+function checkIfBannedWord(string: string): boolean {
 	const std_ratio = 70;
-	return pannedSimilarityRatio(removeArabicAffixes(string)) >= std_ratio;
+	return bannedSimilarityRatio(removeArabicAffixes(string)) >= std_ratio;
 }
 
 /**
- * Performs tashfeer encryption on a given sentence, but only for words that are considered "panned" words.
- * Panned words are determined based on a predefined similarity ratio.
+ * Performs tashfeer encryption on a given sentence, but only for words that are considered "banned" words.
+ * Banned words are determined based on a predefined similarity ratio.
  *
  * @param {string} sentence - The input sentence to be encrypted.
  * @param {number} [levelOfTashfeer=2] - The encryption level (default is 2).
- * @returns {string} The encrypted sentence with tashfeer applied to panned words.
+ * @returns {string} The encrypted sentence with tashfeer applied to banned words.
  */
-export function tashfeerPannedWords(sentence: string, levelOfTashfeer: number = 2): string {
+export function tashfeerBannedWords(sentence: string, levelOfTashfeer: number = 2): string {
 	let new_sentence = '';
 	for (const word of sentence.split(' ')) {
-		if (checkIfPannedWord(word)) {
+		if (checkIfBannedWord(word)) {
 			new_sentence += tashfeerHandler(word, levelOfTashfeer) + ' ';
 		} else {
 			new_sentence += word + ' ';

tests/scripts.test.ts

@@ -58,10 +58,10 @@ describe('#toOldArabic()', () => {
 	});
 });
 
-describe('#toOldArabicAndTashfeerPannedWords()', () => {
-	it('should perform tashfeer encryption on panned words only and convert the rest to old arabic script', () => {
+describe('#toOldArabicAndTashfeerBannedWords()', () => {
+	it('should perform tashfeer encryption on banned words only and convert the rest to old arabic script', () => {
 		const sentence = 'جيش العدو يقتل الأطفال';
-		const result = ArabicServices.toOldArabicAndTashfeerPannedWords(sentence);
+		const result = ArabicServices.toOldArabicAndTashfeerBannedWords(sentence);
 		expect(result).not.toEqual(sentence);
 		expect(result).toMatch(/الاطڡال/);
 		expect(result).not.toMatch(/جيش/);
@@ -251,26 +251,26 @@ describe('#similarityScore', () => {
 	});
 });
 
-describe('#tashfeerPannedWords', () => {
-	it('should perform tashfeer encryption on panned words only', () => {
+describe('#tashfeerBannedWords', () => {
+	it('should perform tashfeer encryption on banned words only', () => {
 		const sentence = 'جيش العدو يقتل الأطفال';
-		const result = ArabicServices.tashfeerPannedWords(sentence);
+		const result = ArabicServices.tashfeerBannedWords(sentence);
 		expect(result).not.toEqual(sentence);
 		expect(result).toMatch(/الأطفال/);
 		expect(result).not.toMatch(/جيش/);
 		expect(result).not.toMatch(/العدو/);
 		expect(result).not.toMatch(/يقتل/);
 	});
 
-	it('should not perform tashfeer encryption on non-panned words', () => {
+	it('should not perform tashfeer encryption on non-banned words', () => {
 		const sentence = 'هذه جملة غير مشفرة';
-		const result = ArabicServices.tashfeerPannedWords(sentence);
+		const result = ArabicServices.tashfeerBannedWords(sentence);
 		expect(result).toEqual(sentence);
 	});
 
 	it('should handle empty input', () => {
 		const sentence = '';
-		const result = ArabicServices.tashfeerPannedWords(sentence);
+		const result = ArabicServices.tashfeerBannedWords(sentence);
 		expect(result).toEqual('');
 	});
 });