@antora/assembler 1.0.0-alpha.2 → 1.0.0-alpha.5

package/lib/load-config.js

@@ -27,13 +27,15 @@ function loadConfig (playbook, configSource = './antora-assembler.yml') {
     if (config.enabled === false) return undefined
     let asciidocAttrs
     if (!config.asciidoc) {
-      config.asciidoc = { attributes: (asciidocAttrs = { doctype: 'book' }) }
+      config.asciidoc = { attributes: (asciidocAttrs = {}) }
     } else if (!(asciidocAttrs = config.asciidoc.attributes)) {
-      config.asciidoc.attributes = asciidocAttrs = { doctype: 'book' }
+      config.asciidoc.attributes = asciidocAttrs = {}
     }
-    Object.assign(asciidocAttrs, { revdate: new Date().toISOString().split('T')[0], 'page-partial': null })
+    if (!('doctype' in asciidocAttrs)) asciidocAttrs.doctype = 'book'
+    asciidocAttrs.revdate = new Date().toISOString().split('T')[0]
+    asciidocAttrs['page-partial'] = null
     if (config.componentVersions == null) {
-      config.componentVersions = ['**']
+      config.componentVersions = ['*']
     } else if (typeof config.componentVersions === 'string') {
       config.componentVersions = config.componentVersions.split(', ')
     }

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}//`
@@ -166,27 +166,19 @@ function aggregateAsciiDoc (
       buffer.push(`${'='.repeat(hlevel)} ${overviewTitle}`)
       if (toggleSectids) buffer.push(':sectids:')
     }
-    const siteUrl = doc.getAttribute('site-url')
+    const siteUrl = ((val) => {
+      if (!val || val === '/') return ''
+      return val.charAt(val.length - 1) === '/' ? val.substr(0, val.length - 1) : val
+    })(doc.getAttribute('site-url'))
     const lines = doc.getSourceLines()
     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.getDocument().isNested()
+        : !(it.getContext() === 'table_cell' && it.getStyle() === 'asciidoc')
+    )
     allBlocks.forEach((block) => {
       const contentModel = block.content_model
       if (
@@ -218,11 +210,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 +223,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,13 +296,14 @@ 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
       if (typeof lineno !== 'number') return
       const context = block.getContext()
-      const idx = lineno - 1
-      if (context === 'section') {
+      let idx = lineno - 1
+      if (context === 'section' && !block.getDocument().isNested()) {
         if (block.getSectionName() === 'header') {
           lines.splice(idx, 1)
           return
@@ -327,34 +323,37 @@ 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]
           }
+        } else if (context === 'document' && block.hasHeader()) {
+          // nested document
+          idx = (block.getHeader().getLineNumber() || idx + 1) - 1
         }
         if (block.getId()) rewriteStyleAttribute(block, lines, idx, idprefix)
       }
@@ -372,7 +371,7 @@ function aggregateAsciiDoc (
             } else if (val !== initialVal) {
               accum.push(`:${name}:${initialVal ? ' ' + initialVal : ''}`)
             }
-          } else if (val != null && !doc.isAttributeLocked(name)) {
+          } else if (val != null && !(doc.isAttributeLocked(name) || name === 'doctype')) {
             accum.push(`:!${name}:`)
           }
           return accum

package/lib/produce-aggregate-documents.js

@@ -7,7 +7,9 @@ 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
+  const { doctype, 'source-highlighter': sourceHighlighter } = assemblerAsciiDocAttributes
+  delete assemblerAsciiDocAttributes.doctype
+  delete assemblerAsciiDocAttributes['source-highlighter']
   return filterComponentVersions(contentCatalog.getComponents(), assemblerConfig.componentVersions).reduce(
     (accum, componentVersion) => {
       const { name: componentName, version, title, navigation } = componentVersion
@@ -30,7 +32,8 @@ function produceAggregateDocuments (loadAsciiDoc, contentCatalog, assemblerConfi
       const mutableAttributes = startPage
         ? selectMutableAttributes(loadAsciiDoc, contentCatalog, startPage, mergedAsciiDocConfig)
         : {}
-      return accum.concat(
+      delete mutableAttributes.doctype
+      accum = accum.concat(
         prepareOutlines(navigation, rootEntry, rootLevel).map((outline) =>
           produceAggregateDocument(
             loadAsciiDoc,
@@ -44,6 +47,11 @@ function produceAggregateDocuments (loadAsciiDoc, contentCatalog, assemblerConfi
           )
         )
       )
+      mergedAsciiDocConfig.attributes.doctype = doctype
+      sourceHighlighter
+        ? (mergedAsciiDocConfig.attributes['source-highlighter'] = sourceHighlighter)
+        : delete mergedAsciiDocConfig.attributes['source-highlighter']
+      return accum
     },
     []
   )

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.2",
+  "version": "1.0.0-alpha.5",
   "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)",
@@ -25,6 +25,7 @@
     "./filter-component-versions": "./lib/filter-component-versions.js",
     "./load-config": "./lib/load-config.js",
     "./produce-aggregate-document": "./lib/produce-aggregate-document.js",
+    "./produce-aggregate-documents": "./lib/produce-aggregate-documents.js",
     "./select-mutable-attributes": "./lib/select-mutable-attributes.js"
   },
   "dependencies": {