asciidoctor-rhrev 1.2.3 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87f9419e740ba6f0002e1a4fd06c2930319910ff2a3bf2fbeeefbfee33d6c0d3
-  data.tar.gz: 2c6759b77bd7c9ab7d16e906a569541c36a185a594f45b0e398e2f028087e0bc
+  metadata.gz: b64bf51f30ba6f298ac05c96c68df9b5a1d42c1c0671ca2cedf903df53b2c584
+  data.tar.gz: 359c71a434b72fa4cb734362c27eae1a499ad96480602ab1ae9d1e1d73f69789
 SHA512:
-  metadata.gz: d939d3d0be086e54ef94165c96532594992d45adf7d3f93cd1b1d64b2667db5bddfdfc6566252b7dc0b830536c46c2dc822c313d19477ec78c0e8dfbb816905a
-  data.tar.gz: 9918859a0819b3ad98926199f499eab62ff3185cd012f31b0c45fe5b8f76ae310c6fcdb9ab3096fa256335b2d5cdd42fb1f1a739e6cbba53e8db9da5c3fbb654
+  metadata.gz: 7380f1500ae2ba4befc6b3650cbc02fb2f5db15588fedfca99fc59ec17ae6dff557225f470a71908fd2af7c06d5217e55f1bee1e9f4eb1fcc1042f68657b6a94
+  data.tar.gz: 612871f81c20e144fbda5901cebf46a122005786d719dab0a2557bf04a609e508ff7238c69794e62ea46dcde8761b7d26dca694427d3e8d5f01d7a630c49e241

data/CHANGELOG.adoc

@@ -1,5 +1,17 @@
 = Changelog
 
+== 1.3.1 (2026-07-28)
+
+* Fix silent content loss in long revision-history tables (PDF backend): the extent dry-run that reserves space for the table now runs after `prescan_document` populates each tracked node's real `title`/`sectnum`/`reftext`/`caption_number`, so a description cross-reference (`[.rhrevdescription]`) that forward-references its own target no longer measures a humanized-anchor placeholder in the dry-run and the resolved text in the final backfill. When the two lengths differed, the accumulated row heights could shift a row across a reserved page boundary and drop its content from the output; measurement and backfill now agree. The metadata pass is gated on nodes carrying their own `rhrevN-M` attribute, so it adds no full-document walk
+* Fix the `rhrev-table-extra-blank-row` trailing blank row overflowing alone onto a continuation page (PDF backend): when the real entries nearly fill a page, the trailing blank row is now dropped rather than paginated to a page of its own. The check is scoped to the revision-history table's own last row and decided once per row, so no other table's pagination is affected and a multi-column blank row is never half-drawn
+* Note: this is a PDF-only release; the npm package skips 1.3.1
+
+== 1.3.0 (2026-07-16)
+
+* Add HTML change bars: with `:rhrev-change-bars:` set, tracked blocks (section, floating title, example, listing, table, image) marked with the current revision get the `rhrev-changed` CSS class in the HTML backend and the Antora extension; `rhrev-change-bars-color`, `-width`, and `-offset` are emitted as CSS custom properties (`--rhrev-change-bar-*`). The side is always right in HTML (no recto/verso model), and a marked section's bar spans its nested subsections, unlike the PDF backend. Default styling (red right border) ships in the baiyibai UI bundle
+* Fix the documented Assembler xref format example emitting a "possible invalid reference" warning by escaping the inline example
+* Replace the figure example in the docs with an original image (gem and npm both 1.3.0)
+
 == 1.2.3 (2026-07-15)
 
 * Fix the initial-release table (revnumber `1.0`/`1` with `rhrev-initial-handling` `initial-release`) rendering a "Major changes since Revision X" header row: an initial release has no prior revision, so the table is now a single `Page | Initial Release` row (PDF backend, HTML backend, and Antora extension). Caption, custom first row, and all localization/customization attributes are unaffected; `rhrev-localization-major-changes` still applies to the regular revision-history table

data/lib/asciidoctor/rhrev/converter.rb

@@ -279,6 +279,17 @@ module Asciidoctor
           end
         end
         
+        # True when the node carries its own rhrev* attribute in its raw (non-inherited)
+        # attribute set -- the same check collect_revision_entries makes, hoisted out so
+        # prescan_document can gate update_revision_entry_metadata on it.
+        def node_carries_own_rhrev? node
+          return false unless node.respond_to?(:attributes)
+          raw = (node.instance_variable_get(:@attributes) rescue nil)
+          return false if raw.nil? || raw.empty?
+          prefix = @revision_prefix || 'rhrev'
+          raw.keys.any? { |k| k.to_s.start_with?(prefix) }
+        end
+
         def update_revision_entry_metadata node
           return unless node.id
           return unless node.respond_to?(:attributes)
@@ -459,6 +470,13 @@ module Asciidoctor
             [:section, :floating_title, :example, :listing, :table, :image].each do |ctx|
               doc.find_by(context: ctx).each do |node|
                 collect_revision_entries node
