Experimenting with preprocess config function

Now all candidate text for linkifying is first
passed to a preprocess function to enable
arbitrary extension while piggy-backing on
the nice href detection.

Author: sherbondy

dist/Autolinker.js

@@ -119,6 +119,10 @@
 	};
 
 
+	var defaultSecondPassFn = function( context, str ) {
+		return str;
+	};
+
 	Autolinker.prototype = {
 		constructor : Autolinker,  // fix constructor property
 
@@ -209,6 +213,20 @@
 		 */
 
 
+		/**
+		 * @cfg {Function} secondPassReplaceFn
+		 *
+		 * A function which gets called for any string where no built-in matches are found in the input.
+		 * Defaults to the identity function.
+		 * This function is called with the following parameters:
+		 *
+		 * @cfg {Autolinker} secondPassReplaceFn.autolinker The Autolinker instance
+		 * @cfg {String} secondPassReplaceFn.str The text to be replaced
+		 *
+		 *
+		 */
+		secondPassReplaceFn: defaultSecondPassFn,
+
 		/**
 		 * @private
 		 * @property {Autolinker.htmlParser.HtmlParser} htmlParser
@@ -236,7 +254,6 @@
 		 */
 		tagBuilder : undefined,
 
-
 		/**
 		 * Automatically links URLs, email addresses, phone numbers, and Twitter handles found in the given chunk of HTML.
 		 * Does not link URLs found within HTML tags.
@@ -294,7 +311,6 @@
 			return resultHtml.join( "" );
 		},
 
-
 		/**
 		 * Process the text that lies in between HTML tags, performing the anchor tag replacements for matched
 		 * URLs/emails/phone#s/Twitter handles, and returns the string with the replacements made.
@@ -306,7 +322,7 @@
 		 * @return {String} The text with anchor tags auto-filled.
 		 */
 		linkifyStr : function( str ) {
-			return this.getMatchParser().replace( str, this.createMatchReturnVal, this );
+			return this.getMatchParser().replace( str, this.createMatchReturnVal, this.secondPassReplaceFn, this );
 		},
 
 
@@ -1647,10 +1663,11 @@
 		 * @param {Object} [contextObj=window] The context object ("scope") to run the `replaceFn` in.
 		 * @return {String}
 		 */
-		replace : function( text, replaceFn, contextObj ) {
+		replace : function( text, replaceFn, secondPassReplaceFn, contextObj ) {
 			var me = this;  // for closure
+			var didFindMatch = false;
 
-			return text.replace( this.matcherRegex, function( matchStr, $1, $2, $3, $4, $5, $6, $7, $8, $9) {
+			var initialResult = text.replace( this.matcherRegex, function( matchStr, $1, $2, $3, $4, $5, $6, $7, $8, $9) {
 				var matchDescObj = me.processCandidateMatch( matchStr, $1, $2, $3, $4, $5, $6, $7, $8, $9);  // "match description" object
 
 				// Return out with no changes for match types that are disabled (url, email, twitter), or for matches that are
@@ -1660,10 +1677,17 @@
 
 				} else {
 					// Generate replacement text for the match from the `replaceFn`
+					didFindMatch = true;
 					var replaceStr = replaceFn.call( contextObj, matchDescObj.match );
 					return matchDescObj.prefixStr + replaceStr + matchDescObj.suffixStr;
 				}
 			} );
+
+			if (!didFindMatch) {
+				return secondPassReplaceFn.call( contextObj, initialResult );
+			} else {
+				return initialResult;
+			}
 		},
 
 

dist/Autolinker.min.js

@@ -94,6 +94,10 @@ var Autolinker = function( cfg ) {
 };
 
 
+var defaultPreprocessFn = function( autolinker, str ) {
+	return str;
+};
+
 Autolinker.prototype = {
 	constructor : Autolinker,  // fix constructor property
 
@@ -184,6 +188,20 @@ Autolinker.prototype = {
 	 */
 
 
+	/**
+	 * @cfg {Function} preprocessFn
+	 *
+	 * A function which gets called to preprocess input strings before performing the built-in autolinker replacement operations.
+	 * Defaults to the identity function.
+	 * This function is called with the following parameters:
+	 *
+	 * @cfg {Autolinker} preprocessFn.autolinker The Autolinker instance
+	 * @cfg {String} preoprocessFn.str The text to be replaced
+	 *
+	 *
+	 */
+	preprocessFn: defaultPreprocessFn,
+
 	/**
 	 * @private
 	 * @property {Autolinker.htmlParser.HtmlParser} htmlParser
@@ -211,7 +229,6 @@ Autolinker.prototype = {
 	 */
 	tagBuilder : undefined,
 
-
 	/**
 	 * Automatically links URLs, email addresses, phone numbers, and Twitter handles found in the given chunk of HTML.
 	 * Does not link URLs found within HTML tags.
@@ -269,7 +286,6 @@ Autolinker.prototype = {
 		return resultHtml.join( "" );
 	},
 
-
 	/**
 	 * Process the text that lies in between HTML tags, performing the anchor tag replacements for matched
 	 * URLs/emails/phone#s/Twitter handles, and returns the string with the replacements made.
@@ -281,7 +297,9 @@ Autolinker.prototype = {
 	 * @return {String} The text with anchor tags auto-filled.
 	 */
 	linkifyStr : function( str ) {
-		return this.getMatchParser().replace( str, this.createMatchReturnVal, this );
+		// preprocess string, then pas into match parser.
+		var initialResult = this.preprocessFn( this, str );
+		return this.getMatchParser().replace( initialResult, this.createMatchReturnVal, this );
 	},
 
 

src/Autolinker.js

@@ -204,9 +204,9 @@ Autolinker.matchParser.MatchParser = Autolinker.Util.extend( Object, {
 			// invalid (false positives from the matcherRegex, which can't use look-behinds since they are unavailable in JS).
 			if( !matchDescObj ) {
 				return matchStr;
-
 			} else {
 				// Generate replacement text for the match from the `replaceFn`
+				didFindMatch = true;
 				var replaceStr = replaceFn.call( contextObj, matchDescObj.match );
 				return matchDescObj.prefixStr + replaceStr + matchDescObj.suffixStr;
 			}

src/matchParser/MatchParser.js

@@ -1,6 +1,20 @@
 /*global Autolinker, _, describe, beforeEach, afterEach, it, expect */
 describe( "Autolinker", function() {
 
+	describe( "preprocess function", function() {
+		it( "should capitalize string, then linkify", function() {
+			var capitalizer = function( autolinker, str ){
+				return str.toUpperCase();
+			}
+
+			var autolinker = new Autolinker( { newWindow: false, preprocessFn: capitalizer});
+
+			var result = autolinker.link( "Hi, my number is: 919-789-1622" );
+			expect( result ).toBe('HI, MY NUMBER IS: <a href="tel:9197891622">919-789-1622</a>');
+		});
+
+	});
+
 	describe( "instantiating and using as a class", function() {
 
 		it( "should configure the instance with configuration options, and then be able to execute the link() method", function() {
@@ -12,7 +26,6 @@ describe( "Autolinker", function() {
 
 	} );
 
-
 	describe( "link() method", function() {
 		var autolinker;