highmark-markdown 1.0.173 → 1.0.174

package/src/map/node/markdown.js

@@ -0,0 +1,125 @@
+"use strict";
+
+import LineMarkdownNode from "../../node/markdown/line";
+import PathMarkdownNode from "../../node/markdown/path";
+import ImageMarkdownNode from "../../node/markdown/image";
+import ErrorMarkdownNode from "../../node/markdown/error";
+import AnchorMarkdownNode from "../../node/markdown/anchor";
+import TopmostMarkdownNode from "../../node/markdown/topmost";
+import DivisionMarkdownNode from "../../node/markdown/division";
+import FootnoteMarkdownNode from "../../node/markdown/footnote";
+import BlockEndMarkdownNode from "../../node/markdown/blockEnd";
+import ParagraphMarkdownNode from "../../node/markdown/paragraph";
+import ReferenceMarkdownNode from "../../node/markdown/reference";
+import HyperlinkMarkdownNode from "../../node/markdown/hyperlink";
+import IndexListMarkdownNode from "../../node/markdown/indexList";
+import IndexLinkMarkdownNode from "../../node/markdown/indexLink";
+import EmailLinkMarkdownNode from "../../node/markdown/emailLink";
+import PlainTextMarkdownNode from "../../node/markdown/text/plain";
+import BlockTextMarkdownNode from "../../node/markdown/text/block";
+import ClassNameMarkdownNode from "../../node/markdown/className";
+import BlockStartMarkdownNode from "../../node/markdown/blockStart";
+import InlineTextMarkdownNode from "../../node/markdown/inlineText";
+import StrongTextMarkdownNode from "../../node/markdown/strongText";
+import OrderedItemMarkdownNode from "../../node/markdown/item/ordered";
+import BlockListingMarkdownNode from "../../node/markdown/blockListing";
+import ContentsLinkMarkdownNode from "../../node/markdown/contentsLink";
+import ContentsItemMarkdownNode from "../../node/markdown/contentsItem";
+import ContentsListMarkdownNode from "../../node/markdown/contentsList";
+import FootnoteLinkMarkdownNode from "../../node/markdown/footnoteLink";
+import InlineListingMarkdownNode from "../../node/markdown/inlineListing";
+import FootnotesItemMarkdownNode from "../../node/markdown/footnotesItem";
+import FootnotesListMarkdownNode from "../../node/markdown/footnotesList";
+import EmphasisedTextMarkdownNode from "../../node/markdown/emphasisedText";
+import PrimaryHeadingMarkdownNode from "../../node/markdown/heading/primary";
+import EmbedDirectiveMarkdownNode from "../../node/markdown/directive/embee";
+import TertiaryHeadingMarkdownNode from "../../node/markdown/heading/tertiary";
+import SecondaryHeadingMarkdownNode from "../../node/markdown/heading/secondary";
+import IncludeDirectiveMarkdownNode from "../../node/markdown/directive/include";
+import QuaternaryHeadingMarkdownNode from "../../node/markdown/heading/quaternary";
+import PageNumberDirectiveMarkdownNode from "../../node/markdown/directive/pageNumber";
+import StronglyEmphasisedTextMarkdownNode from "../../node/markdown/stronglyEmphasisedText";
+
+import { LINE_RULE_NAME,
+         PATH_RULE_NAME,
+         IMAGE_RULE_NAME,
+         ERROR_RULE_NAME,
+         ANCHOR_RULE_NAME,
+         TOPMOST_RULE_NAME,
+         DIVISION_RULE_NAME,
+         FOOTNOTE_RULE_NAME,
+         BLOCK_END_RULE_NAME,
+         PARAGRAPH_RULE_NAME,
+         REFERENCE_RULE_NAME,
+         HYPERLINK_RULE_NAME,
+         INDEX_LIST_RULE_NAME,
+         INDEX_LINK_RULE_NAME,
+         EMAIL_LINK_RULE_NAME,
+         PLAIN_TEXT_RULE_NAME,
+         BLOCK_TEXT_RULE_NAME,
+         CLASS_NAME_RULE_NAME,
+         BLOCK_START_RULE_NAME,
+         INLINE_TEXT_RULE_NAME,
+         STRONG_TEXT_RULE_NAME,
+         ORDERED_ITEM_RULE_NAME,
+         BLOCK_LISTING_RULE_NAME,
+         CONTENTS_LINK_RULE_NAME,
+         CONTENTS_ITEM_RULE_NAME,
+         CONTENTS_LIST_RULE_NAME,
+         FOOTNOTE_LINK_RULE_NAME,
+         INLINE_LISTING_RULE_NAME,
+         FOOTNOTES_ITEM_RULE_NAME,
+         FOOTNOTES_LIST_RULE_NAME,
+         EMPHASISED_TEXT_RULE_NAME,
+         PRIMARY_HEADING_RULE_NAME,
+         EMBED_DIRECTIVE_RULE_NAME,
+         TERTIARY_HEADING_RULE_NAME,
+         SECONDARY_HEADING_RULE_NAME,
+         INCLUDE_DIRECTIVE_RULE_NAME,
+         QUATERNARY_HEADING_RULE_NAME,
+         PAGE_NUMBER_DIRECTIVE_RULE_NAME,
+         STRONGLY_EMPHASISED_TEXT_RULE_NAME } from "../../ruleNames";
+
+const markdownNodeMap = {
+  [LINE_RULE_NAME]: LineMarkdownNode,
+  [PATH_RULE_NAME]: PathMarkdownNode,
+  [IMAGE_RULE_NAME]: ImageMarkdownNode,
+  [ERROR_RULE_NAME]: ErrorMarkdownNode,
+  [ANCHOR_RULE_NAME]: AnchorMarkdownNode,
+  [TOPMOST_RULE_NAME]: TopmostMarkdownNode,
+  [DIVISION_RULE_NAME]: DivisionMarkdownNode,
+  [FOOTNOTE_RULE_NAME]: FootnoteMarkdownNode,
+  [BLOCK_END_RULE_NAME]: BlockEndMarkdownNode,
+  [REFERENCE_RULE_NAME]: ReferenceMarkdownNode,
+  [HYPERLINK_RULE_NAME]: HyperlinkMarkdownNode,
+  [PARAGRAPH_RULE_NAME]: ParagraphMarkdownNode,
+  [INDEX_LIST_RULE_NAME]: IndexListMarkdownNode,
+  [INDEX_LINK_RULE_NAME]: IndexLinkMarkdownNode,
+  [EMAIL_LINK_RULE_NAME]: EmailLinkMarkdownNode,
+  [PLAIN_TEXT_RULE_NAME]: PlainTextMarkdownNode,
+  [BLOCK_TEXT_RULE_NAME]: BlockTextMarkdownNode,
+  [CLASS_NAME_RULE_NAME]: ClassNameMarkdownNode,
+  [BLOCK_START_RULE_NAME]: BlockStartMarkdownNode,
+  [INLINE_TEXT_RULE_NAME]: InlineTextMarkdownNode,
+  [STRONG_TEXT_RULE_NAME]: StrongTextMarkdownNode,
+  [ORDERED_ITEM_RULE_NAME]: OrderedItemMarkdownNode,
+  [CONTENTS_LINK_RULE_NAME]: ContentsLinkMarkdownNode,
+  [BLOCK_LISTING_RULE_NAME]: BlockListingMarkdownNode,
+  [CONTENTS_ITEM_RULE_NAME]: ContentsItemMarkdownNode,
+  [CONTENTS_LIST_RULE_NAME]: ContentsListMarkdownNode,
+  [FOOTNOTE_LINK_RULE_NAME]: FootnoteLinkMarkdownNode,
+  [INLINE_LISTING_RULE_NAME]: InlineListingMarkdownNode,
+  [FOOTNOTES_ITEM_RULE_NAME]: FootnotesItemMarkdownNode,
+  [FOOTNOTES_LIST_RULE_NAME]: FootnotesListMarkdownNode,
+  [EMPHASISED_TEXT_RULE_NAME]: EmphasisedTextMarkdownNode,
+  [PRIMARY_HEADING_RULE_NAME]: PrimaryHeadingMarkdownNode,
+  [EMBED_DIRECTIVE_RULE_NAME]: EmbedDirectiveMarkdownNode,
+  [TERTIARY_HEADING_RULE_NAME]: TertiaryHeadingMarkdownNode,
+  [SECONDARY_HEADING_RULE_NAME]: SecondaryHeadingMarkdownNode,
+  [INCLUDE_DIRECTIVE_RULE_NAME]: IncludeDirectiveMarkdownNode,
+  [QUATERNARY_HEADING_RULE_NAME]: QuaternaryHeadingMarkdownNode,
+  [PAGE_NUMBER_DIRECTIVE_RULE_NAME]: PageNumberDirectiveMarkdownNode,
+  [STRONGLY_EMPHASISED_TEXT_RULE_NAME]: StronglyEmphasisedTextMarkdownNode
+};
+
+export default markdownNodeMap;

