Merge pull request #6 from abdullahchaudhry/dev_fixes

Dev fixes

Author: RobertJGabriel

.babelrc

@@ -14,13 +14,13 @@ npm install -s @coffeeandfun/google-profanity-words
 
 ## Usage
 ```js
-import { profanityEngine } from '@coffeeandfun/google-profanity-words';
+import { ProfanityEngine } from '@coffeeandfun/google-profanity-words';
 
-let profanity = new profanityEngine();
+let profanity = new ProfanityEngine();
 
-await profanity.all(); // returns all bad words as an array.
+profanity.all(); // returns all bad words as an array.
 
-await profanity.search('bad word'); // returns true if the word is found in the list.
+profanity.search('bad word'); // returns true if the word is found in the list.
 
 ```
 

README.md

@@ -1,21 +1,28 @@
-import { profanityEngine } from '../index.js';
+import { ProfanityEngine } from '../index.js';
 
-let profanity = new profanityEngine();
+let profanity = new ProfanityEngine({
+  test: true
+});
 
 describe('Profanity tests', () => {
 
-    it('Get all words in an array', async () => {
-        const allWords = await profanity.all();
-        expect(allWords.length).toEqual(453);
+    it('Should get all the profanity words in an array', () => {
+        const allWords = profanity.all();
+        expect(allWords.length).toEqual(451);
     });
 
-    it('Search for the word Shit in list', async () => {
-        const searchWord = await profanity.search('shit');
+    it('Should return true for profanity words', () => {
+        const searchWord = profanity.search('shit');
         expect(searchWord).toEqual(true);
     });
 
-    it('Search for the word ka in list', async () => {
-        const searchWord = await profanity.search('ka');
+    it('Should return false for normal words', () => {
+        const searchWord = profanity.search('ka');
+        expect(searchWord).toEqual(false);
+    });
+
+    it('Should return false for any empty string', () => {
+        const searchWord = profanity.search('');
         expect(searchWord).toEqual(false);
     });
 });

__tests__/words.test.js

@@ -208,7 +208,6 @@ gangbangs
 gaylord
 gaysex
 goatse
-God
 god-dam
 god-damned
 goddamn
@@ -449,4 +448,4 @@ whore
 willies
 willy
 xrated
-xxx
+xxx

data/list.txt

@@ -1,31 +1,24 @@
 import fs from 'fs';
 
 
-export class profanityEngine {
-    constructor() {
-
-        this.terms = fs.readFileSync('data/list.txt', 'utf8').split('\n');
-
+export class ProfanityEngine {
+    constructor(config) {
+        let path;
+        if (config && config.test) {
+            path = 'data/list.txt'
+        } else {
+            path = './node_modules/@coffeeandfun/google-profanity-words/data/list.txt';
+        }
+
+        this.terms = fs.readFileSync(`${path}`, 'utf8').split('\n');
     }
 
-    async all() {
-        return new Promise(async (resolve, reject) => {
-            resolve(this.terms); // this.terms;
-        });
+    all() {
+        return this.terms
     }
 
-    async search(term) {
-
-        return new Promise(async (resolve, reject) => {
-            let result = this.terms.indexOf(term);
-            if (result > -1) {
-                resolve(true);
-            } else {
-                resolve(false);
-            }
-        });
-
-
+    search(term) {
+        let result = this.terms.indexOf(term);
+        return result > -1 ? true : false
     }
-
 }