Add Autolinker.match.Match#getMatchedText method.

Author: gregjacobs

README.md

@@ -227,6 +227,14 @@ The full API docs for Autolinker may be referenced at: [http://gregjacobs.github
 
 ## Changelog:
 
+### 0.12.3
+
+- Add `Autolinker.match.Match#getMatchedText` method
+
+### 0.12.2
+
+- Add documentation generation, and update inline documentation.
+
 ### 0.12.1
 
 - Expose the `Autolinker.HtmlTag` class, and allow it to be used in the `replaceFn`

dist/Autolinker.js

@@ -487,7 +487,7 @@
 
 
 				if( emailAddressMatch ) {
-					match = new Autolinker.match.Email( { email: emailAddressMatch } );
+					match = new Autolinker.match.Email( { matchedText: matchStr, email: emailAddressMatch } );
 
 				} else if( twitterMatch ) {
 					// fix up the `matchStr` if there was a preceding whitespace char, which was needed to determine the match 
@@ -496,7 +496,7 @@
 						prefixStr = twitterHandlePrefixWhitespaceChar;
 						matchStr = matchStr.slice( 1 );  // remove the prefixed whitespace char from the match
 					}
-					match = new Autolinker.match.Twitter( { twitterHandle: twitterHandle } );
+					match = new Autolinker.match.Twitter( { matchedText: matchStr, twitterHandle: twitterHandle } );
 
 				} else {  // url match
 					// If it's a protocol-relative '//' match, remove the character before the '//' (which the matcherRegex needed
@@ -509,7 +509,13 @@
 							matchStr = matchStr.slice( 1 );  // remove the prefixed char from the match
 						}
 					}
-					match = new Autolinker.match.Url( { url: matchStr, protocolRelativeMatch: protocolRelativeMatch, stripPrefix: me.stripPrefix } );
+					
+					match = new Autolinker.match.Url( {
+						matchedText : matchStr,
+						url : matchStr,
+						protocolRelativeMatch : protocolRelativeMatch,
+						stripPrefix : me.stripPrefix
+					} );
 				}
 
 				// Generate the replacement text for the match
