@antora/assembler 1.0.0-alpha.1 → 1.0.0-alpha.4

package/lib/produce-aggregate-document.js

@@ -105,7 +105,7 @@ function aggregateAsciiDoc (
     page = new page.constructor(Object.assign({}, page, { contents, mediaType: 'text/asciidoc' }))
     const { module: module_, relative, origin } = page.src
     const doc = loadAsciiDoc(page, contentCatalog, asciidocConfig)
-    const ids = doc.getCatalog().ids
+    const refs = doc.getCatalog().refs
     // NOTE: in Antora, docname is relative src path from module without file extension
     const docname = doc.getAttribute('docname')
     //const idprefix = `${module_ === 'ROOT' ? '' : module_ + ':'}${docname}//`
@@ -171,22 +171,10 @@ function aggregateAsciiDoc (
     const ignoreLines = []
     // TODO: think more about when multipart is allowed; perhaps configurable
     if (doc.hasSections()) fixSectionLevels(doc.getSections(), level === 0)
-    // TODO: update / simplify findBy calls when upgrading to Asciidoctor 2
-    const allBlocks = doc
-      .findBy((it) => it.getContext() !== 'document')
-      .reduce((accum, block) => {
-        accum.push(block)
-        if (block.getContext() === 'table') {
-          const rows = block.rows
-          ;[...rows.body, ...rows.foot].forEach((row) => {
-            row.forEach((cell) => {
-              if (cell.style !== 'asciidoc') return
-              accum.push(...cell.inner_document.findBy((it) => it.getContext() !== 'document'))
-            })
-          })
-        }
-        return accum
-      }, [])
+    const allBlocks = doc.findBy(
+      { traverse_documents: true },
+      (it) => it.getContext() !== 'document' && !(it.getContext() === 'table_cell' && it.getStyle() === 'asciidoc')
+    )
     allBlocks.forEach((block) => {
       const contentModel = block.content_model
       if (
@@ -218,11 +206,9 @@ function aggregateAsciiDoc (
       let line = lines[idx]
       if (~line.indexOf('<<')) {
         line = line.replace(/(?<![\\+])<<#?([\p{Alpha}0-9_/.:{][^>,]*?)(?:|, *([^>]+?))?>>/gu, (m, refid, text) => {
-          // support natural xref; note this logic will change when upgrading to Asciidoctor 2
-          if (!ids['$key?'](refid) && (~refid.indexOf(' ') || refid.toLowerCase() !== refid)) {
-            if (!(refid = doc.getCatalog().ids.$key(refid).$to_s())) {
-              return m
-            }
+          // support natural xref
+          if (!refs['$key?'](refid) && (~refid.indexOf(' ') || refid.toLowerCase() !== refid)) {
+            if ((refid = doc.$resolve_id(refid))['$nil?']()) return m
           }
           return `<<${idprefix}${refid}${text ? ',' + text : ''}>>`
         })
@@ -233,21 +219,26 @@ function aggregateAsciiDoc (
       }
       if (~line.indexOf('xref:')) {
         // Q: should we allow : as first character of target?
-        line = line.replace(/xref:([\p{Alpha}#/.{].*?)\[(|.*?[^\\])\]/gu, (m, target, text) => {
+        line = line.replace(/xref:([\p{Alpha}0-9_/.{#].*?)\[(|.*?[^\\])\]/gu, (m, target, text) => {
           let pagePart, fragment, targetPage
           const hashIdx = target.indexOf('#')
           if (~hashIdx) {
             pagePart = target.substr(0, hashIdx)
             fragment = target.substr(hashIdx + 1)
             // TODO: for now, assume .adoc; in the future, consider other file extensions
-            if (!(pagePart && pagePart.endsWith('.adoc'))) pagePart += '.adoc'
+            if (pagePart && !pagePart.endsWith('.adoc')) pagePart += '.adoc'
           } else if (target.endsWith('.adoc')) {
             pagePart = target
             fragment = ''
           } else {
             fragment = target
           }
-          if (!pagePart) return `<<${idprefix}${fragment}${text ? ',' + text.replace(/\\]/g, ']') : ''}>>`
+          if (!pagePart) {
+            // Q: should we validate the internal ID here?
+            return text && ~text.indexOf('=')
+              ? `xref:${idprefix}${fragment}[${text}]`
+              : `<<${idprefix}${fragment}${text ? ',' + text.replace(/\\]/g, ']') : ''}>>`
+          }
           if (~pagePart.indexOf('@') || /:.*:/.test(pagePart)) {
             // TODO: handle unresolved page better
             return siteUrl && (targetPage = contentCatalog.resolvePage(pagePart, page.src))
@@ -301,6 +292,7 @@ function aggregateAsciiDoc (
     // NOTE: need to do this last since it modifies the line numbers
     // we could remap the line numbers to make them resilient
     // or we could mark which lines to remove and filter them after
+    let lastImageMacroAt
     ;[...allBlocks].reverse().forEach((block) => {
       const lineno = block.getLineNumber()
       // NOTE: lineno is not defined for preamble
@@ -327,33 +319,33 @@ function aggregateAsciiDoc (
         if (block.getId()) rewriteStyleAttribute(block, lines, idx, idprefix, blockStyle)
       } else {
         if (context === 'image') {
-          const atImageMacro = (lines[idx] || '').startsWith('image::')
-          // NOTE: the following logic is needed only if parser is messing up line number of image block
-          //let atImageMacro
-          //// NOTE: account for line number tracking error in parser when image has block anchor
-          //if (block.getId()) {
-          //  const originalIdx = idx
-          //  let line
-          //  while ((line = lines[idx]) != null && !(atImageMacro = line.startsWith('image::'))) idx++
-          //  if (!atImageMacro) {
-          //    idx = originalIdx
-          //    if ((lines[idx - 1] || '').startsWith('image::')) {
-          //      atImageMacro = true
-          //      idx--
-          //    }
-          //  }
-          //} else if ((lines[idx] || '').startsWith('image::')) {
-          //  atImageMacro = true
-          //}
-          const target = block.getAttribute('target')
-          if (atImageMacro && isResourceSpec(target)) {
-            const image = contentCatalog.resolveResource(target, page.src, 'image', ['image'])
-            // FIXME: handle (or report) case when image is not resolved
-            if (image) {
-              image.out.assembled = true
-              const line = lines[idx]
-              lines[idx] = `image::${image.pub.url.substr(1)}${line.substr(line.indexOf('['))}`
+          let line = lines[idx] || ''
+          let prefix = ''
+          // Q: can we use startsWith('image::') in certain cases?
+          let imageMacroOffset = (
+            lastImageMacroAt && lastImageMacroAt[0] === idx ? line.substr(0, lastImageMacroAt[1]) : line
+          ).lastIndexOf('image::')
+          if (imageMacroOffset > 0) {
+            if (
+              block.getDocument().isNested() &&
+              (prefix = line.substr(0, imageMacroOffset)).trimRight().endsWith('|')
+            ) {
+              line = line.substr(prefix.length)
+            } else {
+              imageMacroOffset = -1
+            }
+          }
+          if (imageMacroOffset >= 0) {
+            const target = block.getAttribute('target')
+            if (isResourceSpec(target)) {
+              const image = contentCatalog.resolveResource(target, page.src, 'image', ['image'])
+              // FIXME: handle (or report) case when image is not resolved
+              if (image) {
+                lines[idx] = `${prefix}image::${image.pub.url.substr(1)}${line.substr(line.indexOf('['))}`
+                image.out.assembled = true
+              }
             }
+            lastImageMacroAt = [idx, imageMacroOffset]
           }
         }
         if (block.getId()) rewriteStyleAttribute(block, lines, idx, idprefix)

package/lib/produce-aggregate-documents.js

@@ -6,13 +6,15 @@ const selectMutableAttributes = require('./select-mutable-attributes')
 
 function produceAggregateDocuments (loadAsciiDoc, contentCatalog, assemblerConfig) {
   const { insertStartPage, rootLevel, sectionMergeStrategy, asciidoc: assemblerAsciiDocConfig } = assemblerConfig
+  const assemblerAsciiDocAttributes = Object.assign({}, assemblerAsciiDocConfig.attributes)
+  delete assemblerAsciiDocAttributes['source-highlighter'] // only used at convert time
   return filterComponentVersions(contentCatalog.getComponents(), assemblerConfig.componentVersions).reduce(
     (accum, componentVersion) => {
       const { name: componentName, version, title, navigation } = componentVersion
       if (!navigation) return accum
       const componentVersionAsciiDocConfig = getAsciiDocConfigWithAsciidoctorReducerExtension(componentVersion)
       const mergedAsciiDocConfig = Object.assign({}, componentVersionAsciiDocConfig, {
-        attributes: Object.assign({}, componentVersionAsciiDocConfig.attributes, assemblerAsciiDocConfig.attributes),
+        attributes: Object.assign({}, componentVersionAsciiDocConfig.attributes, assemblerAsciiDocAttributes),
       })
       const rootEntry = { content: title }
       const startPage = contentCatalog.getComponentVersionStartPage(componentName, version)
@@ -60,6 +62,7 @@ function getAsciiDocConfigWithAsciidoctorReducerExtension (componentVersion) {
         },
         [asciidoctorReducerExtension]
       ),
+      sourcemap: true,
     })
   }
   return Object.assign({}, asciidocConfig, { extensions: [asciidoctorReducerExtension], sourcemap: true })

package/lib/util/lazy-readable.js

@@ -6,9 +6,8 @@ const { PassThrough } = require('stream')
 class LazyReadable extends PassThrough {
   constructor (fn, options) {
     super(options)
-    const _read = this._read
     this._read = function () {
-      this._read = _read.bind(this)
+      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)
     }

package/lib/util/run-command.js

@@ -43,11 +43,15 @@ async function runCommand (cmd, argv = [], opts = {}) {
     ps.on('error', (err) => reject(err.code === 'ENOENT' ? new Error(`Command not found: ${cmdv.join(' ')}`) : err))
     ps.stdout.on('data', (data) => (output ? process.stdout.write(data) : stdout.push(data)))
     ps.stderr.on('data', (data) => stderr.push(data))
-    try {
-      input instanceof Buffer ? ps.stdin.end(input) : ps.stdin.end()
-    } catch (err) {
-      reject(err)
-    } finally {
+    if (input instanceof Buffer) {
+      try {
+        ps.stdin.on('error', () => undefined)
+        ps.stdin.end(input)
+      } catch (err) {
+        if (!ps.stdin.writableEnded) ps.stdin.end()
+        reject(err)
+      }
+    } else {
       ps.stdin.end()
     }
   })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/assembler",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.4",
   "description": "An extension library for Antora that assembles content from multiple pages into a single AsciiDoc file to converted and publish.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",