Skip to content

Commit

Permalink
feat(core/webidl): allow self-defining IDL (#2408)
Browse files Browse the repository at this point in the history 
* feat(core/webidl): allow self-defining IDL

* Update src/core/webidl.js

Co-Authored-By: Marcos Cáceres <marcos@marcosc.com>
  • Loading branch information
@saschanaz @marcoscaceres
saschanaz and marcoscaceres committed Jul 1, 2019
1 parent 8ffc497 commit 4b22416
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 38 deletions.
20 changes: 14 additions & 6 deletions src/core/webidl.js
View file
Expand Up @@ -75,12 +75,12 @@ const templates = {
if (data.idlType && data.idlType.type === "argument-type") {
return hyperHTML`<span class="idlParamName">${escaped}</span>`;
}
const idlAnchor = createIdlAnchor(escaped, data, parent);
const className = parent ? "idlName" : "idlID";
if (data.type === "enum-value") {
return idlAnchor;
const idlLink = defineIdlName(escaped, data, parent);
if (data.type !== "enum-value") {
const className = parent ? "idlName" : "idlID";
idlLink.classList.add(className);
}
return hyperHTML`<span class="${className}">${idlAnchor}</span>`;
return idlLink;
},
type(contents) {
return hyperHTML`<span class="idlType">${contents}</span>`;
Expand Down Expand Up @@ -108,7 +108,10 @@ const templates = {
},
};

function createIdlAnchor(escaped, data, parent) {
/**
* Returns a link to existing <dfn> or creates one if doesn’t exists.
*/
function defineIdlName(escaped, data, parent) {
const parentName = parent ? parent.name : "";
const { name } = getNameAndId(data, parentName);
const dfn = findDfn(data, name, {
Expand Down Expand Up @@ -136,6 +139,11 @@ function createIdlAnchor(escaped, data, parent) {
data-link-type="dfn"
data-lt="default toJSON operation">${escaped}</a>`;
}
if (!data.partial) {
return hyperHTML`<dfn data-export data-dfn-type="${linkType}" data-dfn-for="${parent &&
parent.name}">${escaped}</dfn>`;
}

const unlinkedAnchor = hyperHTML`<a
data-idl="${data.partial ? "partial" : null}"
data-link-type="${linkType}"
Expand Down
2 changes: 1 addition & 1 deletion tests/spec/core/dfn-finder-spec.js
View file
Expand Up @@ -27,7 +27,7 @@ describe("Core — Definition finder", () => {
body: makeDefaultBody() + bodyText,
};
const doc = await makeRSDoc(ops);
const [dfn] = doc.getElementsByTagName("dfn");
const [, dfn] = doc.getElementsByTagName("dfn");
expect(dfn.dataset.lt).toBe("bar()|bar|foo.bar()|foo.bar");
expect(dfn.classList.contains("respec-offending-element")).toBeFalsy();
});
Expand Down
80 changes: 49 additions & 31 deletions tests/spec/core/webidl-spec.js
View file
Expand Up @@ -87,7 +87,7 @@ describe("Core - WebIDL", () => {
);

// Promise&lt;void> returnsPromise(unsigned long long argument);
const [promiseLink, voidLink, , unsignedLongLink] = idl.querySelectorAll(
const [promiseLink, voidLink, unsignedLongLink] = idl.querySelectorAll(
"*[data-title='returnsPromise'] a"
);
// Promise
Expand Down Expand Up @@ -126,7 +126,7 @@ describe("Core - WebIDL", () => {
mapLike,
] = similarlyNamedInterface.querySelectorAll(".idlAttribute, .idlMaplike");
const typeQuery = "span.idlType a";
const nameQuery = "span.idlName a";
const nameQuery = "a.idlName";
// attribute TestInterface testInterface;
expect(testInterface.querySelector(typeQuery).getAttribute("href")).toBe(
"#dom-testinterface"
Expand Down Expand Up @@ -269,20 +269,18 @@ describe("Core - WebIDL", () => {

target = doc.getElementById("if-doc");
const interfaces = target.querySelectorAll(".idlInterface");
expect(interfaces[0].querySelector(".idlID a").getAttribute("href")).toBe(
expect(interfaces[0].querySelector("a.idlID").getAttribute("href")).toBe(
"#dom-docinterface"
);
expect(interfaces[1].querySelector(".idlID a").getAttribute("href")).toBe(
expect(interfaces[1].querySelector("a.idlID").getAttribute("href")).toBe(
"#dom-docisnotcasesensitive"
);
expect(interfaces[0].id).toBe("idl-def-docinterface");
expect(interfaces[1].id).toBe("idl-def-docisnotcasesensitive");
expect(interfaces[2].id).toBe("idl-def-undocinterface");
expect(
interfaces[2].querySelector(".idlID a.respec-offending-element")
).toBeTruthy();
expect(interfaces[2].querySelector("dfn.idlID")).toBeTruthy();
const namespace = target.querySelector(".idlNamespace");
expect(namespace.querySelector(".idlID a").getAttribute("href")).toBe(
expect(namespace.querySelector("a.idlID").getAttribute("href")).toBe(
"#dom-afterglow"
);
});
Expand Down Expand Up @@ -387,7 +385,7 @@ describe("Core - WebIDL", () => {
expect(
consts
.find(c => c.textContent.includes("rambaldi"))
.querySelector(".idlName a")
.querySelector("a.idlName")
.getAttribute("href")
).toBe("#dom-consttest-rambaldi");
expect(
Expand All @@ -396,19 +394,19 @@ describe("Core - WebIDL", () => {
expect(
consts
.find(c => c.textContent.includes("bite"))
.querySelector(".idlName a")
.querySelector("a.idlName")
.getAttribute("href")
).toBe("#dom-consttest-bite");
expect(
consts
.find(c => c.textContent.includes("inf"))
.querySelector(".idlName a")
.querySelector("a.idlName")
.getAttribute("href")
).toBe("#dom-consttest-inf");
expect(
consts
.find(c => c.textContent.includes("ationDevice"))
.querySelector(".idlName a.respec-offending-element")
.querySelector("dfn.idlName")
).toBeTruthy();
});

Expand Down Expand Up @@ -456,13 +454,13 @@ describe("Core - WebIDL", () => {
expect(
attrs
.find(c => c.textContent.includes("regular"))
.querySelector(".idlName a")
.querySelector("a.idlName")
.getAttribute("href")
).toBe("#dom-attrbasic-regular");
expect(
attrs
.find(c => c.textContent.includes("alist"))
.querySelector(".idlName a.respec-offending-element")
.querySelector("dfn.idlName")
).toBeTruthy();

const performanceInterfaceLink = Array.from(
Expand Down Expand Up @@ -583,13 +581,13 @@ describe("Core - WebIDL", () => {
// Links and IDs.
const ulls = methods
.filter(m => m.textContent.includes("ull"))
.map(m => m.querySelector(".idlName a").getAttribute("href"));
.map(m => m.querySelector("a.idlName").getAttribute("href"));
expect(ulls[0]).toBe("#dom-methbasic-ull");
expect(ulls[ulls.length - 1]).toBe("#dom-methbasic-ull!overload-1");
expect(
methods
.find(m => m.textContent.includes("withName"))
.querySelector(".idlName a.respec-offending-element")
.querySelector("dfn.idlName")
).toBeTruthy();

const performanceTypeLink = Array.from(target.querySelectorAll("a")).find(
Expand Down Expand Up @@ -704,27 +702,27 @@ interface ReadOnlySetLike {
const dictDocTest = doc
.getElementById("dict-doc")
.querySelector(".idlDictionary");
expect(dictDocTest.querySelector(".idlID a").getAttribute("href")).toBe(
expect(dictDocTest.querySelector("a.idlID").getAttribute("href")).toBe(
"#dom-dictdoctest"
);
expect(dictDocTest.getAttribute("id")).toBe("idl-def-dictdoctest");
const mems = [...dictDocTest.querySelectorAll(".idlMember")];
const dictDocField = mems.find(m => m.textContent.includes("dictDocField"));
expect(dictDocField.querySelector(".idlName a").getAttribute("href")).toBe(
expect(dictDocField.querySelector("a.idlName").getAttribute("href")).toBe(
"#dom-dictdoctest-dictdocfield"
);
expect(
mems
.find(m => m.textContent.includes("otherField"))
.querySelector(".idlName a")
.querySelector("a.idlName")
.getAttribute("href")
).toBe("#dom-dictdoctest-otherfield");
expect(dictDocField.getAttribute("id")).toBe(
"idl-def-dictdoctest-dictdocfield"
);
const warningLink = mems
.find(m => m.textContent.includes("undocField"))
.querySelector(".idlName a.respec-offending-element");
.querySelector("dfn.idlName");
expect(warningLink).toBeTruthy();
});

Expand Down Expand Up @@ -802,7 +800,7 @@ enum EnumBasic {
target.querySelector("a[href='#dom-enumbasic-white-space']")
).toBeTruthy();
// Links and IDs.
expect(target.querySelector(".idlID a").getAttribute("href")).toBe(
expect(target.querySelector("a.idlID").getAttribute("href")).toBe(
"#dom-enumbasic"
);
expect(doc.getElementById("idl-def-enumbasic")).toBeTruthy();
Expand Down Expand Up @@ -907,9 +905,9 @@ callback CallBack = Z? (X x, optional Y y, /*trivia*/ optional Z z);
expect(target.textContent).toBe(text);

// Links and IDs.
expect(
target.querySelector(".idlID").children[0].getAttribute("href")
).toBe("#dom-tdlessbasic");
expect(target.querySelector(".idlID").getAttribute("href")).toBe(
"#dom-tdlessbasic"
);
expect(target.querySelector(".idlTypedef").id).toBe("idl-def-tdlessbasic");

target = doc.getElementById("td-extended-attribute");
Expand Down Expand Up @@ -944,7 +942,7 @@ callback CallBack = Z? (X x, optional Y y, /*trivia*/ optional Z z);
const target = doc.getElementById("doc-iface");

expect(
target.querySelector(".idlName a[href='#dom-documented-docstring']")
target.querySelector("a.idlName[href='#dom-documented-docstring']")
.textContent
).toBe("docString");
expect(
Expand All @@ -962,9 +960,7 @@ callback CallBack = Z? (X x, optional Y y, /*trivia*/ optional Z z);
"p[data-link-for] a[href='#dom-documented-docstring']"
).textContent
).toBe("docString");
const notDefinedAttr = target.querySelectorAll(
".idlAttribute .idlName .respec-offending-element"
);
const notDefinedAttr = target.querySelectorAll(".idlAttribute dfn.idlName");
expect(notDefinedAttr.length).toBe(1);
expect(notDefinedAttr[0].getElementsByTagName("a").length).toBe(0);
expect(notDefinedAttr[0].textContent).toBe("notDefined");
Expand All @@ -982,9 +978,8 @@ callback CallBack = Z? (X x, optional Y y, /*trivia*/ optional Z z);
);
expect(definedElsewhere.textContent).toBe("Documented.definedElsewhere");
expect(
target.querySelector(
".idlName a[href='#dom-documented-definedelsewhere']"
).textContent
target.querySelector("a.idlName[href='#dom-documented-definedelsewhere']")
.textContent
).toBe("definedElsewhere");
expect(linkFromElsewhere.textContent).toBe("Documented.docString");

Expand Down Expand Up @@ -1293,4 +1288,27 @@ callback CallBack = Z? (X x, optional Y y, /*trivia*/ optional Z z);
expect(itWorksMember.classList).toContain("internalDFN");
expect(itWorksMember.getAttribute("href")).toBe("#dom-eventinit-itworks");
});
it("self-defining IDL", async () => {
const body = `
<section>
<pre class="idl">
interface RASAintShared {
attribute DOMString layer;
};
partial interface TeaTime {};
</pre>
</section>
`;
const ops = makeStandardOps(null, body);
const doc = await makeRSDoc(ops);
const [it, attr] = doc.querySelectorAll("pre dfn");

expect(it.classList).not.toContain("respec-offending-element");
expect(it.dataset.dfnType).toBe("interface");
expect(it.dataset.export).toBe("");
expect(attr.dataset.dfnType).toBe("attribute");

const tea = doc.querySelector(".respec-offending-element");
expect(tea.textContent).toBe("TeaTime");
});
});

0 comments on commit 4b22416

Please sign in to comment.