@@ -1436,6 +1442,13 @@
 	 */
 	Autolinker.match.Match = Autolinker.Util.extend( Object, {
 
+		/**
+		 * @cfg {String} matchedText (required)
+		 * 
+		 * The original text that was matched.
+		 */
+		
+		
 		/**
 		 * @constructor
 		 * @param {Object} cfg The configuration properties for the Match instance, specified in an Object (map).
@@ -1453,6 +1466,16 @@
 		 */
 		getType : Autolinker.Util.abstractMethod,
 
+		
+		/**
+		 * Returns the original text that was matched.
+		 * 
+		 * @return {String}
+		 */
+		getMatchedText : function() {
+			return this.matchedText;
+		},
+		
 
 		/**
 		 * Returns the anchor href that should be generated for the match.

dist/Autolinker.min.js

@@ -1,6 +1,6 @@
 {
   "name": "autolinker",
-  "version": "0.12.2",
+  "version": "0.12.3",
   "description": "Utility to automatically link the URLs, email addresses, and Twitter handles in a given block of text/HTML",
   "main": "dist/Autolinker.js",
   "directories": {

package.json

@@ -466,7 +466,7 @@ Autolinker.prototype = {
 
 
 			if( emailAddressMatch ) {
-				match = new Autolinker.match.Email( { email: emailAddressMatch } );
+				match = new Autolinker.match.Email( { matchedText: matchStr, email: emailAddressMatch } );
 
 			} else if( twitterMatch ) {
 				// fix up the `matchStr` if there was a preceding whitespace char, which was needed to determine the match 
@@ -475,7 +475,7 @@ Autolinker.prototype = {
 					prefixStr = twitterHandlePrefixWhitespaceChar;
 					matchStr = matchStr.slice( 1 );  // remove the prefixed whitespace char from the match
 				}
-				match = new Autolinker.match.Twitter( { twitterHandle: twitterHandle } );
+				match = new Autolinker.match.Twitter( { matchedText: matchStr, twitterHandle: twitterHandle } );
 
 			} else {  // url match
 				// If it's a protocol-relative '//' match, remove the character before the '//' (which the matcherRegex needed
@@ -488,7 +488,13 @@ Autolinker.prototype = {
 						matchStr = matchStr.slice( 1 );  // remove the prefixed char from the match
 					}
 				}
-				match = new Autolinker.match.Url( { url: matchStr, protocolRelativeMatch: protocolRelativeMatch, stripPrefix: me.stripPrefix } );
+				
+				match = new Autolinker.match.Url( {
+					matchedText : matchStr,
+					url : matchStr,
+					protocolRelativeMatch : protocolRelativeMatch,
+					stripPrefix : me.stripPrefix
+				} );
 			}
 
 			// Generate the replacement text for the match

src/Autolinker.js

@@ -32,6 +32,13 @@
  */
 Autolinker.match.Match = Autolinker.Util.extend( Object, {
 
+	/**
+	 * @cfg {String} matchedText (required)
+	 * 
+	 * The original text that was matched.
+	 */
+	
+	
 	/**
 	 * @constructor
 	 * @param {Object} cfg The configuration properties for the Match instance, specified in an Object (map).
@@ -49,6 +56,16 @@ Autolinker.match.Match = Autolinker.Util.extend( Object, {
 	 */
 	getType : Autolinker.Util.abstractMethod,
 
+	
+	/**
+	 * Returns the original text that was matched.
+	 * 
+	 * @return {String}
+	 */
+	getMatchedText : function() {
+		return this.matchedText;
+	},
+	
 
 	/**
 	 * Returns the anchor href that should be generated for the match.

src/match/Match.js

@@ -921,6 +921,52 @@ describe( "Autolinker", function() {
 			var returnTrueFn = function() { return true; },
 			    returnFalseFn = function() { return false; };
 
+			
+			it( "should populate a UrlMatch object with the appropriate properties", function() {
+				var replaceFnCallCount = 0;
+				var result = Autolinker.link( "Website: asdf.com ", {  // purposeful trailing space
+					replaceFn : function( autolinker, match ) {
+						replaceFnCallCount++;
+						
+						expect( match.getMatchedText() ).toBe( 'asdf.com' );
+						expect( match.getUrl() ).toBe( 'http://asdf.com' );
+					}
+				} );
+				
+				expect( replaceFnCallCount ).toBe( 1 );  // make sure the replaceFn was called
+			} );
+			
+			
+			it( "should populate an EmailMatch object with the appropriate properties", function() {
+				var replaceFnCallCount = 0;
+				var result = Autolinker.link( "Email: asdf@asdf.com ", {  // purposeful trailing space
+					replaceFn : function( autolinker, match ) {
+						replaceFnCallCount++;
+						
+						expect( match.getMatchedText() ).toBe( 'asdf@asdf.com' );
+						expect( match.getEmail() ).toBe( 'asdf@asdf.com' );
+					}
+				} );
+				
+				expect( replaceFnCallCount ).toBe( 1 );  // make sure the replaceFn was called
+			} );
+			
+			
+			it( "should populate a TwitterMatch object with the appropriate properties", function() {
+				var replaceFnCallCount = 0;
+				var result = Autolinker.link( "Twitter: @myTwitter ", {  // purposeful trailing space
+					replaceFn : function( autolinker, match ) {
+						replaceFnCallCount++;
+						
+						expect( match.getMatchedText() ).toBe( '@myTwitter' );
+						expect( match.getTwitterHandle() ).toBe( 'myTwitter' );
+					}
+				} );
+				
+				expect( replaceFnCallCount ).toBe( 1 );  // make sure the replaceFn was called
+			} );
+			
+			
 			it( "should replace the match as Autolinker would normally do when `true` is returned from the `replaceFn`", function() {
 				var result = Autolinker.link( "Website: asdf.com, Email: asdf@asdf.com, Twitter: @asdf", { 
 					newWindow : false,  // just to suppress the target="_blank" from the output for this test