bad-words - npm Package Compare versions

Comparing version 0.0.3 to 0.5.0

lib/badwords.js

@@ -1,34 +0,40 @@
-var detector = (function(){
-	function Filter(){
-		this.list = require('./lang.json').words;
-	}
+var detector = (function() {
+  function Filter(options) {
+    options = options || {};
+    this.list = require('./lang.json').words;
+    this.placeHolder = options.placeHolder || '*';
+    this.Factory = Filter;
+  }
 
-	Filter.prototype.isProfane = function isProfane(string){
-		for(var i = 0; i < this.list.length; i++)
-			if(string.toLowerCase() == this.list[i].toLowerCase())
-				return true;
+  Filter.prototype.isProfane = function isProfane(string) {
+    for (var i = 0; i < this.list.length; i++) {
+      var words = string.split(' ');
+      for (var j = 0; j < words.length; j++) {
+        if (words[j].toLowerCase().replace(/\*|\+|\-|\./g, '') === this.list[i].toLowerCase()) {
+          return true;
+        }
+      }
+    }
+    return false;
+  };
 
-		return false;
-	};
+  Filter.prototype.replaceWord = function replaceWord(string) {
+    return string.replace(/\*|\+|\-|\./g, '').replace(/\w/g, this.placeHolder);
+  };
 
-	Filter.prototype.replaceWord = function replaceWord(string){
-		return string.split("").map(function(c){
-			return "*";
-		}).join("");
-	};
+  Filter.prototype.clean = function clean(string) {
+    return string.split(' ').map(function(word) {
+      return this.isProfane(word) ? this.replaceWord(word) : word;
+    }.bind(this)).join(' ');
+  };
 
-	Filter.prototype.clean = function clean(string){
-		return string.split(" ").map(function(word){
-			return this.isProfane(word) ? this.replaceWord(word) : word;
-		}.bind(this)).join(" ");
-	};
-
-	return Filter;
+  Filter.prototype.addWords = function addWords(words) {
+    words = (words instanceof Array) ? words : [words];
+    this.list = this.list.concat(words);
+  };
+  return Filter;
 })();
 
-String.prototype.clean = function clean(){
-	var filter = new detector();
-	return filter.clean(this);
-};
+String.prototype.clean = String.prototype.clean || function(){};
 
 module.exports = new detector();

package.json

 {
   "name": "bad-words",
-  "version": "0.0.3",
+  "version": "0.5.0",
   "description": "A javascript filter for bad words",
@@ -5,0 +5,0 @@ "main": "./lib/badwords",

README.md

@@ -1,2 +0,2 @@
-badwords
+badwords v0.5.0
 ========
@@ -6,7 +6,7 @@
 
-```javascript
+```
 npm install bad-words
 ```
 #Examples
-```javascript
+```
 var filter = require('bad-words');
@@ -16,17 +16,38 @@
 ```
-Outputs:
-
+#####Outputs:
+```
 Don't be an ******
+```
 
-#String Helper
+###Factory
+Allows the creation of new instances of a filter
 
-```javascript
-require('bad-words');
+```
+var filter = require('bad-words');
+var customFilter = new filter.Factory();
 
-console.log("Don't be an ash0le".clean());
+customFilter.clean('Bad words...');
 ```
-Outputs:
 
-Don't be an ******
+###Placeholder Overrides
 
+```
+var filter = require('bad-words');
+var customFilter = new filter.Factory({ placeHolder: 'x'});
+
+customFilter.clean('Don't be an ash0le');
+```
+
+#####Outputs:
+```
+Don't be an xxxxxx
+```
+#String Helper
+
+Will no longer be supported and removed in the next release.
+
+#Testing
+```
+mocha
+```
 ========
@@ -33,0 +54,0 @@

test/filter.js

@@ -7,14 +7,20 @@ require('assert');
 	describe('clean',function(){
-		it("Should replace a bad word within a sentence asterisks (******)",function(){
-			assert(filter.clean("Don't be an ash0le") == "Don't be an ******");
+		it('Should replace a bad word within a sentence asterisks (******)',function(){
+			assert(filter.clean('Don\'t be an ash0le') === 'Don\'t be an ******');
 		});
 
-		it("Should replace multiple instances of any bad words within a sentence asterisks (******)",function(){
-			assert(filter.clean("cnts ash0le knob xxx") == "**** ****** **** ***");
+		it('Should replace multiple instances of any bad words within a sentence asterisks (******)',function(){
+			assert(filter.clean('cnts ash0le knob xxx') === '**** ****** **** ***');
 		});
 
-		it("Should not replace anything within a sentence if there are no bad words",function(){
-			assert(filter.clean("The cat ran fast") == "The cat ran fast");
+		it('Should not replace anything within a sentence if there are no bad words',function(){
+			assert(filter.clean('The cat ran fast') === 'The cat ran fast');
 		});
+
+		it('Should replace a string with proper placeholder when overridden', function(){
+			var customFilter = new filter.Factory({ placeHolder:'x'});
+			assert(customFilter.clean('This is a hells good test') === 'This is a xxxxx good test');
+		});
+
 	});
 });

test/isProfane.js

@@ -15,3 +15,7 @@ require('assert');
 		});
+
+		it("Should be able to detect a bad word in a sentence",function(){
+			assert(filter.isProfane("that person is an ash0le"));
+		})
 	});
-});
+});

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13365

increased by5.82%

Lines of code

548

increased by1.29%

Number of lines in readme file

76

increased by38.18%

No dependency changes