RubyGems - opendoc-theme - Versions diffs - 2.0.2 → 2.0.5 - Mend

opendoc-theme 2.0.2 → 2.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bba0d36199745d01ecd554e70d0e8ff15d556abf16cb512397948fe76ef4d8c5
-  data.tar.gz: f0d6277ff4ceb00609db16f42038522b0c2b45e0096b7a8b3af0eb9fdcdd338b
+  metadata.gz: 71f5e69914f38659f102e6567692052bd61896c2c0937ac04e60d5c3fccb21d5
+  data.tar.gz: 92bfa317395e7bc019884a3ca922a433ef315d74ca97e5d3d366e6942b482867
 SHA512:
-  metadata.gz: 27fe5013f29d34cffd1b040ef5f7b4ac0120345e395ec008f3ebc1a73e75de51599b16ba7d864cfbb201cd81fe669f93451d2c90e4503bfc7c2fa033c8a50ea8
-  data.tar.gz: 8a79e246acf0d9d198905c6b54b7b93678645eea364ea1a127f40f36cb6c7293af7c0d83f7cde54824da3a267afba7ed0b263749c1db12e0f82608c023ce6242
+  metadata.gz: 70f4127b68434caa99d1faf4e89d5a9244dc9ae64c0ccb05510de955e868caffc50c715cc28db9c8e7f38e728814eb878b66dc823738f84316eb5865fe83cb45
+  data.tar.gz: 0f85ce9521b4da81788d0ec43a7438dadf09091a21f643c2d9ec88fd5a4478874fe3c4c38710aa41ab319adb6ee7ccd69c8a5a4b0170fd7bb95bfc1b70e45172

data/README.md CHANGED

@@ -4,8 +4,7 @@ Welcome to your new Jekyll theme! In this directory, you'll find the files you n
 # Deployment
 - Update version number on `opendoc-theme.gemspec`
-- Run `gem build opendoc-theme.gemspec`
-- Add tag with new version number to commit
+- Add tag with new version number to commit e.g. `2.0.2`
 - Push to origin
 ## Installation

data/_includes/directory.html CHANGED

@@ -81,7 +81,7 @@ If there is only one folder or documents all at root, dont show back button
 If there is only one folder, show expanded content list
 {% endcomment %}
 {% assign toc_id = 'toc_' | append: folder | downcase %}
-{% if folders.size == 1 %}
+{% if sorted_folders.size == 1 %}
 <section class="contents lonely" id="{{ toc_id }}">
 {% elsif include_currdir_decode == folder and include.currdir != '/' %}
 <section class="contents" id="{{ toc_id }}">

data/_includes/toc.html CHANGED