package/src/map/tagName.js

@@ -0,0 +1,16 @@
+"use strict";
+
+import htmlNodeMap from "../map/node/html";
+
+import { ruleNames } from "../map/node/html";
+
+const tagNameMap = {};
+
+ruleNames.forEach((ruleName) => {
+  const Class = htmlNodeMap[ruleName],
+        { tagName } = Class;
+
+  tagNameMap[ruleName] = tagName;
+});
+
+export default tagNameMap;

package/src/markdown/bnf.js

@@ -2,10 +2,10 @@
 
 const bnf = `
 
-    division                ::=  ( subDivision | endOfLine | error )+ ;
+    markdown                ::=  ( division | endOfLine | error )+ ;
     
     
-    subDivision             ::=  verticalSpace ( directives 
+    division                ::=  verticalSpace ( directives 
     
                                                | primaryHeading 
          
@@ -41,9 +41,7 @@ const bnf = `
                               ;
 
 
-    directives              ::=  pageNumber 
-    
-                               | indexDirective 
+    directives              ::=  indexDirective 
   
                                | ignoreDirective 
   
@@ -51,6 +49,8 @@ const bnf = `
   
                                | footnotesDirective
                                
+                               | pageNumberDirective 
+    
                                | embedDirective ( endOfLine embedDirective )* 
                                
                                | includeDirective ( endOfLine includeDirective )* 
@@ -82,15 +82,12 @@ const bnf = `
     unorderedList           ::=  unorderedItem ( endOfLine unorderedItem )* ;
 
 
