asciidoctor-rhrev 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ff948e637bb99f9d64376d94ad293310988680a558ef3796aa797911210ad48
-  data.tar.gz: f47c7b2ecf6aa55d7e396b44221e8d7af6445c9c6085a71182e8b0a457e09226
+  metadata.gz: f150c21ea6f2c3fe871bc18d4e91cae846279104ddc72d72e9b7f06e4a009a20
+  data.tar.gz: 5f1ef686a5575db2d83e818577310e9f81060beb891ec800abcad29f19327c2b
 SHA512:
-  metadata.gz: a908055a506c6d32629d381a800c2c8911e649e0d4dfcd51ea2b5bb64a7d70e6bd4bb45229541947b9e840df95a9c3335d03179634cfe8efd99d51bedc8a5cb5
-  data.tar.gz: 8f5442540754978416479cf2b90f01d207993659b9e243277cdc1d645475dec294379691b62b88d1b7ad55ef3748f4af318486ea3bc7fc3ee6d6e08e2cf3d74b
+  metadata.gz: f6de41ae3d96fdf56c8eeda288f1bc2650d365019e641ccc5259755107e8f81af2be29715b6ef4a0c9f42e8eb22d53f7db73bfe38e2d447b19e7d1382f3e8047
+  data.tar.gz: 68251c6a35b808bd9e138cc6cfd3996969d052c20fac88e3bb8b17f5efd8b9a388a243a4c9a50471ba1e54fd95e126ca0acab584abd4c627c9a0067c84bf9d89

data/CHANGELOG.adoc

@@ -1,5 +1,15 @@
 = Changelog
 
