@antora/ui-loader 3.0.0-beta.3 → 3.0.0-rc.1

package/lib/file.js

@@ -40,7 +40,7 @@ class ReadableFile extends Readable {
 
   _read () {
     this.push(this._file)
-    this._file = null
+    this.push((this._file = null))
   }
 }
 

package/lib/load-ui.js

@@ -2,7 +2,6 @@
 
 const { compile: bracesToGroup } = require('braces')
 const camelCaseKeys = require('camelcase-keys')
-const concat = require('simple-concat')
 const { createHash } = require('crypto')
 const expandPath = require('@antora/expand-path-helper')
 const { File, MemoryFile, ReadableFile } = require('./file')
@@ -14,8 +13,9 @@ const ospath = require('path')
 const { posix: path } = ospath
 const picomatch = require('picomatch')
 const posixify = ospath.sep === '\\' ? (p) => p.replace(/\\/g, '/') : undefined
-const { pipeline, Transform } = require('stream')
-const map = (transform, flush = undefined) => new Transform({ objectMode: true, transform, flush })
+const { pipeline, Transform, Writable } = require('stream')
+const forEach = (write, final) => new Writable({ objectMode: true, write, final })
+const map = (transform) => new Transform({ objectMode: true, transform })
 const UiCatalog = require('./ui-catalog')
 const yaml = require('js-yaml')
 const vzip = require('gulp-vinyl-zip')
@@ -40,7 +40,7 @@ const EXT_RX = /\.[a-z]{2,3}$/
  * the playbook. If the path is a URI, it downloads the file and caches it at a
  * unique path to avoid this step in future calls. It then reads all the files
  * from the bundle into memory, skipping any files that fall outside of the
- * start path specified in the ui.startPath property of the playbook.  Finally,
+ * start path specified in the ui.startPath property of the playbook. Finally,
  * it classifies the files and adds them to a UiCatalog, which is then
  * returned.
  *
