highmark-markdown 0.0.404 → 0.0.406

package/src/example/importer.js

@@ -0,0 +1,115 @@
+"use strict";
+
+import { MarkdownLexer, MarkdownParser } from "../index";
+
+import { EMPTY_STRING } from "./constants";
+
+const markdownLexer = MarkdownLexer.fromNothing(),
+      markdownParser = MarkdownParser.fromNothing();
+
+export default function importer(filePath, context) {
+  const content = contentMap[filePath] || null;
+
+  if (content !== null) {
+    const startOfContent = true,
+          startRule = markdownParser.getStartRule(),
+          tokens = markdownLexer.tokenise(content),
+          node = markdownParser.parse(tokens, startRule, startOfContent),
+          importedNode = node,  ///
+          importedTokens = tokens,
+          importedClassName = classNameFromFilePath(filePath);
+
+    Object.assign(context, {
+      importedNode,
+      importedTokens,
+      importedClassName
+    });
+  }
+}
+
+function classNameFromFilePath(filePath) {
+  const className = filePath.replace(/\.md/, EMPTY_STRING);
+
+  return className;
+}
+
+const CONTENT_PATH = "content.md",
+      CONTENTS_PATH = "contents.md",
+      HALF_TITLE_PATH = "half-title.md",
+      FRONT_MATTER_PATH = "front-matter.md",
+      INTRODUCTION_PATH = "introduction.md",
+      GETTING_STARTED_PATH = "getting-started.md",
+      INSTALLING_THE_CLI_PATH = "installing-the-cli.md",
+      GETTING_TO_GRIPS_WITH_THE_IDE_PATH = "getting-to-grips-with-the-ide.md";
+
+export const defaultContent = `@ignore
+
+@include ${FRONT_MATTER_PATH}
+@include ${CONTENT_PATH}`;
+
+const contentContent = `@ignore
+
+@include ${INTRODUCTION_PATH}
+@include ${GETTING_STARTED_PATH}`,
+
+      contentsContent = `## Contents
+
+@contents`,
+
+      halfTitleContent = `# Occam`,
+
+      frontMatterContent = `@ignore
+
+@include ${HALF_TITLE_PATH}
+@include ${CONTENTS_PATH}`,
+
+      introductionContent = `# Introduction
+      
+I have tried to make Occam[^occam] as useable as possible but there are limits.
+At the end of the day it is an expert system and some of its parts, not least the verifier, need detailed explanation.
+It is the purpose of this book is to provide these explanations.
+
+This book also goes into considerable detail on the subject of Occam's approach to language, which largely boils down to its use of grammars.
+Occam has its own language, called Florence,[^florence] but it will also support controlled natural languages in the near future.
+Indeed, the verifier cannot distinguish between these languages at all.
+This book explains how this is possible.
+
+@footnotes
+
+@pageNumber
+`,
+
+      gettingStartedContent = `# Getting started
+      
+Another short paragraph with a reference to a footnote[^occam].
+      
+[^occam]: The word Occam is used somewhat nebulously here.
+It is most often associated with Occam's IDE but in fact it encompasses a range of software and services.
+This book explains these divers parts and there is a companion book, called The Foundations of Symbolic Reasoning, that covers the underlying theory.
+
+[^florence]: Occam was originally called Florence but the former seemed more apt.
+
+@footnotes
+
+@embed ${INSTALLING_THE_CLI_PATH}
+@embed ${GETTING_TO_GRIPS_WITH_THE_IDE_PATH}
+
+@pageNumber
+`,
+
+      installingTheCLIContent = `## Installing the CLI`,
+
+      gettingToGripsWithTheIDEIContent = `## Getting to grips with the IDE`;
+
+const contentMap = {
+
+  [CONTENT_PATH]: contentContent,
+  [CONTENTS_PATH]: contentsContent,
+  [HALF_TITLE_PATH]: halfTitleContent,
+  [FRONT_MATTER_PATH]: frontMatterContent,
+  [INTRODUCTION_PATH]: introductionContent,
+  [GETTING_STARTED_PATH]: gettingStartedContent,
+  [INSTALLING_THE_CLI_PATH]: installingTheCLIContent,
+  [GETTING_TO_GRIPS_WITH_THE_IDE_PATH]: gettingToGripsWithTheIDEIContent
+
+};

