@antora/content-classifier 3.0.0-alpha.9 → 3.0.0-beta.4

package/README.md

@@ -3,7 +3,7 @@
 The Content Classifier is a component in Antora responsible for organizing aggregated content into a virtual file catalog for use in an Antora documentation pipeline.
 
 [Antora](https://antora.org) is a modular static site generator designed for creating documentation sites from AsciiDoc documents.
-Its site generator pipeline aggregates documents from versioned content repositories and processes them using [Asciidoctor](https://asciidoctor.org).
+Its site generator aggregates documents from versioned content repositories and processes them using [Asciidoctor](https://asciidoctor.org).
 
 ## Copyright and License
 

package/lib/constants.js

@@ -1,6 +1,6 @@
 'use strict'
 
 module.exports = Object.freeze({
-  START_ALIAS_ID: Object.freeze({ component: '', version: '', module: '', family: 'alias', relative: 'index.adoc' }),
-  START_PAGE_ID: Object.freeze({ component: '', version: '', module: '', family: 'page', relative: 'index.adoc' }),
+  ROOT_INDEX_ALIAS_ID: { component: 'ROOT', version: '', module: 'ROOT', family: 'alias', relative: 'index.adoc' },
+  ROOT_INDEX_PAGE_ID: { component: 'ROOT', version: '', module: 'ROOT', family: 'page', relative: 'index.adoc' },
 })

package/lib/content-catalog.js

@@ -9,7 +9,7 @@ const { posix: path } = require('path')
 const resolveResource = require('./util/resolve-resource')
 const versionCompare = require('./util/version-compare-desc')
 
-const { START_ALIAS_ID, START_PAGE_ID } = require('./constants')
+const { ROOT_INDEX_ALIAS_ID, ROOT_INDEX_PAGE_ID } = require('./constants')
 const SPACE_RX = / /g
 
 const $components = Symbol('components')
@@ -169,11 +169,11 @@ class ContentCatalog {
       ('/' + src.relative).indexOf('/_') < 0
     ) {
       publishable = true
-      versionSegment = computeVersionSegment.bind(this)(src.component, src.version)
+      versionSegment = computeVersionSegment.call(this, src.component, src.version)
       file.out = computeOut(src, family, versionSegment, this.htmlUrlExtensionStyle)
     }
     if (!file.pub && (publishable || family === 'nav')) {
-      if (versionSegment == null) versionSegment = computeVersionSegment.bind(this)(src.component, src.version)
+      if (versionSegment == null) versionSegment = computeVersionSegment.call(this, src.component, src.version)
       file.pub = computePub(src, file.out, family, versionSegment, this.htmlUrlExtensionStyle)
     }
     filesForFamily.set(key, file)
@@ -249,7 +249,7 @@ class ContentCatalog {
 
   // TODO add `follow` argument to control whether alias is followed
   getSiteStartPage () {
-    return this.getById(START_PAGE_ID) || (this.getById(START_ALIAS_ID) || {}).rel
+    return this.getById(ROOT_INDEX_PAGE_ID) || (this.getById(ROOT_INDEX_ALIAS_ID) || {}).rel
   }
 
   registerComponentVersionStartPage (name, componentVersion, startPageSpec = undefined) {
@@ -261,15 +261,19 @@ class ContentCatalog {
     }
     let startPage
     let startPageSrc
-    const indexPageId = { component: name, version, module: 'ROOT', family: 'page', relative: 'index.adoc' }
+    const indexPageId = Object.assign({}, ROOT_INDEX_PAGE_ID, { component: name, version })
     if (startPageSpec) {
       if (
         (startPage = this.resolvePage(startPageSpec, indexPageId)) &&
         (startPageSrc = startPage.src).component === name &&
         startPageSrc.version === version
       ) {
-        if ((startPageSrc.module !== 'ROOT' || startPageSrc.relative !== 'index.adoc') && !this.getById(indexPageId)) {
-          this.addFile({ src: Object.assign({}, indexPageId, { family: 'alias' }), rel: startPage })
+        if (!this.getById(indexPageId)) {
+          const indexAliasId = Object.assign({}, ROOT_INDEX_ALIAS_ID, { component: name, version })
+          const indexAlias = this.getById(indexAliasId)
+          indexAlias
+            ? indexAlias.synthetic && Object.assign(indexAlias, { rel: startPage })
+            : this.addFile({ src: indexAliasId, rel: startPage, synthetic: true })
         }
       } else {
         // TODO pass componentVersion as logObject
@@ -289,7 +293,7 @@ class ContentCatalog {
       componentVersion.url = startPage.pub.url
     } else {
       // QUESTION: should we warn if the default start page cannot be found?
-      const versionSegment = computeVersionSegment.bind(this)(name, version)
+      const versionSegment = computeVersionSegment.call(this, name, version)
       componentVersion.url = computePub(
         (startPageSrc = prepareSrc(Object.assign({}, indexPageId, { family: 'page' }))),
         computeOut(startPageSrc, startPageSrc.family, versionSegment, this.htmlUrlExtensionStyle),
@@ -302,7 +306,7 @@ class ContentCatalog {
     const symbolicVersionAlias = createSymbolicVersionAlias(
       name,
       version,
-      computeVersionSegment.bind(this)(name, version, 'alias'),
+      computeVersionSegment.call(this, name, version, 'alias'),
       this.latestVersionUrlSegmentStrategy
     )
     if (symbolicVersionAlias) this.addFile(symbolicVersionAlias)
@@ -312,7 +316,10 @@ class ContentCatalog {
     if (!startPageSpec) return
     const rel = this.resolvePage(startPageSpec)
     if (rel) {
-      return this.addFile({ src: Object.assign({}, START_ALIAS_ID), rel })
+      if (this.getById(ROOT_INDEX_PAGE_ID)) return
+      const indexAlias = this.getById(ROOT_INDEX_ALIAS_ID)
+      if (indexAlias) return indexAlias.synthetic ? Object.assign(indexAlias, { rel }) : undefined
+      return this.addFile({ src: Object.assign({}, ROOT_INDEX_ALIAS_ID), rel, synthetic: true })
     } else if (rel === false) {
       logger.warn('Start page specified for site has invalid syntax: %s', startPageSpec)
     } else if (~startPageSpec.indexOf(':')) {
@@ -367,9 +374,10 @@ class ContentCatalog {
    *
    * Parses the specified contextual page ID spec into a page ID object, then attempts to lookup a
    * file with this page ID in the catalog. If a component is specified, but not a version, the
-   * latest version of the component stored in the catalog is used. If a file cannot be resolved,
-   * the function returns undefined. If the spec does not match the page ID syntax, this function
-   * throws an error.
+   * latest version of the component stored in the catalog is used. If a page cannot be resolved,
+   * the search is attempted again for an "alias". If neither a page or alias can be resolved, the
+   * function returns undefined. If the spec does not match the page ID syntax, this function throws
+   * an error.
    *
    * @param {String} spec - The contextual page ID spec (e.g., version@component:module:topic/page.adoc).
    * @param {ContentCatalog} catalog - The content catalog in which to resolve the page file.
@@ -450,6 +458,7 @@ function prepareSrc (src) {
 
 function computeOut (src, family, version, htmlUrlExtensionStyle) {
   let { component, module: module_, basename, extname, relative, stem } = src
+  if (component === 'ROOT') component = ''
   if (module_ === 'ROOT') module_ = ''
   let indexifyPathSegment = ''
   let familyPathSegment = ''
@@ -480,8 +489,11 @@ function computePub (src, out, family, version, htmlUrlExtensionStyle) {
   const pub = {}
   let url
   if (family === 'nav') {
-    const urlSegments = version ? [src.component, version] : [src.component]
-    if (src.module && src.module !== 'ROOT') urlSegments.push(src.module)
+    const component = src.component || 'ROOT'
+    const urlSegments = component === 'ROOT' ? [] : [component]
+    if (version) urlSegments.push(version)
+    const module_ = src.module || 'ROOT'
+    if (module_ !== 'ROOT') urlSegments.push(module_)
     // an artificial URL used for resolving page references in navigation model
     url = '/' + urlSegments.join('/') + '/'
     pub.moduleRootPath = '.'

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

@@ -56,9 +56,16 @@ function parseResourceId (spec, ctx = {}, defaultFamily = 'page', permittedFamil
   }
 
   if (~relative.indexOf('/')) {
-    relative = relative
-      .split('/')
-      .filter((it) => it && it !== '.' && it !== '..')
+    const relativeSegments = relative.split('/')
+    let from
+    if (relativeSegments[0] === '.' && (from = ctx.relative)) {
+      relativeSegments[0] = from.substr(0, (from.lastIndexOf('/') + 1 || 1) - 1)
+    }
+    relative = relativeSegments
+      .reduce((accum, segment) => {
+        segment === '..' ? accum.pop() : (segment || '.') !== '.' && accum.push(segment)
+        return accum
+      }, [])
       .join('/')
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/content-classifier",
-  "version": "3.0.0-alpha.9",
+  "version": "3.0.0-beta.4",
   "description": "Organizes aggregated content into a virtual file catalog for use in an Antora documentation pipeline.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -16,12 +16,12 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "@antora/logger": "3.0.0-alpha.9",
+    "@antora/logger": "3.0.0-beta.4",
     "mime-types": "~2.1",
     "vinyl": "~2.2"
   },
   "engines": {
-    "node": ">=10.17.0"
+    "node": ">=12.21.0"
   },
   "files": [
     "lib/"
@@ -34,5 +34,6 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "a504d6889819b548e8a5416a7194cbb6f9a93e93"
+  "gitHead": "8a142499e9f1a9e0631777796e06dd6c010d3a90",
+  "readmeFilename": "README.md"
 }