+                # Populate the *real* title/sectnum/reftext/caption_number now, from
+                # the parsed AST, so the extent dry-run measures the same content the
+                # deferred backfill will later ink. Gated on the node carrying its own
+                # rhrevN-M attribute: reusing node.attributes here (inherited config keys
+                # like rhrev-table-caption match the prefix) would turn this into a full
+                # per-node document walk.
+                update_revision_entry_metadata node if node_carries_own_rhrev? node
               end
             end
             

data/lib/asciidoctor/rhrev/renderer.rb

@@ -329,15 +329,24 @@ module Asciidoctor
         
         def create_revision_table_properly doc
           asciidoc_table = build_table_via_parsing doc
-          
+
           disable_caption = doc.attr? 'rhrev-disable-caption'
           if disable_caption
             saved_caption = doc.attr 'table-caption'
             doc.set_attr 'table-caption', ''
           end
-          
-          convert_table asciidoc_table
-          
+
+          # Scope the lonely-trailing-blank-row skip (PrawnTableDrawPatch) to just
+          # this table. Both the extent dry-run and the real ink flow through here,
+          # so the skip is applied identically in measurement and draw.
+          had_skip_flag = @_rhrev_skip_lonely_blank_row
+          @_rhrev_skip_lonely_blank_row = true if doc.attr? 'rhrev-table-extra-blank-row'
+          begin
+            convert_table asciidoc_table
+          ensure
+            @_rhrev_skip_lonely_blank_row = had_skip_flag
+          end
+
           if disable_caption
             if saved_caption
               doc.set_attr 'table-caption', saved_caption

data/lib/asciidoctor/rhrev/rhrev_html.rb

@@ -5,6 +5,49 @@ require 'asciidoctor/converter/html5'
 
 module Asciidoctor
   module Rhrev