@@ -86,6 +86,12 @@ Output:
             {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
             {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
+            {% comment %}
+                Strips out footnotes links then strips out all other html tags
+                This naively assumes that all footnote links are appended at the end of the header
+            {% endcomment %}
+            {% assign header = header | split: '<sup' | first %}
+            {% assign header = header | strip_html | strip %}
             {% assign space = '' %}
             {% for i in (1..indentAmount) %}
@@ -104,4 +110,4 @@ Output:
 {% capture my_toc %}{:.{{ include.class }}}
 {{ my_toc | lstrip }}{% endcapture %}
 {% endif %}
-{% endcapture %}{% assign tocWorkspace = '' %}{{ my_toc | markdownify | strip }}
+{% endcapture %}{% assign tocWorkspace = '' %}{{ my_toc | markdownify | strip }}

data/_layouts/print.html CHANGED

@@ -13,7 +13,7 @@
     <link rel="stylesheet" href="./assets/styles/main.css">
   </head>
-  <body id="print-content">
+  <body class="print-content">
     <section class="description">
       <img class="description-logo" src="{{ '.' | append: site.styling_options.logo_path }}">
       <div class="description-title">{{ site.title }}</div>

data/_sass/_base.scss CHANGED

@@ -145,6 +145,13 @@ pre {
   margin-bottom: $block-spacing;
 }
+blockquote {
+  margin-inline-end: 0;
+  @include mobile-screen() {
+    margin-inline-start: 20px;
+  }
+}
 // Lists
 // -----
 dl {

data/_sass/_print.scss CHANGED

@@ -1,5 +1,4 @@
-#print-content {
-  /* print styles go here */
+.print-content {
   .site-header-text {
     color: $primary-brand-color;
     font-family: $header-font-family;
@@ -22,6 +21,34 @@
   }
 }
+.print-content-small {
+  .site-header-text {
+    font-size: 25px;
+  }
+  #document-title {
+    font-size: 20px;
+  }
+  #main-content {
+    font-size: 13px;
+  }
+}
+.print-content-large {
+  .site-header-text {
+    font-size: 40px;
+  }
+  #document-title {
+    font-size: 30px;
+  }
+  #main-content {
+    font-size: $base-font-size;
+  }
+}
 @media print {
   @page {
     size: A4;

data/assets/js/search.js CHANGED

@@ -92,7 +92,7 @@
     // Load Lunr Index if set
     // ============================================================================
-    var searchSetOffline = "{{ site.offline_search_only }}" === "true" || false
+    var searchSetOffline = "{{ site.offline }}" === "true" || false
     if (searchSetOffline) {
         getLunrIndex()
@@ -263,7 +263,7 @@
     var generateResultHTML = function (result, i) {
         var element = document.createElement('a')
         element.className = 'search-link nav-link'
-        var urlParts = ('{{site.baseurl}}' + result.url).split('/')
+        var urlParts = result.url.split('/')
         urlParts = urlParts.filter(function (part) {
             return part !== ''
         })
@@ -577,4 +577,4 @@
         }
     }
-})()
+})()

data/assets/js/toolbar.js CHANGED

