@antora/assembler 1.0.0-beta.8 → 1.0.0-rc.1

package/lib/produce-assembly-files.js

@@ -1,17 +1,15 @@
 'use strict'
 
-const computeOut = require('./util/compute-out')
-const createAsciiDocFile = require('./util/create-asciidoc-file')
 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) {
-  const { asciidoc: assemblerAsciiDocConfig, assembly: assemblyConfig } = assemblerConfig
-  resolveAssemblyModel ??= (componentVersion) => ({
+function produceAssemblyFiles (loadAsciiDoc, contentCatalog, assemblerConfig, selectAssemblyProfile) {
+  const { assembly: assemblyConfig } = assemblerConfig
+  selectAssemblyProfile ??= (componentVersion) => ({
+    attributes: assemblyConfig.attributes,
     doctype: assemblyConfig.doctype,
     insertStartPage: assemblyConfig.insertStartPage,
     rootLevel: assemblyConfig.rootLevel,
@@ -21,40 +19,51 @@ function produceAssemblyFiles (loadAsciiDoc, contentCatalog, assemblerConfig, re
     embedReferenceStyle: assemblyConfig.embedReferenceStyle,
     linkReferenceStyle: assemblyConfig.linkReferenceStyle,
     dropExplicitXrefText: assemblyConfig.dropExplicitXrefText,
+    revdate: assemblyConfig.revdate,
+    logger: assemblyConfig.logger, // for tests
   })
-  const assemblerAsciiDocAttributes = Object.assign({}, assemblerAsciiDocConfig.attributes)
-  const { revdate, 'source-highlighter': sourceHighlighter } = assemblerAsciiDocAttributes
-  delete assemblerAsciiDocAttributes.revdate
-  delete assemblerAsciiDocAttributes['source-highlighter']
-  const publishableFiles = contentCatalog.getFiles().filter((file) => file.out)
+  const baseAssemblyAttributes = assemblyConfig.attributes
+  const publishableFiles = contentCatalog.getFiles().filter((file) => file.out && file.pub)
   let siteRoot
   const configMdc = assemblerConfig.file ? { file: { path: assemblerConfig.file } } : {}
-  return filterComponentVersions(contentCatalog.getComponents(), assemblerConfig.componentVersionFilter.names).reduce(
+  return filterComponentVersions(contentCatalog.getComponents(), assemblerConfig.componentVersionFilter).reduce(
     (accum, componentVersion) => {
-      const assemblyModel = resolveAssemblyModel(componentVersion)
-      if (!assemblyModel.navigation) return accum
+      const assemblyModel = selectAssemblyProfile(componentVersion)
+      const { attributes: assemblyAttributes, logger, navigation, rootLevel } = assemblyModel
+      if (!navigation) return accum
+      const contextualLogger = logger ? { warn: logger.warn.bind(logger, configMdc) } : undefined
       const { name: componentName, version, title } = componentVersion
       const componentVersionAsciiDocConfig = getAsciiDocConfigWithAsciidoctorReducerExtension(componentVersion)
+      let sourceHighlighter
+      if ('source-highlighter' in assemblyAttributes) {
+        sourceHighlighter = assemblyAttributes['source-highlighter']
+        delete assemblyAttributes['source-highlighter']
+      }
       const mergedAsciiDocAttributes = collateAsciiDocAttributes(
-        Object.assign({ revdate }, componentVersionAsciiDocConfig.attributes),
-        assemblerAsciiDocAttributes,
-        { logger: assemblyModel.logger, mdc: configMdc }
+        Object.assign({}, componentVersionAsciiDocConfig.attributes),
+        assemblyAttributes,
+        contextualLogger
       )
       const mergedAsciiDocConfig = Object.assign({}, componentVersionAsciiDocConfig, {
         attributes: mergedAsciiDocAttributes,
       })
-      assemblyModel.outDirname = computeOut.call(contentCatalog, {
-        component: componentName,
-        version,
-        family: 'export',
-        relative: '.index.adoc',
-      }).dirname
-      assemblyModel.filetype = assemblerAsciiDocAttributes['assembler-filetype']
+      assemblyModel.filetype = baseAssemblyAttributes['assembler-filetype']
+      const outDirname = (assemblyModel.outDirname = contentCatalog.createFile({
+        src: {
+          component: componentName,
+          version,
+          componentVersion,
+          module: 'ROOT',
+          family: 'export',
+          relative: 'index.adoc',
+        },
+      }).out.dirname)
+      assemblyModel.pubRoot = outDirname ? '/' + outDirname : ''
       assemblyModel.siteRoot =
         siteRoot === undefined
           ? (siteRoot ??= ((val) => {
               if (!val) return null
-              if (val.charAt(val.length - 1) === '/') val = val.slice(0, val.length - 1)
+              if (val.charAt(val.length - 1) === '/') val = val.substring(0, val.length - 1)
               if (!val || val.charAt() === '/') return { path: val }
               return { url: val, path: extractUrlPath(val) }
             })(mergedAsciiDocAttributes['site-url'] || mergedAsciiDocAttributes['primary-site-url']))
@@ -64,21 +73,10 @@ function produceAssemblyFiles (loadAsciiDoc, contentCatalog, assemblerConfig, re
         if (linkRefStyle === 'absolute' && siteRoot?.url == null) linkRefStyle = 'root-relative'
         if (linkRefStyle === 'root-relative' && siteRoot?.path == null) linkRefStyle = 'relative'
         assemblyModel.linkReferenceStyle = linkRefStyle
-      } else {
+      } else if (!(assemblyModel.filetype === 'pdf' && assemblyModel.linkReferenceStyle === 'relative')) {
         assemblyModel.linkReferenceStyle = 'absolute'
       }
-      const auxiliaryImages = new Set()
-      Object.entries(mergedAsciiDocAttributes).forEach(([name, val]) => {
-        const match = name.endsWith('-image') && val.startsWith('image:') && IMAGE_MACRO_RX.exec(val)
-        if (!(match && isResourceRef(match[1]))) return
-        // Q should we allow image to be resolved relative to component version?
-        const image = contentCatalog.resolveResource(match[1], undefined, 'image', ['image'])
-        if (!image?.out) return
-        mergedAsciiDocAttributes[name] = `image:${image.out.path}[${match[2]}]`
-        auxiliaryImages.add(image)
-      })
       const rootEntry = { content: title }
-      const { navigation, rootLevel } = assemblyModel
       let startPage =
         'startPage' in componentVersion
           ? componentVersion.startPage
@@ -86,23 +84,24 @@ function produceAssemblyFiles (loadAsciiDoc, contentCatalog, assemblerConfig, re
       if (startPage && startPage.src.component === componentName && startPage.src.version === version) {
         if (assemblyModel.insertStartPage) {
           const navtitle = startPage.asciidoc?.navtitle || rootEntry.content
-          Object.assign(rootEntry, { navtitle, url: startPage.pub.url, urlType: 'internal' })
+          Object.assign(rootEntry, { navtitle, url: startPage.pub.url, urlType: 'internal', roles: ['page'] })
         }
       } else {
         // Q: should we always use a reference page as startPage for computing mutableAttributes?
-        startPage = createAsciiDocFile(contentCatalog, {
+        startPage = contentCatalog.createFile({
           src: {
             component: componentVersion.name,
             version: componentVersion.version,
+            componentVersion,
             module: 'ROOT',
             family: 'page',
-            relative: '.start-page.adoc',
+            relative: 'index.adoc',
             origin: (componentVersion.origins || [])[0],
           },
         })
+        startPage.path = ['modules', startPage.src.module, startPage.src.family + 's', startPage.src.relative].join('/')
       }
       const mutableAttributes = selectMutableAttributes(loadAsciiDoc, contentCatalog, startPage, mergedAsciiDocConfig)
-      delete mutableAttributes.doctype // Q: should this be in selectMutableAttributes?
       prepareOutlines(navigation, rootEntry, rootLevel).reduce((any, outline) => {
         const assemblyFile = produceAssemblyFile(
           loadAsciiDoc,
@@ -115,16 +114,14 @@ function produceAssemblyFiles (loadAsciiDoc, contentCatalog, assemblerConfig, re
           assemblyModel
         )
         if (!assemblyFile) return any
-        if (!any && auxiliaryImages.size) {
-          const assembledAssets = assemblyFile.assembler.assembled.assets
-          auxiliaryImages.forEach((asset) => assembledAssets.add(asset))
+        // NOTE restore source highlighter for conversion if defined in Assembler config
+        if (sourceHighlighter !== undefined) {
+          assemblyFile.asciidoc.attributes['source-highlighter'] = sourceHighlighter
+        } else if (assemblyModel.filetype !== 'html') {
+          delete assemblyFile.asciidoc.attributes['source-highlighter']
         }
-        accum.push(assemblyFile)
-        return true
+        return !!accum.push(assemblyFile)
       }, false)
-      sourceHighlighter
-        ? (mergedAsciiDocAttributes['source-highlighter'] = sourceHighlighter)
-        : delete mergedAsciiDocAttributes['source-highlighter']
       return accum
     },
     []
@@ -150,15 +147,11 @@ function includedInNav (items, url) {
   return items.find((it) => it.url === url || includedInNav(it.items || [], url))
 }
 
-function isResourceRef (target) {
-  return ~target.indexOf(':') && !(~target.indexOf('://') || (target.startsWith('data:') && ~target.indexOf(',')))
-}
-
 function prepareOutlines (navigation, rootEntry, rootLevel) {
   const singleEntry = navigation.length === 1
   const items = navigation.reduce((accum, it) => {
     if (!it.content || (singleEntry && it.url ? it.url === rootEntry.url : it.content === rootEntry.content)) {
-      accum.push(...it.items)
+      it.items && accum.push(...it.items)
     } else {
       accum.push(it)
     }
@@ -166,7 +159,7 @@ function prepareOutlines (navigation, rootEntry, rootLevel) {
   }, [])
   if (rootLevel === 0) {
     if (rootEntry.url && includedInNav(items, rootEntry.url)) {
-      for (const p of ['url', 'urlType']) delete rootEntry[p]
+      for (const p of ['roles', 'url', 'urlType']) delete rootEntry[p]
     }
     return [Object.assign(rootEntry, { index: true, items })]
   }
@@ -177,20 +170,18 @@ function prepareOutlines (navigation, rootEntry, rootLevel) {
   return items
 }
 
-function collateAsciiDocAttributes (collated, additional, { logger, mdc }) {
+function collateAsciiDocAttributes (collated, additional, logger) {
   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)
+        if (ref.charAt() === '\\') return ref.substring(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)
-            }
+            logger?.warn("Skipping reference to missing attribute '%s' in value of '%s' attribute", refname, name)
           }
           return ref
         }

package/lib/select-mutable-attributes.js

@@ -17,6 +17,7 @@ function selectMutableAttributes (loadAsciiDoc, contentCatalog, referencePage, a
   ]
   // we could consider using an Asciidoctor extension here to grab attributes passed via the API instead
   const immutableAttributeNames = doc.attribute_overrides.$keys()['$-'](additionalMutableNames)
+  immutableAttributeNames.push('doctype')
   return Object.entries(doc.getAttributes()).reduce((accum, [name, val]) => {
     if (!immutableAttributeNames.includes(name)) accum[name] = val
     return accum

package/lib/util/create-resource-key.js

@@ -0,0 +1,7 @@
+'use strict'
+
+function createResourceKey ({ component, version, module: mod, family, relative }) {
+  return `${version}@${component}:${mod === 'ROOT' ? '' : mod}:${family === 'page' ? '' : family + '$'}${relative}`
+}
+
+module.exports = createResourceKey

package/lib/util/generate-scoped-id.js

@@ -0,0 +1,25 @@
+'use strict'
+
+const HTML_RESERVED_ID_NAMES = 'content header footnotes footer footer-text premable toc toctitle'.split(' ')
+
+function generateScopedId (componentSrc, componentVersion, separators, filetype, asXrefTarget) {
+  let { component, module: mod, relative } = componentSrc
+  let id = relative.replace(/\.adoc$/, '').replace(/[/.]/g, '-')
+  let { coordinate: coordinateSeparator, prefix: prefixSeparator } = separators
+  if (component !== componentVersion.name) {
+    id = [component, mod === 'ROOT' ? '' : mod, id].join(coordinateSeparator)
+  } else if (mod !== 'ROOT') {
+    if (asXrefTarget && coordinateSeparator === ':' && /(?:pass|stem)$/.test(mod) && /^[a-z]+(?:,[a-z-]+)*$/.test(id)) {
+      prefixSeparator = ''
+      mod = mod.replace(/(?:pass|stem)$/, '\\$&')
+    }
+    id = mod + coordinateSeparator + id
+  } else if (filetype === 'html' && HTML_RESERVED_ID_NAMES.includes(id)) {
+    id = prefixSeparator + id
+    prefixSeparator = ''
+  }
+  if (prefixSeparator && !/^[\p{Alpha}_:]/u.test(id)) id = prefixSeparator + id
+  return id
+}
+
+module.exports = generateScopedId

package/lib/util/matcher.js

@@ -0,0 +1,150 @@
+'use strict'
+
+const SPECIAL = { '.': true, '[': true, ']': true, '^': true, $: true, '}': true, ')': true, '|': true }
+const QUANTIFIER_ALTERNATE = { '*': '.*?', '+': '\\+', '?': '.' }
+const QUANTIFIERS = { '*': true, '+': true, '?': true, '@': true, '!': true }
+const RS = '\x1e'
+
+const BRACE_RANGE_RX = /^\{(?:([a-z])\.\.([a-z])|(0|[1-9][0-9]*)\.\.(0|[1-9][0-9]*))\}/
+
+function filterCollection (candidates, patterns, opts = {}) {
+  const rxs = patterns.map(opts.compilePattern ?? compilePattern)
+  const test = opts.test ?? ((rx, candidate) => rx.test(candidate))
+  return candidates.filter((candidate) => {
+    let matched = false
+    for (const rx of rxs) {
+      let voteIfMatched = true
+      if (matched) {
+        if (!rx.negated) continue
+        voteIfMatched = false
+      } else if (rx.negated) {
+        voteIfMatched = false
+      }
+      if (test(rx, candidate)) matched = voteIfMatched
+    }
+    return matched
+  })
+}
+
+function compilePattern (str) {
+  const negated = str.charAt() === '!' ? typeof (str = str.substring(1)) === 'string' : false
+  if (str === '**') return Object.assign(new RegExp(), { globstar: true, negated })
+  if (str === '*') return Object.assign(new RegExp(), { star: true, negated })
+  const buffer = { result: '', brace: undefined, group: undefined }
+  let target = 'result'
+  let nestedTarget
+  for (let i = 0, len = str.length; i < len; i++) {
+    const c = str[i]
+    if (target === 'brace') {
+      if (c === '}') {
+        const braceBuffer = buffer.brace
+        let braceResult
+        if (~braceBuffer.indexOf(RS)) {
+          braceResult = braceBuffer === RS ? '' : '(?:' + braceBuffer.replace(/\x1e/g, '|') + ')'
+        } else {
+          const m = BRACE_RANGE_RX.exec('{' + braceBuffer.replace('\\.\\.', '..') + '}')
+          braceResult = m[1] != null ? `[${m[1]}-${m[2]}]` : rangeRe(+m[3], +m[4])
+        }
+        buffer[(target = nestedTarget === 'group' ? 'group' : 'result')] += braceResult
+        buffer.brace = nestedTarget = undefined
+        continue
+      } else if (c === ',') {
+        buffer.brace += RS
+        continue
+      }
+    } else if (target === 'group') {
+      if (c === ')') {
+        const { group: groupBuffer, groupQuantifier } = buffer
+        let groupResult = '(?:' + groupBuffer + ')'
+        if (groupQuantifier === '!') {
+          groupResult = '(?!' + groupResult + '.*?)'
+        } else if (groupQuantifier !== '@') {
+          groupResult += groupQuantifier
+        }
+        buffer[(target = nestedTarget === 'brace' ? 'brace' : 'result')] += groupResult
+        buffer.group = buffer.groupQuantifier = nestedTarget = undefined
+        continue
+      }
+    }
+    if (SPECIAL[c]) {
+      buffer[target] += '\\' + c
+    } else if (c === '(' || QUANTIFIERS[c]) {
+      const hasQuantifier = c !== '('
+      const atGroupStart = hasQuantifier ? str[i + 1] === '(' : true
+      if (target !== 'group' && atGroupStart && isGroup(str.substring(hasQuantifier ? i + 1 : i))) {
+        if (target === 'brace') nestedTarget = 'brace'
+        buffer[(target = 'group')] = ''
+        buffer.groupQuantifier = hasQuantifier ? ++i > 0 && c : ''
+      } else if (hasQuantifier) {
+        buffer[target] += (QUANTIFIER_ALTERNATE[c] ?? c) + (atGroupStart ? ++i > 0 && '\\(' : '')
+      } else {
+        buffer[target] += '\\('
+      }
+    } else if (c === '{') {
+      if (target !== 'brace' && isBrace(str.substring(i))) {
+        if (target === 'group') nestedTarget = 'group'
+        buffer[(target = 'brace')] = ''
+      } else {
+        buffer[target] += '\\' + c
+      }
+    } else {
+      buffer[target] += c
+    }
+  }
+  return Object.assign(new RegExp('^' + cleanup(buffer, target, nestedTarget) + '$'), { negated })
+}
+
+function cleanup (buffer, target, nestedTarget) {
+  if (target === 'result') return buffer.result
+  if (target === 'brace') {
+    buffer.result += '\\{' + buffer.brace.replace(/\x1e/g, ',')
+    buffer.brace = undefined
+  } else if (target === 'group') {
+    const groupQuantifier = buffer.groupQuantifier
+    buffer.result += (QUANTIFIER_ALTERNATE[groupQuantifier] ?? groupQuantifier) + '\\(' + buffer.group
+    buffer.group = buffer.groupQuantifier = undefined
+  }
+  return nestedTarget ? cleanup(buffer, nestedTarget) : buffer.result
+}
+
+function isBrace (str) {
+  const endBraceIdx = str.indexOf('}')
+  const candidate = ~endBraceIdx ? str.substring(0, endBraceIdx + 1) : ''
+  if (!candidate || ~candidate.indexOf('{', 1)) return false
+  return ~candidate.indexOf(',') || BRACE_RANGE_RX.test(candidate)
+}
+
+function isGroup (str) {
+  const endBraceIdx = str.indexOf(')')
+  const candidate = ~endBraceIdx ? str.substring(0, endBraceIdx + 1) : ''
+  return candidate ? !~candidate.indexOf('(', 1) : false
+}
+
+function rangeRe (min, max) {
+  if (min === max) return String(min)
+  min > max && ([min, max] = [max, min])
+  if (min < 10 && max < 10) return `[${min}${min + 1 === max ? '' : '-'}${max}]`
+  const result = []
+  let minStr, minStrLen, toStr
+  while (min <= max) {
+    let to = (minStrLen = (minStr = String(min)).length) < String(max).length ? 10 ** minStrLen - 1 : max
+    const limit = 10 ** minStrLen
+    for (let i = 10; i <= limit; i *= 10) {
+      const candidate = min + (i - (min % i) || i) - 1
+      if (candidate > max) break
+      to = candidate
+    }
+    toStr = String(to)
+    let rangesForChunk = ''
+    for (let i = 0, len = minStr.length; i < len; i++) {
+      const lhs = minStr[i]
+      const rhs = toStr[i]
+      rangesForChunk += lhs === rhs ? lhs : `[${lhs}${+lhs + 1 === +rhs ? '' : '-'}${rhs}]`
+    }
+    result.push(rangesForChunk)
+    min = to + 1
+  }
+  return result.length > 1 ? `(?:${result.join('|')})` : result[0]
+}
+
+module.exports = { filterCollection, compilePattern }

package/lib/util/parse-resource-ref.js

@@ -0,0 +1,36 @@
+'use strict'
+
+function parseResourceRef (ref, ctx = {}, family = undefined, contentCatalog = undefined) {
+  const atIdx = ref.indexOf('@')
+  let firstColonIdx = ref.indexOf(':')
+  let component, version, module_
+  if (~atIdx && (~firstColonIdx ? atIdx < firstColonIdx : true)) {
+    if ((version = ref.substring(0, atIdx)) === '_') version = ''
+    ref = ref.substring(atIdx + 1)
+    if (~firstColonIdx) firstColonIdx -= atIdx + 1
+  }
+  const addColons = ~firstColonIdx ? (~ref.indexOf(':', firstColonIdx + 1) ? '' : ':') : '::'
+  const segments = (addColons + ref).split(':')
+  if ((component = segments[0])) {
+    module_ = segments[1] || 'ROOT'
+    version ??= contentCatalog?.getComponent(component)?.latest.version
+  } else {
+    component = ctx.component
+    version ??= ctx.version
+    module_ = segments[1] || ctx.module || 'ROOT'
+  }
+  let relative = segments.length > 3 ? segments.slice(2).join(':') : segments[2]
+  const dollarIdx = relative.indexOf('$')
+  if (~dollarIdx) {
+    family = relative.substring(0, dollarIdx) || family
+    relative = relative.substring(dollarIdx + 1)
+  }
+  if (relative.charAt() === '.' && relative.charAt(1) === '/') {
+    const ctxRelative = ctx.relative
+    const topic = ctxRelative ? ctxRelative.substring(0, (ctxRelative.lastIndexOf('/') + 1 || 1) - 1) : undefined
+    relative = (topic ? topic + '/' : '') + relative.substring(2)
+  }
+  return { component, version, module: module_, family, relative }
+}
+
+module.exports = parseResourceRef

package/lib/util/resolver.js

@@ -0,0 +1,36 @@
+'use strict'
+
+const path = require('node:path/posix')
+
+function resolveEmbedTarget (resource, outDirname, referenceStyle, escapeForInline) {
+  const target =
+    referenceStyle === 'output-relative' ? resource.out.path : path.relative(outDirname + '/', resource.out.path)
+  return escapeForInline ? target.replace(/_/g, '{underscore}') : target
+}
+
+function resolveLinkTarget (resource, siteRoot, pubRoot, referenceStyle, escapeForInline, ensurePrefix = true) {
+  let target
+  if (resource.site?.url) {
+    target = ['', resource.pub.url]
+  } else {
+    switch (referenceStyle) {
+      case 'absolute':
+        target = ['', siteRoot.url + resource.pub.url]
+        break
+      case 'root-relative':
+        target = [ensurePrefix ? 'link:' : '', siteRoot.path + resource.pub.url]
+        break
+      default:
+        target = [ensurePrefix ? 'link:' : '', computeRelativeUrl(pubRoot + '/', resource.pub.url)]
+    }
+  }
+  if (escapeForInline) target[1] = target[1].replace(/_/g, '{underscore}')
+  return target.join('')
+}
+
+function computeRelativeUrl (from, to) {
+  const rel = path.relative(from, to)
+  return to.charAt(to.length - 1) === '/' ? rel + '/' : rel
+}
+
+module.exports = { resolveEmbedTarget, resolveLinkTarget }