UNPKG

docxtemplater

Version:

.docx generator working with templates and data (like Mustache)

483 lines (482 loc) 14.4 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for es6/docxtemplater.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../prettify.css" /> <link rel="stylesheet" href="../base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="../index.html">all files</a> / <a href="index.html">es6/</a> docxtemplater.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">90.36% </span> <span class="quiet">Statements</span> <span class='fraction'>75/83</span> </div> <div class='fl pad1y space-right2'> <span class="strong">81.25% </span> <span class="quiet">Branches</span> <span class='fraction'>13/16</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Functions</span> <span class='fraction'>16/16</span> </div> <div class='fl pad1y space-right2'> <span class="strong">90.36% </span> <span class="quiet">Lines</span> <span class='fraction'>75/83</span> </div> </div> </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">65×</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">65×</span> <span class="cline-any cline-yes">65×</span> <span class="cline-any cline-yes">65×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">12×</span> <span class="cline-any cline-yes">12×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">77×</span> <span class="cline-any cline-yes">77×</span> <span class="cline-any cline-yes">231×</span> <span class="cline-any cline-yes">231×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">77×</span> <span class="cline-any cline-yes">12×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">77×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">64×</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">64×</span> <span class="cline-any cline-yes">64×</span> <span class="cline-any cline-yes">64×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">80×</span> <span class="cline-any cline-yes">80×</span> <span class="cline-any cline-yes">80×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">32×</span> <span class="cline-any cline-yes">32×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">76×</span> <span class="cline-any cline-yes">76×</span> <span class="cline-any cline-yes">76×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">31×</span> <span class="cline-any cline-yes">31×</span> <span class="cline-any cline-yes">150×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">31×</span> <span class="cline-any cline-yes">162×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">31×</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">31×</span> <span class="cline-any cline-yes">162×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">31×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">31×</span> <span class="cline-any cline-yes">162×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">31×</span> <span class="cline-any cline-yes">80×</span> <span class="cline-any cline-yes">80×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">31×</span> <span class="cline-any cline-yes">162×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">31×</span> <span class="cline-any cline-yes">80×</span> <span class="cline-any cline-yes">80×</span> <span class="cline-any cline-yes">80×</span> <span class="cline-any cline-yes">80×</span> <span class="cline-any cline-yes">80×</span> <span class="cline-any cline-yes">80×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">31×</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">31×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">30×</span> <span class="cline-any cline-yes">30×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">105×</span> <span class="cline-any cline-yes">105×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">105×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">105×</span> <span class="cline-any cline-yes">315×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">105×</span> <span class="cline-any cline-yes">105×</span> <span class="cline-any cline-yes">105×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">25×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">"use strict"; &nbsp; const DocUtils = require("./doc-utils"); DocUtils.traits = require("./traits"); DocUtils.moduleWrapper = require("./module-wrapper"); const wrapper = DocUtils.moduleWrapper; &nbsp; const Docxtemplater = class Docxtemplater { constructor() { <span class="missing-if-branch" title="if path not taken" >I</span>if (arguments.length &gt; 0) { <span class="cstat-no" title="statement not covered" > throw new Error("The constructor with parameters have been removed in docxtemplater 3.0, please check the upgrade guide.");</span> } this.compiled = {}; this.modules = []; this.setOptions({}); } attachModule(module) { this.modules.push(wrapper(module)); return this; } setOptions(options) { this.options = options; Object.keys(DocUtils.defaults).forEach((key) =&gt; { const defaultValue = DocUtils.defaults[key]; this[key] = (this.options[key] != null) ? this.options[key] : defaultValue; }); if (this.zip) { this.updateFileTypeConfig(); } return this; } loadZip(zip) { <span class="missing-if-branch" title="if path not taken" >I</span>if (zip.loadAsync) { <span class="cstat-no" title="statement not covered" > throw new Error("Docxtemplater doesn't handle JSZip version &gt;=3, see changelog");</span> } this.zip = zip; this.updateFileTypeConfig(); return this; } compileFile(fileName) { const currentFile = this.createTemplateClass(fileName); currentFile.parse(); this.compiled[fileName] = currentFile; } compile() { this.templatedFiles = this.fileTypeConfig.getTemplatedFiles(this.zip); return this; } updateFileTypeConfig() { this.fileType = this.zip.files["word/document.xml"] ? "docx" : "pptx"; this.fileTypeConfig = this.options.fileTypeConfig || Docxtemplater.FileTypeConfig[this.fileType]; return this; } render() { this.options.xmlFileNames = []; this.modules = this.fileTypeConfig.baseModules.map(function (moduleFunction) { return moduleFunction(); }).concat(this.modules); this.options = this.modules.reduce((options, module) =&gt; { return module.optionsTransformer(options, this); }, this.options); this.xmlDocuments = this.options.xmlFileNames.reduce((xmlDocuments, fileName) =&gt; { <span class="cstat-no" title="statement not covered" > const content = this.zip.files[fileName].asText();</span> <span class="cstat-no" title="statement not covered" > xmlDocuments[fileName] = DocUtils.str2xml(content);</span> <span class="cstat-no" title="statement not covered" > return xmlDocuments;</span> }, {}); this.modules.forEach((module) =&gt; { module.set({zip: this.zip, xmlDocuments: this.xmlDocuments, data: this.data}); }); this.compile(); &nbsp; this.modules.forEach((module) =&gt; { module.set({compiled: this.compiled}); }); // Loop inside all templatedFiles (ie xml files with content). // Sometimes they don't exist (footer.xml for example) this.templatedFiles.forEach((fileName) =&gt; { <span class="missing-if-branch" title="else path not taken" >E</span>if (this.zip.files[fileName] != null) { this.compileFile(fileName); } }); &nbsp; this.mapper = this.modules.reduce(function (value, module) { return module.getRenderedMap(value); }, {}); &nbsp; Object.keys(this.mapper).forEach((to) =&gt; { const mapped = this.mapper[to]; const from = mapped.from; const currentFile = this.compiled[from]; currentFile.setTags(mapped.data); currentFile.render(to); this.zip.file(to, currentFile.content); }); &nbsp; Object.keys(this.xmlDocuments).forEach((fileName) =&gt; { <span class="cstat-no" title="statement not covered" > this.zip.remove(fileName);</span> <span class="cstat-no" title="statement not covered" > const content = DocUtils.xml2str(this.xmlDocuments[fileName]);</span> <span class="cstat-no" title="statement not covered" > return this.zip.file(fileName, content, {});</span> }); return this; } setData(data) { this.data = data; return this; } getZip() { return this.zip; } createTemplateClass(path) { const usedData = this.zip.files[path].asText(); return this.createTemplateClassFromContent(usedData, path); } createTemplateClassFromContent(content, filePath) { const xmltOptions = { filePath, }; Object.keys(DocUtils.defaults).forEach((key) =&gt; { xmltOptions[key] = this[key]; }); xmltOptions.fileTypeConfig = this.fileTypeConfig; xmltOptions.modules = this.modules; return new Docxtemplater.XmlTemplater(content, xmltOptions); } getFullText(path) { return this.createTemplateClass(path || this.fileTypeConfig.textPath).getFullText(); } getTemplatedFiles() { this.compile(); return this.templatedFiles; } }; &nbsp; Docxtemplater.DocUtils = require("./doc-utils"); Docxtemplater.Errors = require("./errors"); Docxtemplater.XmlTemplater = require("./xml-templater"); Docxtemplater.FileTypeConfig = require("./file-type-config"); Docxtemplater.XmlMatcher = require("./xml-matcher"); module.exports = Docxtemplater; &nbsp;</pre></td></tr> </table></pre> <div class='push'></div><!-- for sticky footer --> </div><!-- /wrapper --> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Fri Mar 17 2017 11:22:16 GMT+0100 (CET) </div> </div> <script src="../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../sorter.js"></script> </body> </html>