-    blockListing            ::=  blockListingStart ( blockLine | endOfLine )+ blockListingEnd ;
+    blockListing            ::=  blockStart blockLine* blockEnd ;
 
 
     paragraph               ::=  line ( endOfLine line )* ;
     
 
-    pageNumber              ::=  "@pageNumber" ;
-
-
     indexDirective          ::=  "@index" ;
 
 
@@ -109,6 +106,9 @@ const bnf = `
     footnotesDirective      ::=  "@footnotes" ;
 
 
+    pageNumberDirective     ::=  "@pageNumber" ;
+
+
     nonsense                ::=  ( [escaped] | [number] | [identifier] | [word] | [special] | [unassigned] )+ ;
 
 
@@ -124,11 +124,8 @@ const bnf = `
     unorderedItem           ::=  [bullet] line ( endOfLine line )* ;
 
 
-    blockListingStart       ::=  [backticks] className? <END_OF_LINE> ;
-
-
-    blockListingEnd         ::=  [backticks] ;
-
+    blockLine.              ::=  blockText* endOfLine ;
+    
 
     tableHeadRow            ::=  tableCellDivider tableHeadCell+ ;
 
@@ -156,34 +153,53 @@ const bnf = `
     tableCell               ::=  line tableCellDivider ;
     
     
-    tableDivider            ::=  [dashes] ;
-    
+    contentsList            ::=  contentsItem+ ;
+
+
+    contentsItem            ::=  contentsLink 
     
-    tableCellDivider        ::=  [vertical-bar] ;
+                              |  contentsLink? contentsList
+                              
+                              ;
+
+
+    contentsLink            ::=  line ;
+
+
+    footnotesList           ::=  footnotesItem+ ;
+
+
+    footnotesItem           ::=  anchor paragraph ;
+
+
+    indexHeading            ::=  line ;
     
     
-    line.                   ::=  ( footnoteLink 
+    indexList               ::=  indexItem+ ;
+
+
+    indexItem               ::=  line... comma indexLink ( comma indexLink )* ;
+
+
+    line.                   ::=  ( inlineListing 
     
+                                 | footnoteLink 
+                                 
                                  | emailLink 
                                  
                                  | hyperlink 
                                  
                                  | image 
                                  
-                                 | inlineListing 
+                                 | plainText 
                                  
-                                 | stronglyEmphasisedText 
+                                 | strongText 
                                  
                                  | emphasisedText 
                                  
-                                 | strongText 
-                                 
-                                 | plainText )+ ;
-    
+                                 | stronglyEmphasisedText )+ ;
     
-    footnoteLink.           ::=  [link] ;
     
-
     emailLink.              ::=  "[" inlineText... "]"<NO_WHITESPACE>"(" [email-address] ")" 
     
                               |  [email-address] 
@@ -201,29 +217,34 @@ const bnf = `
     image.                  ::=  "![" inlineText... "]"<NO_WHITESPACE>"(" path ")" ;
 
 
