@antora/pdf-extension 1.0.0-alpha.1 → 1.0.0-alpha.10

package/README.md

@@ -21,7 +21,7 @@ antora:
 # ...
 ```
 
-You can configure the behavior of the extension using the optional *antora-assembler.yml* file.
+You can configure the behavior of the extension using the optional _antora-assembler.yml_ file.
 
 ## Copyright and License
 

package/lib/convert-document-to-pdf.js

@@ -1,42 +1,54 @@
 'use strict'
 
-const { runCommand } = (() => {
-  try {
-    return require('@antora/assembler')
-  } catch {
-    return require('../../assembler')
-  }
-})()
-const ospath = require('path')
+const fs = require('node:fs')
+const { promises: fsp } = fs
+const LazyReadable = require('./util/lazy-readable')
+const ospath = require('node:path')
 
 // Q: how can we simplify this to avoid redundant code?
 // Q: rename to convertDocumentToPDF?
-function convertDocumentToPdf (doc, buildConfig) {
+async function convertDocumentToPdf (doc, buildConfig, runCommand) {
   const {
     asciidoc: { attributes: baseAttributes } = { attributes: {} },
-    contents: input,
-    src: { component, version, basename, extname: docfilesuffix },
+    contents: stdin,
+    src: { component, version, basename, extname = doc.extname },
   } = doc
-  const { command = 'asciidoctor-pdf', cwd, dir } = buildConfig
+  const { cwd = process.cwd(), dir = cwd } = buildConfig
+  const command = buildConfig.command ?? (await scopeDefaultCommand(cwd))
+  const padCharRef = process.platform === 'win32' && command.startsWith('bundle exec ')
   const docfile = `${version}@${component}::pdf$${basename}`
-  const docname = basename.substr(0, basename.length - docfilesuffix.length)
+  const docname = basename.slice(0, basename.length - extname.length)
   const convertAttributes = Object.assign({}, baseAttributes, {
     docfile,
-    docfilesuffix,
+    docfilesuffix: extname,
     'docname@': docname,
     imagesdir: dir,
   })
   Object.assign(doc, { contents: null, extname: '.pdf', mediaType: 'application/pdf' })
-  const argv = Object.entries(convertAttributes).reduce(
-    (accum, [name, val]) =>
-      accum.push('-a', val ? `${name}=${val}` : val === '' ? name : `!${name}${val === false ? '=@' : ''}`) && accum,
-    []
+  const extraArgs = Object.entries(convertAttributes).reduce((accum, [name, val]) => {
+    if (val) {
+      val = `${name}=${padCharRef && val.charAt() === '&' ? ' ' : ''}${val}`
+    } else if (val === '') {
+      val = name
+    } else {
+      val = `!${name}${val === false ? '=@' : ''}`
+    }
+    accum.push('-a', val)
+    return accum
+  }, [])
+  const outputPath = ospath.join(dir, doc.path)
+  // Q: should mkdirs be the default behavior?
+  if (buildConfig.mkdirs) await fsp.mkdir(ospath.dirname(outputPath), { recursive: true, force: true })
+  extraArgs.push('-o', outputPath, '-')
+  return runCommand(command, extraArgs, { parse: true, cwd, stdin, stdout: 'print', stderr: 'print' }).then(() =>
+    Object.assign(doc, { contents: new LazyReadable(() => fs.createReadStream(outputPath)), out: { path: doc.path } })
   )
-  const output = ospath.join(dir, doc.path)
-  argv.push('-o', output)
-  // Q: should runCommand accept outputFlag and automatically append to argv?
-  return runCommand(command, argv, { cwd, input, output }).then((contents) =>
-    Object.assign(doc, { contents, out: { path: doc.path } })
+}
+
+function scopeDefaultCommand (cwd, baseCommand = 'asciidoctor-pdf') {
+  return fsp.access(ospath.join(cwd, 'Gemfile.lock')).then(
+    () => `bundle exec ${baseCommand}`,
+    () => baseCommand
   )
 }
 

package/lib/index.js

@@ -1,26 +1,19 @@
 'use strict'
 
 const convertDocumentToPdf = require('./convert-document-to-pdf')
-const { assembleContent } = (() => {
-  try {
-    return require('@antora/assembler')
-  } catch {
-    return require('../../assembler')
-  }
-})()
 
-module.exports.register = function () {
-  //this.on('beforeProcess', ({ asciidocConfig }) => {
-  //  asciidocConfig.keepSource = true
-  //})
-  this.on('contentClassified', ({ contentCatalog }) => {
-    contentCatalog.getPages((page) => {
-      if (!page.out) return
-      page.src.contents = page.contents
-      page.src = new Proxy(page.src, { deleteProperty: (o, p) => (p === 'contents' ? true : delete o[p]) })
-    })
+module.exports.register = function ({ config: { configFile: configSource } }) {
+  this.once('beforeProcess', ({ siteAsciiDocConfig }) => {
+    siteAsciiDocConfig.keepSource = true
+  })
+  this.once('navigationBuilt', ({ playbook, contentCatalog, siteCatalog }) => {
+    const { assembleContent } = (() => {
+      try {
+        return this.require('@antora/assembler') // when installed with Antora
+      } catch {
+        return require('@antora/assembler') // when installed separate from Antora, perhaps in project
+      }
+    })()
+    return assembleContent.call(this, playbook, contentCatalog, convertDocumentToPdf, { configSource, siteCatalog })
   })
-  this.on('beforePublish', ({ playbook, contentCatalog, siteCatalog }) =>
-    assembleContent.call(this, playbook, contentCatalog, convertDocumentToPdf, { siteCatalog })
-  )
 }

package/lib/util/lazy-readable.js

@@ -0,0 +1,18 @@
+'use strict'
+
+const { PassThrough } = require('node:stream')
+
+// adapted from https://github.com/jpommerening/node-lazystream/blob/master/lib/lazystream.js | license: MIT
+class LazyReadable extends PassThrough {
+  constructor (fn, options) {
+    super(options)
+    this._read = function () {
+      delete this._read // restores original method
+      fn.call(this, options).on('error', this.emit.bind(this, 'error')).pipe(this)
+      return this._read.apply(this, arguments)
+    }
+    this.emit('readable')
+  }
+}
+
+module.exports = LazyReadable

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/pdf-extension",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.10",
   "description": "An Antora extension that assembles content pages into PDF files by version and publishes them with the site.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -14,15 +14,20 @@
     "url": "https://gitlab.com/antora/antora-assembler/issues"
   },
   "scripts": {
-    "prepublishOnly": "node $npm_config_local_prefix/npm/prepublishOnly.js",
-    "postpublish": "node $npm_config_local_prefix/npm/postpublish.js"
+    "test": "node --test test/*-test.js",
+    "prepublishOnly": "npx -y downdoc --prepublish",
+    "postpublish": "npx -y downdoc --postpublish"
   },
   "main": "lib/index.js",
   "exports": {
     ".": "./lib/index.js"
   },
+  "imports": {
+    "#convert-document-to-pdf": "./lib/convert-document-to-pdf.js",
+    "#run-command": "@antora/run-command-helper"
+  },
   "dependencies": {
-    "@antora/assembler": "1.0.0-alpha.1"
+    "@antora/assembler": "1.0.0-alpha.10"
   },
   "engines": {
     "node": ">=16.0.0"