@@ -103,7 +103,7 @@ async function loadUi (playbook) {
     resolveBundle.then((bundleFile) =>
       new Promise((resolve, reject) =>
         bundleFile.isDirectory()
-          ? srcFs(bundleFile.path).then(resolve, reject)
+          ? srcFs(ospath.join(bundleFile.path, bundle.startPath || '', '.')).then(resolve, reject)
           : vzip
             .src(bundleFile.path)
             .on('error', (err) => reject(Object.assign(err, { message: `not a valid zip file; ${err.message}` })))
@@ -186,12 +186,12 @@ function downloadBundle (url, to, agent) {
         .on('error', (err) =>
           reject(Object.assign(err, { message: `not a valid zip file; ${err.message}`, summary: 'Invalid UI bundle' }))
         )
-        .on('finish', function () {
+        .on('finish', () =>
           fsp
             .mkdir(ospath.dirname(to), { recursive: true })
             .then(() => fsp.writeFile(to, contents))
             .then(() => resolve(new File({ path: to, stat: { isDirectory: () => false } })))
-        })
+        )
     })
   }).catch((err) => {
     const wrapped = new Error(`${err.summary || 'Failed to download UI bundle'}: ${url}`)
@@ -234,25 +234,25 @@ function bufferizeContents () {
   return map((file, _, next) => {
     // NOTE gulp-vinyl-zip automatically converts the contents of an empty file to a Buffer
     if (file.isStream()) {
-      concat(file.contents, (err, contents) => {
-        if (err) return next(err)
-        file.contents = contents
-        next(null, file)
-      })
+      const buffer = []
+      pipeline(
+        file.contents,
+        forEach((chunk, _, done) => buffer.push(chunk) && done()),
+        (err) => (err ? next(err) : next(null, Object.assign(file, { contents: Buffer.concat(buffer) })))
+      )
     } else {
       next(null, file)
     }
   })
 }
 
-function collectFiles (done) {
-  const files = new Map()
-  return map(
-    (file, _, next) => {
+function collectFiles (resolve, files = new Map()) {
+  return forEach(
+    (file, _, done) => {
       files.set(file.path, file)
-      next()
+      done()
     },
-    () => done(files)
+    (done) => done() || resolve(files)
   )
 }
 
@@ -283,13 +283,13 @@ function srcSupplementalFiles (filesSpec, startDir) {
     ).then((files) => files.reduce((accum, file) => accum.set(file.path, file) && accum, new Map()))
   } else {
     const cwd = expandPath(filesSpec, { dot: startDir })
-    return fsp
-      .access(cwd)
-      .then(() => srcFs(cwd))
-      .catch((err) => {
+    return fsp.access(cwd).then(
+      () => srcFs(cwd),
+      (err) => {
         // Q: should we skip unreadable files?
         throw Object.assign(err, { message: `problem encountered while reading ui.supplemental_files: ${err.message}` })
-      })
+      }
+    )
   }
 }
 
@@ -340,23 +340,25 @@ function resolveOut (file, outputDir = '_') {
 }
 
 function srcFs (cwd) {
-  return new Promise((resolve, reject, cache = {}, files = new Map()) =>
+  const relpathStart = cwd.length + 1
+  return new Promise((resolve, reject, cache = Object.create(null), files = new Map()) =>
     pipeline(
       globStream(UI_SRC_GLOB, Object.assign({ cache, cwd }, UI_SRC_OPTS)),
-      map(({ path: abspathPosix }, _, next) => {
+      forEach(({ path: abspathPosix }, _, done) => {
+        if (Array.isArray(cache[abspathPosix])) return done() // detects some directories, but not all
         const abspath = posixify ? ospath.normalize(abspathPosix) : abspathPosix
-        const relpath = abspath.substr(cwd.length + 1)
+        const relpath = abspath.substr(relpathStart)
         symlinkAwareStat(abspath).then(
           (stat) => {
-            if (stat.isDirectory()) return next()
+            if (stat.isDirectory()) return done() // detects remaining directories
             fsp.readFile(abspath).then(
               (contents) => {
                 const path_ = posixify ? posixify(relpath) : relpath
                 files.set(path_, new File({ cwd, path: path_, contents, stat, local: true }))
-                next()
+                done()
               },
               (readErr) => {
-                next(Object.assign(readErr, { message: readErr.message.replace(`'${abspath}'`, relpath) }))
+                done(Object.assign(readErr, { message: readErr.message.replace(`'${abspath}'`, relpath) }))
               }
             )
           },
@@ -369,7 +371,7 @@ function srcFs (cwd) {
             } else {
               statErr.message = statErr.message.replace(`'${abspath}'`, relpath)
             }
-            next(statErr)
+            done(statErr)
           }
         )
       }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/ui-loader",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-rc.1",
   "description": "Downloads a UI bundle, if necessary, and loads the files into a UI catalog for use in an Antora documentation pipeline.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -16,17 +16,20 @@
     "url": "https://gitlab.com/antora/antora/issues"
   },
   "main": "lib/index.js",
+  "scripts": {
+    "test": "_mocha"
+  },
   "dependencies": {
     "@antora/expand-path-helper": "~2.0",
     "braces": "~3.0",
     "cache-directory": "~2.0",
     "camelcase-keys": "~7.0",
+    "glob-stream": "~7.0",
     "gulp-vinyl-zip": "~2.5",
     "hpagent": "~0.1.0",
     "js-yaml": "~4.1",
     "picomatch": "~2.3",
     "should-proxy": "~1.0",
-    "simple-concat": "~1.0",
     "simple-get": "~4.0",
     "vinyl": "~2.2"
   },
@@ -45,5 +48,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "45da95a2e2dea538379d2d9f42013d2208fb86c3"
+  "gitHead": "044371a33e2c0fed9724d30945bbb549d64845d5"
 }