+    # Tags blocks marked with the current revision (revnumber 1.2 => attribute
+    # rhrev1-2) with the rhrev-changed role so a stylesheet can draw an HTML
+    # change bar (border on the right side). Enabled by the rhrev-change-bars
+    # document attribute, mirroring the PDF backend. The rhrev-change-bars-color,
+    # -width, and -offset attributes are emitted as CSS custom properties; the
+    # side is always right in HTML output (no recto/verso model).
+    class ChangeBarsHtmlTreeprocessor < Asciidoctor::Extensions::Treeprocessor
+      TRACKED_CONTEXTS = [:section, :floating_title, :example, :listing, :table, :image].freeze
+
+      def process document
+        return document unless document.basebackend? 'html'
+        return document unless document.attr? 'rhrev-change-bars'
+        return document unless (revnumber = document.attr 'revnumber')
+        prefix = document.attr 'revhistoryprefix', 'rhrev'
+        change_attr = %(#{prefix}#{revnumber.to_s.tr '.', '-'})
+
+        tagged = false
+        document.find_by { |b| TRACKED_CONTEXTS.include? b.context }.each do |block|
+          next unless block.attributes && (block.attributes.key? change_attr)
+          roles = (block.attr 'role')
+          block.set_attr 'role', [roles, 'rhrev-changed'].compact.join(' ')
+          tagged = true
+        end
+        return document unless tagged
+
+        overrides = []
+        if (color = document.attr 'rhrev-change-bars-color')
+          overrides << %(--rhrev-change-bar-color: ##{color.to_s.delete_prefix '#'};)
+        end
+        if (width = document.attr 'rhrev-change-bars-width')
+          overrides << %(--rhrev-change-bar-width: #{width}px;)
+        end
+        if (offset = document.attr 'rhrev-change-bars-offset')
+          overrides << %(--rhrev-change-bar-offset: #{offset}px;)
+        end
+        unless overrides.empty?
+          style = create_block document, :pass, %(<style>:root { #{overrides.join ' '} }</style>), {}
+          document.blocks.unshift style
+        end
+        document
+      end
+    end
+
     # Treeprocessor to auto-inject revision history at document start
     class HtmlTreeprocessor < Asciidoctor::Extensions::Treeprocessor
       def process document

data/lib/asciidoctor/rhrev/rhrev_pdf.rb

@@ -5,3 +5,4 @@ require 'asciidoctor/pdf' unless defined? Asciidoctor::PDF
 require_relative 'converter'
 require_relative 'renderer'
 require_relative 'exporter'
+require_relative 'table_draw_patch'

data/lib/asciidoctor/rhrev/table_draw_patch.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+# Scoped override of prawn-table's Table#draw.
+#
+# When the rhrev revision-history table is drawn with rhrev-table-extra-blank-row
+# set, build_table_via_parsing appends a trailing blank (NBSP) row. prawn-table
+# treats that row like any other: if the real entries nearly fill a page, the blank
+# row alone overflows onto a fresh continuation page whose only content is the
+# "(continued)" caption and an invisible row.
+#
+# This patch is INERT for every table except the rhrev revision-history one: draw
+# returns super unless the converter has set @_rhrev_skip_lonely_blank_row on the
+# document around that table's conversion. Only then do we reimplement the 0.2.2 draw
+# loop (verified against prawn-table 0.2.2) with a single added rule: if the table's
+# last row would land alone at the top of a fresh page, drop it instead of paginating
+# to it. The decision is made once, from the row's first cell, and applied to every
+# cell of the row -- prawn-table evaluates pagination per cell, so re-deciding per cell
+# could ink one cell of the row and drop the other, leaving a half-drawn blank row.
+
+begin
+  require 'prawn/table' unless defined? ::Prawn::Table
+rescue LoadError
+  # prawn-table not present; nothing to patch
+end
+
+if defined? ::Prawn::Table
+  module Asciidoctor
+    module PDF
+      module Rhrev
+        module PrawnTableDrawPatch
+          def draw
+            unless @pdf.respond_to?(:instance_variable_get) &&
+                   @pdf.instance_variable_get(:@_rhrev_skip_lonely_blank_row)
+              return super
+            end
+
+            # Defensive: only take the reimplemented path when the prawn-table
+            # internals we rely on are exactly the shape we reimplement against
+            # (0.2.2). On any drift, fall back to stock behavior.
+            internals = %i[initial_row_on_initial_page start_new_page?
+                           ink_and_draw_cells_and_start_new_page set_background_color
+                           ink_and_draw_cells header_rows with_position]
+            unless internals.all? { |m| respond_to?(m, true) } &&
+                   @pdf.respond_to?(:reference_bounds)
+              return super
+            end
+
+            with_position do
+              ref_bounds = @pdf.reference_bounds
+              started_new_page_at_row = initial_row_on_initial_page
+              offset = @pdf.y
+              @header_row = header_rows if @header
+
+              cells_this_page = []
+              last_drawn_cell = nil
+
+              last_row_index = @cells.map(&:row).max
+              blank_row_decided = false
+              skip_blank_row = false
+
+              @cells.each do |cell|
+                if cell.row == last_row_index && rhrev_blank_cell?(cell)
+                  # Decide once, from the first (column 0) cell of the last row, and
+                  # apply the same answer to every cell of that row.
+                  unless blank_row_decided
+                    skip_blank_row = start_new_page?(cell, offset, ref_bounds)
+                    blank_row_decided = true
+                  end
+                  next if skip_blank_row
+                end
+
+                if start_new_page?(cell, offset, ref_bounds)
+                  cells_this_page, offset = ink_and_draw_cells_and_start_new_page(cells_this_page, cell)
+                  started_new_page_at_row = cell.row
+                end
+
+                cell = set_background_color(cell, started_new_page_at_row)
+                cells_this_page << [cell, [cell.relative_x, cell.relative_y(offset)]]
+                last_drawn_cell = cell
+              end
+
+              ink_and_draw_cells(cells_this_page)
+
+              # @cells.last may now be a dropped blank cell; anchor the final cursor
+              # to the last cell we actually inked.
+              if last_drawn_cell
+                @pdf.move_cursor_to(last_drawn_cell.relative_y(offset) - last_drawn_cell.height)
+              end
+            end
+          end
+
+          # The trailing row appended for rhrev-table-extra-blank-row is a pair of
+          # non-breaking-space cells. Treat a last-row cell as blank when its content
+          # is empty once NBSP/whitespace is stripped; when the content can't be read,
+          # rely on the caller's flag + last-row guarantee and treat it as blank.
+          def rhrev_blank_cell? cell
+            content = (cell.content.to_s rescue nil)
+            return true if content.nil?
+            content.gsub(/[ \s]|&#160;|&nbsp;/, '').empty?
+          end
+        end
+
+        ::Prawn::Table.prepend PrawnTableDrawPatch
+      end
+    end
+  end
+end

data/lib/asciidoctor/rhrev.rb

@@ -31,4 +31,5 @@ Asciidoctor::Extensions.register do
   block_macro Asciidoctor::Rhrev::RhrevBlockMacroProcessor
   inline_macro Asciidoctor::Rhrev::PagerhrefInlineMacroProcessor
   treeprocessor Asciidoctor::Rhrev::HtmlTreeprocessor if html_available
+  treeprocessor Asciidoctor::Rhrev::ChangeBarsHtmlTreeprocessor if html_available
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-rhrev
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.1
 platform: ruby
 authors:
 - 白一百 baiyibai
@@ -46,6 +46,7 @@ files:
 - lib/asciidoctor/rhrev/renderer.rb
 - lib/asciidoctor/rhrev/rhrev_html.rb
 - lib/asciidoctor/rhrev/rhrev_pdf.rb
+- lib/asciidoctor/rhrev/table_draw_patch.rb
 homepage: https://gitlab.com/baiyibai/rhrev-asciidoctor-automatic-revision-history
 licenses:
 - CC0-1.0