+== 1.8.0 (2026-09-08)
+
+* Table-cell marks no longer require the AsciiDoc-style cell prefix `a|`: an rhrev attribute list alone on the first line of any cell's content marks the cell, for every style prefix and none, and for cells in a header row, which no earlier release could mark at all. `Asciidoctor::Rhrev::CellTextMarks` reads the attribute list off the cell's raw text, sets the attributes on the cell, and strips the line, before the existing `a|` propagation runs; the PDF prescan, the HTML treeprocessor, and both Antora extension files use it. In Antora output the lift wraps a marked plain or header cell's text in an `rhrev-changed` role span so the existing table post-processor tags the cell's own `<td>`/`<th>`; a literal cell renders verbatim and stays untagged there, its mark still rolls up. Foot rows now join every table-cell walk. New fixture `tests/features/test-change-bars-table-header-cells.adoc` and regression files `tests/regression/table-header-cell-marks.rb`, `html-table-header-cell-marks.rb`, and `js-table-header-cell-marks.js`
+* Multi-row table headers: rows promoted into the header with the `hrows` tree processor carry their marks the same way. asciidoctor-pdf drops header-cell rowspan (asciidoctor/asciidoctor-pdf#2631); the `multirow_table_header.rb` converter in baiyibai-antora-collector-assembler-pdf-themes restores it together with the `hrows` promotion
+
+== 1.7.1 (2026-09-02)
+
+* Fix two revision-history entries sharing the same start page sorting in the wrong relative order whenever one of them has body content that spans a page break (PDF backend). `Converter#convert_section` correctly reads a section's own starting page via `pdf-page-start`, set by asciidoctor-pdf's own `convert_section` right before the heading itself is inked, but paired it with a `:dest][:y]` value read from `cursor` after `result = super` returns, once the section's whole body (nested content, a large table, anything that can span several physical pages of its own) had already rendered. For a page-spanning section that cursor belongs to whatever page the body finished on, not the section's own start page `pdf-page-start` names, so the two stopped describing the same physical location at all; two entries sharing that start page are ordered by this `y` value alone (`renderer.rb`'s own `entries.sort_by`), and a wrong one can reverse their true top-to-bottom order. Reported directly, with real captured values from a real document, confirming exactly this: a page-spanning section's own `y` secretly belonging to the next physical page, sorting it ahead of another entry that genuinely was higher on their shared page. `ChangeBars#record_section_heading_position`, called unconditionally, not gated on change bars being enabled at all, from `ink_general_heading`/`ink_chapter_title`/`ink_part_title`, the same moment upstream itself captures `pdf-page-start`, right before the heading is actually inked. `Converter#convert_section` reads it back instead of a live post-super cursor, so `page_num` and `y` always describe the section's own start consistently. New regression file, `tests/regression/section-dest-y-page-mismatch.rb`, forces the page-spanning body with an explicit `<<<` page break rather than tuning paragraph-repeat counts against exact font metrics, deterministic regardless of theme or font; confirmed to fail (reversed order) without the fix and pass with it
+* Note: gem-only; the Antora extension (HTML output, no PDF page/cursor concept) is unaffected, npm still bumps concurrently per the standing 1.5.1 policy
+
 == 1.7.0 (2026-09-02)
 
 * Replace 1.6.0's per-item list change bars with a different design, after real user feedback that the syntax it needed was too heavy: marking one item required a `+` continuation, an attribute line, and a two-line empty open block, four lines to mark a single bullet, far more than every other rhrev-markable construct's own single attribute line. 1.6.0's mechanism (`Converter#propagate_list_item_content_marks`, the attached-continuation-block workaround, `list_item` added to the roll-up contexts) is fully removed, not just superseded

data/lib/asciidoctor/rhrev/cell_text_marks.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Rhrev
+    # 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, so the mark reaches the cell for every cell style,
+    # including cells in a header row.
+    #
+    # Asciidoctor parses a header-row cell without any style at all:
+    # Table::Cell#initialize forces the style to nil whenever the table's
+    # header option is in effect, so the a| prefix is consumed and ignored
+    # there, and the cell's content is never parsed as blocks. Rows promoted
+    # into the header after parsing (the hrows tree processor from
+    # asciidoctor-extensions-lab) keep their parsed style, but asciidoctor-pdf
+    # and Asciidoctor's own HTML5 converter render every head cell through
+    # the plain-text path, which returns an AsciiDoc-style cell's raw source,
+    # attribute line included. Both cases leave the attribute list in the
+    # cell's raw text. Reading that raw text directly, before any converter
+    # touches it, covers every style, every row kind, and every promotion
+    # mechanism with one rule: an rhrev attribute list alone on the first
+    # line of the cell's content marks the cell.
+    #
+    # Reads and writes only the cell's raw @text. Cell#text applies
+    # substitutions, and the PDF converter's prescan runs with attribute
+    # substitution deliberately suppressed because counter attributes
+    # increment on every evaluation; table_contains_pagerhref? already takes
+    # the same care. Idempotent: once the line is stripped a second pass
+    # finds nothing to lift, which matters for asciidoctor-pdf's scratch
+    # passes and rhrev's own deferred pagerhref re-render, both of which
+    # reuse the same node objects.
+    #
+    # For an AsciiDoc-style cell the inner document was already parsed from
+    # the same raw text, with the attribute list attached to its first nested
+    # block; propagate_cell_content_marks still moves that mark onto the cell
+    # and strips it from the nested block, so the two mechanisms agree on the
+    # cell's attributes and the strip here only affects the raw text a head
+    # cell renders from.
+    #
+    # An attribute list without any rhrev-prefixed key is left untouched: it
+    # belongs to the writer's own content.
+    module CellTextMarks
+      LEADING_ATTRIBUTE_LIST_RX = /\A\[([^\[\]\n]+)\]\n/
+
+      module_function
+
+      # Lifts marks from every cell of every table in doc. Returns the number
+      # of cells changed.
+      def lift doc, prefix
+        lifted = 0
+        doc.find_by(context: :table).each do |table|
+          rows = table.rows
+          (rows.head + rows.body + rows.foot).flatten.each do |cell|
+            lifted += 1 if lift_cell cell, prefix
+          end
+        end
+        lifted
+      end
+
+      # Lifts a mark from one cell. Returns true when the cell changed.
+      def lift_cell cell, prefix
+        raw = cell.instance_variable_get :@text
+        return false unless raw.is_a?(::String) && (m = LEADING_ATTRIBUTE_LIST_RX.match raw)
+        attrs = (::Asciidoctor::AttributeList.new m[1]).parse
+        marks = attrs.select { |key, _| key.to_s.start_with? prefix }
+        return false if marks.empty?
+        marks.each { |key, value| cell.set_attr key.to_s, value }
+        cell.instance_variable_set :@text, (raw.slice m[0].length, raw.length)
+        true
+      end
+    end
+  end
+end

data/lib/asciidoctor/rhrev/change_bars.rb

@@ -62,6 +62,29 @@ module Asciidoctor
           @change_bar_starts&.delete node
         end
 
+        # A section's own cursor position at heading-ink time, before its
+        # body (potentially spanning several pages) renders. Unconditional,
+        # not gated on change bars being enabled at all: Converter#
+        # convert_section's own revision-history dest needs this, pairing
+        # it with pdf-page-start (also captured at this same moment,
+        # upstream's own convert_section, right before the heading ink
+        # call this method wraps) so both fields describe the section's
+        # own start consistently. A page-spanning section's cursor read
+        # after the whole body renders belongs to wherever that body
+        # finished, not the section's own start page; two entries sharing
+        # the same start page then sort by a y value that was never on
+        # that page at all, reversing their true top-to-bottom order,
+        # confirmed directly against a real document.
+        def record_section_heading_position node
+          return unless node.context == :section
+          @section_heading_positions ||= {}
+          @section_heading_positions[node] = cursor
+        end
+
+        def take_section_heading_position node
+          @section_heading_positions&.delete node
+        end
+
         # A section's bar covers only its own directly-owned content, not any
         # nested child sections/chapters: as soon as a child section begins
         # rendering, close out the bar of every still-open ancestor section
@@ -177,11 +200,13 @@ module Asciidoctor
         # have settled the page, so this is the first accurate start position.
         def ink_general_heading node, title, opts = {}
           record_change_bar_start node if @change_bar_attr && !scratch? && (change_bar? node)
+          record_section_heading_position node unless scratch?
           super
         end
 
         def ink_chapter_title node, title, opts = {}
           record_change_bar_start node if @change_bar_attr && !scratch? && (change_bar? node)
+          record_section_heading_position node unless scratch?
           super
         end
 
@@ -189,6 +214,7 @@ module Asciidoctor
         # so it must be overridden separately
         def ink_part_title node, title, opts = {}
           record_change_bar_start node if @change_bar_attr && !scratch? && (change_bar? node)
+          record_section_heading_position node unless scratch?
           super
         end
       end

data/lib/asciidoctor/rhrev/converter.rb

@@ -227,6 +227,27 @@ module Asciidoctor
             # page break. A pre-super page_number would be the page before that
             # break, one page too low for any chapter-starting section.
             page_num = ((node.attr 'pdf-page-start') || page_number).to_i
+
+            # y must describe the same physical location page_num does: the
+            # section's own start, not wherever cursor happens to sit once
+            # this whole call returns. A section's body can span several
+            # pages of its own (nested content, a large table, and so on);
+            # a post-super cursor read then belongs to whatever page that
+            # body finished on, not page_num's page, and the two stop
+            # describing the same point at all. take_section_heading_
+            # position (change_bars.rb) captured cursor at the same moment
+            # upstream captured pdf-page-start, right before the heading
+            # itself was inked, so pairing the two here always describes
+            # the section's own start consistently. Reported directly
+            # against a real document: two entries sharing the same
+            # page_sortable sorted in the wrong relative order, one of
+            # them a page-spanning section whose old post-super y actually
+            # belonged to the page after the one it was paired with.
+            # Falls back to the old post-super cursor only for a section
+            # with no heading ink call at all (a hidden title), no worse
+            # than before for that one remaining case.
+            y_pos = take_section_heading_position(node) || cursor
+
             @anchor_catalog ||= {}
             @anchor_catalog[node.id] ||= {
               title: node.title,
@@ -235,10 +256,10 @@ module Asciidoctor
               context: node.context,
               level: node.level
             }
-            @anchor_catalog[node.id][:dest] = { page: (rhrev_display_page page_num), physical_page: page_num, y: cursor }
+            @anchor_catalog[node.id][:dest] = { page: (rhrev_display_page page_num), physical_page: page_num, y: y_pos }
 
             # Link destination to page for revision history
-            revision_history.link_dest_to_page node.id, page_num, (@rhrev_body_start_page || 1), y: cursor
+            revision_history.link_dest_to_page node.id, page_num, (@rhrev_body_start_page || 1), y: y_pos
           end
 
           # Start position was captured at heading-ink time (after any page advance)
@@ -262,7 +283,7 @@ module Asciidoctor
         # way, only the bar geometry was wrong, and bars are graphical.
         def marked_table_cell_bar_rows node
           marked_rows = []
-          (node.rows[:head] + node.rows[:body]).each_with_index do |row, row_idx|
+          (node.rows[:head] + node.rows[:body] + node.rows[:foot]).each_with_index do |row, row_idx|
             marked_rows << row_idx if row.any? do |cell|
               cell.respond_to?(:attributes) && cell.attributes && (cell.attributes.key? @change_bar_attr)
             end
@@ -845,9 +866,16 @@ module Asciidoctor
         # Must run before rollup_table_cell_revision_entries and before real
         # rendering, so the cell's own attributes are already in place by
         # the time either reads them.
+        #
+        # CellTextMarks.lift (cell_text_marks.rb) runs right before this: it
+        # reads the same attribute list off the cell's raw text, which is
+        # the only place it survives for a plain cell or any header-row
+        # cell, so a mark no longer needs the a| form at all. Both paths
+        # set the same attributes on the cell; this one still strips the
+        # nested block for the double-bar reason described here.
         def propagate_cell_content_marks doc
           doc.find_by(context: :table).each do |table|
-            cells = (table.rows[:head] + table.rows[:body]).flatten
+            cells = (table.rows[:head] + table.rows[:body] + table.rows[:foot]).flatten
             cells.each do |cell|
               next unless cell.style == :asciidoc
               inner = (cell.inner_document rescue nil)
@@ -870,7 +898,7 @@ module Asciidoctor
 
         def rollup_table_cell_revision_entries doc
           doc.find_by(context: :table).each do |table|
-            cells = (table.rows[:head] + table.rows[:body]).flatten
+            cells = (table.rows[:head] + table.rows[:body] + table.rows[:foot]).flatten
             cells.each do |cell|
               attr_entries = (cell.instance_variable_get(:@attributes) rescue nil)
               next if attr_entries.nil? || attr_entries.empty?
@@ -1099,6 +1127,7 @@ module Asciidoctor
               end
             end
 
+            ::Asciidoctor::Rhrev::CellTextMarks.lift doc, @revision_prefix
             propagate_cell_content_marks doc
             rollup_child_revision_entries doc
             rollup_table_cell_revision_entries doc

data/lib/asciidoctor/rhrev/rhrev_html.rb

@@ -31,13 +31,20 @@ module Asciidoctor
     # as the PDF side: leaving it in place would tag both the cell and the
     # nested paragraph independently, a redundant double border for what is
     # really one mark on one piece of content.
+    #
+    # CellTextMarks.lift (cell_text_marks.rb) runs first inside this
+    # treeprocessor: it reads the same attribute list off the cell's raw
+    # text, which is the only place it survives for a plain cell or any
+    # header-row cell, so a mark no longer needs the a| form at all.
     class TableCellMarkPropagationHtmlTreeprocessor < Asciidoctor::Extensions::Treeprocessor
       def process document
         return document unless document.basebackend? 'html'
         prefix = document.attr 'revhistoryprefix', 'rhrev'
 
+        ::Asciidoctor::Rhrev::CellTextMarks.lift document, prefix
+
         document.find_by(context: :table).each do |table|
-          cells = (table.rows[:head] + table.rows[:body]).flatten
+          cells = (table.rows[:head] + table.rows[:body] + table.rows[:foot]).flatten
           cells.each do |cell|
             next unless cell.style == :asciidoc
             inner = (cell.inner_document rescue nil)
@@ -469,7 +476,7 @@ module Asciidoctor
       # treeprocessor phase, before this (a converter method) ever runs.
       def rollup_table_cell_revision_entries catalog, doc, prefix
         doc.find_by(context: :table).each do |table|
-          cells = (table.rows[:head] + table.rows[:body]).flatten
+          cells = (table.rows[:head] + table.rows[:body] + table.rows[:foot]).flatten
           cells.each do |cell|
             attr_entries = (cell.instance_variable_get(:@attributes) rescue nil)
             next if attr_entries.nil? || attr_entries.empty?

data/lib/asciidoctor/rhrev.rb

@@ -6,6 +6,7 @@ require 'asciidoctor' unless defined? Asciidoctor
 # Load shared components (processors, helpers, catalog)
 require_relative 'rhrev/processors'
 require_relative 'rhrev/helpers'
+require_relative 'rhrev/cell_text_marks'
 require_relative 'rhrev/catalog'
 
 # Try to load the PDF converter support if asciidoctor-pdf is available

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-rhrev
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - 白一百 baiyibai
@@ -38,6 +38,7 @@ files:
 - lib/asciidoctor-rhrev.rb
 - lib/asciidoctor/rhrev.rb
 - lib/asciidoctor/rhrev/catalog.rb
+- lib/asciidoctor/rhrev/cell_text_marks.rb
 - lib/asciidoctor/rhrev/change_bars.rb
 - lib/asciidoctor/rhrev/converter.rb
 - lib/asciidoctor/rhrev/exporter.rb