asciidoctor-rhrev 1.0.0

data/lib/asciidoctor/rhrev/rhrev_html.rb

@@ -0,0 +1,334 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'asciidoctor/converter/html5'
+
+module Asciidoctor
+  module Rhrev
+    # Treeprocessor to auto-inject revision history at document start
+    class HtmlTreeprocessor < Asciidoctor::Extensions::Treeprocessor
+      def process document
+        return document unless document.attr? 'rhrev'
+        
+        rhrev_value = document.attr('rhrev')
+        return document if rhrev_value == 'macro' || rhrev_value == 'manual'
+        
+        # Insert rhrev block at the beginning of the document
+        rhrev_block = create_block document, :rhrev, nil, {}
+        document.blocks.unshift rhrev_block
+        
+        document
+      end
+    end
+    
+    module Html5Converter
+      include Asciidoctor::Rhrev::Helpers
+
+      def convert node, transform = node.node_name, opts = {}
+        if node.context == :rhrev
+          convert_rhrev_block node
+        else
+          super
+        end
+      end
+
+      def convert_rhrev_block node
+        doc = node.document
+        return '' unless doc.attr? 'rhrev'
+        return '' if doc.attr('rhrev') == 'manual'
+        
+        # Check for initial release handling
+        revnumber = doc.attr('revnumber', '1.0')
+        initial_handling = doc.attr('rhrev-initial-handling', 'initial-release')
+        
+        if is_initial_release?(revnumber)
+          return '' if initial_handling == 'skip'
+          return generate_initial_release_html(doc) if initial_handling == 'initial-release'
+        end
+        
+        # Generate revision history HTML table
+        catalog = collect_all_entries(doc)
+        return '' if catalog.nil? || catalog.entries.empty?
+        
+        generate_html_output(doc, catalog)
+      end
+      
+      def is_initial_release?(revnumber)
+        revnumber.to_s == '1.0' || revnumber.to_s == '1'
+      end
+      
+      def generate_html_output(doc, catalog)
+        html = []
+        discrete = doc.attr? 'rhrev-discrete'
+        
+        # Wrapper
+        html << '<div class="rhrev-section">' if discrete
+        html << '<section id="revision-history">' unless discrete
+        
+        # Title
+        if (title = doc.attr('rhrev-customization-title'))
+          unless title.empty?
+            version_label = doc.attr('version-label', 'Revision')
+            resolved_title = title.gsub('{version-label}', version_label)
+            html << %(<h2>#{resolved_title}</h2>)
+          end
+        else
+          # Default title
+          version_label = doc.attr('version-label', 'Revision')
+          html << %(<h2>#{version_label} History</h2>)
+        end
+        
+        # Table
+        html << generate_html_table(doc, catalog)
+        
+        # Close wrapper
+        html << (discrete ? '</div>' : '</section>')
+        
+        html.join("\n")
+      end
+      
+      def generate_initial_release_html(doc)
+        html = []
+        discrete = doc.attr? 'rhrev-discrete'
+        
+        # Wrapper
+        html << '<div class="rhrev-section">' if discrete
+        html << '<section id="revision-history">' unless discrete
+        
+        # Title
+        if (title = doc.attr('rhrev-customization-title'))
+          unless title.empty?
+            version_label = doc.attr('version-label', 'Revision')
+            resolved_title = title.gsub('{version-label}', version_label)
+            html << %(<h2>#{resolved_title}</h2>)
+          end
+        else
+          version_label = doc.attr('version-label', 'Revision')
+          html << %(<h2>#{version_label} History</h2>)
+        end
+        
+        # Simple table
+        initial_text = doc.attr('rhrev-customization-initial-release-text') ||
+                       doc.attr('rhrev-localization-initial-release') ||
+                       'Initial release'
+        
+        column_widths = doc.attr('rhrev-table-column-width', '30,70').split(',').map(&:strip)
+        section_label = doc.attr('rhrev-localization-location', 'Section')
+        major_changes_text = doc.attr('rhrev-localization-major-changes', 'Major changes since')
+        version_label = doc.attr('version-label', 'Revision')
+        revnumber = doc.attr('revnumber', '1.0')
+        
+        # Build table CSS classes with frame and grid
+        frame = doc.attr('rhrev-table-frame', 'all')
+        grid = doc.attr('rhrev-table-grid', 'all')
+        html << %(<table class="tableblock frame-#{frame} grid-#{grid} stretch">)
+        
+        # Caption as title div
+        unless doc.attr? 'rhrev-disable-caption'
+          if (caption = doc.attr('rhrev-table-caption'))
+            html << %(<div class="title">#{caption}</div>)
+          end
+        end
+        
+        html << '<colgroup>'
+        column_widths.each { |w| html << %(<col style="width: #{w}%;">)}
+        html << '</colgroup>'
+        html << '<tbody>'
+        html << '<tr class="rhrev-header">'
+        html << %(<th class="tableblock halign-left valign-top">#{section_label}</th>)
+        html << %(<th class="tableblock halign-left valign-top"><strong>#{major_changes_text} #{version_label} #{revnumber}</strong></th>)
+        html << '</tr>'
+        html << '<tr>'
+        html << '<td>&nbsp;</td>'
+        html << %(<td>#{initial_text}</td>)
+        html << '</tr>'
+        html << '</tbody>'
+        html << '</table>'
+        
+        html << (discrete ? '</div>' : '</section>')
+        
+        html.join("\n")
+      end
+
+      def collect_all_entries(doc)
+        catalog = Catalog.new
+        prefix = doc.attr 'revhistoryprefix', 'rhrev'
+        
+        # Collect document-level entries (-all)
+        (0..9).each do |major|
+          (0..9).each do |minor|
+            revision = "#{major}-#{minor}"
+            prevrev_attr = "#{revision}-prevrev"
+            
+            if doc.attr(prevrev_attr)
+              all_attr_name = "#{prefix}#{revision}-all"
+              if (all_value = doc.attr(all_attr_name))
+                catalog.add_all_entry revision, all_value
+              end
+              
+              # Skip -cover entries for HTML
+            end
+          end
+        end
+        
+        # Collect block-level entries by scanning document
+        contexts = [:section, :floating_title, :example, :listing, :table, :image]
+        doc.find_by { |b| contexts.include?(b.context) }.each do |block|
+          next unless block.id
+          
+          if block.respond_to?(:attributes)
+            block.attributes.each do |key, value|
+              key_str = key.to_s
+              next unless key_str.start_with?(prefix)
+              next if key_str.include?('-all') || key_str.end_with?('-cover')
+              
+              revision = key_str.sub(prefix, '')
+              
+              catalog.add_entry revision, block.id, value.to_s,
+                reftext: block.reftext,
+                title: block.title,
+                sectnum: block.respond_to?(:sectnum) ? block.sectnum : nil,
+                context: block.context,
+                is_chapter: false,
+                sectname: block.respond_to?(:sectname) ? block.sectname : nil,
+                caption_number: nil,
+                source_line: block.lineno
+            end
+          end
+        end
+        
+        catalog
+      end
+
+      def generate_html_table(doc, catalog)
+        column_widths = doc.attr 'rhrev-table-column-width', '30,70'
+        widths = column_widths.split(',').map(&:strip)
+        
+        html = []
+        
+        # Build table CSS classes with frame and grid
+        frame = doc.attr('rhrev-table-frame', 'all')
+        grid = doc.attr('rhrev-table-grid', 'all')
+        html << %(<table class="tableblock frame-#{frame} grid-#{grid} stretch">)
+        
+        # Caption as title div
+        unless doc.attr? 'rhrev-disable-caption'
+          if (caption = doc.attr('rhrev-table-caption'))
+            html << %(<div class="title">#{caption}</div>)
+          end
+        end
+        
+        html << '<colgroup>'
+        widths.each { |w| html << %(<col style="width: #{w}%;">) }
+        html << '</colgroup>'
+        html << '<tbody>'
+        
+        # Custom first row
+        if (first_row = doc.attr('rhrev-customization-first-row'))
+          html << '<tr class="rhrev-custom-first-row">'
+          html << %(<td colspan="2">#{first_row}</td>)
+          html << '</tr>'
+        elsif (first_row_left = doc.attr('rhrev-customization-first-row-left')) ||
+              (first_row_right = doc.attr('rhrev-customization-first-row-right'))
+          html << '<tr class="rhrev-custom-first-row">'
+          html << %(<td>#{first_row_left || '&nbsp;'}</td>)
+          html << %(<td>#{first_row_right || '&nbsp;'}</td>)
+          html << '</tr>'
+        end
+        
+        section_label = doc.attr 'rhrev-localization-location', 'Section'
+        major_changes_text = doc.attr 'rhrev-localization-major-changes', 'Major changes since'
+        all_text = doc.attr 'rhrev-localization-all', 'All'
+        
+        catalog.sorted_revisions.each do |revision|
+          prevrev_attr = "#{revision}-prevrev"
+          prevrevdate_attr = "#{revision}-prevrevdate"
+          revision_label = doc.attr('version-label', 'Revision')
+          prev_title = doc.attr(prevrev_attr) || revision.tr('-', '.')
+          prev_date = doc.attr(prevrevdate_attr) || ""
+          prev_rev_text = format_prev_rev(prev_title, prev_date, doc)
+          
+          # Build header text
+          if prev_title.strip.downcase.start_with?(revision_label.downcase)
+            header_text = "#{major_changes_text} #{prev_rev_text}"
+          else
+            header_text = "#{major_changes_text} #{revision_label} #{prev_rev_text}"
+          end
+          
+          # Header row for this revision
+          html << '<tr class="rhrev-header">'
+          html << %(<th class="tableblock halign-left valign-top">#{section_label}</th>)
+          html << %(<th class="tableblock halign-left valign-top"><strong>#{header_text}</strong></th>)
+          html << '</tr>'
+          
+          # All entry
+          if (all_change = catalog.instance_variable_get(:@all_entries)[revision])
+            html << '<tr>'
+            html << %(<td>#{all_text}</td>)
+            html << %(<td>#{format_change_as_html_list(all_change)}</td>)
+            html << '</tr>'
+          end
+          
+          # Block entries
+          entries = catalog.entries[revision] || []
+          entries.sort_by! { |e| e[:sequence] || 0 }
+          
+          entries.each do |entry|
+            anchor = entry[:anchor]
+            title = entry[:title] || anchor.tr('_-', ' ').split.map(&:capitalize).join(' ')
+            
+            html << '<tr>'
+            html << %(<td><a href="##{anchor}">#{title}</a></td>)
+            html << %(<td>#{format_change_as_html_list(entry[:change])}</td>)
+            html << '</tr>'
+          end
+        end
+        
+        html << '</tbody>'
+        html << '</table>'
+        
+        html.join("\n")
+      end
+
+      def format_change_as_html_list(text)
+        return '' if text.to_s.empty?
+        
+        # Process attribute content (handle line breaks)
+        processed = preprocess_attribute_content(text)
+        
+        # Split by asterisks to create list items
+        tokens = processed.split(/\s(?=\*+\s)/)
+        
+        items = []
+        if tokens.empty? || tokens.length == 1 && !processed.include?('*')
+          # Single item without asterisk - wrap in list anyway
+          items << { level: 1, content: processed }
+        else
+          tokens.each do |token|
+            next if token.strip.empty?
+            
+            # Count leading asterisks for nesting level
+            if token.strip =~ /^(\*+)\s+(.+)/
+              level = $1.length
+              content = $2
+              items << { level: level, content: content }
+            else
+              items << { level: 1, content: token.strip }
+            end
+          end
+        end
+        
+        # Always generate HTML list
+        html = ['<ul>']
+        items.each do |item|
+          html << '<li>' + item[:content] + '</li>'
+        end
+        html << '</ul>'
+        html.join("\n")
+      end
+    end
+  end
+end
+
+# Extend Html5Converter with our module
+Asciidoctor::Converter::Html5Converter.prepend Asciidoctor::Rhrev::Html5Converter

data/lib/asciidoctor/rhrev/rhrev_pdf.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# PDF-specific converter - only loaded if asciidoctor-pdf is available
+require 'asciidoctor/pdf' unless defined? Asciidoctor::PDF
+require_relative 'converter'
+require_relative 'renderer'
+require_relative 'exporter'

data/lib/asciidoctor/rhrev.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Load Asciidoctor first
+require 'asciidoctor' unless defined? Asciidoctor
+
+# Load shared components (processors, helpers, catalog)
+require_relative 'rhrev/processors'
+require_relative 'rhrev/helpers'
+require_relative 'rhrev/catalog'
+
+# Try to load the PDF converter support if asciidoctor-pdf is available
+begin
+  require 'asciidoctor-pdf'
+  require_relative 'rhrev/rhrev_pdf'
+rescue LoadError
+  # PDF not available, that's ok
+end
+
+# Try to load the HTML backend support
+html_available = false
+begin
+  require_relative 'rhrev/rhrev_html'
+  html_available = true
+rescue LoadError
+  # HTML-specific code couldn't be loaded
+end
+
+# Register extensions (processors are backend-agnostic)
+Asciidoctor::Extensions.register do
+  preprocessor Asciidoctor::Rhrev::XrefSanitizerPreprocessor
+  block_macro Asciidoctor::Rhrev::RhrevBlockMacroProcessor
+  inline_macro Asciidoctor::Rhrev::PagerhrefInlineMacroProcessor
+  treeprocessor Asciidoctor::Rhrev::HtmlTreeprocessor if html_available
+end

data/lib/asciidoctor-rhrev.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'asciidoctor/rhrev'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-rhrev
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- 白一百 baiyibai
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A comprehensive revision history tracking system for asciidoctor-pdf
+  that automatically creates a grouped, formatted table of document changes with clickable
+  page numbers, xrefstyle support, and extensive customization options.
+email: rubygems@baiyibai.cyou
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.adoc
+- USAGE.adoc
+- lib/asciidoctor-rhrev.rb
+- lib/asciidoctor/rhrev.rb
+- lib/asciidoctor/rhrev/catalog.rb
+- lib/asciidoctor/rhrev/converter.rb
+- lib/asciidoctor/rhrev/exporter.rb
+- lib/asciidoctor/rhrev/helpers.rb
+- lib/asciidoctor/rhrev/processors.rb
+- lib/asciidoctor/rhrev/renderer.rb
+- lib/asciidoctor/rhrev/rhrev_html.rb
+- lib/asciidoctor/rhrev/rhrev_pdf.rb
+homepage: https://gitlab.com/baiyibai/rhrev-asciidoctor-automatic-revision-history
+licenses:
+- CC0-1.0
+metadata:
+  source_code_uri: https://gitlab.com/baiyibai/rhrev-asciidoctor-automatic-revision-history.git
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Comprehensive revision history tracking extension for asciidoctor and asciidoctor-pdf
+test_files: []