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

package/lib/asciidoctor/reducer-extension.js

@@ -121,6 +121,7 @@ const IncludeDirectiveTracker = (() => {
     this.$$reducer.includePushed = true
     const directiveLineno = this.lineno - 1 // we're below the include line, which is 1-based
     const prevIncDepth = this.include_stack.length
+    let offset = lineno > 1 ? lineno - 1 : 0
     const result = Opal.send(this, Opal.find_super_dispatcher(this, 'push_include', pushInclude), [
       data,
       file,
@@ -128,12 +129,12 @@ const IncludeDirectiveTracker = (() => {
       lineno,
       attrs,
     ])
-    pushIncludeReplacement.call(
-      this,
-      directiveLineno,
-      this.include_stack.length > prevIncDepth ? this.$lines() : [],
-      lineno > 1 ? lineno - 1 : 0
-    )
+    let incLines = []
+    if (this.include_stack.length > prevIncDepth) {
+      incLines = this.$lines()
+      if (attrs['$key?']('leveloffset') && incLines[0].startsWith(':leveloffset: ') && incLines[1] === '') offset -= 2
+    }
+    pushIncludeReplacement.call(this, directiveLineno, incLines, offset)
     return result
   })
 
@@ -174,8 +175,12 @@ function treeProcessor () {
           let targetLines, idx
           if (into != null) {
             targetLines = incReplacements[into].lines
-            // adds assurance that we're replacing the correct line
-            if (targetLines[(idx = lineno - 1)] !== line) return
+            // adds extra assurance that the program is replacing the correct line
+            if (targetLines[(idx = lineno - 1)] !== line) {
+              const msg = `include directive to reduce not found; expected: "${line}"; got: "${targetLines[idx]}"`
+              doc.getLogger().error(msg)
+              return
+            }
           }
           if ((drop || []).length) {
             drop

package/lib/load-config.js

@@ -1,13 +1,10 @@
 'use strict'
 
-const camelCaseKeys = require('camelcase-keys')
 const expandPath = require('@antora/expand-path-helper')
 const { promises: fsp } = require('fs')
 const os = require('os')
 const yaml = require('js-yaml')
 
-const CAMEL_CASE_KEYS_OPTS = { deep: true, stopPaths: ['asciidoc'] }
-
 function loadConfig (playbook, configSource = './antora-assembler.yml') {
   return (
     configSource.constructor === Object
@@ -19,21 +16,21 @@ function loadConfig (playbook, configSource = './antora-assembler.yml') {
           () => false
         )
         .then((exists) =>
-          exists
-            ? fsp.readFile(configSource).then((data) => camelCaseKeys(yaml.load(data), CAMEL_CASE_KEYS_OPTS))
-            : {}
+          exists ? fsp.readFile(configSource).then((data) => camelCaseKeys(yaml.load(data), ['asciidoc'])) : {}
         )
   ).then((config) => {
     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(', ')
     }
@@ -59,4 +56,16 @@ function loadConfig (playbook, configSource = './antora-assembler.yml') {
   })
 }
 
+function camelCaseKeys (o, stopPaths = [], p) {
+  if (Array.isArray(o)) return o.map((it) => camelCaseKeys(it, stopPaths, p))
+  if (o == null || o.constructor !== Object) return o
+  const pathPrefix = p ? p + '.' : ''
+  const accum = {}
+  for (const [k, v] of Object.entries(o)) {
+    const camelKey = k.charAt() + k.substr(1).replace(/_([a-z])/g, (_, l) => l.toUpperCase())
+    accum[camelKey] = ~stopPaths.indexOf(pathPrefix + camelKey) ? v : camelCaseKeys(v, stopPaths, pathPrefix + camelKey)
+  }
+  return accum
+}
+
 module.exports = loadConfig

package/lib/produce-aggregate-document.js

@@ -8,6 +8,7 @@ function produceAggregateDocument (
   contentCatalog,
   componentVersion,
   outline,
+  doctype,
   pages,
   asciidocConfig,
   mutableAttributes,
@@ -16,7 +17,7 @@ function produceAggregateDocument (
   const pagesInOutline = selectPagesInOutline(outline, pages)
   const navtitle = outline.content
   const stem = generateStem(componentVersion, navtitle)
-  const header = buildAsciiDocHeader(componentVersion, navtitle)
+  const header = buildAsciiDocHeader(componentVersion, navtitle, doctype)
   const body = aggregateAsciiDoc(
     loadAsciiDoc,
     contentCatalog,
@@ -44,13 +45,13 @@ function produceAggregateDocument (
   })
 }
 
-function buildAsciiDocHeader (componentVersion, navtitle) {
+function buildAsciiDocHeader (componentVersion, navtitle, doctype = 'book') {
   const doctitle = navtitle === componentVersion.title ? navtitle : `${componentVersion.title}: ${navtitle}`
-  const version = componentVersion.version && componentVersion.version !== 'master' ? componentVersion.version : ''
+  const version = componentVersion.version === 'master' ? '' : componentVersion.version
   return [
     `= ${doctitle}`,
     ...(version ? [`v${version}`] : []),
-    ':doctype: book', // for debugging only; set via CLI
+    ...(doctype === 'article' ? [] : [`:doctype: ${doctype}`]),
     // Q: should we pass these via the CLI so they cannot be modified?
     `:page-component-name: ${componentVersion.name}`,
     `:page-component-version:${version ? ' ' + version : ''}`,
@@ -166,14 +167,18 @@ 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)
-    const allBlocks = doc.findBy(
-      { traverse_documents: true },
-      (it) => it.getContext() !== 'document' && !(it.getContext() === 'table_cell' && it.getStyle() === 'asciidoc')
+    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
@@ -204,6 +209,11 @@ function aggregateAsciiDoc (
     for (let idx = 0, len = lines.length; idx < len; idx++) {
       if (~ignoreLines.indexOf(idx)) continue
       let line = lines[idx]
+      if (line.charAt() === ':' && /^:(?:leveloffset: .*|!leveloffset:|leveloffset!:)$/.test(line)) {
+        if (lines[idx - 1] === '') lines[idx - 1] = undefined
+        lines[idx] = undefined
+        continue
+      }
       if (~line.indexOf('<<')) {
         line = line.replace(/(?<![\\+])<<#?([\p{Alpha}0-9_/.:{][^>,]*?)(?:|, *([^>]+?))?>>/gu, (m, refid, text) => {
           // support natural xref
@@ -219,7 +229,7 @@ function aggregateAsciiDoc (
       }
       if (~line.indexOf('xref:')) {
         // Q: should we allow : as first character of target?
-        line = line.replace(/xref:([\p{Alpha}0-9_/.{#].*?)\[(|.*?[^\\])\]/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) {
@@ -298,22 +308,20 @@ function aggregateAsciiDoc (
       // 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)
+          lines[idx] = undefined
           return
         }
         let blockStyle = sectionMergeStrategy === 'discrete' ? 'discrete' : undefined
-        // FIXME: quick fix; needs more thorough review
-        const leveloffset = Number(doc.getAttribute('leveloffset') || 0)
-        lines[idx] = lines[idx].replace(/^=+( .+)/, (_, rest) => {
-          let targetMarkerLength = block.level + (1 - leveloffset) + level + (enclosed ? 1 : 0)
+        lines[idx] = lines[idx].replace(/^=+ (.+)/, (_, rest) => {
+          let targetMarkerLength = block.level + 1 + level + (enclosed ? 1 : 0)
           if (targetMarkerLength > 6) {
             targetMarkerLength = 6
             blockStyle = 'discrete'
           }
-          return '='.repeat(targetMarkerLength) + rest
+          return '='.repeat(targetMarkerLength) + ' ' + rest
         })
         // NOTE: ID will be undefined if sectids are turned off
         if (block.getId()) rewriteStyleAttribute(block, lines, idx, idprefix, blockStyle)
@@ -323,7 +331,7 @@ function aggregateAsciiDoc (
           let prefix = ''
           // Q: can we use startsWith('image::') in certain cases?
           let imageMacroOffset = (
-            lastImageMacroAt && lastImageMacroAt[0] === idx ? line.substr(0, lastImageMacroAt[1]) : line
+            lastImageMacroAt?.[0] === idx ? line.substr(0, lastImageMacroAt[1]) : line
           ).lastIndexOf('image::')
           if (imageMacroOffset > 0) {
             if (
@@ -347,11 +355,14 @@ function aggregateAsciiDoc (
             }
             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)
       }
     })
-    buffer.push(...lines)
+    buffer.push(...lines.filter((it) => it !== undefined))
     const attributeEntries = Object.entries(doc.attributes_defined_in_header || {})
     if (attributeEntries.length) {
       const resolvedAttributeEntries = attributeEntries.reduce(
@@ -364,7 +375,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' || name === 'leveloffset')) {
             accum.push(`:!${name}:`)
           }
           return accum
@@ -431,7 +442,8 @@ function aggregateAsciiDoc (
 
 function generateStem (componentVersion, title) {
   const { name, version } = componentVersion
-  const segments = [name]
+  const segments = []
+  if (name !== 'ROOT') segments.push(name)
   if (version && version !== 'master') segments.push(version)
   segments.push(
     title

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,13 +32,15 @@ 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,
             contentCatalog,
             componentVersion,
             outline,
+            doctype,
             contentCatalog.getPages((page) => page.out),
             mergedAsciiDocConfig,
             mutableAttributes,
@@ -44,6 +48,11 @@ function produceAggregateDocuments (loadAsciiDoc, contentCatalog, assemblerConfi
           )
         )
       )
+      mergedAsciiDocConfig.attributes.doctype = doctype
+      sourceHighlighter
+        ? (mergedAsciiDocConfig.attributes['source-highlighter'] = sourceHighlighter)
+        : delete mergedAsciiDocConfig.attributes['source-highlighter']
+      return accum
     },
     []
   )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/assembler",
-  "version": "1.0.0-alpha.4",
+  "version": "1.0.0-alpha.6",
   "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,12 +25,12 @@
     "./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": {
     "@antora/expand-path-helper": "~2.0",
     "braces": "~3.0",
-    "camelcase-keys": "~7.0",
     "picomatch": "~2.3",
     "vinyl": "~2.2",
     "js-yaml": "~4.1"