asciidoctor-rhrev 1.7.0 → 1.8.0

package/antora-extension/antora-rhrev-asciidoc.js

@@ -17,6 +17,8 @@
 // of their own. A marked one rolls up as a bullet into its nearest
 // enclosing section's entry instead (or the document-level -all entry, if
 // it has no enclosing section, or its enclosing section has no id).
+const { liftCellTextMarks } = require('./cell-text-marks.js')
+
 const ROLLUP_CONTEXTS = ['paragraph', 'ulist', 'olist', 'dlist', 'admonition', 'open', 'quote', 'verse', 'sidebar']
 
 // Row-level: gets its own revision-history row when marked, requires an id.
@@ -122,6 +124,15 @@ function propagateCellContentMarks(doc, prefix) {
   const revnumber = doc.getAttribute('revnumber')
   const changeAttr = (changeBarsEnabled && revnumber) ? prefix + String(revnumber).replace(/\./g, '-') : null
 
+  // First the raw-text rule (cell-text-marks.js): an rhrev attribute list
+  // alone on the first line of any cell's content, any style, any row
+  // kind, lifted onto the cell and stripped from the raw text. This is the
+  // only path a header-row cell has, since Asciidoctor never parses its
+  // content as blocks. The role span it wraps a marked plain cell's text in
+  // is what patchConvertTableForCellTagging's HTML lift finds for such a
+  // cell, the same way a marked nested node's role serves an a| cell.
+  liftCellTextMarks(doc, prefix, { changeAttr, wrapForTag: !!changeAttr })
+
   doc.findBy((n) => n.getContext() === 'table').forEach((table) => {
     const rows = table.getRows()
     const cells = [].concat(rows.head.flat(), rows.foot.flat(), rows.body.flat())

package/antora-extension/antora-rhrev-html.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const { liftCellTextMarks } = require('./cell-text-marks.js')
+
 /**
  * Antora pipeline extension for revision history (rhrev).
  * 
@@ -337,6 +339,10 @@ function buildComponentCatalog(pageFiles, logger, quiet) {
     // own findBy. Same gotcha as antora-rhrev-asciidoc.js and the Ruby
     // gem's converter.rb. Copies the mark onto the enclosing cell (for the
     // revision-history entry below) and strips it from the nested node.
+    // The raw-text rule runs first (cell-text-marks.js): an rhrev attribute
+    // list alone on the first line of any cell's content, any style, any
+    // row kind, lifted onto the cell. The only path a header-row cell has.
+    liftCellTextMarks(doc, prefix)
     doc.findBy((n) => n.getContext() === 'table').forEach((table) => {
       const rows = table.getRows()
       const cells = [].concat(rows.head.flat(), rows.foot.flat(), rows.body.flat())

package/antora-extension/cell-text-marks.js

@@ -0,0 +1,84 @@
+'use strict'
+
+// Lifts an rhrev attribute list written as the first line of a table
+// cell's content onto the cell itself, then removes that line from the
+// cell's raw text. Mirrors lib/asciidoctor/rhrev/cell_text_marks.rb on the
+// Ruby side; see that file for the full reasoning. In short: Asciidoctor
+// parses a header-row cell with no style at all (the a| prefix is consumed
+// and ignored there), rows promoted into the header after parsing keep
+// their style but render through the plain-text path anyway, and both
+// leave the attribute list sitting in the cell's raw text. Reading that raw
+// text directly covers every cell style and every row kind with one rule:
+// an rhrev attribute list alone on the first line of the cell's content
+// marks the cell.
+//
+// Reads and writes the cell's raw @text through the property Opal stores
+// it under (`cell.text`), never getText(), which applies substitutions.
+// Idempotent: once the line is stripped a second pass finds nothing.
+//
+// Parses the attribute list with Asciidoctor's own AttributeList, reached
+// through the Opal runtime the caller's @asciidoctor/core already loaded
+// (global.Opal), so the accepted syntax matches the Ruby side exactly. When
+// no Opal runtime is present the cell is left untouched.
+//
+// wrapForTag: when set, and the lifted attributes include changeAttr (the
+// current revision's own attribute, change bars enabled), the remaining
+// cell text is wrapped in an unconstrained role span carrying the
+// rhrev-changed role. Antora's HTML pipeline cannot tag a cell's own
+// <td>/<th> from a treeprocessor; antora-rhrev-asciidoc.js's converter
+// patch lifts a marker found inside the rendered cell onto the enclosing
+// cell tag instead, and a cell that never parses its content as blocks has
+// no nested node to carry that marker, so the span supplies it. Never
+// applied to an AsciiDoc-style cell: its raw text is not what renders
+// (the inner document is), and a head cell of that style renders the raw
+// text verbatim, where the span syntax would show as literal characters.
+// Never applied to a literal cell either: its content renders verbatim,
+// so no inline markup survives and the span would show as characters.
+// A literal cell's mark still reaches the revision history; only the
+// visible tag on its own <td> is unavailable in Antora output.
+
+const LEADING_ATTRIBUTE_LIST_RX = /^\[([^\[\]\n]+)\]\n/
+
+function parseAttributeList (list) {
+  const Opal = global.Opal
+  const AttributeList = Opal && Opal.Asciidoctor && Opal.Asciidoctor.AttributeList
+  if (!AttributeList) return null
+  const parsed = AttributeList.$new(list).$parse()
+  const attrs = {}
+  parsed.$to_a().forEach((pair) => { attrs[String(pair[0])] = pair[1] })
+  return attrs
+}
+
+// Lifts a mark from one cell. Returns true when the cell changed.
+function liftCellTextMark (cell, prefix, { changeAttr = null, wrapForTag = false } = {}) {
+  const raw = cell.text
+  if (typeof raw !== 'string') return false
+  const m = LEADING_ATTRIBUTE_LIST_RX.exec(raw)
+  if (!m) return false
+  const attrs = parseAttributeList(m[1])
+  if (!attrs) return false
+  const markKeys = Object.keys(attrs).filter((key) => key.startsWith(prefix))
+  if (markKeys.length === 0) return false
+  markKeys.forEach((key) => cell.setAttribute(key, attrs[key]))
+  let rest = raw.slice(m[0].length)
+  const style = cell.getStyle()
+  if (wrapForTag && changeAttr && markKeys.includes(changeAttr) && style !== 'asciidoc' && style !== 'literal') {
+    rest = `[.rhrev-changed]##${rest}##`
+  }
+  cell.text = rest
+  return true
+}
+
+// Lifts marks from every cell of every table in doc. Returns the number of
+// cells changed.
+function liftCellTextMarks (doc, prefix, options = {}) {
+  let lifted = 0
+  doc.findBy((n) => n.getContext() === 'table').forEach((table) => {
+    const rows = table.getRows()
+    const cells = [].concat(rows.head.flat(), rows.body.flat(), rows.foot.flat())
+    cells.forEach((cell) => { if (liftCellTextMark(cell, prefix, options)) lifted++ })
+  })
+  return lifted
+}
+
+module.exports = { liftCellTextMarks, liftCellTextMark, LEADING_ATTRIBUTE_LIST_RX }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "asciidoctor-rhrev",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Revision history block macro extension for Asciidoctor.js and Antora (HTML5 backend)",
   "main": "antora-extension/antora-rhrev-asciidoc.js",
   "scripts": {
@@ -27,6 +27,7 @@
     "antora-extension/antora-rhrev-assembler-pagerhref.js",
     "antora-extension/antora-rhrev-html.js",
     "antora-extension/antora-rhrev-placeholder.js",
+    "antora-extension/cell-text-marks.js",
     "README.adoc",
     "LICENSE"
   ]