Our board.
\n\nFLEETYARDS-ABCDEFGHIJ
' ) ) - ).toEqual(["Welcome aboard.", "Our board.", "Our manifesto."]); + ).toEqual( + new Map([ + ["introduction", "Welcome aboard.
"], + ["history", "Our board.
"], + ["manifesto", "Our manifesto.
"], + ]) + ); + }); + + it("reads a section past the divs Textile nests in it", () => { + expect( + contentSections(orgPage("Inner
After
")) + ?.get("history") + ).toBe('Inner
After
'); }); it("refuses a page without text blocks", () => { - expect(contentBlocks("Our board. 
Our board. 
Same
Edited
"), + orgPage("Same
Original
") + ) + ).toBe(true); + }); + + it("reads a section one page leaves out as empty", () => { + const withEmptyCharter = `${orgPage("Our board.
")}`;
+
+ expect(
+ hasPendingChanges(withEmptyCharter, orgPage("
Our board.
")) + ).toBe(false); + }); + it("refuses to compare a page it cannot read", () => { expect(hasPendingChanges("", orgPage("x
"))).toBeNull(); }); }); + +describe("tokenOnPage", () => { + const token = "FLEETYARDS-ABCDEFGHIJ"; + + it("finds a token Textile split with a span in the history", () => { + expect( + tokenOnPage( + orgPage('Our board.
FLEETYARDS-ABCDEFGHIJ
'), + token, + "history" + ) + ).toEqual({ inField: true, elsewhere: false }); + }); + + it("tells a token in another section apart", () => { + expect( + tokenOnPage(orgPage("Our board.
", token), token, "history") + ).toEqual({ inField: false, elsewhere: true }); + }); + + it("refuses a page it cannot read", () => { + expect(tokenOnPage("", token, "history")).toBeNull(); + }); +}); diff --git a/lib/bio.ts b/lib/bio.ts index f24edd5..f60edb7 100644 --- a/lib/bio.ts +++ b/lib/bio.ts @@ -1,6 +1,8 @@ +import { appendToken, removeAppendedToken } from "./tokens"; + export const BIO_MAX_LENGTH = 1024; -export const VERIFICATION_TOKEN_PATTERN = /^FLEETYARDS-[A-Z0-9]{10}$/; +export { VERIFICATION_TOKEN_PATTERN } from "./tokens"; const ENTITIES: Record([\s\S]*?)<\/div>/g),
- ].map((match) =>
- match[1]!
- .replace(/<[^>]*>/g, "")
- .replace(/&[^;\s]+;/g, (entity) => decodeEntities(entity) ?? entity)
- .replace(TOKEN_IN_TEXT, "")
- .replace(/\s+/g, " ")
- .trim()
- );
+// Every way a rendered page shows a FleetYards token: Textile wraps the
+// capitals in a span.
+const TOKEN_IN_MARKUP =
+ /(?:)?FLEETYARDS(?:<\/span>)?-[A-Z0-9]{10}/g;
+
+const BLOCK_START = ' | null {
+ const sections = new Map();
- return blocks.length > 0 ? blocks : null;
+ for (
+ let index = html.indexOf(BLOCK_START);
+ index !== -1;
+ index = html.indexOf(BLOCK_START, index + 1)
+ ) {
+ const inner = blockAt(html, index + BLOCK_START.length);
+ if (inner === null) return null;
+
+ sections.set(sectionOf(html, index), inner);
+ }
+
+ return sections.size > 0 ? sections : null;
+}
+
+// The org's text sections for comparing two renderings of the page: markup
+// kept, so an image, a link or formatting counts as a change too; every
+// FleetYards token, the paragraphs left empty by taking one out, and
+// whitespace dropped.
+export function contentSections(html: string): Map | null {
+ const sections = rawSections(html);
+ if (!sections) return null;
+
+ return new Map(
+ [...sections].map(([name, inner]) => [
+ name,
+ inner
+ .replace(TOKEN_IN_MARKUP, "")
+ .replace(/
';
+
+// A block's inner markup up to its own closing tag: Textile's `div.` blocks
+// nest divs inside it.
+function blockAt(html: string, start: number) {
+ const tags = //g;
+ tags.lastIndex = start;
+ let depth = 1;
+
+ for (let tag = tags.exec(html); tag; tag = tags.exec(html)) {
+ depth += tag[0] === "
" ? -1 : 1;
+ if (depth === 0) return html.slice(start, tag.index);
+ }
+
+ return null;
+}
+
+// Which org text a block belongs to: the content tab it sits in, or the
+// introduction above the tabs.
+function sectionOf(html: string, index: number) {
+ const tab = [...html.slice(0, index).matchAll(/id="tab-([a-z]+)"/g)].pop();
+
+ return tab ? tab[1]! : "introduction";
+}
+
+// Each org text section's inner markup as rendered, by name. Null when the
+// page has none, or a block never closes: markup this cannot read.
+function rawSections(html: string): Map\s*<\/p>/g, "") + .replace(/\s+/g, " ") + .trim(), + ]) + ); } // Whether the org's draft holds changes besides FleetYards tokens: RSI // publishes the whole draft at once, so writing then would publish them too. +// A section one page leaves out counts as empty. export function hasPendingChanges( previewHtml: string, publicHtml: string ): boolean | null { - const draft = contentBlocks(previewHtml); - const live = contentBlocks(publicHtml); + const draft = contentSections(previewHtml); + const live = contentSections(publicHtml); if (!draft || !live) return null; - return ( - draft.length !== live.length || - draft.some((block, index) => block !== live[index]) + return [...new Set([...draft.keys(), ...live.keys()])].some( + (section) => (draft.get(section) ?? "") !== (live.get(section) ?? "") ); } + +// Where a rendered org page shows the token, Textile's markup aside: in the +// section the extension writes, or anywhere else, which it never wrote and +// cannot take out. Null for a page it cannot read. +export function tokenOnPage( + html: string, + token: string, + field: string +): { inField: boolean; elsewhere: boolean } | null { + const sections = rawSections(html); + if (!sections) return null; + + const shows = (markup: string) => markup.replace(/<[^>]*>/g, "").includes(token); + + return { + inField: shows(sections.get(field) ?? ""), + elsewhere: [...sections].some( + ([name, markup]) => name !== field && shows(markup) + ), + }; +} diff --git a/lib/tokens.ts b/lib/tokens.ts new file mode 100644 index 0000000..0ee1f4a --- /dev/null +++ b/lib/tokens.ts @@ -0,0 +1,21 @@ +export const VERIFICATION_TOKEN_PATTERN = /^FLEETYARDS-[A-Z0-9]{10}$/; + +// A verification token goes after the text, a blank line apart, and only that +// is ever taken out again: the same token placed elsewhere by hand is the +// owner's to remove. +export function appendToken(text: string, token: string) { + if (text.includes(token)) return { text, changed: false }; + + return { text: text ? `${text}\n\n${token}` : token, changed: true }; +} + +export function removeAppendedToken(text: string, token: string) { + if (text === token) return { text: "", changed: true }; + + const suffix = `\n\n${token}`; + if (text.endsWith(suffix)) { + return { text: text.slice(0, -suffix.length), changed: true }; + } + + return { text, changed: false }; +}