-    path                    ::=  [path] ;
+    inlineText              ::=  plainText+ ;
+    
+    
+    strongText              ::=  "***" inlineText "***" ;
 
 
-    inlineListing           ::=  [backticked-literal] ;
-    
+    emphasisedText          ::=  "**" inlineText "**" ;
+
 
     stronglyEmphasisedText  ::=  "****" inlineText "****" ;
     
 
-    emphasisedText          ::=  "**" inlineText "**" ;
+    className               ::=  <NO_WHITESPACE>[identifier] ;
+    
 
+    blockStart              ::=  [backticks] className? <END_OF_LINE> ;
 
-    strongText              ::=  "***" inlineText "***" ;
 
+    blockEnd                ::=  [backticks] ;
 
-    blockLine.              ::=  ( plainText 
-                                
-                                 | [dashes] 
-    
-                                 | [vertical-bar] )* ;
+
+    footnoteLink.           ::=  [link] ;
     
 
-    inlineText              ::=  plainText+ ;
+    tableCellDivider        ::=  [vertical-bar] ;
+    
+    
+    tableDivider            ::=  [dashes] ;
     
     
     plainText               ::=  [escaped] 
@@ -247,41 +268,41 @@ const bnf = `
                               ;
     
 
-    reference.              ::=  [reference] ;
-    
-
-    className               ::=  <NO_WHITESPACE>[identifier] ;
-    
-
-    contentsList            ::=  contentsItem+ ;
-
-
-    contentsItem            ::=  contentsLink 
-    
-                              |  contentsLink? contentsList
+    blockText               ::=  [escaped] 
+                              
+                              |  [number] 
+                              
+                              |  [identifier] 
+                              
+                              |  [email-address]
+                              
+                              |  [url] 
+                              
+                              |  [path] 
+                              
+                              |  [word] 
+                              
+                              |  [special] 
+                              
+                              |  [unassigned]  
+                                
+                              |  [dashes] 
+ 
+                              |  [vertical-bar]
                               
                               ;
-
-
-    contentsLink            ::=  line ;
-
-
-    footnotesList           ::=  footnotesItem+ ;
-
-
-    footnotesItem           ::=  anchor paragraph ;
-
-
-    indexHeading            ::=  line ;
     
+
+    inlineListing           ::=  [backticked-literal] ;
     
-    indexList               ::=  indexItem+ ;
 
+    reference.              ::=  [reference] ;
+    
 
-    indexItem               ::=  line... comma indexLink ( comma indexLink )* ;
+    indexLink               ::=  [number] ;    
 
 
-    indexLink               ::=  [number] ;    
+    path                    ::=  [path] ;
 
 
     comma.                  ::=  "," ;    

package/src/markdown/parser.js

@@ -3,10 +3,12 @@
 import { CommonParser } from "occam-parsers";
 
 import bnf from "./bnf";
-import nodeMap from "../nodeMap";
+import markdownNodeMap from "../map/node/markdown";
 
 import { setNonTerminalNodes } from "../utilities/parser";
 
+const nodeMap = markdownNodeMap;  ///
+
 export default class MarkdownParser extends CommonParser {
   static bnf = bnf;
 

package/src/markdownStyle/entries.js

@@ -1,10 +1,10 @@
 "use strict";
 
-import elementMap from "../elementMap";
+import tagNameMap from "../map/tagName";
 
-import { ruleNamesExpressionFromElementMap } from "../utilities/entries";
+import { ruleNamesExpressionFromTagNameMap } from "../utilities/entries";
 
-const ruleNamesExpression = ruleNamesExpressionFromElementMap(elementMap);
+const ruleNamesExpression = ruleNamesExpressionFromTagNameMap(tagNameMap);
 
 const entries = [
   {

package/src/mixins/node.js

@@ -1,35 +1,13 @@
 "use strict";
 
-function appendChildNode(appendedChildNode) {
-  const multiplicity = this.getMultiplicity(),
-        startIndex = multiplicity,  ///
-        addedChildNode = appendedChildNode; ///
-
-  this.addChildNode(addedChildNode, startIndex);
-}
-
-function prependChildNode(prependedChildNode) {
-  const startIndex = 0,
-        addedChildNode = prependedChildNode; ///
-
-  this.addChildNode(addedChildNode, startIndex);
-}
-
-function addChildNodeAfter(existingChildNode, addedChildNode) {
-  const addedChildNodes = [
-          addedChildNode
-        ];
+function filterChildNode(callback) {
+  this.forEachChildNode((childNode) => {
+    const result = callback(childNode);
 
-  this.addChildNodesAfter(existingChildNode, addedChildNodes);
-}
-
-function addChildNodesAfter(existingChildNode, addedChildNodes) {
-  const childNode = existingChildNode,  ///
-        index = this.indexOfChildNode(childNode),
-        startIndex = index + 1,
-        deleteCount = 0;
-
-  this.spliceChildNodes(startIndex, deleteCount, addedChildNodes);
+    if (!result) {
+       this.removeChildNode(childNode);
+    }
+  });
 }
 
 function fromFirstChildNode(callback) {
@@ -124,16 +102,33 @@ function fromSecondLastChildNode(callback) {
   return result;
 }
 
+function fromThirdLastChildNode(callback) {
+  let result;
+
+  const multiplicity = this.getMultiplicity(),
+        thirdLastIndex = multiplicity - 2;
+
+  this.backwardsSomeChildNode((childNode, index) => {
+    if (index === thirdLastIndex) {
+      const thirdChildNode = childNode; ///
+
+      result = callback(thirdChildNode);
+
+      return true;
+    }
+  });
+
+  return result;
+}
+
 const nodeMixins = {
-  appendChildNode,
-  prependChildNode,
-  addChildNodeAfter,
-  addChildNodesAfter,
+  filterChildNode,
   fromFirstChildNode,
   fromSecondChildNode,
   fromThirdChildNode,
   fromFirstLastChildNode,
-  fromSecondLastChildNode
+  fromSecondLastChildNode,
+  fromThirdLastChildNode
 };
 
 export default nodeMixins;

package/src/node/html/anchor.js

@@ -5,8 +5,6 @@ import HTMLNode from "../../node/html";
 import { ID_ATTRIBUTE_NAME } from "../../attributeNames";
 
 export default class AnchorHTMLNode extends HTMLNode {
-  content(context) { return this.outerNode.content(context); }
-
   attributeName(context) {
     const attributeName = ID_ATTRIBUTE_NAME;
 
@@ -40,13 +38,36 @@ export default class AnchorHTMLNode extends HTMLNode {
     return html;
   }
 
-  childNodesAsHTML(indent, context) {
+  createDOMElement(context) {
+    let domElement;
+
     const content = this.content(context),
-          childNodesHTML = content; ///
+          textNode = document.createTextNode(content);
+
+    domElement = super.createDOMElement(context)
+
+    const parentDOMElement = domElement;  ///
+
+    domElement = textNode; ///
 
-    return childNodesHTML;
+    parentDOMElement.appendChild(domElement);
+
+    domElement = parentDOMElement;  ///
+
+    return domElement;
   }
 
+  // childNodesAsHTML(indent, context) {
+  //   const content = this.content(context),
+  //         childNodesHTML = content; ///
+  //
+  //   return childNodesHTML;
+  // }
+
+  static tagName = "a";
+
+  static className = "anchor";
+
   static fromNothing() { return HTMLNode.fromNothing(AnchorHTMLNode); }
 
   static fromOuterNode(outerNode) { return HTMLNode.fromOuterNode(AnchorHTMLNode, outerNode); }

package/src/node/html/blockLine.js

@@ -2,25 +2,76 @@
 
 import HTMLNode from "../../node/html";
 
+import { EMPTY_STRING, CARRIAGE_RETURN } from "../../constants";
+
 export default class BlockLineHTMLNode extends HTMLNode {
-  content(context) { return this.outerNode.content(context); }
+  mount(parentDOMElement, siblingDOMElement, context) {
+    super.mount(parentDOMElement, siblingDOMElement, context);
+
+    let domElement;
+
+    domElement = this.getDOMElement();
+
+    parentDOMElement = domElement;
+
+    siblingDOMElement = null;
+
+    const content = CARRIAGE_RETURN,
+          textNode = document.createTextNode(content);
+
+    domElement = textNode;
+
+    parentDOMElement.insertBefore(domElement, siblingDOMElement)
+  }
+
+  unmount(parentDOMElement, context) {
+    {
+      let domElement;
+
+      domElement = this.getDOMElement();
+
+      const parentDOMElement = domElement,  ///
+            lastChild = domElement.lastChild
+
+      domElement = lastChild;  ///
+
+      parentDOMElement.removeChild(domElement);
+    }
+
+    super.unmount(parentDOMElement, context);
+  }
 
   asHTML(indent, context) {
+    let html;
+
     const childNodesHTML = this.childNodesAsHTML(indent, context),
           startingTag = this.startingTag(context),
-          closingTag = this.closingTag(context),
-          html = `${startingTag}${childNodesHTML}${closingTag}`;
+          closingTag = this.closingTag(context);
+
+    html = `${startingTag}${childNodesHTML}${closingTag}
+`;
 
     return html;
   }
 
-  childNodesAsHTML(indent, context) {
-    const content = this.content(context),
-          childNodesHTML = content; ///
+  childNodesAsPlainText(context) {
+    const childNodesPlainText = this.reduceChildNode((childNodesPlainText, childNode) => {
+      const childNodePlainText = childNode.asPlainText(context);
 
-    return childNodesHTML;
+      childNodesPlainText = `${childNodesPlainText}${childNodePlainText}`;
+
+      return childNodesPlainText;
+    }, EMPTY_STRING);
+
+    return childNodesPlainText;
   }
 
+  static lines = 2;
+
+  static tagName = "span";
+
+  static className = "block-line";
+
   static fromNothing() { return HTMLNode.fromNothing(BlockLineHTMLNode); }
 
   static fromOuterNode(outerNode) { return HTMLNode.fromOuterNode(BlockLineHTMLNode, outerNode); }

package/src/node/html/division.js

@@ -0,0 +1,15 @@
+"use strict";
+
+import HTMLNode from "../../node/html";
+
+export default class DivisionHTMLNode extends HTMLNode {
+  className(context) { return this.outerNode.className(context); }
+
+  static tagName = "div";
+
+  static className = null;
+
+  static fromNothing() { return HTMLNode.fromNothing(DivisionHTMLNode); }
+
+  static fromOuterNode(outerNode) { return HTMLNode.fromOuterNode(DivisionHTMLNode, outerNode); }
+}