adds provision to add notes and references on the akn document, updat…

…es abbreviations (#26)

examples/manual generation/index.js

@@ -1,4 +1,4 @@
-import { Elements, Attributes, Helpers } from 'nkyimu';
+import { Elements, Attributes, Helpers, Engine } from 'nkyimu';
 
 // Generation of Wet Tropics of Queensland World Heritage Area Conservation Act 1994
 class TestDocument {
@@ -154,9 +154,29 @@ class TestDocument {
 
   getBody() {
     const body = new Elements.Body();
+    const { root, last } = Engine.Generator.fromSelector('chapter>part[num:1,heading:Some Part]>section>subsection>content>p');
+    const noteRef = this.createNote();
+    const sampleBody = new Elements.TextElement('Always have notes.');
+    last.appendChild(sampleBody);
+    last.appendChild(noteRef);
+
+    body.appendChild(root);
+
+    console.log(root, last);
+
 
     return body;
   }
+
+  createNote() {
+    const note = new Elements.Note();
+    const p = new Elements.P();
+
+    p.appendChild(new Elements.TextElement('This is a note'));
+    note.appendChild(p);
+
+    return this.doc.addNote(note);
+  }
 }
 
 const generated = new TestDocument();

src/Abstracts/AbstractAttribute.ts

@@ -46,6 +46,13 @@ export abstract class AbstractAttribute {
     return this.name;
   }
 
+  /**
+   * Get the name of the attribute
+   */
+  static getName(): string {
+    throw new Error('Implement the function getClassName');
+  }
+
   /**
    * Get the value of the attribute
    */

src/Abstracts/AbstractNode.ts

@@ -180,6 +180,17 @@ export abstract class AbstractNode implements HasChildrenMap {
     this.node.textContent = str;
   }
 
+  /**
+   * Get the text content of a node.
+   */
+  getTextContent(): string|null {
+    if (this.getNodeType() !== NodeType.TEXT_NODE && this.getNodeType() !== NodeType.COMMENT_NODE) {
+      throw new Error(`${this.getNodeName()} is a non-text node`);
+    }
+
+    return this.node.textContent;
+  }
+
   /**
    * Extract the nodes from the nested CHILDREN_MAP object.
    *
@@ -611,24 +622,71 @@ export abstract class AbstractNode implements HasChildrenMap {
     const nodeCount:{ [key:string]: number } = {};
 
     node.children.forEach((child: AbstractNode) => {
-      if (child.abbreviation.length < 1) {
+      const requiresEId = child.ATTRIBUTE_GROUPS
+        .some(e => e.attribute.getName() === 'eId' && e.required === true);
+
+      const currentEId = this.getElement().getAttribute('eId');
+
+      if (!requiresEId || child.abbreviation.length < 1) {
         this.generateIds(child, prefix);
 
         return;
       }
 
-      if (!nodeCount[child.getNodeName()]) {
-        nodeCount[child.getNodeName()] = 0;
+      if (currentEId && currentEId.indexOf('__replace__') === -1) {
+        this.generateIds(child, currentEId);
+
+        return;
       }
 
-      nodeCount[child.getNodeName()] += 1;
+      const childId = this.getCorrectNodeId(prefix, nodeCount, child);
 
-      child.setElementId(`${prefix}${child.abbreviation}_${nodeCount[child.getNodeName()]}`);
+      child.setElementId(childId);
 
       this.generateIds(child, `${child.generatedId}_`);
     });
   }
 
+  private getCorrectNodeId(prefix: string, nodeCount: { [key:string]: number }, node: AbstractNode): string {
+    const nodePrefix = `${prefix}${node.abbreviation}_`;
+
+    const nodeNumber = this.getNodeNumberContent(node);
+
+    if (nodeNumber) {
+      return `${nodePrefix}${nodeNumber}`;
+    }
+
+    if (!nodeCount[node.getNodeName()]) {
+      nodeCount[node.getNodeName()] = 0;
+    }
+
+    nodeCount[node.getNodeName()] += 1;
+
+    return `${nodePrefix}${nodeCount[node.getNodeName()]}`;
+  }
+
+  private getNodeNumberContent(node: AbstractNode) {
+    const numTag = node.children.filter((e) => e.getNodeName() === 'num');
+
+    if (numTag.length < 1 || numTag[0].children.length < 1) return null;
+
+    const text = numTag[0].children.filter((e) => e.getNodeName() === '');
+
+    if (text.length < 1) return null;
+
+    const content = text[0].getTextContent();
+
+    if (!content) return null;
+
+    const nodeRegx = new RegExp(node.getNodeName(), 'gi');
+
+    return content
+      .replace(nodeRegx, '')
+      .replace(/[.()-]/gi, '')
+      .trim()
+      .replace(/\s/g, '_');
+  }
+
   setElementId(id: string) {
     this.generatedId = id;
 
@@ -638,8 +696,42 @@ export abstract class AbstractNode implements HasChildrenMap {
 
     const attr = this.getElement().getAttribute('eId');
 
-    if (attr && attr.indexOf('__replace__') !== -1) {
+    if (!attr) {
       this.setAttribute(new EIdAttribute(id));
+
+      return;
     }
+
+    if (attr.indexOf('__replace__') !== -1) {
+      this.setAttribute(new EIdAttribute(id));
+    }
+  }
+
+  getFirstDescendant(nodeName: string): AbstractNode|null {
+    let match: AbstractNode|null = null;
+
+    this.children.some((child) => {
+      if (child.getNodeName() === nodeName) {
+        match = child;
+        return true;
+      }
+
+      return false;
+    });
+
+    if (match) return match;
+
+    this.children.some((e) => {
+      const childMatch = e.getFirstDescendant(nodeName);
+
+      if (childMatch) {
+        match = childMatch;
+        return true;
+      }
+
+      return false;
+    });
+
+    return match;
   }
 }

src/Elements/Blocks/Table.ts

@@ -5,7 +5,7 @@ import { AttributeGroupItem } from "../../Interfaces/AttributeGroupItem";
 import { NodeRules } from "../../Interfaces/NodeRules";
 
 export class Table extends AbstractNode {
-  abbreviation = 'tbl';
+  abbreviation = 'table';
 
   getNodeName(): string { return 'table'; }
 

src/Elements/Citation.ts

@@ -10,7 +10,7 @@ const type = new ItemType();
  * that is called citation
  */
 export class Citation extends AbstractNode {
-  abbreviation = 'citation';
+  abbreviation = 'cit';
 
   getNodeName(): string { return 'citation'; }
 

src/Elements/ComponentRef.ts

@@ -13,7 +13,7 @@ const type = new SrcType();
  * internal (within the components element)
  */
 export class ComponentRef extends AbstractNode {
-  abbreviation = 'componentref';
+  abbreviation = 'cref';
 
   getNodeName(): string { return 'componentRef'; }
 

src/Elements/Containers/Attachment.ts

@@ -10,7 +10,7 @@ const type = new DocContainerType();
  * attachment elements
  */
 export class Attachment extends AbstractNode {
-  abbreviation = 'attachment';
+  abbreviation = 'att';
 
   getNodeName(): string { return 'attachment'; }
 

src/Elements/Containers/BlockContainer.ts

@@ -10,7 +10,7 @@ const type = new BlockContainerType();
  * individual block elements in a block context
  */
 export class BlockContainer extends AbstractNode {
-  abbreviation = 'blc';
+  abbreviation = 'blockcontainer';
 
   getNodeName(): string { return 'blockContainer'; }
 

src/Elements/Containers/BlockList.ts

@@ -10,7 +10,7 @@ const type = new BlockListType();
  * of many individual item elements to be treated as in a list.
  */
 export class BlockList extends AbstractNode {
-  abbreviation = 'bll';
+  abbreviation = 'list';
 
   getNodeName(): string { return 'blockList'; }
 

src/Elements/Containers/Citations.ts

@@ -9,7 +9,7 @@ const type = new CitationHierarchy();
  * The element container is a generic element for a container.
  */
 export class Citations extends AbstractNode {
-  abbreviation = 'citations';
+  abbreviation = 'cits';
 
   getNodeName(): string { return 'citations'; }
 

src/Elements/Containers/Container.ts

@@ -9,7 +9,7 @@ const type = new ContainerType();
  * The element container is a generic element for a container.
  */
 export class Container extends AbstractNode {
-  abbreviation = 'co';
+  abbreviation = 'container';
 
   getNodeName(): string { return 'container'; }
 

src/Elements/Containers/Content.ts

@@ -11,7 +11,7 @@ const type = new Blocksreq();
  * specified
  */
 export class Content extends AbstractNode {
-  abbreviation = 'cnt';
+  abbreviation = 'content';
 
   getNodeName(): string { return 'content'; }
 

src/Elements/Containers/Formula.ts

@@ -14,7 +14,7 @@ const type = new Blocksreq();
  * specification of the actual type of formula.
  */
 export class Formula extends AbstractNode {
-  abbreviation = 'fo';
+  abbreviation = 'formula';
 
   getNodeName(): string { return 'formula'; }
 

src/Elements/Containers/LongTitle.ts

@@ -9,7 +9,7 @@ const type = new Blocksreq();
  * or coverPage that is called long title.
  */
 export class LongTitle extends AbstractNode {
-  abbreviation = 'lt';
+  abbreviation = 'longtitle';
 
   getNodeName(): string { return 'longTitle'; }
 

src/Elements/Containers/Recitals.ts

@@ -8,7 +8,7 @@ const type = new RecitalHierarchy();
  * The element recitals is the section of the preamble that contains recitals.
  */
 export class Recitals extends AbstractNode {
-  abbreviation = 'recitals';
+  abbreviation = 'recs';
 
   getNodeName(): string { return 'recitals'; }
 

src/Elements/Containers/Tblock.ts

@@ -10,7 +10,7 @@ const type = new ItemType();
  * hierarchical structure
  */
 export class Tblock extends AbstractNode {
-  abbreviation = 'tbl';
+  abbreviation = 'tblock';
 
   getNodeName(): string { return 'tblock'; }
 

src/Elements/Core/ActiveRef.ts

@@ -10,7 +10,7 @@ const type = new ReferenceType();
  * document (i.e., an active references)
  */
 export class ActiveRef extends AbstractNode {
-  abbreviation = 'activeRef';
+  abbreviation = 'activeref';
 
   getNodeName(): string {
     return 'activeRef';

src/Elements/Core/AttachmentOf.ts

@@ -11,7 +11,7 @@ const type = new ReferenceType();
  * document is an attachment
  */
 export class AttachmentOf extends AbstractNode {
-  abbreviation = "";
+  abbreviation = "attachmentof";
 
   getNodeName(): string {
     return "attachmentOf";

src/Elements/Core/EventRef.ts

@@ -13,7 +13,7 @@ const type = new AnyOtherType();
  * that generated the event must be referenced.
  */
 export class EventRef extends AbstractNode {
-  abbreviation = 'eventref';
+  abbreviation = 'eref';
 
   getNodeName(): string {
     return 'eventRef';

src/Elements/Core/HasAttachment.ts

@@ -11,7 +11,7 @@ const type = new ReferenceType();
  * document is an attachment
  */
 export class HasAttachment extends AbstractNode {
-  abbreviation = "";
+  abbreviation = "hasattachment";
 
   getNodeName(): string {
     return "hasAttachment";

src/Elements/Core/Jurisprudence.ts

@@ -10,7 +10,7 @@ const type = new ReferenceType();
  * document is an attachment
  */
 export class Jurisprudence extends AbstractNode {
-  abbreviation = "";
+  abbreviation = "jurisprudence";
 
   getNodeName(): string {
     return "jurisprudence";

src/Elements/Core/Note.ts

@@ -11,7 +11,7 @@ const type = new SubFlowStructure();
  * endnote specified.
  */
 export class Note extends AbstractNode {
-  abbreviation = 'nt';
+  abbreviation = 'note';
 
   getNodeName(): string { return 'note'; }
 

src/Elements/Core/Notes.ts

@@ -5,7 +5,7 @@ import { Source } from "../../AttributeGroups/Source";
 import { Xmllang } from "../../AttributeGroups/Xmllang";
 
 export class Notes extends AbstractNode {
-  abbreviation = 'nts';
+  abbreviation = 'notes';
 
   getNodeName(): string { return 'notes'; }
 

src/Elements/Core/PassiveRef.ts

@@ -10,7 +10,7 @@ const type = new ReferenceType();
  * on this document (i.e., a passive references)
  */
 export class PassiveRef extends AbstractNode {
-  abbreviation = "";
+  abbreviation = "passiveref";
 
   getNodeName(): string {
     return "passiveRef";

src/Elements/Core/References.ts

@@ -12,7 +12,7 @@ const refItems = new RefItems();
  * anything else is managed by the Akoma Ntoso ontology.
  */
 export class References extends AbstractNode {
-  abbreviation = "";
+  abbreviation = "references";
   getNodeName(): string {
     return "references";
   }

src/Elements/Core/TLCConcept.ts

@@ -16,7 +16,7 @@ const type = new ReferenceType();
  * Akoma Ntoso IRI of an ontology instance of the class Concept
  */
 export class TLCConcept extends AbstractNode {
-  abbreviation = "";
+  abbreviation = "tlcconcept";
 
   getNodeName(): string {
     return "TLCConcept";