@@ -61,7 +61,20 @@
     printButtons.forEach(function (btn) {
         btn.addEventListener('click', function () {
-            window.open('./export.pdf', '_blank')
+            // S3 folder name; replace slashes to avoid creating sub-folders
+            var replacedRepoName = '{{ site.repository }}'.replace(/\//g, '-')
+            var pdfUrl = '{{ site.offline }}' === 'true' ?
+                '{{ "/assets/pdfs" | relative_url }}' :
+                'https://opendoc-theme-pdf.s3-ap-southeast-1.amazonaws.com/' + replacedRepoName
+            var page = pageIndex[window.location.pathname]
+            // documentTitle refers to the name of the document folder
+            // If page.dir is slash, that indicates the root directory
+            // PDF at root dir is named export.pdf
+            var documentTitle = page.dir !== '/' ? page.dir : '/export/'
+            if (documentTitle) {
+                pdfUrl += documentTitle.substring(0, documentTitle.length-1) + '.pdf'
+            }
+            window.open(pdfUrl, '_blank')
         })
     })

data/assets/pdfs/empty ADDED

File without changes

data/assets/startup/build.sh CHANGED

@@ -5,14 +5,12 @@
 echo 'Started script to generate PDFs'
 echo 'Installing node dependencies'
 npm i glob jsdom js-yaml p-all
-if [[ (-z "${PDF_GEN_API_SERVER}") || (-z "${PDF_GEN_API_KEY}") ]]; then
-  npm i html-pdf
-fi
-node _site/assets/startup/pdf-gen.js
-if [ "{{ site.offline_search_only }}" == "true" ]; then
+if [ "{{ site.offline }}" == "true" ]; then
     node _site/assets/startup/prebuild-lunr-index.js
-    echo 'Generating Lunr Index complete'
+    echo 'Generating lunr index complete'
+    npm i html-pdf
 else
-    echo 'Skipping Lunr Index'
+    echo 'Skipping lunr index'
 fi
+node _site/assets/startup/pdf-gen.js
 echo 'End script'

data/assets/startup/docprint.html CHANGED

@@ -12,7 +12,7 @@
   <link rel="stylesheet" href="./assets/styles/main.css">
 </head>
-<body id=print-content>
+<body class=print-content>
   <div id="main-content" class="site-main">
   </div>
 </body>

data/assets/startup/pdf-gen.js CHANGED

@@ -1,28 +1,47 @@
+---
+---
 const fs = require('fs')
-const fsp = require('fs').promises
+const crypto = require('crypto')
 const pAll = require('p-all')
 const https = require('https')
 const glob = require('glob')
 const path = require('path')
+const URL = require('url').URL;
 const jsdom = require('jsdom')
 const jsyaml = require('js-yaml')
 const sitePath = __dirname + '/../..'
-// Env vars to generate PDFs on AWS Lambda
-let pdfGenVarsPresent = true
-let pdf
-let PDF_GEN_CONCURRENCY
+let generatingPdfLocally = '{{ site.offline }}' === 'true' || false
+const S3StorageUrl = new URL('https://opendoc-theme-pdf.s3-ap-southeast-1.amazonaws.com')
+const localPdfFolder = path.join(sitePath, 'assets', 'pdfs') // local folder for pdfs
+ // S3 folder; replace slashes to avoid creating sub-folders
+const S3PdfFolder = '{{ site.repository }}'.replace(/\//g, '-')
+const bucketName = S3StorageUrl.hostname.split('.')[0]
+// CSS to be applied to the PDFs, this will be inserted in <head>
+const pathToCss = path.join(sitePath, 'assets', 'styles', 'main.css')
+// Hash is stored as S3 metadata and served as custom header whenever the pdf is requested
+const serializedHtmlHashHeader = 'x-amz-meta-html-hash'
-if (process.env.PDF_GEN_API_KEY === undefined || process.env.PDF_GEN_API_SERVER === undefined) {
-    console.log('Env var PDF_GEN_API_KEY or PDF_GEN_API_SERVER for AWS Lambda not present: Generating PDFs locally instead.')
+let pdf
+let pdfGenConcurrency = 1
+if (generatingPdfLocally) {
     pdf = require('html-pdf')
-    pdfGenVarsPresent = false
-    PDF_GEN_CONCURRENCY = 1 // When generating locally make it synchronous
+    console.log('Generating PDFs and storing locally instead.')
 } else {
-    PDF_GEN_CONCURRENCY = process.env.PDF_GEN_CONCURRENCY !== undefined ?
+    if (process.env.PDF_LAMBDA_KEY === undefined ||
+        process.env.PDF_LAMBDA_SERVER === undefined) {
+            console.log('Environment variables PDF_LAMBDA_KEY or PDF_LAMBDA_SERVER for AWS Lambda not present')
+            process.exit(1)
+        }
+    pdfGenConcurrency = process.env.PDF_GEN_CONCURRENCY !== undefined ?
         parseInt(process.env.PDF_GEN_CONCURRENCY) :
         50 // Tuned for Netlify
-    console.log(`Env vars detected: Generating PDFs on AWS Lambda with concurrency of ${PDF_GEN_CONCURRENCY}`)
+    console.log(`Generating PDFs on AWS Lambda with concurrency of ${pdfGenConcurrency}.`)
+    console.log(`PDFs will be placed in bucket: ${bucketName} in folder ${S3PdfFolder}.`)
 }
 // These options are only applied when PDFs are built locally
@@ -49,19 +68,19 @@ const printIgnoreFiles = ['export.html', 'index.html']
 // Tracking statistics
 let numPdfsStarted = 0
+let numPdfsUnchanged = 0
 let numPdfsError = 0
 let numPdfsSuccess = 0
 let numTotalPdfs = 0
 const TIMER = 'Time to create PDFs'
 const main = async () => {
     // creating exports of individual documents
     console.time(TIMER)
     const docFolders = getDocumentFolders(sitePath, printIgnoreFolders)
     await exportPdfTopLevelDocs(sitePath)
     await exportPdfDocFolders(sitePath, docFolders)
-    console.log(`PDFs created with success:${numPdfsSuccess} error:${numPdfsError} total:${numTotalPdfs}`)
+    console.log(`PDFs created with success:${numPdfsSuccess} unchanged:${numPdfsUnchanged} error:${numPdfsError} total:${numTotalPdfs}`)
     console.timeEnd(TIMER)
 }
@@ -77,7 +96,7 @@ const exportPdfTopLevelDocs = async (sitePath) => {
         const configYml = yamlToJs(configFilepath)
         htmlFilePaths = reorderHtmlFilePaths(htmlFilePaths, configYml.order)
     }
-    await createPdf(htmlFilePaths, sitePath)
+    await createPdf(htmlFilePaths, sitePath, 'export')
 }
 const exportPdfDocFolders = (sitePath, docFolders) => {
@@ -90,7 +109,7 @@ const exportPdfDocFolders = (sitePath, docFolders) => {
         htmlFilePaths = htmlFilePaths.map((filepath) => path.join(folderPath, filepath))
         // Remove folders without HTML files (don't want empty pdfs)
-        if (htmlFilePaths.length === 0) return
+        if (htmlFilePaths.length === 0) continue
         numTotalPdfs++
         const indexFilepath = path.join(sitePath, '..', folder, 'index.md')
         if (indexFileHasValidOrdering(indexFilepath)) {
@@ -98,16 +117,22 @@ const exportPdfDocFolders = (sitePath, docFolders) => {
             const order = configMd.order
             htmlFilePaths = reorderHtmlFilePaths(htmlFilePaths, order)
         }
-        actions.push((() => createPdf(htmlFilePaths, folderPath)))
+        actions.push((() => createPdf(htmlFilePaths, folderPath, folder)))
     }
-    return pAll(actions, { concurrency: PDF_GEN_CONCURRENCY })
+    return pAll(actions, { concurrency: pdfGenConcurrency })
 }
 // Concatenates the contents in .html files, and outputs export.pdf in the specified output folder
-const createPdf = (htmlFilePaths, outputFolderPath) => {
+const createPdf = (htmlFilePaths, outputFolderPath, documentName) => {
     logStartedPdf(outputFolderPath)
     // docprint.html is our template to build pdf up from.
     const exportHtmlFile = fs.readFileSync(__dirname + '/docprint.html')
+    let cssFile = ''
+    try {
+        cssFile = fs.readFileSync(pathToCss)
+    } catch(err) {
+        console.log('Failed to read CSS file at ' + pathToCss +', CSS will not be applied')
+    }
     const exportDom = new jsdom.JSDOM(exportHtmlFile)
     const exportDomBody = exportDom.window.document.body
     const exportDomMain = exportDom.window.document.getElementById('main-content')
@@ -123,19 +148,7 @@ const createPdf = (htmlFilePaths, outputFolderPath) => {
         // html-pdf can't deal with these
         removeTagsFromDom(dom, 'script')
         removeTagsFromDom(dom, 'iframe')
-        // If a <img src=...> link src begins with '/', it is a relative link
-        // and needs to be prepended with '.' to show up in the pdf. Does not
-        // work for Lambda functions as the images are not available server side.
-        const imgsrcs = dom.window.document.getElementsByTagName('img')
-        for (let i = 0; i < imgsrcs.length; i++) {
-            const imgsrc = imgsrcs[i]
-            if (imgsrc.src.startsWith('/')) {
-                imgsrc.src = '.' + imgsrc.src
-            } else if (imgsrc.src.startsWith('.')) {
-                imgsrc.src = outputFolderPath + imgsrc.src.substr(1)
-            }
-        }
+        inlineImages(dom, outputFolderPath)
         // Site titles needs only be added once
         if (!addedTitle) {
@@ -169,10 +182,15 @@ const createPdf = (htmlFilePaths, outputFolderPath) => {
         }
         dom.window.close()
     })
-    if (!pdfGenVarsPresent) {
+    const serializedHtmlHash = crypto.createHash('md5').update(exportDom.serialize()).digest('base64')
+    exportDom.window.document.head.innerHTML += '<style>' + cssFile + '</style>'
+    console.log('createpdf hash for:' + outputFolderPath + ': ' + serializedHtmlHash)
+    if (generatingPdfLocally) {
+        exportDomBody.className += ' print-content-large'
+        // Generate and store locally
         return new Promise((resolve, reject) => {
-            pdf.create(exportDom.serialize(), localPdfOptions).toFile(path.join(outputFolderPath, 'export.pdf'), (err, res) => {
+            const url = path.join(localPdfFolder, documentName + '.pdf')
+            pdf.create(exportDom.serialize(), localPdfOptions).toFile(url, (err, res) => {
                 if (err) {
                     logErrorPdf('Creating PDFs locally', err)
                     return reject()
@@ -183,51 +201,73 @@ const createPdf = (htmlFilePaths, outputFolderPath) => {
             exportDom.window.close()
         })
     } else {
+        // Apply small font sizes because puppeteer tends to print big
+        exportDomBody.className += ' print-content-small'
         // Code for this API lives at https://github.com/opendocsg/pdf-lambda
-        const requestOptions = {
-            method: 'POST',
-            responseType: 'arraybuffer',
-            headers: {
-                'x-api-key': process.env.PDF_GEN_API_KEY,
-                'content-type': 'application/json',
-            },
-        }
-        return new Promise(function(resolve, reject) {
-            const request = https.request(process.env.PDF_GEN_API_SERVER, requestOptions, function(res) {
-                if (res.statusCode < 200 || res.statusCode >= 300) {
-                    logErrorPdf('Request status code', res.statusCode)
-                    reject()
+        const pdfName = `${documentName}.pdf`
+        return new Promise(function (resolve, reject) {
+            // Promise resolves if PDF is present and hash matches. Else reject.
+            const pdfS3Url = S3StorageUrl.toString() + S3PdfFolder + '/' + pdfName
+            const options = {
+                method: 'HEAD'
+            }
+            const pdfExistsRequest = https.request(pdfS3Url, options, function (res) {
+                if (res.statusCode === 404) {
+                    return reject('PDF not present')
                 }
-                const chunks = []
-                res.on('data', function(d) {
-                    chunks.push(d)
-                })
-                res.on('end', function() {
-                    const buf = Buffer.concat(chunks)
-                    resolve(buf)
-                })
+                if (!(serializedHtmlHashHeader in res.headers)) {
+                    return reject('HTML hash header not present')
+                }
+                if (res.headers[serializedHtmlHashHeader] !== serializedHtmlHash) {
+                    return reject('PDF hash does not match')
+                }
+                logUnchangedPdf(pdfName, pdfS3Url)
+                resolve()
             })
-            request.on('error', (err) => {
-                logErrorPdf('Request encountered error', err)
-                reject()
+            pdfExistsRequest.on('error', function (err) {
+                console.log(`pdfExistsRequest encountered error for ${pdfName}:, ${err}`)
+                return reject()
             })
-            // POST request body
-            request.write(JSON.stringify({
-                'serializedDom': exportDom.serialize()
-            }))
-            request.end()
-            exportDom.window.close()
-        }).then((buffer) => {
-            const outputPdfPath = path.join(outputFolderPath, 'export.pdf')
-            return fsp.writeFile(outputPdfPath, buffer)
-                .then(() => {
-                    logSuccessPdf(outputPdfPath)
-                }).catch((err) => {
-                    logErrorPdf('Writing out file', err)
+            pdfExistsRequest.end()
+        }).then(() => {},
+            function (rejected) {
+                // Rejected: send to lambda function to create PDF
+                const options = {
+                    method: 'POST',
+                    headers: {
+                        'x-api-key': process.env.PDF_LAMBDA_KEY,
+                        'content-type': 'application/json',
+                    }
+                }
+                const pdfCreationBody = {
+                    'serializedHTML': exportDom.serialize(),
+                    'serializedHTMLName': S3PdfFolder + '/' + pdfName,
+                    'serializedHTMLHash': serializedHtmlHash,
+                    'bucketName': bucketName
+                }
+                return new Promise(function (resolve, reject) {
+                    const pdfCreationRequest = https.request(process.env.PDF_LAMBDA_SERVER, options, function (res) {
+                        if (res.statusCode < 200 || res.statusCode >= 300) {
+                            logErrorPdf(`pdfCreationRequest status code for ${pdfName}: `, res.statusCode)
+                            return reject()
+                        }
+                        logSuccessPdf(pdfName)
+                        return resolve()
+                    })
+                    pdfCreationRequest.on('error', function(err) {
+                        logErrorPdf(`pdfCreationRequest encountered error for ${pdfName}:`, err)
+                        return reject()
+                    })
+                    pdfCreationRequest.write(JSON.stringify(pdfCreationBody))
+                    pdfCreationRequest.end()
+                }).catch((error) => {
+                    logErrorPdf(`pdfCreation promise error for ${pdfName}`, error)
+                }).finally(() => {
+                    exportDom.window.close()
                 })
-        }).catch((error) => {
-            logErrorPdf('Request promise', error)
-        })
+            })
     }
 }
@@ -236,6 +276,11 @@ const logStartedPdf = (outputFolderPath) => {
     console.log(`createpdf started for:${outputFolderPath} (${numPdfsStarted}/${numTotalPdfs})`)
 }
+const logUnchangedPdf = (outputFolderPath, pdfUrl) => {
+    numPdfsUnchanged++
+    console.log(`createpdf unchanged for:${outputFolderPath} at ${pdfUrl} (${numPdfsUnchanged}/${numTotalPdfs})`)
+}
 const logErrorPdf = (origin, error) => {
     numPdfsError++
     console.log(`createpdf error for: ${origin}: ${error}(${numPdfsError}/${numTotalPdfs})`)
@@ -246,6 +291,38 @@ const logSuccessPdf = (outputPdfPath) => {
     console.log(`createpdf success for:${outputPdfPath} (${numPdfsSuccess}/${numTotalPdfs})`)
 }
+const imageType = {
+    '.png':'image/png',
+    '.jpg':'image/jpeg',
+    '.jpeg':'image/jpeg',
+    '.bmp':'image/bmp',
+    '.webp':'image/webp',
+}
+// Load images and inline them
+const inlineImages = (dom, outputFolderPath) => {
+    const imgs = dom.window.document.getElementsByTagName('img')
+    for (let i = 0; i < imgs.length; i++) {
+        const img = imgs[i]
+        if (!img.src.startsWith('http')) {
+            // Convert all file paths into absolute file paths
+            const imgPath = img.src.startsWith('/') ?
+                path.join(__dirname, '..', '..', img.src).toString() :
+                path.join(outputFolderPath, img.src).toString()
+            if (fs.existsSync(imgPath)) {
+                const imgRaw = fs.readFileSync(imgPath)
+                if (path.extname(imgPath) === '.svg') { // don't encode svgs in base64, simply insert them
+                    img.src = 'data:image/svg+xml;utf8,' + imgRaw.toString('utf-8')
+                } else {
+                    const dataType = imageType[path.extname(imgPath)] || 'image/png'
+                    const uri = 'data:' + dataType + ';base64,' + imgRaw.toString('base64')
+                    img.src = uri
+                }
+            }
+        }
+    }
+}
 // Returns a list of the valid document (i.e. folder) paths
 const getDocumentFolders = (sitePath, printIgnoreFolders) => {
     return fs.readdirSync(sitePath).filter(function (filePath) {

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opendoc-theme
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.5
 platform: ruby
 authors:
 - Opendoc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-04 00:00:00.000000000 Z
+date: 2019-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -116,6 +116,7 @@ files:
 - assets/js/pre-loader.js
 - assets/js/search.js
 - assets/js/toolbar.js
+- assets/pdfs/empty
 - assets/siteIndex.json
 - assets/startup/build.sh
 - assets/startup/docprint.html
@@ -150,7 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubyforge_project:
+rubygems_version: 2.7.7
 signing_key:
 specification_version: 4
 summary: Jekyll theme for Opendoc sites