package/src/example/view/textarea/css.js

@@ -28,6 +28,6 @@ class CSSTextarea extends Textarea {
 
 export default withStyle(CSSTextarea)`
 
-  height: 12rem;
+  height: 16rem;
   
 `;

package/src/example/view.js

@@ -7,6 +7,7 @@ import { MarkdownLexer, MarkdownParser, MarkdownStyleLexer, MarkdownStyleParser
 import { RowDiv, RowsDiv, ColumnDiv, ColumnsDiv, VerticalSplitterDiv, HorizontalSplitterDiv } from "easy-layout";
 
 import HTMLDiv from "./view/div/html";
+import importer from "./importer";
 import PreviewDiv from "./view/div/preview";
 import SubHeading from "./view/subHeading";
 import CSSTextarea from "./view/textarea/css";
@@ -16,8 +17,9 @@ import RightSizeableDiv from "./view/div/sizeable/right";
 import MarkdownContainerDiv from "./view/div/container/markdown";
 import MarkdownStyleContainerDiv from "./view/div/container/markdownStyle";
 
-import { postprocess } from "../utilities/markdown";
-import { LINES_PER_PAGE, CONTENTS_DEPTH, CHARACTERS_PER_LINE, INTRODUCTION_CLASS_NAME } from "./constants";
+import { postprocess } from "../utilities/processing";
+import { defaultContent } from "./importer";
+import { LINES_PER_PAGE, CONTENTS_DEPTH, CHARACTERS_PER_LINE } from "./constants";
 
 const markdownLexer = MarkdownLexer.fromNothing(),
       markdownParser = MarkdownParser.fromNothing(),
@@ -80,15 +82,15 @@ class View extends Element {
     this.setTokens(tokens);
 
     if (node !== null) {
-      const divisionClassName = INTRODUCTION_CLASS_NAME,
-            divisionMarkdownNode = node;  ///
-
-      divisionMarkdownNode.setDivisionClassName(divisionClassName);
-
-      const charactersPerLine = CHARACTERS_PER_LINE,
+      const divisionMarkdownNode = node,  ///
+            charactersPerLine = CHARACTERS_PER_LINE,
+            contentsDepth = CONTENTS_DEPTH,
+            linesPerPage = LINES_PER_PAGE,
             context = {
               tokens,
               importer,
+              linesPerPage,
+              contentsDepth,
               charactersPerLine
             },
             divisionMarkdownNodes = postprocess(divisionMarkdownNode, context);
@@ -254,14 +256,7 @@ class View extends Element {
     className: "view"
   };
 
-  static initialMarkdown = `Occam.
-
-@embed introduction.md
-
-@footnotes
-
-@pageNumber
-`;
+  static initialMarkdown = defaultContent;  ///
 
   static initialMarkdownStyle = `width: 100%;
 position: absolute;
@@ -275,23 +270,3 @@ export default withStyle(View)`
   padding: 1rem;
   
 `;
-
-function importer(filePath, context) {
-  const content = `Florence [^florence].
-
-[^florence]: Florence footnote.  
-`,
-        startOfContent = true,
-        startRule = markdownParser.getStartRule(),
-        tokens = markdownLexer.tokenise(content),
-        node = markdownParser.parse(tokens, startRule, startOfContent),
-        importedNode = node,  ///
-        importedTokens = tokens,
-        importedClassName = "introduction";
-
-  Object.assign(context, {
-    importedNode,
-    importedTokens,
-    importedClassName
-  });
-}

package/src/example.js

@@ -9,13 +9,13 @@ import { mediaTypeNames, MarkdownStyleElement, DefaultMarkdownStyleElement } fro
 
 import View from "./example/view";
 
-import { INTRODUCTION_DIV_SELECTORS_STRING } from "./example/constants";
+import { PREVIEWED_DIV_SELECTORS_STRING } from "./example/constants";
 
 const { renderStyles } = withStyle,
       { PREVIEW_MEDIA_TYPE_NAME } = mediaTypeNames;
 
 const mediaTypeName = PREVIEW_MEDIA_TYPE_NAME,
-      selectorsString = INTRODUCTION_DIV_SELECTORS_STRING;
+      selectorsString = PREVIEWED_DIV_SELECTORS_STRING;
 
 DefaultMarkdownStyleElement.fromMediaTypeNameAndSelectorsString(mediaTypeName, selectorsString);
 

package/src/index.js

@@ -8,8 +8,8 @@ export { default as MarkdownStyleParser } from "./markdownStyle/parser";
 export { default as cssUtilities } from "./utilities/css";
 export { default as nodeUtilities } from "./utilities/node";
 export { default as queryUtilities } from "./utilities/query";
-export { default as markdownUtilities } from "./utilities/markdown";
 export { default as footnotesUtilities } from "./utilities/footnotes";
+export { default as processingUtilities } from "./utilities/processing";
 
 export { default as nodeMap } from "./nodeMap";
 export { default as ruleNames } from "./ruleNames";

package/src/markdown/bnf.js

@@ -49,8 +49,10 @@ const bnf = `
   
                                | footnotesDirective
                                
-                               | ( embedDirective | includeDirective ) ( endOfLine ( embedDirective | includeDirective ) )* 
+                               | embedDirective ( endOfLine embedDirective )* 
                                
+                               | includeDirective ( endOfLine includeDirective )* 
+
                                ; 
   
 

package/src/mixins/node.js

@@ -26,16 +26,16 @@ function removeChildNode(removedChildNode) {
   childNodes.splice(start, deleteCount);
 }
 
-function prependChildNode(childNode) {
+function prependChildNode(prependedChildNode) {
   const childNodes = this.getChildNodes();
 
-  childNodes.unshift(childNode);
+  childNodes.unshift(prependedChildNode);
 }
 
-function appendChildNode(childNode) {
+function appendChildNode(appendedChildNode) {
   const childNodes = this.getChildNodes();
 
-  childNodes.push(childNode);
+  childNodes.push(appendedChildNode);
 }
 
 function replaceChildNode(replacedChildNode, replacementChildNode) {
@@ -56,6 +56,24 @@ function replaceChildNodes(replacedChildNode, replacementChildNodes) {
   childNodes.splice(start, deleteCount, ...replacementChildNodes);
 }
 
+function addChildNodeAfter(existingChildNode, addedChildNode) {
+  const childNodes = this.getChildNodes(),
+        index = childNodes.indexOf(existingChildNode),
+        start = index + 1,
+        deleteCount = 0;
+
+  childNodes.splice(start, deleteCount, addedChildNode);
+}
+
+function addChildNodesAfter(existingChildNode, addedChildNodes) {
+  const childNodes = this.getChildNodes(),
+        index = childNodes.indexOf(existingChildNode),
+        start = index + 1,
+        deleteCount = 0;
+
+  childNodes.splice(start, deleteCount, ...addedChildNodes);
+}
+
 function getDescendantNodes(descendantNodes = []) {
   const descendantNode = this; ///
 
@@ -76,6 +94,34 @@ function getDescendantNodes(descendantNodes = []) {
   return descendantNodes;
 }
 
+function retrieveParentNode(childNode, node = this) {
+  let parentNode = null;
+
+  const nodeNonTerminalNode = node.isNonTerminalNode();
+
+  if (nodeNonTerminalNode) {
+    const nonTerminalNode = node, ///
+          childNodes = nonTerminalNode.getChildNodes(),
+          index = childNodes.indexOf(childNode);
+
+    if (index !== -1) {
+      parentNode = node;  ///
+    } else {
+      const nodes = childNodes; ///
+
+      nodes.some((node) => {
+        parentNode = this.retrieveParentNode(childNode, node);
+
+        if (parentNode !== null) {
+          return true;
+        }
+      });
+    }
+  }
+
+  return parentNode;
+}
+
 const nodeMixins = {
   removeChildNodes,
   removeChildNode,
@@ -83,7 +129,10 @@ const nodeMixins = {
   prependChildNode,
   replaceChildNode,
   replaceChildNodes,
-  getDescendantNodes
+  addChildNodeAfter,
+  addChildNodesAfter,
+  getDescendantNodes,
+  retrieveParentNode
 };
 
 export default nodeMixins;

package/src/node/markdown/contentsLink.js

@@ -31,8 +31,7 @@ export default class ContentsLinkMarkdownNode extends MarkdownNode {
   clone() { return super.clone(this.identifier); }
 
   static fromLineReplacementAndIdentifier(lineReplacement, identifier) {
-      const lineReplacementNode = lineReplacement.getNode(),
-            lineMarkdownNode = lineReplacementNode, ///
+      const lineMarkdownNode = lineReplacement.getLineMarkdownNode(),
             ruleName = CONTENTS_LINK_RULE_NAME,
             childNodes = [
               lineMarkdownNode

package/src/node/markdown/contentsList.js

@@ -8,7 +8,7 @@ export default class ContentsListMarkdownNode extends MarkdownNode {
   static fromContentsItemReplacements(contentsItemReplacements) {
     const ruleName = CONTENTS_LIST_RULE_NAME,
           childNodes = contentsItemReplacements.map((contentsItemReplacement) => {
-            const contentsItemReplacementNode = contentsItemReplacement.getNode(),
+            const contentsItemReplacementNode = contentsItemReplacement.getContentsItemMarkdownNode(),
                   childNode = contentsItemReplacementNode;  ///
 
             return childNode;

package/src/node/markdown/directive/embee.js

@@ -2,38 +2,35 @@
 
 import { arrayUtilities } from "necessary";
 
-import ImportedReplacement from "../../../replacement/imported";
 import DirectiveMarkdownNode from "../../../node/markdown/directive";
+import EmbedDirectiveReplacement from "../../../replacement/embedDirective";
 
 const { last } = arrayUtilities;
 
 export default class EmbedDirectiveMarkdownNode extends DirectiveMarkdownNode {
-  import(context) {
-    let importedReplacement = null;
+  resolve(context) {
+    let embedDirectiveReplacement = null;
 
-    const { importer = null } = context;
+    const { importer } = context;
 
-    if (importer !== null) {
-      const filePath = this.filePath(context);
+    const filePath = this.filePath(context);
 
-      importer(filePath, context);
+    importer(filePath, context);
 
-      const { importedNode = null,
-              importedTokens = null } = context;
+    const { importedNode = null,
+            importedTokens = null } = context;
 
-      if (importedNode !== null) {
-        const node = importedNode,  ///
-              tokens = importedTokens;  ///
+    if (importedNode !== null) {
+      delete context.importedNode;
+      delete context.importedTokens;
 
-        importedReplacement = ImportedReplacement.fromNodeAndTokens(node, tokens);
+      const divisionMarkdownNode = importedNode,  ///
+            tokens = importedTokens;  ///
 
-        delete context.importedNode;
-        delete context.importedTokens;
-        delete context.importedClassName;
-      }
+      embedDirectiveReplacement = EmbedDirectiveReplacement.fromDivisionMarkdownNodeAndTokens(divisionMarkdownNode, tokens);
     }
 
-    return importedReplacement;
+    return embedDirectiveReplacement;
   }
 
   filePath(context) {

package/src/node/markdown/directive/include.js

@@ -3,47 +3,39 @@
 import { arrayUtilities } from "necessary";
 
 import DirectiveMarkdownNode from "../../../node/markdown/directive";
+import IncludeDirectiveReplacement from "../../../replacement/includeDirective";
 
-const { push, last } = arrayUtilities;
+const { last } = arrayUtilities;
 
 export default class IncludeDirectiveMarkdownNode extends DirectiveMarkdownNode {
-  resolveIncludes(context) {
-    let html = null;
+  resolve(context) {
+    let includeDirectiveReplacement = null;
 
-    const { importer = null } = context;
+    const { importer } = context;
 
-    if (importer !== null) {
-      const filePath = this.filePath(context);
+    const filePath = this.filePath(context);
 
-      importer(filePath, context);
+    importer(filePath, context);
 
-      const { importedNode = null,
-              importedTokens = null,
-              importedClassName = null } = context;
+    const { importedNode = null,
+          importedTokens = null,
+          importedClassName = null } = context;
 
-      if (importedNode !== null) {
-        delete context.importedNode;
-        delete context.importedTokens;
-        delete context.importedClassName;
+    if (importedNode !== null) {
+      delete context.importedNode;
+      delete context.importedTokens;
+      delete context.importedClassName;
 
-        const { tokens, divisionMarkdownNodes } = context,
-              divisionMarkdownNode = importedNode,  ///
-              divisionClassName = importedClassName,  ///
-              ignored = divisionMarkdownNode.isIgnored();
+      const divisionMarkdownNode = importedNode,  ///
+            divisionClassName = importedClassName,  ///
+            tokens = importedTokens;  ///
 
-        divisionMarkdownNode.setDivisionClassName(divisionClassName);
+      divisionMarkdownNode.setDivisionClassName(divisionClassName);
 
-        if (!ignored) {
-          push(tokens, importedTokens);
-
-          divisionMarkdownNodes.push(divisionMarkdownNode);
-        }
-
-        divisionMarkdownNode.resolveIncludes(context);
-      }
+      includeDirectiveReplacement = IncludeDirectiveReplacement.fromDivisionMarkdownNodeAndTokens(divisionMarkdownNode, tokens);
     }
 
-    return html;
+    return includeDirectiveReplacement;
   }
 
   filePath(context) {

package/src/node/markdown/directives.js

@@ -4,75 +4,38 @@ import { arrayUtilities } from "necessary";
 
 import MarkdownNode from "../../node/markdown";
 
-const { clear, first, push } = arrayUtilities;
+const { first } = arrayUtilities;
 
 export default class DirectivesMarkdownNode extends MarkdownNode {
-  constructor(ruleName, childNodes, opacity, precedence, domElement, domElements) {
-    super(ruleName, childNodes, opacity, precedence, domElement);
-
-    this.domElements = domElements;
-  }
-
   getDOMElement() {
-    let domElement = null;
-
-    const domElementsLength = this.domElements.length;
-
-    if (domElementsLength > 0) {
-      const firstDOMElement = first(this.domElements);
-
-      domElement = firstDOMElement; ///
-    }
+    const directiveMarkdownNode = this.getDirectiveMarkdownNode(),
+          directiveMarkdownNodeDOMElement = directiveMarkdownNode.getDOMElement(),
+          domElement = directiveMarkdownNodeDOMElement; ///
 
     return domElement;
   }
 
-  getDOMElements() {
-    return this.domElements;
-  }
-
   asHTML(indent, context) {
-    const childNodesHTML = this.childNodesAsHTML(indent, context),
-          html = childNodesHTML;  ///
+    const directiveMarkdownNode = this.getDirectiveMarkdownNode(),
+          directiveMarkdownNodeHTML = directiveMarkdownNode.asHTML(indent, context),
+          html = directiveMarkdownNodeHTML;  ///
 
     return html;
   }
 
   createDOMElement(context) {
-    const domElement = null,
-          childNodes = this.getChildNodes();
-
-    clear(this.domElements);
+    const directiveMarkdownNode = this.getDirectiveMarkdownNode();
 
-    childNodes.forEach((childNode) => {
-      const childNodeNonTerminalNode = childNode.isNonTerminalNode();
-
-      if (childNodeNonTerminalNode) {
-        const nonTerminalNode = childNode,  ///
-              markdownNode = nonTerminalNode; ///
-
-        markdownNode.createDOMElement(context);
-
-        const markdownNodeDOMElements = markdownNode.getDOMElements();
-
-        push(this.domElements, markdownNodeDOMElements);
-      }
-    });
-
-    return domElement;
+    directiveMarkdownNode.createDOMElement(context);
   }
 
-  clone() {
-    const domElements = [],
-          directivesMarkdownNode = super.clone(domElements);
+  getDirectiveMarkdownNode() {
+    const childNodes = this.getChildNodes(),
+          firstChildNode = first(childNodes),
+          directiveMarkdownNode = firstChildNode; ///
 
-    return directivesMarkdownNode;
+    return directiveMarkdownNode;
   }
 
-  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) {
-    const domElements = [],
-          directivesMarkdownNode = MarkdownNode.fromRuleNameChildNodesAndOpacity(DirectivesMarkdownNode, ruleName, childNodes, opacity, domElements);
-
-    return directivesMarkdownNode;
-  }
+  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(DirectivesMarkdownNode, ruleName, childNodes, opacity); }
 }