Refactored Linkifier class into single function

Modified design so that linkify interacts with MessageBodyBuilder
through callbacks.

Signed-off-by: RMidhunSuresh <rmidhunsuresh@gmail.com>
This commit is contained in:
RMidhunSuresh 2021-05-10 21:30:11 +05:30
parent dca649dfd4
commit 787d438a74
2 changed files with 12 additions and 173 deletions

View file

@ -1,173 +0,0 @@
import { MessageBodyBuilder } from "./MessageBodyBuilder.js";
export class Linkifier {
/**
* @param {String} text Text to linkify
*/
constructor(text) {
this._text = text;
this._curr = 0;
this._message = new MessageBodyBuilder();
}
/**
* Separate string into text, newlines and add them into message object.
* @param {String} text
*/
_addTextToMessage(text) {
const components = text.split("\n");
components.slice(0, -1).forEach(t => {
this._message.insertText(t);
this._message.insertNewline();
});
const [last] = components.slice(-1);
this._message.insertText(last);
}
/**
* Add text from this._curr upto start of supplied match into message object.
* If match is not provided, everything from this._curr to the end of
* this._text is added as text to the message object.
* @param {Array} [match] regex match
*/
_handleText(match) {
const index = match?.index;
const text = this._text.slice(this._curr, index);
this._addTextToMessage(text);
const len = match?.[0].length;
this._curr = index + len;
}
/**
* Splits message text into parts (text, newline and links)
* @returns {MessageBodyBuilder} Object representation of chat message
*/
linkify() {
const regex = /(?:https|http|ftp):\/\/[a-zA-Z0-9:.\[\]#-]+(?:\/[^\s]*[^\s.,?!]|[^\s\u{80}-\u{10ffff}.,?!])/gui
const matches = this._text.matchAll(regex);
for (let match of matches) {
const link = match[0];
this._handleText(match);
this._message.insertLink(link, link);
}
this._handleText();
return this._message;
}
}
export function tests() {
function linkify(text) {
const obj = new Linkifier(text);
return obj.linkify();
}
function test(assert, input, output) {
output = new MessageBodyBuilder(output);
input = linkify(input);
assert.deepEqual(input, output);
}
function testLink(assert, link, expectFail = false) {
const input = link;
const output = expectFail ? [{ type: "text", text: input }] :
[{ type: "link", url: input, text: input }];
test(assert, input, output);
}
return {
// Tests for text
"Text only": assert => {
const input = "This is a sentence";
const output = [{ type: "text", text: input }];
test(assert, input, output);
},
"Text with newline": assert => {
const input = "This is a sentence.\nThis is another sentence.";
const output = [
{ type: "text", text: "This is a sentence." },
{ type: "newline" },
{ type: "text", text: "This is another sentence." }
];
test(assert, input, output);
},
"Text with newline & trailing newline": assert => {
const input = "This is a sentence.\nThis is another sentence.\n";
const output = [
{ type: "text", text: "This is a sentence." },
{ type: "newline" },
{ type: "text", text: "This is another sentence." },
{ type: "newline" }
];
test(assert, input, output);
},
// Tests for links
"Link with host": assert => {
testLink(assert, "https://matrix.org");
},
"Link with host & path": assert => {
testLink(assert, "https://matrix.org/docs/develop");
},
"Link with host & fragment": assert => {
testLink(assert, "https://matrix.org#test");
},
"Link with host & query": assert => {
testLink(assert, "https://matrix.org/?foo=bar");
},
"Complex link": assert => {
const link = "https://www.foobar.com/url?sa=t&rct=j&q=&esrc=s&source" +
"=web&cd=&cad=rja&uact=8&ved=2ahUKEwjyu7DJ-LHwAhUQyzgGHc" +
"OKA70QFjAAegQIBBAD&url=https%3A%2F%2Fmatrix.org%2Fdocs%" +
"2Fprojects%2Fclient%2Felement%2F&usg=AOvVaw0xpENrPHv_R-" +
"ERkyacR2Bd";
testLink(assert, link);
},
"Localhost link": assert => {
testLink(assert, "http://localhost");
testLink(assert, "http://localhost:3000");
},
"IPV4 link": assert => {
testLink(assert, "https://192.0.0.1");
testLink(assert, "https://250.123.67.23:5924");
},
"IPV6 link": assert => {
testLink(assert, "http://[2001:0db8:85a3:0000:0000:8a2e:0370:7334]");
testLink(assert, "http://[2001:0db8:85a3:0000:0000:8a2e:0370:7334]:7000");
},
"Missing scheme must not linkify": assert => {
testLink(assert, "matrix.org/foo/bar", true);
},
"Punctuation at end of link must not linkify": assert => {
const link = "https://foo.bar/?nenjil=lal810";
const end = ".,? ";
for (const char of end) {
const out = [{ type: "link", url: link, text: link }, { type: "text", text: char }];
test(assert, link + char, out);
}
},
"Unicode in hostname must not linkify": assert => {
const link = "https://foo.bar\uD83D\uDE03.com";
const out = [{ type: "link", url: "https://foo.bar", text: "https://foo.bar" },
{ type: "text", text: "\uD83D\uDE03.com" }];
test(assert, link, out);
},
"Link with unicode only after / must linkify": assert => {
testLink(assert, "https://foo.bar.com/\uD83D\uDE03");
}
};
}

View file

@ -0,0 +1,12 @@
export function linkify(text, callback) {
const regex = /(?:https|http|ftp):\/\/[a-zA-Z0-9:.\[\]#-]+(?:\/[^\s]*[^\s.,?!]|[^\s\u{80}-\u{10ffff}.,?!])/gui
const matches = text.matchAll(regex);
let curr = 0;
for (let match of matches) {
callback(match[0], true);
callback(text.slice(curr, match.index), false);
const len = match[0].length;
curr = match.index + len;
}
callback(text.slice(curr), false);
}