@antora/assembler 1.0.0-beta.4 → 1.0.0-beta.6

package/lib/assemble-content.js

@@ -51,7 +51,7 @@ async function assembleContent (playbook, contentCatalog, converter, { configSou
   const { convert = converter, extname: targetExtname, mediaType: targetMediaType } = converter ?? {}
   if (!(convert && assemblyFiles.length)) return assemblyFiles
   const { publishSite: publishFiles = require('@antora/site-publisher') } = generatorFunctions
-  await prepareWorkspace(publishFiles, assemblyFiles, contentCatalog, buildConfig)
+  await prepareWorkspace(publishFiles, assemblyFiles, buildConfig)
   const boundConvert = convert.bind(context)
   return new PromiseQueue({ concurrency: buildConfig.processLimit })
     .add(
@@ -100,22 +100,23 @@ async function assembleContent (playbook, contentCatalog, converter, { configSou
 }
 
 function createResolveAssemblyModel (context, contentCatalog, shared, intrinsicAttributes, navigationCatalog) {
+  const logger = context.getLogger ? context.getLogger(PACKAGE_NAME) : undefined
   const { assemblerProfiles } = context.getVariables()
   if (!assemblerProfiles) {
     return (componentVersion) => {
       const navigation =
         navigationCatalog?.getNavigation(componentVersion.name, componentVersion.version) ?? componentVersion.navigation
-      return Object.assign({}, shared, { navigation })
+      return Object.assign({ logger }, shared, { navigation })
     }
   }
-  const boundSendToLog = sendToLog.bind(context.getLogger ? context.getLogger(PACKAGE_NAME) : undefined)
+  const boundSendToLog = sendToLog.bind(logger)
   const { buildNavigation = require('@antora/navigation-builder') } = context.getFunctions()
   return (componentVersion) => {
     const componentVersionProfiles = assemblerProfiles.get(componentVersion.version + '@' + componentVersion.name)
     const overrides =
       componentVersionProfiles?.get(intrinsicAttributes['assembler-profile']) ?? componentVersionProfiles?.get() ?? {}
     const { navFiles, messages } = overrides
-    const model = Object.assign({}, shared, overrides)
+    const model = Object.assign({ logger }, shared, overrides)
     delete model.navFiles
     delete model.messages
     const navigationOverride = navigationCatalog?.getNavigation(componentVersion.name, componentVersion.version)
@@ -177,7 +178,7 @@ function prepareConvertAttributes (doc, targetExtname, buildConfig) {
         } else {
           val = `!${name}${val === false ? '@' : ''}`
         }
-        args.push('-a', val)
+        args.push(optionFlag, val)
       }
       return args
     },
@@ -206,7 +207,7 @@ function findFirstExportWithExtname (extname) {
 }
 
 // TODO: if no workspace dir is defined, we shouldn't continue
-function prepareWorkspace (publishFiles, assemblyFiles, contentCatalog, buildConfig) {
+function prepareWorkspace (publishFiles, assemblyFiles, buildConfig) {
   const { dir, clean, keepSource } = buildConfig
   const files = []
   const outPaths = new Set()
@@ -223,7 +224,7 @@ function prepareWorkspace (publishFiles, assemblyFiles, contentCatalog, buildCon
 
 function isBound (obj) {
   if (obj == null) return false
-  for (const p in obj) return true
+  for (const _ in obj) return true
   return false
 }
 

package/lib/load-config.js

@@ -16,7 +16,11 @@ function loadConfig (playbook, configSource = './antora-assembler.yml') {
             () => false
           )
           .then((exists) =>
-            exists ? fsp.readFile(configSource).then((data) => camelCaseKeys(yaml.load(data), ['asciidoc'])) : {}
+            exists
+              ? fsp
+                  .readFile(configSource)
+                  .then((data) => Object.assign(camelCaseKeys(yaml.load(data), ['asciidoc']), { file: configSource }))
+              : {}
           )
   ).then((config) => {
     if (config.enabled === false) return undefined

package/lib/produce-assembly-file.js

@@ -8,7 +8,7 @@ const unconvertInlineAsciiDoc = require('./util/unconvert-inline-asciidoc')
 const AttributeEntryRx = /^:([^:-][^:]*):(?: .*)?$/
 const BuiltInNamedEntities = { amp: '&', apos: "'", gt: '>', lt: '<', nbsp: ' ', quot: '"' }
 const CharRefRx = /&(?:([a-z][a-z]+\d{0,2})|#(?:(\d{2,6})|x([a-z\d]{2,5})));/g
-const DiscardAttributes = 'doctype leveloffset assembly-style underscore'.split(' ')
+const DiscardAttributes = 'doctype leveloffset assembly-navtitle assembly-style underscore'.split(' ')
 const ReservedIdNames = 'content header footnotes footer footer-text premable toc toctitle'.split(' ')
 
 function produceAssemblyFile (
@@ -24,11 +24,10 @@ function produceAssemblyFile (
   const pagesByUrl = files.reduce((map, it) => (it.src.family === 'page' ? map.set(it.pub.url, it) : map), new Map())
   if (outline.urlType === 'internal' && !pagesByUrl.get(outline.url) && !(outline.items || []).length) return
   const pagesInOutline = selectPagesInOutline(outline, pagesByUrl, componentVersion)
-  const navtitle = outline.content
   const buffer = mergeAsciiDoc(
     loadAsciiDoc,
     contentCatalog,
-    buildAsciiDocHeader(componentVersion, navtitle, assemblyModel),
+    buildAsciiDocHeader(componentVersion, outline.content, assemblyModel),
     componentVersion,
     outline,
     files,
@@ -38,7 +37,7 @@ function produceAssemblyFile (
     assemblyModel
   )
   const rootLevel = assemblyModel.rootLevel
-  const stem = rootLevel === 0 ? 'index' : generateSlug(navtitle)
+  const stem = rootLevel === 0 ? 'index' : generateSlug(buffer.navtitle)
   const downloadStem = [componentVersion.name, componentVersion.version, rootLevel === 0 ? '' : stem]
     .filter((it) => it)
     .join('-')
@@ -63,7 +62,7 @@ function buildAsciiDocHeader (componentVersion, navtitle, assemblyModel) {
   let doctitle = navtitleAsciiDoc
   if (navtitlePlain !== componentVersion.title) doctitle = `${componentVersion.title}: ${doctitle}`
   const version = componentVersion.version === 'master' ? '' : componentVersion.version
-  return [
+  const buffer = [
     `= ${doctitle}`,
     ...(version ? [`:revnumber: ${version}`] : []),
     ...(doctype === 'article' ? [] : [`:doctype: ${doctype ?? 'book'}`]),
@@ -75,6 +74,7 @@ function buildAsciiDocHeader (componentVersion, navtitle, assemblyModel) {
     `:page-component-display-version: ${componentVersion.displayVersion}`,
     `:page-component-title: ${componentVersion.title}`,
   ]
+  return Object.assign(buffer, { navtitle })
 }
 
 function selectPagesInOutline (outlineEntry, pagesByUrl, componentVersion, accum) {
@@ -106,13 +106,19 @@ function mergeAsciiDoc (
   supportsParts = false
 ) {
   // TODO: we could try to be smart about it and make sure the page with fragment is included at least once
-  if (outlineEntry.hash) return buffer
-  const { content: navtitle, items = [], unresolved, urlType, url } = outlineEntry
+  if (outlineEntry.hash) {
+    buffer.inBody ??= false
+    return buffer
+  }
+  let navtitle = outlineEntry.content
+  let navtitlePlain = sanitize(navtitle)
+  let navtitleAsciiDoc = unconvertInlineAsciiDoc(navtitle)
+  const { items = [], unresolved, urlType, url } = outlineEntry
+  // FIXME: ideally, resource ID would be stored in navigation so we can look up the page more efficiently
+  const page = urlType === 'internal' && !unresolved ? pagesInOutline.get(url) : undefined
   const atDocumentRoot = !buffer.inBody
   const atBookRoot = atDocumentRoot && !level && assemblyModel.doctype === 'book' && (supportsParts = true)
   const hasItems = items.length > 0
-  const navtitlePlain = sanitize(navtitle)
-  const navtitleAsciiDoc = unconvertInlineAsciiDoc(navtitle)
   const siteUrl = ((val) => {
     if (!val || val === '/') return ''
     return val.charAt(val.length - 1) === '/' ? val.slice(0, val.length - 1) : val
@@ -120,25 +126,23 @@ function mergeAsciiDoc (
   const idSeparator = assemblyModel.xmlIds ? '-' : ':'
   const idScopeSeparator = idSeparator.repeat(3)
   const idCoordinateSeparator = idSeparator === '-' ? '----' : idSeparator
-  // FIXME: ideally, resource ID would be stored in navigation so we can look up the page more efficiently
-  let page = urlType === 'internal' && !unresolved ? pagesInOutline.get(url) : undefined
-  if (page && pagesInOutline.assembled.pages.has(page)) page = undefined
-  if (page) {
-    let contents = page.src.contents
-    if (contents == null) return buffer
-    // NOTE: blank lines at top and bottom of document create mismatch when using line numbers to navigate source lines
-    // IMPORTANT: this must not leave behind lines the parser will drop!
-    // IDEA: another option is to capture initial lineno of reader and use as offset (but preseves those blank lines)
-    contents = Buffer.from(
-      contents
-        .toString()
-        .replace(/^(?:[ \t]*\r\n?|[ \t]*\n)+/, '')
-        .trimRight()
-    )
-    const { component, version, module: module_, relative, origin } = page.src
+  if (page && !pagesInOutline.assembled.pages.has(page)) {
+    const contents = page.src.contents
+    if (contents == null) {
+      buffer.inBody ??= false
+      return buffer
+    }
+    const { component, version, module: module_, relative, origin, mediaType } = page.src
     const topicPrefix = ~relative.indexOf('/') ? path.dirname(relative) + '/' : ''
-    const pageAsAsciiDoc = new page.constructor(Object.assign({}, page, { contents, mediaType: page.src.mediaType }))
+    const pageAsAsciiDoc = new page.constructor(
+      Object.assign({}, page, { contents: trimAsciiDoc(contents), mediaType })
+    )
     const doc = loadAsciiDoc(pageAsAsciiDoc, contentCatalog, asciidocConfig)
+    if (doc.hasAttribute('assembly-navtitle')) {
+      navtitleAsciiDoc = doc.getAttribute('assembly-navtitle')
+      navtitlePlain = sanitize((navtitle = doc.$apply_reftext_subs(navtitleAsciiDoc)))
+      if (buffer.inBody == null) buffer.navtitle = navtitle
+    }
     if (atDocumentRoot) {
       const authors = doc.getAuthors()
       if (authors.length) {
@@ -198,7 +202,6 @@ function mergeAsciiDoc (
     }
     buffer.push(`:page-module: ${module_}`)
     buffer.push(`:page-relative-src-path: ${relative}`)
-    //buffer.push(`:page-origin-type: ${origin.type}`)
     buffer.push(`:page-origin-url: ${origin.url}`)
     buffer.push(`:page-origin-start-path:${origin.startPath && ' '}${origin.startPath}`)
     buffer.push(`:page-origin-refname: ${origin.branch || origin.tag}`)
@@ -400,9 +403,9 @@ function mergeAsciiDoc (
             if (~hashIdx && !relativePart.endsWith('.adoc')) relativePart += '.adoc'
           }
           if (!isPage || ~relativePart.indexOf('@') || /:.*:/.test(relativePart)) {
-            if (siteUrl && (targetResource = contentCatalog.resolveResource(relativePart, page.src, 'page'))?.out) {
+            if (siteUrl && (targetResource = contentCatalog.resolveResource(relativePart, page.src, 'page'))?.pub) {
               text ||= targetResource.asciidoc?.xreftext || target
-              return `${siteUrl}${targetResource.pub.url}${fragment && '#' + fragment}[${text}]`
+              return `${siteUrl}${targetResource.pub.url.replace(/_/g, '{underscore}')}${fragment && '#' + fragment}[${text}]`
             }
             // TODO: handle unresolved resource better
             return m
@@ -555,6 +558,7 @@ function mergeAsciiDoc (
     }
   } else if (level) {
     if (atDocumentRoot && navtitlePlain === componentVersion.title) {
+      buffer.inBody ??= false
       level--
     } else {
       buffer.inBody = true
@@ -663,6 +667,12 @@ function processDocumentHeader (doc, lines, buffer, ignoreLines) {
       } else if (belowDoctitle) {
         if (implicitLines.length === 2 || !/[\p{Alpha}0-9]/u.test(chr0)) break
         implicitLines.push(line)
+      } else if (chr0 === '[' && line.charAt(line.length - 1) === ']') {
+        const attrlist = line
+          .slice(1, -1)
+          .trim()
+          .replace(/(?:^\w[\w-]*(?!=|[\w-]))?([#.%]\w[\w-]*)*/, '')
+        if (attrlist) buffer.push('[' + attrlist + ']')
       }
     } else if (belowDoctitle) {
       break
@@ -685,7 +695,7 @@ function generateSlug (title) {
       return String.fromCharCode(dec ? parseInt(dec, 10) : parseInt(hex, 16))
     })
     .replace(/[\x27\u2019]/g, '')
-    .replace(/[^\p{Alpha}0-9\-]/gu, '-')
+    .replace(/[^\p{Alpha}0-9-]/gu, '-')
     .replace(/^-+|-+$|(-)-+/g, '$1')
 }
 
@@ -752,7 +762,19 @@ function isResourceSpec (str) {
 }
 
 function getObjectId (obj) {
-  return global.Opal.uid()
+  return global.Opal.id(obj)
+}
+
+// NOTE: blank lines at top and bottom of document create mismatch when using line numbers to navigate source lines
+// IMPORTANT: this must not leave behind lines the parser will drop!
+// IDEA: another option is to capture initial lineno of reader and use as offset (but preseves those blank lines)
+function trimAsciiDoc (buffer) {
+  return Buffer.from(
+    buffer
+      .toString()
+      .replace(/^(?:[ \t]*\r\n?|[ \t]*\n)+/, '')
+      .trimRight()
+  )
 }
 
 function safePush (onto, entries) {

package/lib/produce-assembly-files.js

@@ -5,6 +5,7 @@ const filterComponentVersions = require('./filter-component-versions')
 const produceAssemblyFile = require('./produce-assembly-file')
 const selectMutableAttributes = require('./select-mutable-attributes')
 
+const ATTR_REF_RX = /\\?\{(\w[\w-]*)\}/g
 const IMAGE_MACRO_RX = /^image::?(.+?)\[(.*?)\]$/
 
 function produceAssemblyFiles (loadAsciiDoc, contentCatalog, assemblerConfig, resolveAssemblyModel) {
@@ -22,16 +23,21 @@ function produceAssemblyFiles (loadAsciiDoc, contentCatalog, assemblerConfig, re
   delete assemblerAsciiDocAttributes.revdate
   delete assemblerAsciiDocAttributes['source-highlighter']
   const publishableFiles = contentCatalog.getFiles().filter((file) => file.out)
+  const configMdc = assemblerConfig.file ? { file: { path: assemblerConfig.file } } : {}
   return filterComponentVersions(contentCatalog.getComponents(), assemblerConfig.componentVersionFilter.names).reduce(
     (accum, componentVersion) => {
       const assemblyModel = resolveAssemblyModel(componentVersion)
       if (!assemblyModel.navigation) return accum
       const { name: componentName, version, title } = componentVersion
       const componentVersionAsciiDocConfig = getAsciiDocConfigWithAsciidoctorReducerExtension(componentVersion)
+      const mergedAsciiDocAttributes = collateAsciiDocAttributes(
+        Object.assign({ revdate }, componentVersionAsciiDocConfig.attributes),
+        assemblerAsciiDocAttributes,
+        { logger: assemblyModel.logger, mdc: configMdc }
+      )
       const mergedAsciiDocConfig = Object.assign({}, componentVersionAsciiDocConfig, {
-        attributes: Object.assign({ revdate }, componentVersionAsciiDocConfig.attributes, assemblerAsciiDocAttributes),
+        attributes: mergedAsciiDocAttributes,
       })
-      const mergedAsciiDocAttributes = mergedAsciiDocConfig.attributes
       const auxiliaryImages = new Set()
       Object.entries(mergedAsciiDocAttributes).forEach(([name, val]) => {
         const match = name.endsWith('-image') && val.startsWith('image:') && IMAGE_MACRO_RX.exec(val)
@@ -142,4 +148,33 @@ function prepareOutlines (navigation, rootEntry, rootLevel) {
   return items
 }
 
+function collateAsciiDocAttributes (collated, additional, { logger, mdc }) {
+  Object.entries(additional).forEach(([name, val]) => {
+    if (val && val.constructor === String) {
+      let alias
+      val = val.replace(ATTR_REF_RX, (ref, refname) => {
+        if (ref.charAt() === '\\') return ref.substr(1)
+        const refval = collated[refname]
+        if (refval == null || refval === false) {
+          if (refname in collated && ref === val) {
+            alias = refval
+          } else if (collated['attribute-missing'] === 'warn') {
+            if (logger) {
+              logger.warn(mdc, "Skipping reference to missing attribute '%s' in value of '%s' attribute", refname, name)
+            }
+          }
+          return ref
+        }
+        if (refval.constructor === String) return refval
+        if (ref !== val) return refval.toString()
+        alias = refval
+        return ref
+      })
+      if (alias !== undefined) val = alias
+    }
+    collated[name] = val
+  })
+  return collated
+}
+
 module.exports = produceAssemblyFiles

package/lib/util/compute-out.js

@@ -5,7 +5,7 @@ const { posix: path } = require('node:path')
 function computeOut (src) {
   const { component, version, module: module_, family, relative } = src
   const outRelative = family === 'page' ? relative.replace(/\.adoc$/, '.html') : relative
-  const { dir: dirname, base: basename, ext: extname, name: stem } = path.parse(outRelative)
+  const { dir: dirname, base: basename } = path.parse(outRelative)
   const componentVersion = this.getComponentVersion(component, version)
   const versionSegment =
     'activeVersionSegment' in componentVersion
@@ -48,7 +48,7 @@ function resolveActiveVersionSegment (component, version) {
     this.removeFile((startPage = this.addFile({ src: startPageSrc })))
   }
   const outPathSegments = startPage.out.path.split('/')
-  for (const depth of startPage.out.moduleRootPath.split('/')) outPathSegments.pop()
+  for (const _ of startPage.out.moduleRootPath.split('/')) outPathSegments.pop()
   if (startPageSrc.module !== 'ROOT') outPathSegments.pop()
   if (startPageSrc.component !== 'ROOT') outPathSegments.shift()
   return outPathSegments.length ? outPathSegments[0] : ''

package/lib/util/create-asciidoc-file.js

@@ -1,7 +1,6 @@
 'use strict'
 
 const computeOut = require('./compute-out')
-const { posix: path } = require('node:path')
 
 function createAsciiDocFile (contentCatalog, file) {
   file.mediaType = 'text/asciidoc'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/assembler",
-  "version": "1.0.0-beta.4",
+  "version": "1.0.0-beta.6",
   "description": "A JavaScript library that merges AsciiDoc content from multiple pages in an Antora site into assembly files and delegates to an exporter to convert those files to another format, such as PDF.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",