UNPKG

@argdown/node

Version:

Async Argdown application for node.js

406 lines (405 loc) 19.9 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for src/plugins/SvgToPdfExportPlugin.ts</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">src/plugins</a> SvgToPdfExportPlugin.ts </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">20.69% </span> <span class="quiet">Statements</span> <span class='fraction'>12/58</span> </div> <div class='fl pad1y space-right2'> <span class="strong">0% </span> <span class="quiet">Branches</span> <span class='fraction'>0/20</span> </div> <div class='fl pad1y space-right2'> <span class="strong">10% </span> <span class="quiet">Functions</span> <span class='fraction'>1/10</span> </div> <div class='fl pad1y space-right2'> <span class="strong">20.69% </span> <span class="quiet">Lines</span> <span class='fraction'>12/58</span> </div> </div> <p class="quiet"> Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block. </p> </div> <div class='status-line low'></div> <pre><table class="coverage"> <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a> <a name='L2'></a><a href='#L2'>2</a> <a name='L3'></a><a href='#L3'>3</a> <a name='L4'></a><a href='#L4'>4</a> <a name='L5'></a><a href='#L5'>5</a> <a name='L6'></a><a href='#L6'>6</a> <a name='L7'></a><a href='#L7'>7</a> <a name='L8'></a><a href='#L8'>8</a> <a name='L9'></a><a href='#L9'>9</a> <a name='L10'></a><a href='#L10'>10</a> <a name='L11'></a><a href='#L11'>11</a> <a name='L12'></a><a href='#L12'>12</a> <a name='L13'></a><a href='#L13'>13</a> <a name='L14'></a><a href='#L14'>14</a> <a name='L15'></a><a href='#L15'>15</a> <a name='L16'></a><a href='#L16'>16</a> <a name='L17'></a><a href='#L17'>17</a> <a name='L18'></a><a href='#L18'>18</a> <a name='L19'></a><a href='#L19'>19</a> <a name='L20'></a><a href='#L20'>20</a> <a name='L21'></a><a href='#L21'>21</a> <a name='L22'></a><a href='#L22'>22</a> <a name='L23'></a><a href='#L23'>23</a> <a name='L24'></a><a href='#L24'>24</a> <a name='L25'></a><a href='#L25'>25</a> <a name='L26'></a><a href='#L26'>26</a> <a name='L27'></a><a href='#L27'>27</a> <a name='L28'></a><a href='#L28'>28</a> <a name='L29'></a><a href='#L29'>29</a> <a name='L30'></a><a href='#L30'>30</a> <a name='L31'></a><a href='#L31'>31</a> <a name='L32'></a><a href='#L32'>32</a> <a name='L33'></a><a href='#L33'>33</a> <a name='L34'></a><a href='#L34'>34</a> <a name='L35'></a><a href='#L35'>35</a> <a name='L36'></a><a href='#L36'>36</a> <a name='L37'></a><a href='#L37'>37</a> <a name='L38'></a><a href='#L38'>38</a> <a name='L39'></a><a href='#L39'>39</a> <a name='L40'></a><a href='#L40'>40</a> <a name='L41'></a><a href='#L41'>41</a> <a name='L42'></a><a href='#L42'>42</a> <a name='L43'></a><a href='#L43'>43</a> <a name='L44'></a><a href='#L44'>44</a> <a name='L45'></a><a href='#L45'>45</a> <a name='L46'></a><a href='#L46'>46</a> <a name='L47'></a><a href='#L47'>47</a> <a name='L48'></a><a href='#L48'>48</a> <a name='L49'></a><a href='#L49'>49</a> <a name='L50'></a><a href='#L50'>50</a> <a name='L51'></a><a href='#L51'>51</a> <a name='L52'></a><a href='#L52'>52</a> <a name='L53'></a><a href='#L53'>53</a> <a name='L54'></a><a href='#L54'>54</a> <a name='L55'></a><a href='#L55'>55</a> <a name='L56'></a><a href='#L56'>56</a> <a name='L57'></a><a href='#L57'>57</a> <a name='L58'></a><a href='#L58'>58</a> <a name='L59'></a><a href='#L59'>59</a> <a name='L60'></a><a href='#L60'>60</a> <a name='L61'></a><a href='#L61'>61</a> <a name='L62'></a><a href='#L62'>62</a> <a name='L63'></a><a href='#L63'>63</a> <a name='L64'></a><a href='#L64'>64</a> <a name='L65'></a><a href='#L65'>65</a> <a name='L66'></a><a href='#L66'>66</a> <a name='L67'></a><a href='#L67'>67</a> <a name='L68'></a><a href='#L68'>68</a> <a name='L69'></a><a href='#L69'>69</a> <a name='L70'></a><a href='#L70'>70</a> <a name='L71'></a><a href='#L71'>71</a> <a name='L72'></a><a href='#L72'>72</a> <a name='L73'></a><a href='#L73'>73</a> <a name='L74'></a><a href='#L74'>74</a> <a name='L75'></a><a href='#L75'>75</a> <a name='L76'></a><a href='#L76'>76</a> <a name='L77'></a><a href='#L77'>77</a> <a name='L78'></a><a href='#L78'>78</a> <a name='L79'></a><a href='#L79'>79</a> <a name='L80'></a><a href='#L80'>80</a> <a name='L81'></a><a href='#L81'>81</a> <a name='L82'></a><a href='#L82'>82</a> <a name='L83'></a><a href='#L83'>83</a> <a name='L84'></a><a href='#L84'>84</a> <a name='L85'></a><a href='#L85'>85</a> <a name='L86'></a><a href='#L86'>86</a> <a name='L87'></a><a href='#L87'>87</a> <a name='L88'></a><a href='#L88'>88</a> <a name='L89'></a><a href='#L89'>89</a> <a name='L90'></a><a href='#L90'>90</a> <a name='L91'></a><a href='#L91'>91</a> <a name='L92'></a><a href='#L92'>92</a> <a name='L93'></a><a href='#L93'>93</a> <a name='L94'></a><a href='#L94'>94</a> <a name='L95'></a><a href='#L95'>95</a> <a name='L96'></a><a href='#L96'>96</a> <a name='L97'></a><a href='#L97'>97</a> <a name='L98'></a><a href='#L98'>98</a> <a name='L99'></a><a href='#L99'>99</a> <a name='L100'></a><a href='#L100'>100</a> <a name='L101'></a><a href='#L101'>101</a> <a name='L102'></a><a href='#L102'>102</a> <a name='L103'></a><a href='#L103'>103</a> <a name='L104'></a><a href='#L104'>104</a> <a name='L105'></a><a href='#L105'>105</a> <a name='L106'></a><a href='#L106'>106</a> <a name='L107'></a><a href='#L107'>107</a> <a name='L108'></a><a href='#L108'>108</a> <a name='L109'></a><a href='#L109'>109</a> <a name='L110'></a><a href='#L110'>110</a> <a name='L111'></a><a href='#L111'>111</a> <a name='L112'></a><a href='#L112'>112</a> <a name='L113'></a><a href='#L113'>113</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</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-neutral">&nbsp;</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-neutral">&nbsp;</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-neutral">&nbsp;</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-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">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</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-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</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">1x</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-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</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-no">&nbsp;</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-no">&nbsp;</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-no">&nbsp;</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-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</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-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-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</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-no">&nbsp;</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-no">&nbsp;</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-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</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-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</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-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</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-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</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></td><td class="text"><pre class="prettyprint lang-js">// We have to use a local file and let babel ignore it, until pdfkit is ported to ES6 var PDFDocument = require("../pdfkit.js"); var fs = require("fs"); let path = require("path"); let mkdirp = require("mkdirp"); import * as SVGtoPDF from "svg-to-pdfkit"; import * as _ from "lodash"; import { IAsyncArgdownPlugin, IAsyncRequestHandler } from "../IAsyncArgdownPlugin"; import { IArgdownRequest, IRequestHandler, ArgdownPluginError } from "@argdown/core"; import { ISvgResponse } from "./DotToSvgExportPlugin"; import { IFileRequest } from "../IFileRequest"; import { IFileNameProvider } from "./SaveAsFilePlugin"; &nbsp; export interface IPdfSettings { outputDir?: string; } export interface IPdfRequest { pdf?: IPdfSettings; } export interface ISvgToPdfSettings { outputDir?: string; format?: string; fileName?: string | IFileNameProvider; } export interface ISvgToPdfRequest extends IArgdownRequest { svgToPdf?: ISvgToPdfSettings; } export class SvgToPdfExportPlugin implements IAsyncArgdownPlugin { name = "SvgToPdfExportPlugin"; defaults: ISvgToPdfSettings; constructor(config?: ISvgToPdfSettings) { this.defaults = _.defaultsDeep({}, config, { outputDir: "./pdf", format: "svg" }); } <span class="fstat-no" title="function not covered" > getSettings</span>(request: IArgdownRequest): ISvgToPdfSettings { const r = &lt;ISvgToPdfRequest&gt;<span class="cstat-no" title="statement not covered" >request;</span> <span class="cstat-no" title="statement not covered" > r.svgToPdf = r.svgToPdf || {};</span> <span class="cstat-no" title="statement not covered" > return r.svgToPdf;</span> } prepare: IRequestHandler = <span class="fstat-no" title="function not covered" >(r</span>equest, response) =&gt; { <span class="cstat-no" title="statement not covered" > if (!(&lt;ISvgResponse&gt;response).svg) {</span> <span class="cstat-no" title="statement not covered" > throw new ArgdownPluginError(this.name, "Missing svg field in response.");</span> } <span class="cstat-no" title="statement not covered" > _.defaults(this.getSettings(request), this.defaults);</span> }; runAsync: IAsyncRequestHandler = <span class="fstat-no" title="function not covered" >async</span> (request, response) =&gt; { const settings = <span class="cstat-no" title="statement not covered" >this.getSettings(request);</span> let fileName = <span class="cstat-no" title="statement not covered" >"default";</span> let outputDir = <span class="cstat-no" title="statement not covered" >settings.outputDir;</span> const fileRequest = &lt;IFileRequest&gt;<span class="cstat-no" title="statement not covered" >request;</span> const pdfRequest = &lt;IPdfRequest&gt;<span class="cstat-no" title="statement not covered" >request;</span> <span class="cstat-no" title="statement not covered" > if (fileRequest.outputDir) {</span> <span class="cstat-no" title="statement not covered" > fileName = this.getFileName(fileRequest.outputDir);</span> <span class="cstat-no" title="statement not covered" > outputDir = path.dirname(fileRequest.outputDir);</span> } else <span class="cstat-no" title="statement not covered" >if (pdfRequest.pdf &amp;&amp; pdfRequest.pdf.outputDir) {</span> <span class="cstat-no" title="statement not covered" > fileName = this.getFileName(pdfRequest.pdf.outputDir);</span> <span class="cstat-no" title="statement not covered" > outputDir = path.dirname(pdfRequest.pdf.outputDir);</span> } else <span class="cstat-no" title="statement not covered" >if (_.isFunction(settings.fileName)) {</span> <span class="cstat-no" title="statement not covered" > fileName = settings.fileName.call(this, request, response);</span> } else <span class="cstat-no" title="statement not covered" >if (_.isString(settings.fileName)) {</span> <span class="cstat-no" title="statement not covered" > fileName = settings.fileName;</span> } else <span class="cstat-no" title="statement not covered" >if (fileRequest.inputPath) {</span> <span class="cstat-no" title="statement not covered" > fileName = this.getFileName(fileRequest.inputPath);</span> } const absoluteOutputDir = <span class="cstat-no" title="statement not covered" >path.resolve(process.cwd(), outputDir);</span> const filePath = <span class="cstat-no" title="statement not covered" >absoluteOutputDir + "/" + fileName + ".pdf";</span> <span class="cstat-no" title="statement not covered" > await new Promise(<span class="fstat-no" title="function not covered" >(r</span>esolve, reject) =&gt; {</span> <span class="cstat-no" title="statement not covered" > mkdirp(absoluteOutputDir, <span class="fstat-no" title="function not covered" >function(</span>err: Error) {</span> <span class="cstat-no" title="statement not covered" > if (err) {</span> <span class="cstat-no" title="statement not covered" > reject(err);</span> } <span class="cstat-no" title="statement not covered" > resolve();</span> }); }); const svgResponse = &lt;ISvgResponse&gt;<span class="cstat-no" title="statement not covered" >response;</span> const doc = <span class="cstat-no" title="statement not covered" >new PDFDocument(settings);</span> <span class="cstat-no" title="statement not covered" > SVGtoPDF(doc, svgResponse.svg, 0, 0, settings);</span> <span class="cstat-no" title="statement not covered" > await this.savePdfToFile(doc, filePath);</span> }; // https://github.com/devongovett/pdfkit/issues/265 <span class="fstat-no" title="function not covered" > async</span> savePdfToFile(pdf: any, fileName: string) { <span class="cstat-no" title="statement not covered" > return new Promise(<span class="fstat-no" title="function not covered" >resolve</span> =&gt; {</span> // To determine when the PDF has finished being written successfully // we need to confirm the following 2 conditions: // // 1. The write stream has been closed // 2. PDFDocument.end() was called syncronously without an error being thrown &nbsp; let pendingStepCount = <span class="cstat-no" title="statement not covered" >2;</span> &nbsp; const stepFinished = <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >() </span>=&gt; {</span> <span class="cstat-no" title="statement not covered" > if (--pendingStepCount == 0) {</span> <span class="cstat-no" title="statement not covered" > resolve();</span> } }; &nbsp; const writeStream = <span class="cstat-no" title="statement not covered" >fs.createWriteStream(fileName);</span> <span class="cstat-no" title="statement not covered" > writeStream.on("close", stepFinished);</span> <span class="cstat-no" title="statement not covered" > pdf.pipe(writeStream);</span> &nbsp; <span class="cstat-no" title="statement not covered" > pdf.end();</span> &nbsp; <span class="cstat-no" title="statement not covered" > stepFinished();</span> }); } <span class="fstat-no" title="function not covered" > getFileName</span>(file: string): string { let extension = <span class="cstat-no" title="statement not covered" >path.extname(file);</span> <span class="cstat-no" title="statement not covered" > return path.basename(file, extension);</span> } } &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="https://istanbul.js.org/" target="_blank">istanbul</a> at Thu Jun 21 2018 13:21:51 GMT+0200 (CEST) </div> </div> <script src="../../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../../sorter.js"></script> <script src="../../block-navigation.js"></script> </body> </html>