Add Match.buildTag() method as a shorthand for Autolinker.getTagBuilder().build( match ). Fixes #143

Author: gregjacobs

src/AnchorTagBuilder.js

@@ -5,7 +5,8 @@
  * @class Autolinker.AnchorTagBuilder
  * @extends Object
  *
- * Builds anchor (<a>) tags for the Autolinker utility when a match is found.
+ * Builds anchor (<a>) tags for the Autolinker utility when a match is
+ * found.
  *
  * Normally this class is instantiated, configured, and used internally by an
  * {@link Autolinker} instance, but may actually be retrieved in a {@link Autolinker#replaceFn replaceFn}

src/Autolinker.js

@@ -422,6 +422,33 @@ Autolinker.prototype = {
 	},
 
 
+	/**
+	 * After we have found all matches, we need to remove subsequent matches
+	 * that overlap with a previous match. This can happen for instance with
+	 * URLs, where the url 'google.com/#link' would match '#link' as a hashtag.
+	 *
+	 * @private
+	 * @param {Autolinker.match.Match[]} matches
+	 * @return {Autolinker.match.Match[]}
+	 */
+	compactMatches : function( matches ) {
+		// First, the matches need to be sorted in order of offset
+		matches.sort( function( a, b ) { return a.getOffset() - b.getOffset(); } );
+
+		for( var i = 0; i < matches.length - 1; i++ ) {
+			var match = matches[ i ],
+			    endIdx = match.getOffset() + match.getMatchedText().length;
+
+			// Remove subsequent matches that overlap with the current match
+			while( i + 1 < matches.length && matches[ i + 1 ].getOffset() <= endIdx ) {
+				matches.splice( i + 1, 1 );
+			}
+		}
+
+		return matches;
+	},
+
+
 	/**
 	 * Removes matches for matchers that were turned off in the options. For
 	 * example, if {@link #hashtag hashtags} were not to be matched, we'll
@@ -454,33 +481,6 @@ Autolinker.prototype = {
 	},
 
 
-	/**
-	 * After we have found all matches, we need to remove subsequent matches
-	 * that overlap with a previous match. This can happen for instance with
-	 * URLs, where the url 'google.com/#link' would match '#link' as a hashtag.
-	 *
-	 * @private
-	 * @param {Autolinker.match.Match[]} matches
-	 * @return {Autolinker.match.Match[]}
-	 */
-	compactMatches : function( matches ) {
-		// First, the matches need to be sorted in order of offset
-		matches.sort( function( a, b ) { return a.getOffset() - b.getOffset(); } );
-
-		for( var i = 0; i < matches.length - 1; i++ ) {
-			var match = matches[ i ],
-			    endIdx = match.getOffset() + match.getMatchedText().length;
-
-			// Remove subsequent matches that overlap with the current match
-			while( i + 1 < matches.length && matches[ i + 1 ].getOffset() <= endIdx ) {
-				matches.splice( i + 1, 1 );
-			}
-		}
-
-		return matches;
-	},
-
-
 	/**
 	 * Parses the input `text` looking for URLs, email addresses, phone
 	 * numbers, username handles, and hashtags (depending on the configuration
@@ -594,8 +594,7 @@ Autolinker.prototype = {
 
 		} else {  // replaceFnResult === true, or no/unknown return value from function
 			// Perform Autolinker's default anchor tag generation
-			var tagBuilder = this.getTagBuilder(),
-			    anchorTag = tagBuilder.build( match );  // returns an Autolinker.HtmlTag instance
+			var anchorTag = match.buildTag();  // returns an Autolinker.HtmlTag instance
 
 			return anchorTag.toAnchorString();
 		}
@@ -629,13 +628,15 @@ Autolinker.prototype = {
 	 */
 	getMatchers : function() {
 		if( !this.matchers ) {
-			var matchersNs = Autolinker.matcher;
+			var matchersNs = Autolinker.matcher,
+			    tagBuilder = this.getTagBuilder();
+
 			var matchers = [
-				new matchersNs.Hashtag( { serviceName: this.hashtag } ),
-				new matchersNs.Email(),
-				new matchersNs.Phone(),
-				new matchersNs.Twitter(),
-				new matchersNs.Url( { stripPrefix: this.stripPrefix } )
+				new matchersNs.Hashtag( { tagBuilder: tagBuilder, serviceName: this.hashtag } ),
+				new matchersNs.Email( { tagBuilder: tagBuilder } ),
+				new matchersNs.Phone( { tagBuilder: tagBuilder } ),
+				new matchersNs.Twitter( { tagBuilder: tagBuilder } ),
+				new matchersNs.Url( { tagBuilder: tagBuilder, stripPrefix: this.stripPrefix } )
 			];
 
 			return ( this.matchers = matchers );

src/match/Email.js

@@ -10,28 +10,25 @@
 Autolinker.match.Email = Autolinker.Util.extend( Autolinker.match.Match, {
 
 	/**
-	 * @protected
-	 * @property {String} email (required)
+	 * @cfg {String} email (required)
 	 *
 	 * The email address that was matched.
 	 */
 
 
 	/**
 	 * @constructor
-	 * @param {String} matchedText The original text that was matched.
-	 * @param {Number} offset The offset of where the match was made in the
-	 *   input string.
-	 * @param {String} email The email address that was matched.
+	 * @param {Object} cfg The configuration properties for the Match
+	 *   instance, specified in an Object (map).
 	 */
-	constructor : function( matchedText, offset, email ) {
-		Autolinker.match.Match.prototype.constructor.call( this, matchedText, offset );
+	constructor : function( cfg ) {
+		Autolinker.match.Match.prototype.constructor.call( this, cfg );
 
 		// @if DEBUG
-		if( !email ) throw new Error( '`email` arg required' );
+		if( !cfg.email ) throw new Error( '`email` cfg required' );
 		// @endif
 
-		this.email = email;
+		this.email = cfg.email;
 	},
 
 

src/match/Hashtag.js

@@ -12,40 +12,34 @@
 Autolinker.match.Hashtag = Autolinker.Util.extend( Autolinker.match.Match, {
 
 	/**
-	 * @protected
-	 * @property {String} serviceName
+	 * @cfg {String} serviceName
 	 *
 	 * The service to point hashtag matches to. See {@link Autolinker#hashtag}
 	 * for available values.
 	 */
 
 	/**
-	 * @protected
-	 * @property {String} hashtag
+	 * @cfg {String} hashtag (required)
 	 *
 	 * The Hashtag that was matched, without the '#'.
 	 */
 
 
 	/**
 	 * @constructor
-	 * @param {String} matchedText The original text that was matched.
-	 * @param {Number} offset The offset of where the match was made in the
-	 *   input string.
-	 * @param {String} serviceName The service to point hashtag matches to. See
-	 *   {@link Autolinker#hashtag} for available values.
-	 * @param {String} hashtag The Hashtag that was matched, without the '#'.
+	 * @param {Object} cfg The configuration properties for the Match
+	 *   instance, specified in an Object (map).
 	 */
-	constructor : function( matchedText, offset, serviceName, hashtag ) {
-		Autolinker.match.Match.prototype.constructor.call( this, matchedText, offset );
+	constructor : function( cfg ) {
+		Autolinker.match.Match.prototype.constructor.call( this, cfg );
 
 		// @if DEBUG
-		// TODO: if( !serviceName ) throw new Error( '`serviceName` arg required' );
-		if( !hashtag ) throw new Error( '`hashtag` arg required' );
+		// TODO: if( !serviceName ) throw new Error( '`serviceName` cfg required' );
+		if( !cfg.hashtag ) throw new Error( '`hashtag` cfg required' );
 		// @endif
 
-		this.serviceName = serviceName;
-		this.hashtag = hashtag;
+		this.serviceName = cfg.serviceName;
+		this.hashtag = cfg.hashtag;
 	},
 
 

src/match/Match.js

@@ -33,30 +33,40 @@
 Autolinker.match.Match = Autolinker.Util.extend( Object, {
 
 	/**
-	 * @protected
-	 * @property {String} matchedText
+	 * @cfg {Autolinker.AnchorTagBuilder} tagBuilder (required)
+	 *
+	 * Reference to the AnchorTagBuilder instance to use to generate an anchor
+	 * tag for the Match.
+	 */
+
+	/**
+	 * @cfg {String} matchedText (required)
+	 *
+	 * The original text that was matched by the {@link Autolinker.matcher.Matcher}.
 	 */
 
 	/**
-	 * @protected
-	 * @property {Number} offset
+	 * @cfg {Number} offset (required)
+	 *
+	 * The offset of where the match was made in the input string.
 	 */
 
 
 	/**
 	 * @constructor
-	 * @param {String} matchedText The original text that was matched.
-	 * @param {Number} offset The offset of where the match was made in the
-	 *   input string.
+	 * @param {Object} cfg The configuration properties for the Match
+	 *   instance, specified in an Object (map).
 	 */
-	constructor : function( matchedText, offset ) {
+	constructor : function( cfg ) {
 		// @if DEBUG
-		if( matchedText == null ) throw new Error( '`matchedText` arg required' );
-		if( offset == null ) throw new Error( '`offset` arg required' );
+		if( cfg.tagBuilder == null ) throw new Error( '`tagBuilder` cfg required' );
+		if( cfg.matchedText == null ) throw new Error( '`matchedText` cfg required' );
+		if( cfg.offset == null ) throw new Error( '`offset` cfg required' );
 		// @endif
 
-		this.matchedText = matchedText;
-		this.offset = offset;
+		this.tagBuilder = cfg.tagBuilder;
+		this.matchedText = cfg.matchedText;
+		this.offset = cfg.offset;
 	},
 
 
@@ -122,6 +132,26 @@ Autolinker.match.Match = Autolinker.Util.extend( Object, {
 	 * @abstract
 	 * @return {String}
 	 */
-	getAnchorText : Autolinker.Util.abstractMethod
+	getAnchorText : Autolinker.Util.abstractMethod,
+
+
+	/**
+	 * Builds and returns an {@link Autolinker.HtmlTag} instance based on the
+	 * Match.
+	 *
+	 * This can be used to easily generate anchor tags from matches, and either
+	 * return their HTML string, or modify them before doing so.
+	 *
+	 * Example Usage:
+	 *
+	 *     var tag = match.buildTag();
+	 *     tag.addClass( 'cordova-link' );
+	 *     tag.setAttr( 'target', '_system' );
+	 *
+	 *     tag.toAnchorString();  // <a href="http://google.com" class="cordova-link" target="_system">Google</a>
+	 */
+	buildTag : function() {
+		return this.tagBuilder.build( this );
+	}
 
 } );

src/match/Phone.js

@@ -33,24 +33,19 @@ Autolinker.match.Phone = Autolinker.Util.extend( Autolinker.match.Match, {
 
 	/**
 	 * @constructor
-	 * @param {String} matchedText The original text that was matched.
-	 * @param {Number} offset The offset of where the match was made in the
-	 *   input string.
-	 * @param {String} number The phone number that was matched, without any
-	 *   delimiter characters. See {@link #number} for more details.
-	 * @param {Boolean} plusSign `true` if the matched phone number started with
-	 *   a '+' sign. See {@link #plusSign} for more details.
+	 * @param {Object} cfg The configuration properties for the Match
+	 *   instance, specified in an Object (map).
 	 */
-	constructor : function( matchedText, offset, number, plusSign ) {
-		Autolinker.match.Match.prototype.constructor.call( this, matchedText, offset );
+	constructor : function( cfg ) {
+		Autolinker.match.Match.prototype.constructor.call( this, cfg );
 
 		// @if DEBUG
-		if( !number ) throw new Error( '`number` arg required' );
-		if( plusSign == null ) throw new Error( '`plusSign` arg required' );
+		if( !cfg.number ) throw new Error( '`number` cfg required' );
+		if( cfg.plusSign == null ) throw new Error( '`plusSign` cfg required' );
 		// @endif
 
-		this.number = number;
-		this.plusSign = plusSign;
+		this.number = cfg.number;
+		this.plusSign = cfg.plusSign;
 	},
 
 

src/match/Twitter.js

@@ -10,29 +10,25 @@
 Autolinker.match.Twitter = Autolinker.Util.extend( Autolinker.match.Match, {
 
 	/**
-	 * @protected
-	 * @property {String} twitterHandle (required)
+	 * @cfg {String} twitterHandle (required)
 	 *
 	 * The Twitter handle that was matched, without the '@' character.
 	 */
 
 
 	/**
 	 * @constructor
-	 * @param {String} matchedText The original text that was matched.
-	 * @param {Number} offset The offset of where the match was made in the
-	 *   input string.
-	 * @param {String} twitterHandle The Twitter handle that was matched,
-	 *   without the '@' character.
+	 * @param {Object} cfg The configuration properties for the Match
+	 *   instance, specified in an Object (map).
 	 */
-	constructor : function( matchedText, offset, twitterHandle ) {
-		Autolinker.match.Match.prototype.constructor.call( this, matchedText, offset );
+	constructor : function( cfg) {
+		Autolinker.match.Match.prototype.constructor.call( this, cfg );
 
 		// @if DEBUG
-		if( !twitterHandle ) throw new Error( '`twitterHandle` arg required' );
+		if( !cfg.twitterHandle ) throw new Error( '`twitterHandle` cfg required' );
 		// @endif
 
-		this.twitterHandle = twitterHandle;
+		this.twitterHandle = cfg.twitterHandle;
 	},