Tickets plugin (#156)

Nick Frasser · web-flow · commit a4c26d4f3745 · 2016-08-16T22:48:11.000-04:00
* Next jump method for TokenState class

Used for resolving ambiguous states transitions between plugins.

Includes tests

* Hashtag and Mention plugins should use `jump` method from start state

* Complete ticket plugin implementation

Includes tests and build templates

* A few tests and enhancemenets in response to ticket-related changes
diff --git a/plugins/ticket.js b/plugins/ticket.js
@@ -0,0 +1 @@
+module.exports = require('../lib/linkify/plugins/ticket').default;
diff --git a/src/linkify/core/state.js b/src/linkify/core/state.js
@@ -64,9 +64,7 @@ BaseState.prototype = {
 		@return {State} state Returns false if no jumps are available
 	*/
 	next(item) {
-
 		for (let i = 0; i < this.j.length; i++) {
-
 			let jump = this.j[i];
 			let symbol = jump[0]; // Next item to check for
 			let state = jump[1]; // State to jump to if items match
@@ -148,6 +146,26 @@ const CharacterState = inherits(BaseState, createStateClass(), {
 */
 const TokenState = inherits(BaseState, createStateClass(), {
 
+	/**
+	 * Similar to `on`, but returns the state the results in the transition from
+	 * the given item
+	 * @method jump
+	 * @param {Mixed} item
+	 * @param {Token} [token]
+	 * @return state
+	 */
+	jump(token, tClass = null) {
+		var state = this.next(new token('')); // dummy temp token
+		if (state === this.defaultTransition) {
+			// Make a new state!
+			state = new this.constructor(tClass);
+			this.on(token, state);
+		} else if (tClass) {
+			state.T = tClass;
+		}
+		return state;
+	},
+
 	/**
 		Is the given token an instance of the given token class?
 
diff --git a/src/linkify/plugins/hashtag.js b/src/linkify/plugins/hashtag.js
@@ -3,10 +3,8 @@
 */
 export default function hashtag(linkify) {
 	let TT = linkify.scanner.TOKENS; // Text tokens
-	let MT = linkify.parser.TOKENS; // Multi tokens
-	let MultiToken = MT.Base;
+	let MultiToken = linkify.parser.TOKENS.Base; // Base Multi token class
 	let S_START = linkify.parser.start;
-	let S_HASH, S_HASHTAG;
 
 	function HASHTAG(value) {
 		this.v = value;
@@ -17,10 +15,10 @@ export default function hashtag(linkify) {
 		isLink: true
 	});
 
-	S_HASH = new linkify.parser.State();
-	S_HASHTAG = new linkify.parser.State(HASHTAG);
+	const S_HASH = S_START.jump(TT.POUND);
+	const S_HASHTAG = new linkify.parser.State(HASHTAG);
 
-	S_START.on(TT.POUND, S_HASH);
 	S_HASH.on(TT.DOMAIN, S_HASHTAG);
 	S_HASH.on(TT.TLD, S_HASHTAG);
+	S_HASH.on(TT.LOCALHOST, S_HASHTAG);
 }
diff --git a/src/linkify/plugins/mention.js b/src/linkify/plugins/mention.js
@@ -1,5 +1,5 @@
 /**
-	Quick Mention parser plugin for linkify
+	Mention parser plugin for linkify
 */
 export default function mention(linkify) {
 	const TT = linkify.scanner.TOKENS; // Text tokens
@@ -26,15 +26,12 @@ export default function mention(linkify) {
 		}
 	});
 
-	const S_AT = new State();
+	const S_AT = S_START.jump(TT.AT); // @
 	const S_AT_SYMS = new State();
 	const S_MENTION = new State(MENTION);
 	const S_MENTION_SLASH = new State();
 	const S_MENTION_SLASH_SYMS = new State();
 
-	// @
-	S_START.on(TT.AT, S_AT);
-
 	// @_,
 	S_AT.on(TT_UNDERSCORE, S_AT_SYMS);
 
diff --git a/src/linkify/plugins/ticket.js b/src/linkify/plugins/ticket.js
@@ -0,0 +1,24 @@
+/**
+	Ticket number detector
+	TODO: Add cross-repo style tickets? e.g., SoapBox/linkifyjs#42
+	Is that even feasible?
+*/
+export default function ticket(linkify) {
+	let TT = linkify.scanner.TOKENS; // Base Multi token class
+	let MultiToken = linkify.parser.TOKENS.Base;
+	let S_START = linkify.parser.start;
+
+	function TICKET(value) {
+		this.v = value;
+	}
+
+	linkify.inherits(MultiToken, TICKET, {
+		type: 'ticket',
+		isLink: true
+	});
+
+	const S_HASH = S_START.jump(TT.POUND);
+	const S_TICKET = new linkify.parser.State(TICKET);
+
+	S_HASH.on(TT.NUM, S_TICKET);
+}
diff --git a/tasks/uglify.js b/tasks/uglify.js
@@ -49,6 +49,7 @@ exports.unmangleableProps = [
 	'ignoreTags',
 	'inherits',
 	'isLink',
+	'jump',
 	'key',
 	'linkAttributes',
 	'linkClass',
diff --git a/templates/linkify/plugins/ticket.amd.js b/templates/linkify/plugins/ticket.amd.js
@@ -0,0 +1,4 @@
+<%= contents %>
+require(['linkify', 'linkify/plugins/ticket'], function (linkify, ticket) {
+	ticket(linkify);
+});
diff --git a/templates/linkify/plugins/ticket.js b/templates/linkify/plugins/ticket.js
@@ -0,0 +1,4 @@
+;(function (linkify) {
+<%= contents %>
+plugin(linkify);
+})(linkify);
diff --git a/test/amd.conf.js b/test/amd.conf.js
@@ -18,15 +18,20 @@ module.exports = {
 		{pattern: 'test/qunit/react.amd.js', included: false, served: true},
 		'dist/linkify-polyfill.min.js',
 		'dist/linkify.amd.min.js',
+		// 'dist/linkify.amd.js', // Uncompressed
 		'test/qunit/ie8.js',
 		{pattern: 'dist/linkify-react.amd.min.js', included: false, served: true},
+		// {pattern: 'dist/linkify-react.amd.js', included: false, served: true}, // Uncompressed
 		'dist/*.amd.min.js',
+		// 'dist/*.amd.js', // Uncompressed
 		'test/qunit/amd.js',
 		'test/qunit/main.js'
 	],
 
 	// list of files to exclude
-	exclude: [],
+	exclude: [
+		// '*.min.js', // Uncompressed
+	],
 
 	// QUnit configuration
 	client: {
diff --git a/test/conf.js b/test/conf.js
@@ -14,16 +14,21 @@ module.exports = {
 		{pattern: 'node_modules/react-dom/dist/react-dom.js', watched: false, included: false, served: true},
 		'dist/linkify-polyfill.min.js',
 		'dist/linkify.min.js',
+		// 'dist/linkify.js', // Uncompressed
 		'test/qunit/ie8.js',
 		{pattern: 'dist/linkify-react.min.js', included: false, served: true},
+		// {pattern: 'dist/linkify-reactjs', included: false, served: true}, // Uncompressed
 		'dist/*.min.js',
+		// 'dist/*.js', // Uncompressed
 		'test/qunit/globals.js',
 		'test/qunit/main.js'
 	],
 
 	// list of files to exclude
 	exclude: [
-		'dist/*.amd.min.js'
+		'dist/*.amd.min.js',
+		// 'dist/*.amd.js', // Uncompressed
+		// 'dist/*.min.js', // Uncompressed
 	],
 
 	// QUnit configuration
diff --git a/test/qunit/main.js b/test/qunit/main.js
@@ -125,7 +125,7 @@ QUnit.test('finds valid hashtags', function (assert) {
 	assert.deepEqual(result, [{
 		type: 'hashtag',
 		value: '#urls',
-		href: '#urls',
+		href: '#urls'
 	}, {
 		type: 'hashtag',
 		value: '#awesome2015',
@@ -134,21 +134,32 @@ QUnit.test('finds valid hashtags', function (assert) {
 });
 
 
-QUnit.module('linkify-plugin-metntion');
+QUnit.module('linkify-plugin-mention');
 
-QUnit.test('finds valid metntions', function (assert) {
+QUnit.test('finds valid mentions', function (assert) {
 	var result = w.linkify.find('Hey @foo say hello to @bar!');
 	assert.deepEqual(result, [{
 		type: 'mention',
 		value: '@foo',
-		href: '/foo',
+		href: '/foo'
 	}, {
 		type: 'mention',
 		value: '@bar',
 		href: '/bar'
 	}]);
 });
 
+QUnit.module('linkify-plugin-ticket');
+
+QUnit.test('finds valid tickets', function (assert) {
+	var result = w.linkify.find('Please see issue #42!');
+	assert.deepEqual(result, [{
+		type: 'ticket',
+		value: '#42',
+		href: '#42'
+	}]);
+});
+
 // HTML rendered in body
 var originalHtml = 'Hello here are some links to ftp://awesome.com/?where=this and localhost:8080, pretty neat right? <p>Here is a nested github.com/SoapBox/linkifyjs paragraph</p>';
 
diff --git a/test/spec/linkify/core/state/token-test.js b/test/spec/linkify/core/state/token-test.js
@@ -1,10 +1,78 @@
-const TEXT_TOKENS = require(`${__base}linkify/core/tokens`).text;
 const TokenState = require(`${__base}linkify/core/state`).TokenState;
+const tokens = require(`${__base}linkify/core/tokens`);
+const TEXT_TOKENS = tokens.text;
+const MULTI_TOKENS = tokens.multi;
 
 describe('linkify/core/state/TokenState', function () {
-	var TS_START;
+	var S_START;
 
-	before(function () {
-		TS_START = new TokenState();
+	beforeEach(function () {
+		S_START = new TokenState();
+	});
+
+	describe('#jump', () => {
+		context('when called on a state without prior transitions', () => {
+			context('with just a text token', () => {
+				it('returns a non-accepting state', () => {
+					state = S_START.jump(TEXT_TOKENS.AT);
+					expect(state).to.be.an.instanceof(TokenState);
+				});
+
+				it('does not emit anything', () => {
+					state = S_START.jump(TEXT_TOKENS.AT);
+					expect(state.emit()).to.not.be.ok;
+				});
+			});
+
+			context('with a text token and a multi-token', () => {
+				it('returns an accepting state', () => {
+					state = S_START.jump(TEXT_TOKENS.LOCALHOST, MULTI_TOKENS.URL);
+					expect(state).to.be.an.instanceof(TokenState);
+				});
+
+				it('returns an accepting state', () => {
+					state = S_START.jump(TEXT_TOKENS.LOCALHOST, MULTI_TOKENS.URL);
+					expect(state.emit()).to.equal(MULTI_TOKENS.URL);
+				});
+			});
+		});
+
+		context('when called on a state with prior set transitions', () => {
+			var S_AT, S_LOCALHOST;
+
+			beforeEach(() => {
+				S_START = new TokenState();
+				S_AT = new TokenState();
+				S_LOCALHOST = new TokenState(); // No accepting transition yet
+				S_START.on(TEXT_TOKENS.AT, S_AT);
+				S_START.on(TEXT_TOKENS.LOCALHOST, S_LOCALHOST);
+			});
+
+			context('with just a text token', () => {
+				it('returns an exisiting state', () => {
+					state = S_START.jump(TEXT_TOKENS.AT);
+					expect(state).to.equal(S_AT);
+				});
+
+				it('returns an non-accepting state', () => {
+					state = S_START.jump(TEXT_TOKENS.AT);
+					expect(state.accepts()).to.not.be.ok;
+				});
+			});
+
+			context('with a text token and a multi-token', () => {
+				it('returns an exisiting state', () => {
+					state = S_START.jump(TEXT_TOKENS.LOCALHOST, MULTI_TOKENS.URL);
+					expect(state).to.equal(S_LOCALHOST);
+				});
+
+				it('returns an accepting state', () => {
+					state = S_START.jump(TEXT_TOKENS.LOCALHOST, MULTI_TOKENS.URL);
+					expect(state.accepts()).to.be.ok;
+					expect(state.emit()).to.equal(MULTI_TOKENS.URL);
+				});
+			});
+
+		});
 	});
 });
diff --git a/test/spec/linkify/plugins/hashtag-test.js b/test/spec/linkify/plugins/hashtag-test.js
@@ -2,7 +2,7 @@ const linkify = require(`${__base}linkify`);
 const hashtag = require(`${__base}linkify/plugins/hashtag`).default;
 
 describe('linkify/plugins/hashtag', () => {
-	it('Cannot parse hashtags before applying the plugin', () => {
+	it('cannot parse hashtags before applying the plugin', () => {
 		expect(linkify.find('There is a #hashtag #YOLO-2015 and #1234 and #%^&*( should not work'))
 		.to.be.eql([]);
 
@@ -15,7 +15,7 @@ describe('linkify/plugins/hashtag', () => {
 			hashtag(linkify);
 		});
 
-		it ('Can parse hashtags after applying the plugin', () => {
+		it ('can parse hashtags after applying the plugin', () => {
 			expect(linkify.find('There is a #hashtag #YOLO-2015 and #1234 and #%^&*( should not work'))
 			.to.be.eql([{
 				type: 'hashtag',
diff --git a/test/spec/linkify/plugins/ticket-test.js b/test/spec/linkify/plugins/ticket-test.js
@@ -0,0 +1,35 @@
+const linkify = require(`${__base}linkify`);
+const ticket = require(`${__base}linkify/plugins/ticket`).default;
+
+describe('linkify/plugins/ticket', () => {
+	it('cannot parse tickets before applying the plugin', () => {
+		expect(
+			linkify.find('This is ticket #2015 and #1234 and #%^&*( should not work')
+		).to.be.eql([]);
+
+		expect(linkify.test('#1422', 'ticket')).to.not.be.ok;
+		expect(linkify.test('#987', 'ticket')).to.not.be.ok;
+	});
+
+	describe('after plugin is applied', () => {
+		before(() => { ticket(linkify); });
+
+		it ('can parse tickets after applying the plugin', () => {
+			expect(linkify.find('Check out issue #42')).to.be.eql([{
+				type: 'ticket',
+				value: '#42',
+				href: '#42'
+			}]);
+
+			expect(linkify.find('Check out issue #9999999 and also #0')).to.be.eql([{
+				type: 'ticket',
+				value: '#9999999',
+				href: '#9999999'
+			}, {
+				type: 'ticket',
+				value: '#0',
+				href: '#0'
+			}]);
+		});
+	});
+});

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+module.exports = require('../lib/linkify/plugins/ticket').default;`