commonform-docx 6.0.0 → 7.0.0

package/bin.js

@@ -14,20 +14,23 @@ const usage = [
   '  -h, --help                          Show this screen.',
   '  -v, --version                       Show version.',
   '  -H, --hash                          Render form hash',
-  '  -a, --a4-paper                      A4 paper.',
-  '  -b TEXT, --blank-text TEXT          Render blanks with custom text.',
+  '  -a, --a4-paper                      A4 paper',
+  '  -b TEXT, --blank-text TEXT          Render blanks with custom text',
+  '  --component-style STYLE             Change component style [default: both]',
   '  -d JSON --directions JSON           Use directions to fill in blanks',
   '  -e VERSION, --form-version VERSION  Form version to be rendered',
   '  -i, --indent-margins                Indent margins, commonwealth style',
+  '  --incorporate-component-text TEXT   Verb for component references [default: Incorporate]',
+  '  --quote-component-text TEXT         Text for introducing quoted components',
   '  -l, --left-align-title              Align title flush to left margin',
   '  -m, --mark-filled                   Mark filled blanks',
   '  -p, --smart                         Render Unicode punctuation',
   '  -n STYLE, --number STYLE            Numbering style [default: decimal]',
   '  -r --left-align-body                Left-align body paragraphs.',
   '  -s PAGES, --signatures PAGES        Signature page data',
-  '  -t TITLE, --title TITLE             Render title as <h1>.',
+  '  -t TITLE, --title TITLE             Render title as <h1>',
   '  -v JSON --values JSON               Use values to fill in blanks',
-  '  -y JSON, --styles JSON              Render with custom styles.'
+  '  -y JSON, --styles JSON              Render with custom styles'
 ].join('\n')
 
 const parsed = docopt(usage, { version: require('./package.json').version })
@@ -99,6 +102,10 @@ if (parsed['--blank-text']) options.blanks = parsed['--blank-text']
 
 if (parsed['--mark-filled']) options.markFilled = true
 
+options.loadedComponentStyle = parsed['--component-style']
+if (parsed['--quote-component-text']) options.quoteComponentText = parsed['--quote-component-text']
+options.incorporateComponentText = parsed['--incorporate-component-text']
+
 function readJSON (file) {
   return JSON.parse(fs.readFileSync(path.resolve(file)))
 }

package/index.js

