Support for table & ol tags for HTML pasting in composer

This commit is contained in:
Vinoth Kannan 2017-12-20 19:24:55 +05:30
parent e49c7147ce
commit ac1d3a761e
2 changed files with 88 additions and 18 deletions
app/assets/javascripts/discourse/lib
test/javascripts/lib

@ -29,9 +29,8 @@ class Tag {
} }
static blocks() { static blocks() {
return ["address", "article", "aside", "dd", "div", "dl", "dt", "fieldset", return ["address", "article", "aside", "dd", "div", "dl", "dt", "fieldset", "figcaption", "figure",
"figcaption", "figure", "footer", "form", "header", "hgroup", "hr", "main", "nav", "footer", "form", "header", "hgroup", "hr", "main", "nav", "p", "pre", "section", "ul"];
"ol", "p", "pre", "section", "table", "ul"];
} }
static headings() { static headings() {
@ -47,7 +46,7 @@ class Tag {
} }
static trimmable() { static trimmable() {
return [...Tag.blocks(), ...Tag.headings(), ...Tag.slices(), "li", "td", "th", "br", "hr", "blockquote"]; return [...Tag.blocks(), ...Tag.headings(), ...Tag.slices(), "li", "td", "th", "br", "hr", "blockquote", "table", "ol"];
} }
static block(name, prefix, suffix) { static block(name, prefix, suffix) {
@ -116,7 +115,7 @@ class Tag {
decorate(text) { decorate(text) {
const attr = this.element.attributes; const attr = this.element.attributes;
if (attr && attr.href && text !== attr.href) { if (attr.href && text !== attr.href) {
text = text.replace(/\n{2,}/g, "\n"); text = text.replace(/\n{2,}/g, "\n");
return "[" + text + "](" + attr.href + ")"; return "[" + text + "](" + attr.href + ")";
} }
@ -134,7 +133,7 @@ class Tag {
toMarkdown() { toMarkdown() {
const e = this.element; const e = this.element;
const attr = e.attributes || {}; const attr = e.attributes;
const pAttr = (e.parent && e.parent.attributes) || {}; const pAttr = (e.parent && e.parent.attributes) || {};
const src = attr.src || pAttr.src; const src = attr.src || pAttr.src;
@ -171,13 +170,31 @@ class Tag {
} }
static cell(name) { static cell(name) {
return Tag.slice(name, " "); return class extends Tag {
constructor() {
super(name, "|");
}
toMarkdown() {
const text = this.element.innerMarkdown().trim();
if (text.includes("\n") || text.includes("[![")) {
throw "Unsupported format inside Markdown table cells";
}
if (!this.element.next) {
this.suffix = "|";
}
return this.decorate(text);
}
};
} }
static li() { static li() {
return class extends Tag.slice("li", "\n") { return class extends Tag.slice("li", "\n") {
decorate(text) { decorate(text) {
const indent = this.element.filterParentNames("ul").slice(1).map(() => " ").join(""); const indent = this.element.filterParentNames(["ol", "ul"]).slice(1).map(() => " ").join("");
return super.decorate(`${indent}* ${trimLeft(text)}`); return super.decorate(`${indent}* ${trimLeft(text)}`);
} }
}; };
@ -214,6 +231,32 @@ class Tag {
}; };
} }
static table() {
return class extends Tag.block("table") {
decorate(text) {
text = super.decorate(text);
const splitterRow = text.split("|\n")[0].match(/\|/g).map(() => "| --- ").join("") + "|\n";
text = text.replace("|\n", "|\n" + splitterRow).replace(/\|\n{2,}\|/g, "|\n|");
return text;
}
};
}
static ol() {
return class extends Tag.block("ol") {
decorate(text) {
text = "\n" + text;
const bullet = text.match(/\n *\*/)[0];
for (let i = parseInt(this.element.attributes.start || 1); text.includes(bullet); i++) {
text = text.replace(bullet, bullet.replace("*", `${i}.`));
}
return super.decorate(text.slice(1));
}
};
}
} }
const tags = [ const tags = [
@ -224,10 +267,7 @@ const tags = [
Tag.cell("td"), Tag.cell("th"), Tag.cell("td"), Tag.cell("th"),
Tag.replace("br", "\n"), Tag.replace("hr", "\n---\n"), Tag.replace("head", ""), Tag.replace("br", "\n"), Tag.replace("hr", "\n---\n"), Tag.replace("head", ""),
Tag.keep("ins"), Tag.keep("del"), Tag.keep("small"), Tag.keep("big"), Tag.keep("ins"), Tag.keep("del"), Tag.keep("small"), Tag.keep("big"),
Tag.li(), Tag.link(), Tag.image(), Tag.code(), Tag.blockquote(), Tag.li(), Tag.link(), Tag.image(), Tag.code(), Tag.blockquote(), Tag.table(),, Tag.ol(),
// TO-DO CREATE: tbody
// UPDATE: ol, thead, th, td
]; ];
class Element { class Element {
@ -236,7 +276,7 @@ class Element {
this.type = element.type; this.type = element.type;
this.data = element.data; this.data = element.data;
this.children = element.children; this.children = element.children;
this.attributes = element.attributes; this.attributes = element.attributes || {};
if (parent) { if (parent) {
this.parent = parent; this.parent = parent;
@ -294,8 +334,8 @@ class Element {
} }
} }
filterParentNames(name) { filterParentNames(names) {
return this.parentNames.filter(p => p === name); return this.parentNames.filter(p => names.includes(p));
} }
static toMarkdown(element, parent, prev, next) { static toMarkdown(element, parent, prev, next) {

@ -67,7 +67,7 @@ QUnit.test("converts heading tags", assert => {
assert.equal(toMarkdown(html), markdown); assert.equal(toMarkdown(html), markdown);
}); });
QUnit.test("converts ul and ol list tags", assert => { QUnit.test("converts ul list tag", assert => {
const html = ` const html = `
<ul> <ul>
<li>Item 1</li> <li>Item 1</li>
@ -95,7 +95,7 @@ QUnit.test("stripes unwanted inline tags", assert => {
assert.equal(toMarkdown(html), markdown); assert.equal(toMarkdown(html), markdown);
}); });
QUnit.test("converts table as readable", assert => { QUnit.test("converts table tags", assert => {
const html = `<address>Discourse Avenue</address><b>laboris</b> const html = `<address>Discourse Avenue</address><b>laboris</b>
<table> <table>
<thead> <tr><th>Heading 1</th><th>Head 2</th></tr> </thead> <thead> <tr><th>Heading 1</th><th>Head 2</th></tr> </thead>
@ -104,10 +104,21 @@ QUnit.test("converts table as readable", assert => {
<tr><td><b>dolor</b></td> <td><i>sit amet</i></td></tr></tbody> <tr><td><b>dolor</b></td> <td><i>sit amet</i></td></tr></tbody>
</table> </table>
`; `;
const markdown = `Discourse Avenue\n\n**laboris**\n\nHeading 1 Head 2\n\nLorem ipsum\n**dolor** _sit amet_`; const markdown = `Discourse Avenue\n\n**laboris**\n\n|Heading 1|Head 2|\n| --- | --- |\n|Lorem|ipsum|\n|**dolor**|_sit amet_|`;
assert.equal(toMarkdown(html), markdown); assert.equal(toMarkdown(html), markdown);
}); });
QUnit.test("returns empty string if table format not supported", assert => {
const html = `<table>
<thead> <tr><th>Headi\n\nng 1</th><th>Head 2</th></tr> </thead>
<tbody>
<tr><td>Lorem</td><td>ipsum</td></tr>
<tr><td><a href="http://example.com"><img src="http://dolor.com/image.png" /></a></td> <td><i>sit amet</i></td></tr></tbody>
</table>
`;
assert.equal(toMarkdown(html), "");
});
QUnit.test("converts img tag", assert => { QUnit.test("converts img tag", assert => {
const url = "https://example.com/image.png"; const url = "https://example.com/image.png";
let html = `<img src="${url}" width="100" height="50">`; let html = `<img src="${url}" width="100" height="50">`;
@ -184,3 +195,22 @@ QUnit.test("converts blockquote tag", assert => {
output = "> Lorem ipsum\n> > dolor\n> > > sit\n> > amet"; output = "> Lorem ipsum\n> > dolor\n> > > sit\n> > amet";
assert.equal(toMarkdown(html), output); assert.equal(toMarkdown(html), output);
}); });
QUnit.test("converts ol list tag", assert => {
const html = `Testing
<ol>
<li>Item 1</li>
<li>
Item 2
<ol start="100">
<li>Sub Item 1</li>
<li>Sub Item 2</li>
<ul><li>Sub <i>Sub</i> Item 1</li><li>Sub <b>Sub</b> Item 2</li></ul>
</ol>
</li>
<li>Item 3</li>
</ol>
`;
const markdown = `Testing\n\n1. Item 1\n2. Item 2\n\n 100. Sub Item 1\n 101. Sub Item 2\n\n * Sub _Sub_ Item 1\n * Sub **Sub** Item 2\n\n3. Item 3`;
assert.equal(toMarkdown(html), markdown);
});