highmark-markdown 1.0.177 → 1.0.178

package/src/ruleNames.js

@@ -1,5 +1,6 @@
 "use strict";
 
+export const HTML_RULE_NAME = "html";
 export const LINE_RULE_NAME = "line";
 export const PATH_RULE_NAME = "path";
 export const IMAGE_RULE_NAME = "image";
@@ -8,7 +9,7 @@ export const ERROR_RULE_NAME = "error";
 export const COMMA_RULE_NAME = "comma";
 export const ANCHOR_RULE_NAME = "anchor";
 export const FOOTER_RULE_NAME = "footer";
-export const TOPMOST_RULE_NAME = "markdown";  ///
+export const MARKDOWN_RULE_NAME = "markdown";
 export const DIVISION_RULE_NAME = "division";
 export const FOOTNOTE_RULE_NAME = "footnote";
 export const NONSENSE_RULE_NAME = "nonsense";
@@ -70,6 +71,7 @@ export const PAGE_NUMBER_DIRECTIVE_RULE_NAME = "pageNumberDirective";
 export const STRONGLY_EMPHASISED_TEXT_RULE_NAME = "stronglyEmphasisedText";
 
 const ruleNames = {
+  HTML_RULE_NAME,
   LINE_RULE_NAME,
   PATH_RULE_NAME,
   COMMA_RULE_NAME,
@@ -77,7 +79,7 @@ const ruleNames = {
   TABLE_RULE_NAME,
   ERROR_RULE_NAME,
   ANCHOR_RULE_NAME,
-  TOPMOST_RULE_NAME,
+  MARKDOWN_RULE_NAME,
   DIVISION_RULE_NAME,
   FOOTNOTE_RULE_NAME,
   NONSENSE_RULE_NAME,

package/src/transform/{subDivision/contentsDirective.js → contentsDirective.js}

@@ -2,8 +2,6 @@
 
 import SubDivisionTransform from "../subDivision";
 
-import { contentsDirectiveMarkdownNodeFromNode } from "../../utilities/query";
-
 export default class ContentsDirectiveSubDivisionTransform extends SubDivisionTransform {
   static fromSubDivisionMarkdownNode(subDivisionMarkdownNode, context) {
     let contentsDirectiveSubDivisionTransform = null;

package/src/transform/contentsList.js

@@ -7,7 +7,6 @@ import ContentsItemTransform from "../transform/contentsItem";
 import ContentsListMarkdownNode from "../node/markdown/list/contents";
 
 import { nestNodes } from "../utilities/contents";
-import { headingMarkdownNodesFromNode } from "../utilities/query";
 
 const { filter } = arrayUtilities;
 

package/src/transform/footnote.js

@@ -2,8 +2,6 @@
 
 import { Transform } from "occam-dom";
 
-import { footnoteMarkdownNodeFromNode } from "../utilities/query";
-
 export default class FootnoteTransform extends Transform {
   constructor(node, tokens, number) {
     super(node, tokens);

package/src/transform/{subDivision/footnote.js → footnoteIdentifier.js}

@@ -2,8 +2,6 @@
 
 import SubDivisionTransform from "../subDivision";
 
-import { footnoteMarkdownNodeFromNode } from "../../utilities/query";
-
 export default class FootnoteSubDivisionTransform extends SubDivisionTransform {
   identifier(context) {
     const subDivisionMarkdownNode = this.getSubDivisionMarkdownNode(),

package/src/transform/{subDivision/footnotesDirective.js → footnotesDirective.js}

@@ -2,8 +2,6 @@
 
 import SubDivisionTransform from "../subDivision";
 
-import { footnotesDirectiveMarkdownNodeFromNode } from "../../utilities/query";
-
 export default class FootnotesDirectiveSubDivisionTransform extends SubDivisionTransform {
   static fromSubDivisionMarkdownNode(subDivisionMarkdownNode, context) {
     let footnotesDirectiveSubDivisionTransform = null;

package/src/transform/footnotesList.js

@@ -5,8 +5,6 @@ import { Transform } from "occam-dom";
 import FootnotesItemTransform from "../transform/footnotesItem";
 import FootnotesListMarkdownNode from "../node/markdown/list/footnotes";
 
-import { footnoteLinkMarkdownNodesFromNode } from "../utilities/query";
-
 export default class FootnotesListTransform extends Transform {
   replaceFootnotesDirectiveSubDivisionTransform(footnotesDirectiveSubDivisionTransform, divisionMarkdownNode, context) {
     const subDivisionMarkdownNode = footnotesDirectiveSubDivisionTransform.getSubDivisionMarkdownNode(),

package/src/transform/{subDivision/indexDirective.js → indexDirective.js}

@@ -2,8 +2,6 @@
 
 import SubDivisionTransform from "../subDivision";
 
-import { indexDirectiveMarkdownNodeFromNode } from "../../utilities/query";
-
 export default class IndexDirectiveSubDivisionTransform extends SubDivisionTransform {
   static fromSubDivisionMarkdownNode(subDivisionMarkdownNode, context) {
     let indexDirectiveSubDivisionTransform = null;

package/src/transform/{embedDirective.js → markdown/directive/embed.js}

@@ -2,7 +2,7 @@
 
 import { Transform } from "occam-dom";
 
-export default class EmbedDirectiveTransform extends Transform {
+export default class EmbedDirectiveMarkdownTransform extends Transform {
   addAfterSubDivisionMarkdownNode(subDivisionMarkdownNode, divisionMarkdownNode, context) {
     const existingNode = subDivisionMarkdownNode, ///
           parentNode = divisionMarkdownNode;  ///
@@ -12,8 +12,8 @@ export default class EmbedDirectiveTransform extends Transform {
 
   static fromSubDivisionMarkdownNodeAndTokens(subDivisionMarkdownNode, tokens) {
     const node = subDivisionMarkdownNode,  ///
-          embedDirectiveTransform = Transform.fromNodeAndTokens(EmbedDirectiveTransform, node, tokens);
+          embedDirectiveMarkdownTransform = Transform.fromNodeAndTokens(EmbedDirectiveMarkdownTransform, node, tokens);
 
-    return embedDirectiveTransform;
+    return embedDirectiveMarkdownTransform;
   }
 }

package/src/transform/{ignoreDirective.js → markdown/directive/ignore.js}

@@ -2,7 +2,7 @@
 
 import { Transform } from "occam-dom";
 
-export default class IgnoreDirectiveTransform extends Transform {
+export default class IgnoreDirectiveMarkdownTransform extends Transform {
   removeFromTopmostMarkdownNode(topmostMarkdownNode, context) {
     const parentNode = topmostMarkdownNode; ///
 
@@ -12,8 +12,8 @@ export default class IgnoreDirectiveTransform extends Transform {
   static fromDivisionMarkdownNode(divisionMarkdownNode) {
     const node = divisionMarkdownNode,  ///
           tokens = null,
-          includeDirectiveTransform = Transform.fromNodeAndTokens(IgnoreDirectiveTransform, node, tokens);
+          ignoredDirectiveMarkdownTransform = Transform.fromNodeAndTokens(IgnoreDirectiveMarkdownTransform, node, tokens);
 
-    return includeDirectiveTransform;
+    return ignoredDirectiveMarkdownTransform;
   }
 }

package/src/transform/{includeDirective.js → markdown/directive/include.js}

@@ -2,7 +2,7 @@
 
 import { Transform } from "occam-dom";
 
-export default class IncludeDirectiveTransform extends Transform {
+export default class IncludeDirectiveMarkdownTransform extends Transform {
   getDivisionMarkdownNode() {
     const node = this.getNode(),
           divisionMarkdownNode = node;  ///
@@ -22,8 +22,8 @@ export default class IncludeDirectiveTransform extends Transform {
 
   static fromDivisionMarkdownNodeAndTokens(divisionMarkdownNode, tokens) {
     const node = divisionMarkdownNode,  ///
-          includeDirectiveTransform = Transform.fromNodeAndTokens(IncludeDirectiveTransform, node, tokens);
+          includeDirectiveMarkdownTransform = Transform.fromNodeAndTokens(IncludeDirectiveMarkdownTransform, node, tokens);
 
-    return includeDirectiveTransform;
+    return includeDirectiveMarkdownTransform;
   }
 }

package/src/transform/{subDivision.js → markdown/subDivision.js}

@@ -2,7 +2,7 @@
 
 import { Transform } from "occam-dom";
 
-export default class SubDivisionTransform extends Transform {
+export default class SubDivisionMarkdownTransform extends Transform {
   constructor(node, tokens, subDivisionMarkdownNode) {
     super(node, tokens);
 
@@ -18,8 +18,8 @@ export default class SubDivisionTransform extends Transform {
   static fromSubDivisionMarkdownNode(subDivisionMarkdownNode) {
     const node = subDivisionMarkdownNode, ///
           tokens = null,
-          subDivisionTransform = Transform.fromNodeAndTokens(SubDivisionTransform, node, tokens);
+          subDivisionMarkdownTransform = Transform.fromNodeAndTokens(SubDivisionMarkdownTransform, node, tokens);
 
-    return subDivisionTransform;
+    return subDivisionMarkdownTransform;
   }
 }

package/src/transform/{subDivision/pageNumberDirective.js → pageNumberDirective.js}

@@ -2,8 +2,6 @@
 
 import SubDivisionTransform from "../subDivision";
 
-import { pageNumberDirectiveMarkdownNodeFromNode } from "../../utilities/query";
-
 export default class PageNumberDirectiveSubDivisionTransform extends SubDivisionTransform {
   static fromSubDivisionMarkdownNode(subDivisionMarkdownNode, context) {
     let pageNumberDirectiveSubDivisionTransform = null;

package/src/utilities/dom.js

@@ -0,0 +1,58 @@
+"use strict";
+
+import { nodeUtilities } from "occam-dom";
+
+import queries from "../queries";
+import HTMLNode from "../node/html";
+import htmlNodeMap from "../map/node/html";
+import TopmostHTMLNode from "../node/html/topmost";
+
+import { nodesFromNodeAndQueries } from "../utilities/query";
+
+const { topmostNodeFromOuterNodes } = nodeUtilities;
+
+export function htmlNodeFromMarkdownNode(markdownNode) {
+  const node = markdownNode,  ///
+        nodes = nodesFromNodeAndQueries(node, queries),
+        outerNodes = nodes, ///
+        topmostNOde = topmostNodeFromOuterNodes(ClassFromOuterNode, outerNodes),
+        topmostHTMLNode = topmostNOde;  ///
+
+  return topmostHTMLNode;
+}
+
+export function htmlNodeFromMarkdownNodes(markdownNodes) {
+  const nodes = [];
+
+  markdownNodes.forEach((markdownNode) => {
+    const node = markdownNode;  ///
+
+    nodesFromNodeAndQueries(node, queries, nodes);
+  });
+
+  const outerNodes = nodes, ///
+        topmostNOde = topmostNodeFromOuterNodes(ClassFromOuterNode, outerNodes),
+        topmostHTMLNode = topmostNOde;  ///
+
+  return topmostHTMLNode;
+}
+
+export default {
+  htmlNodeFromMarkdownNode,
+  htmlNodeFromMarkdownNodes
+};
+
+function ClassFromOuterNode(outerNode) {
+  let Class;
+
+  if (outerNode === null) {
+    Class = TopmostHTMLNode;  ///
+  } else {
+    const nonTerminalNode = outerNode,  ///
+          ruleName = nonTerminalNode.getRuleName();
+
+    Class = htmlNodeMap[ruleName] || HTMLNode;
+  }
+
+  return Class;
+}

package/src/utilities/footnotes.js

@@ -2,8 +2,6 @@
 
 import FootnotesListMarkdownNode from "../node/markdown/list/footnotes";
 
-import { footnoteLinkMarkdownNodesFromNode } from "../utilities/query";
-
 export function renumberFootnoteLinkMarkdownNodes(divisionMarkdownNode, footnoteReplacementMap, context) {
   const node = divisionMarkdownNode,  ///
         footnoteLinkMarkdownNodes = footnoteLinkMarkdownNodesFromNode(node);

package/src/utilities/html.js

@@ -1,71 +1,144 @@
 "use strict";
 
-export function postProcess(divisionMarkdownNodes, context) {
-  // const footnoteReplacementMap = prepareFootnotes(divisionMarkdownNodes, context),
-  //       markdownNodes = paginate(divisionMarkdownNodes, context);
-  //
-  // divisionMarkdownNodes = divisionMarkdownNodesFromMarkdownNodes(markdownNodes);  ///
-  //
-  // createFootnotes(divisionMarkdownNodes, footnoteReplacementMap, context);
-  //
-  // createContents(divisionMarkdownNodes, context);
-  //
-  // createIndex(divisionMarkdownNodes, context);
-}
+import { Query } from "occam-query";
+
+import { nodeFromNodeAndQuery, nodesFromNodeAndQuery } from "../utilities/query";
+
+const footnoteHTMLNodeQuery = Query.fromExpressionString("/division/footnote"),
+      ignoreDirectiveHTMLNodeQuery = Query.fromExpressionString("/division/subDivision/directives/ignoreDirective"),
+      contentsDirectiveHTMLNodeQuery = Query.fromExpressionString("/division/subDivision/directives/contentsDirective"),
+      footnotesDirectiveHTMLNodeQuery = Query.fromExpressionString("/division/subDivision/directives/footnotesDirective"),
+      pageNumberDirectiveHTMLNodeQuery = Query.fromExpressionString("//directives/pageNumber"),  ///
+      headingHTMLNodesQuery = Query.fromExpressionString("/division/primaryHeading|secondaryHeading|tertiaryHeading|quaternaryHeading"),  ///
+      divisionHTMLNodesQuery = Query.fromExpressionString("/html/division"),  ///
+      footnotesHTMLNodesQuery = Query.fromExpressionString("//footnote|footnoteLink|footnotesDirective"), ///
+      footnoteLinkHTMLNodesQuery = Query.fromExpressionString("//footnoteLink");
 
-function paginate(divisionMarkdownNodes, context) {
-  const pageNumber = 1,
-        markdownNOdes = [];
+export function footnoteHTMLNodeFromNode(node) {
+  const footnoteHTMLNode = nodeFromNodeAndQuery(node, footnoteHTMLNodeQuery);
+
+  return footnoteHTMLNode;
+}
 
-  Object.assign(context, {
-    pageNumber
-  });
+export function contentsDirectiveHTMLNodeFromNode(node) {
+  const contentsDirectiveHTMLNode = nodeFromNodeAndQuery(node, contentsDirectiveHTMLNodeQuery);
 
-  divisionMarkdownNodes.forEach((divisionMarkdownNode) => {
-    divisionMarkdownNode.paginate(markdownNOdes, context);
-  });
+  return contentsDirectiveHTMLNode;
+}
 
-  delete context.pageNumber;
+export function footnotesDirectiveHTMLNodeFromNode(node) {
+  const footnotesDirectiveHTMLNode = nodeFromNodeAndQuery(node, footnotesDirectiveHTMLNodeQuery);
 
-  return markdownNOdes;
+  return footnotesDirectiveHTMLNode;
 }
 
-function createIndex(divisionMarkdownNodes, context) {
-  divisionMarkdownNodes.some((divisionMarkdownNode) => {
-    const indexCreated = divisionMarkdownNode.createIndex(divisionMarkdownNodes, context);
+export function pageNumberDirectiveHTMLNodeFromNode(node) {
+  const pageNumberDirectiveHTMLNode = nodeFromNodeAndQuery(node, pageNumberDirectiveHTMLNodeQuery);
 
-    if (indexCreated) {
-      return true;
-    }
-  });
+  return pageNumberDirectiveHTMLNode;
 }
 
-function createContents(divisionMarkdownNodes, context) {
-  divisionMarkdownNodes.some((divisionMarkdownNode) => {
-    const contentsCreated = divisionMarkdownNode.createContents(divisionMarkdownNodes, context);
+export function headingHTMLNodesFromNode(node, headingHTMLNodes = []) {
+  nodesFromNodeAndQuery(node, headingHTMLNodesQuery, headingHTMLNodes);
 
-    if (contentsCreated) {
-      return true;
-    }
-  });
+  return headingHTMLNodes;
 }
 
-function createFootnotes(divisionMarkdownNodes, footnoteReplacementMap, context) {
-  divisionMarkdownNodes.forEach((divisionMarkdownNode) => {
-    divisionMarkdownNode.createFootnotes(footnoteReplacementMap, context);
-  });
+export function divisionHTMLNodesFromNode(node, divisionHTMLNodes = []) {
+  nodesFromNodeAndQuery(node, divisionHTMLNodesQuery, divisionHTMLNodes);
+
+  return divisionHTMLNodes;
 }
 
-function prepareFootnotes(divisionMarkdownNodes, context) {
-  const footnoteReplacementMap = {};
+export function footnotesHTMLNodesFromNode(node, footnotesHTMLNodes = []) {
+  nodesFromNodeAndQuery(node, footnotesHTMLNodesQuery, footnotesHTMLNodes);
 
-  divisionMarkdownNodes.forEach((divisionMarkdownNode) => {
-    divisionMarkdownNode.prepareFootnotes(footnoteReplacementMap, context);
-  });
+  return footnotesHTMLNodes;
+}
 
-  return footnoteReplacementMap;
+export function footnoteLinkHTMLNodesFromNode(node, linkHTMLNodes = []) {
+  nodesFromNodeAndQuery(node, footnoteLinkHTMLNodesQuery, linkHTMLNodes);
+
+  return linkHTMLNodes;
 }
 
 export default {
-  postProcess
-}
+  footnoteHTMLNodeFromNode,
+  contentsDirectiveHTMLNodeFromNode,
+  footnotesDirectiveHTMLNodeFromNode,
+  pageNumberDirectiveHTMLNodeFromNode,
+  headingHTMLNodesFromNode,
+  divisionHTMLNodesFromNode,
+  footnotesHTMLNodesFromNode,
+  footnoteLinkHTMLNodesFromNode
+};
+
+// export function postProcess(divisionHTMLNodes, context) {
+//   const footnoteReplacementMap = prepareFootnotes(divisionHTMLNodes, context),
+//         markdownNodes = paginate(divisionHTMLNodes, context);
+//
+//   divisionHTMLNodes = divisionHTMLNodesFromHTMLNodes(markdownNodes);  ///
+//
+//   createFootnotes(divisionHTMLNodes, footnoteReplacementMap, context);
+//
+//   createContents(divisionHTMLNodes, context);
+//
+//   createIndex(divisionHTMLNodes, context);
+// }
+//
+// function paginate(divisionHTMLNodes, context) {
+//   const pageNumber = 1,
+//         markdownNOdes = [];
+//
+//   Object.assign(context, {
+//     pageNumber
+//   });
+//
+//   divisionHTMLNodes.forEach((divisionHTMLNode) => {
+//     divisionHTMLNode.paginate(markdownNOdes, context);
+//   });
+//
+//   delete context.pageNumber;
+//
+//   return markdownNOdes;
+// }
+//
+// function createIndex(divisionHTMLNodes, context) {
+//   divisionHTMLNodes.some((divisionHTMLNode) => {
+//     const indexCreated = divisionHTMLNode.createIndex(divisionHTMLNodes, context);
+//
+//     if (indexCreated) {
+//       return true;
+//     }
+//   });
+// }
+//
+// function createContents(divisionHTMLNodes, context) {
+//   divisionHTMLNodes.some((divisionHTMLNode) => {
+//     const contentsCreated = divisionHTMLNode.createContents(divisionHTMLNodes, context);
+//
+//     if (contentsCreated) {
+//       return true;
+//     }
+//   });
+// }
+//
+// function createFootnotes(divisionHTMLNodes, footnoteReplacementMap, context) {
+//   divisionHTMLNodes.forEach((divisionHTMLNode) => {
+//     divisionHTMLNode.createFootnotes(footnoteReplacementMap, context);
+//   });
+// }
+//
+// function prepareFootnotes(divisionHTMLNodes, context) {
+//   const footnoteReplacementMap = {};
+//
+//   divisionHTMLNodes.forEach((divisionHTMLNode) => {
+//     divisionHTMLNode.prepareFootnotes(footnoteReplacementMap, context);
+//   });
+//
+//   return footnoteReplacementMap;
+// }
+//
+// export default {
+//   postProcess
+// }

package/src/utilities/index.js

@@ -124,8 +124,8 @@ function adjustProperNouns(indexMap, context) {
   });
 
   mapKeys(indexMap, (wordOrPhrase) => {
-    const index = lowerCaseProperNouns.findIndex((lowerCaseProperNmae) => {
-      if (lowerCaseProperNmae === wordOrPhrase) {
+    const index = lowerCaseProperNouns.findIndex((lowerCaseProperName) => {
+      if (lowerCaseProperName === wordOrPhrase) {
         return true;
       }
     });
@@ -163,8 +163,8 @@ function adjustAcronyms(indexMap, context) {
   });
 
   mapKeys(indexMap, (wordOrPhrase) => {
-    const index = lowerCaseAcronyms.findIndex((lowerCaseProperNmae) => {
-      if (lowerCaseProperNmae === wordOrPhrase) {
+    const index = lowerCaseAcronyms.findIndex((lowerCaseProperName) => {
+      if (lowerCaseProperName === wordOrPhrase) {
         return true;
       }
     });

package/src/utilities/markdown.js

@@ -0,0 +1,72 @@
+"use strict";
+
+import { Query } from "occam-query";
+
+import { nodeFromNodeAndQuery, nodesFromNodeAndQuery } from "../utilities/query";
+
+const divisionMarkdownNodeQuery = Query.fromExpressionString("/markdown/division"),
+      subDivisionMarkdownNodeQuery = Query.fromExpressionString("/division/subDivision"),
+      indexDirectiveMarkdownNodeQuery = Query.fromExpressionString("/division/subDivision/directives/indexDirective"),
+      ignoreDirectiveMarkdownNodeQuery = Query.fromExpressionString("/division/subDivision/directives/ignoreDirective"),
+      divisionMarkdownNodesQuery = Query.fromExpressionString("/markdown/division"),
+      subDivisionMarkdownNodesQuery = Query.fromExpressionString("/division/subDivision"),
+      embedDirectiveMarkdownNodesQuery = Query.fromExpressionString("/subDivision/directives/embedDirective"),
+      includeDirectiveMarkdownNodesQuery = Query.fromExpressionString("/division/subDivision/directives/includeDirective");
+
+export function divisionMarkdownNodeFromNode(node) {
+  const divisionMarkdownNode = nodeFromNodeAndQuery(node, divisionMarkdownNodeQuery);
+
+  return divisionMarkdownNode;
+}
+
+export function subDivisionMarkdownNodeFromNode(node) {
+  const subDivisionMarkdownNode = nodeFromNodeAndQuery(node, subDivisionMarkdownNodeQuery);
+
+  return subDivisionMarkdownNode;
+}
+
+export function indexDirectiveMarkdownNodeFromNode(node) {
+  const indexDirectiveMarkdownNode = nodeFromNodeAndQuery(node, indexDirectiveMarkdownNodeQuery);
+
+  return indexDirectiveMarkdownNode;
+}
+
+export function ignoreDirectiveMarkdownNodeFromNode(node) {
+  const ignoreDirectiveMarkdownNode = nodeFromNodeAndQuery(node, ignoreDirectiveMarkdownNodeQuery);
+
+  return ignoreDirectiveMarkdownNode;
+}
+
+export function divisionMarkdownNodesFromNode(node, divisionMarkdownNodes = []) {
+  nodesFromNodeAndQuery(node, divisionMarkdownNodesQuery, divisionMarkdownNodes);
+
+  return divisionMarkdownNodes;
+}
+
+export function subDivisionMarkdownNodesFromNode(node, subDivisionMarkdownNodes = []) {
+  nodesFromNodeAndQuery(node, subDivisionMarkdownNodesQuery, subDivisionMarkdownNodes);
+
+  return subDivisionMarkdownNodes;
+}
+
+export function embedDirectiveMarkdownNodesFromNode(node, embedDirectiveMarkdownNodes = []) {
+  nodesFromNodeAndQuery(node, embedDirectiveMarkdownNodesQuery, embedDirectiveMarkdownNodes);
+
+  return embedDirectiveMarkdownNodes;
+}
+
+export function includeDirectiveMarkdownNodesFromNode(node, includeDirectiveMarkdownNodes = []) {
+  nodesFromNodeAndQuery(node, includeDirectiveMarkdownNodesQuery, includeDirectiveMarkdownNodes);
+
+  return includeDirectiveMarkdownNodes;
+}
+
+export default {
+  divisionMarkdownNodeFromNode,
+  subDivisionMarkdownNodeFromNode,
+  indexDirectiveMarkdownNodeFromNode,
+  ignoreDirectiveMarkdownNodeFromNode,
+  divisionMarkdownNodesFromNode,
+  embedDirectiveMarkdownNodesFromNode,
+  includeDirectiveMarkdownNodesFromNode
+};