@@ -33,11 +33,14 @@ module.exports = (
     after = '',
     blanks = { text: '[•]', highlight: 'yellow' },
     hash = false,
+    incorporateComponentText = 'Incorporate',
     indentMargins = false,
     leftAlignBody = false,
     leftAlignTitle = false,
+    loadedComponentStyle = 'inline',
     markFilled = false,
     numberStyle = decimalNumbering,
+    quoteComponentText = 'Quoting for convenience, with any conflicts resolved in favor of the standard:',
     smart,
     styles,
     title,
@@ -56,12 +59,15 @@ module.exports = (
       a4,
       after,
       blanks,
-      leftAlignTitle,
       hash,
+      incorporateComponentText,
       indentMargins,
       leftAlignBody,
+      leftAlignTitle,
+      loadedComponentStyle,
       markFilled,
       numberStyle,
+      quoteComponentText,
       smart,
       styles,
       title,

package/lint.log

@@ -0,0 +1,4 @@
+
+> commonform-docx@6.0.0 lint
+> standard
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "commonform-docx",
   "description": "render Common Forms in Office Open XML (Microsoft Word .docx format)",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "author": "Kyle E. Mitchell <kyle@kemitchell.com> (http://kemitchell.com)",
   "bin": "bin.js",
   "dependencies": {
@@ -14,6 +14,7 @@
     "decimal-numbering": "^3.0.2",
     "has": "^1.0.3",
     "jszip": "^3.2.1",
+    "number-to-words-en": "^1.2.5",
     "ooxml-signature-pages": "^3.0.2",
     "outline-numbering": "^2.0.0",
     "plan-addenda-exhibits-numbering": "^3.0.0",
@@ -24,7 +25,7 @@
     "run-series": "^1.1.8",
     "standard": "^17.0.0",
     "tape": "^5.0.1",
-    "textract": "^2.4.0"
+    "textract": "^2.5.0"
   },
   "keywords": [
     "Microsoft Office",

package/templates/paragraph.js

@@ -1,5 +1,6 @@
 const escape = require('../escape')
 const has = require('has')
+const numberToWords = require('number-to-words-en')
 const run = require('./run')
 const tag = require('./tag')
 
@@ -55,37 +56,48 @@ module.exports = (element, options) => {
   const conspicuous = has(element, 'conspicuous')
   const hasComponent = has(element, 'component')
   const hasContent = has(element, 'content')
-  return tag('w:p',
-    properties(element, number, options.indentMargins) +
-    (number ? makeRun(number, false) + TAB : '') +
-    (
-      has(element, 'heading')
-        ? (
-            makeRun({ caption: element.heading }, conspicuous) +
-          (/\.$/.test(element.heading) ? '' : makeRun('.', false)) +
-          (((hasComponent && !hasContent) || element.content.length === 0) ? '' : makeRun(' ', false))
-          )
-        : ''
-    ) +
-    (
-      hasComponent
-        ? hasContent
-          ? (
-              referenceContent(element.reference, options.rIdForHREF) +
-            makeRun(' Quoting for convenience, with any conflicts resolved in favor of the standard:') +
-            '</w:p>' +
-            '<w:p>' +
-            properties(
-              Object.assign({}, element, { depth: element.depth + 1 }),
-              number,
-              options.indentMargins
-            ) +
-            childContent({ content: element.content })
-            )
-          : referenceContent(element, options.rIdForHREF)
-        : childContent(element)
-    )
-  )
+  let returned = '<w:p>'
+  returned += properties(element, number, options.indentMargins)
+  returned += number ? makeRun(number, false) + TAB : ''
+  if (has(element, 'heading')) {
+    returned += makeRun({ caption: element.heading }, conspicuous)
+    if (!/\.$/.test(element.heading)) {
+      returned += makeRun('.', false)
+    }
+    if ((hasComponent && !hasContent) || element.content.length === 0) {
+      // pass
+    } else {
+      returned += makeRun(' ', false)
+    }
+  }
+  if (hasComponent) {
+    if (hasContent) {
+      const style = options.loadedComponentStyle
+      if (style === 'both') {
+        returned += componentReference(element.reference, element.component)
+        returned += makeRun(' ' + options.quoteComponentText)
+        returned += '</w:p><w:p>'
+        returned += properties(
+          Object.assign({}, element, { depth: element.depth + 1 }),
+          number,
+          options.indentMargins
+        )
+        returned += childContent({ content: element.content })
+      } else if (style === 'copy') {
+        returned += childContent({ content: element.content })
+      } else if (style === 'reference') {
+        returned += componentReference(element.reference, element.component)
+      } else {
+        throw new Error('Uknown Loaded Component Style: ' + style)
+      }
+    } else {
+      returned += componentReference(element)
+    }
+  } else {
+    returned += childContent(element)
+  }
+  returned += '</w:p>'
+  return returned
 
   function childContent (element) {
     const conspicuous = has(element, 'conspicuous')
@@ -98,13 +110,20 @@ module.exports = (element, options) => {
     return run(element, conspicuous, options)
   }
 
-  function referenceContent (component, rIdForHREF) {
+  function componentReference (component, meta) {
     const href = component.component + '/' + component.version
-    const returned = [makeRun('Incorporate ')]
-    const rId = rIdForHREF(href)
-    returned.push(
-      '<w:hyperlink r:id="' + rId + '" w:history="1"><w:r><w:rPr><w:color w:val="0000EE"/><w:u w:val="single"/></w:rPr><w:t>' + escape(href) + '</w:t></w:r></w:hyperlink>'
-    )
+    const returned = [makeRun(options.incorporateComponentText + ' ')]
+    const rId = options.rIdForHREF(href)
+    const link = '<w:hyperlink r:id="' + rId + '" w:history="1"><w:r><w:rPr><w:color w:val="0000EE"/><w:u w:val="single"/></w:rPr><w:t>' + escape(href) + '</w:t></w:r></w:hyperlink>'
+    if (meta) {
+      returned.push(
+        makeRun(meta.publisher + ' ' + meta.name + ' Version ' + meta.version + ' ('),
+        link,
+        makeRun(')')
+      )
+    } else {
+      returned.push(link)
+    }
     const substitutions = component.substitutions
     const hasSubstitutions = (
       Object.keys(substitutions.terms).length > 0 ||
@@ -115,11 +134,28 @@ module.exports = (element, options) => {
       const phrases = []
       Object.keys(substitutions.terms).forEach(from => {
         const to = substitutions.terms[from]
-        phrases.push(makeRun('the term ' + quote(to) + ' for the term ' + quote(from)))
+        phrases.push(
+          makeRun('the term ') +
+          makeRun({ use: to }) +
+          makeRun(' for the term ') +
+          makeRun({ use: from })
+        )
       })
       Object.keys(substitutions.headings).forEach(from => {
         const to = substitutions.headings[from]
-        phrases.push(makeRun('references to ' + quote(to) + ' for references to ' + quote(from)))
+        phrases.push(
+          makeRun('references to ') +
+          makeRun({ use: to }) +
+          makeRun(' for references to ') +
+          makeRun({ use: from })
+        )
+      })
+      Object.keys(substitutions.blanks).forEach(number => {
+        const value = substitutions.blanks[number]
+        phrases.push(
+          makeRun(quote(value)) +
+          makeRun(' for the ' + numberToWords.toWordsOrdinal(parseInt(number)) + ' blank')
+        )
       })
       const length = phrases.length
       if (length === 1) {

package/test.log

@@ -0,0 +1,98 @@
+
+> commonform-docx@6.0.0 pretest
+> npm run prepublish
+
+
+> commonform-docx@6.0.0 prepublish
+> node build/scaffold.js data/scaffold.docx > data/scaffold.json
+
+
+> commonform-docx@6.0.0 test
+> tape test.js
+
+TAP version 13
+# renders text
+ok 1 no render error
+ok 2 no textract error
+ok 3 text appears in output
+# renders definitions
+ok 4 no render error
+ok 5 no textract error
+ok 6 defined term appears in output
+# renders uses
+ok 7 no render error
+ok 8 no textract error
+ok 9 term appears in output
+# renders references
+ok 10 no render error
+ok 11 no textract error
+ok 12 reference appears in output
+# handles components without headings
+ok 13 no render error
+# handles components with substitutions
+ok 14 no render error
+# omits period after heading ending w/ period
+ok 15 no render error
+ok 16 no textract error
+ok 17 double period does not appear in output
+# adds space between heading and defined term
+ok 18 no render error
+ok 19 no textract error
+ok 20 space between heading and term
+# adds space between heading and text
+ok 21 no render error
+ok 22 no textract error
+ok 23 space between heading and text
+# renders broken references
+ok 24 no render error
+ok 25 no textract error
+ok 26 reference appears in output
+# fills blanks
+ok 27 no render error
+ok 28 no textract error
+ok 29 value appears in output
+# custom blank text
+ok 30 no render error
+ok 31 no textract error
+ok 32 value appears in output
+# renders empty blank placeholders
+ok 33 no render error
+ok 34 no textract error
+ok 35 placeholder appears in output
+# renders custom empty blank placeholders
+ok 36 no render error
+ok 37 no textract error
+ok 38 placeholder appears in output
+# renders custom empty blank placeholders
+ok 39 no render error
+ok 40 no textract error
+ok 41 placeholder appears in output
+# renders conspicuous text
+ok 42 no render error
+ok 43 no textract error
+ok 44 conspicuous text appears in output
+# renders titles
+ok 45 no render error
+ok 46 no textract error
+ok 47 title appears in output
+# renders centered titles
+ok 48 no render error
+ok 49 no textract error
+ok 50 title appears in output
+# renders versions
+ok 51 no render error
+ok 52 no textract error
+ok 53 version appears in output
+# renders hashes
+ok 54 no render error
+ok 55 no textract error
+ok 56 hash symbol appears in output
+# throws for invalid content
+ok 57 throw an error
+
+1..57
+# tests 57
+# pass  57
+
+# ok
+