asciidoctor-dot-leader 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9a25c3ac68e342ade564fce5f6ae421fb3ba5da8ebec4584682cf6b5c2f0202
+  data.tar.gz: 3883b7986da82e541f1a7dcdf029dc077489906a3ad303e33140ca2f98696d1a
+SHA512:
+  metadata.gz: 671510acec6229d3d54dfb4b9255c307a9141e70d307e3db369ca40773ac4d1f5bc880def7f0d3bc506251a42886956660e5a7535b0743e7e42d98adffaf0e96
+  data.tar.gz: 4a21802b05620af76b340504cd1d9951430a0502c4e1f77769c04a76cafc7ee86b26b1163e91fc4525082e2cc74e9223dd0f8bb30780a74a41d2084c16d4772b

data/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+
+This project includes code from Asciidoctor PDF by OpenDevise Inc. and the Asciidoctor Project,
+licensed under the MIT License:
+
+Copyright (c) 2025 白一百 baiyibai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.adoc

@@ -0,0 +1,98 @@
+= AsciiDoctor Dot Leader Inline Macro
+
+This project provides an inline macro which `pass:[dot:leader["left", "right"]]` which inserts leaders between the values.
+
+Dot . . . . . . . . . . . . . . . . . . . . . . . . Leaders
+
+It currently supports three backends:
+
+* AsciiDoctor (Ruby) - `backend-html5`
+* AsciiDoctor-PDF (Ruby) - `backend-pdf`
+* AsciiDoctor.js - `backend-webview-html5` - See <<asciidoctor-js-dot-leader>>
+
+.PDF
+image:resources/images/example-pdf-adoc-formatted.png[]
+
+.HTML5
+image:resources/images/example-html5-roles.png[]
+
+.AsciiDoctor.js
+image:resources/images/example-webview-html5-inline-passthroughs.png[]
+
+== Markup And Usage _Manual_ 
+
+Markup examples, rendered output examples, and extensive compatibility information is provided _for multiple output_ formats *in multiple formats*:
+
+* link:dot_leader_example.pdf[]
+* link:dot_leader_example.html[] 
+* Or clone the project and open the link:dot_leader_example.adoc[] file with Visual Studio Code's Asciidoc's preview window.
+
+== Todo
+
+There are a few items which need fixing:
+
+* PDF
+** [ ] Upload gem to rubygems.org
+* HTML5
+** [ ] Include .css automatically?
+* webview-html5 (Asciidoctor.js) for Microsoft Visual Studio Code and possibly others
+** [ ] Release on npm
+
+== Ruby GEM Build Instructions (for 白一百 baiyibai)
+
+```
+gem build asciidoctor-dot-leader.gemspec 
+gem install ./asciidoctor-dot-leader-1.0.0.gem
+```
+
+[#asciidoctor-js-dot-leader]
+== AsciiDoctor.js Dot Leader Inline Macro
+
+This project provides an inline macro, `pass:[dot:leader["left", "right"]]`, which inserts dot leaders between the provided values. 
+
+=== Target Application
+
+This has only been tested with the  Microsoft Visual Studio Code's AsciiDoc extension's _Preview_ function which uses the `backen-webview-html5`.
+
+=== Usage
+
+Complete these steps to enable the pass:[dot:leader[]] macro:
+
+. Install the library.
+. Create an `.asciidoctor/lib/` folder in the root of the asciidoctor project.
+. Set up the target project directory to use the extension by using either of these methods:
+.. Copy the `.dot_leader.js` file to the `.asciidoctor/lib/` folder.
+.. Create a `.dot_leader_linker.js` file in the `.asciidoctor/lib/` folder and copy and modify this content to it:
++
+[source,javascript]
+----
+module.exports = require('../../asciidoctorjs-extension/dot_leader.js')
+
+// TODO: Install locally and test if it works
+// module.exports = require('asciidoctor-dot-leader')
+----
++
+. Enable the AsciiDoc Extension's ability to use extensions in the _Preview_ function using either of these methods:
+.. Set this configuration flag: 
++
+[source,javascript]
+----
+"asciidoc.extensions.registerWorkspaceExtensions": true
+----
++
+.. Enable the Asciidoc > Extensions: *Register Workspace Extensions* option.
+. Open a document containing `pass:[dot:leader[]]` inline macros, and press the _Preview_ button.
+
+
+== Copyright
+
+Copyright (C) 2025-present 白一百 baiyibai
+Free use of this software is granted under the terms of the MIT License.
+
+* The image _The «Public Domain Mark» icon from Creative Commons with transparent background._ is in the public domain and taken from: +
+https://commons.wikimedia.org/wiki/File:Cc-public_domain_mark.svg[^]
+
+* The CSS taken from https://www.w3.org/Style/Examples/007/leaders.en.html[^].
+
+
+For the full text of the license, see the link:LICENSE[] file.

data/lib/asciidoctor/dot_leader/dot_leader_html.rb

@@ -0,0 +1,11 @@
+# dot_leader_html.rb 2025-07-20 白一百 baiyibai
+# https://gitlab.com/baiyibai/asciidoctor-pdf-dot-leader
+require 'asciidoctor/converter/html5'
+
+Asciidoctor::Converter::Html5Converter.class_eval do
+  def convert_inline_dot_leader(node)
+    l_text = node.attr('l_text')
+    r_text = node.attr('r_text')
+    %(<ul class="leaders"><li><span>#{l_text}</span><span>#{r_text}</span></li></ul>)
+  end
+end

data/lib/asciidoctor/dot_leader/dot_leader_inline_macro.rb

@@ -0,0 +1,31 @@
+# dot_leader_inline_macro.rb 2025-07-20 白一百 baiyibai
+# https://gitlab.com/baiyibai/asciidoctor-pdf-dot-leader
+# This extension provides the 'dot:leader["left","right"]' extension.
+Asciidoctor::Extensions.register do
+  inline_macro do
+    named :dot
+    process do |parent, target, attrs|
+      l_text = attrs[1] || ''
+      r_text = attrs[2] || ''
+
+      # Perform attribute substitution (must be done twice because attributes are placed inside of attributes)
+      l_text = parent.apply_subs l_text, [:attributes]
+      r_text = parent.apply_subs r_text, [:attributes]
+      
+      # Handles both pass:[]#text# and [.role]#text#, and attributes again
+      # Do not use :specialcharacters
+      l_fragments = parent.apply_subs l_text, [:quotes, :macros, :attributes, :replacements, :post_replacements]
+      r_fragments = parent.apply_subs r_text, [:quotes, :macros, :attributes, :replacements, :post_replacements]
+      
+      
+      # warn "DEBUG dot: target='#{target}', l_text='#{l_fragments}', r_text='#{r_fragments}'"
+
+      create_inline parent, :dot_leader, target,
+        type: :dot,
+        attributes: {
+          'l_text' => l_fragments,
+          'r_text' => r_fragments,
+        }
+    end
+  end
+end

data/lib/asciidoctor/dot_leader/dot_leader_pdf.rb

@@ -0,0 +1,190 @@
+# dot_leader_pdf.rb 2025-07-20 白一百 baiyibai
+# https://gitlab.com/baiyibai/asciidoctor-pdf-dot-leader
+# This inline macro uses AsciiDoctor-PDF's ToC generation code as a jumping off point, but departs from it.
+# Use '':dot-leader-scale: 0.6' to set the document-wide factor
+require 'asciidoctor-pdf' unless defined? ::Asciidoctor::Converter::PdfConverter
+class DotLeader < (Asciidoctor::Converter.for 'pdf')
+  register_for 'pdf'
+
+  def rendered_width_of_fragments(fragments, scale, roles = [])
+      fragments.sum do |fragment|
+      styles = fragment[:styles] || Set.new
+      size = font_size
+      size *= scale if styles.include?(:subscript) || styles.include?(:superscript)
+      font_style = if styles.include?(:bold) && styles.include?(:italic)
+        :bold_italic
+      elsif styles.include?(:bold)
+        :bold
+      elsif styles.include?(:italic)
+        :italic
+      else
+        :normal
+      end
+  
+      font_name = fragment[:font] || font_family
+      
+      width = nil
+      # Handle inline image width
+      if fragment[:image_format]
+        # Use numeric value if it's a string
+        image_width = fragment[:image_width]
+        return image_width.to_f if image_width
+      end
+      font font_name, style: font_style, size: size do
+        width = rendered_width_of_string(fragment[:text])
+      end
+      width
+    end
+  end
+  
+  def convert_inline_dot_leader(node)
+    # warn "Node attributes: #{node.attributes.inspect}"
+    return nil unless node.type == :dot
+
+    left_side = node.attr('l_text') || ''
+    right_side = node.attr('r_text') || ''    
+    if left_side.empty? # Allow items only on the right
+      left_side = ' '
+    end
+    doc = node.document
+    if doc.attr 'dot-leader-scale'
+      scale = doc.attr 'dot-leader-scale'
+      scale = scale.to_f
+    else
+      scale = 0.6
+    end
+    
+    # 2025-07-17 BYB: Create the dot_leader array; copied from ink_toc
+    dot_leader = theme_font :toc do    
+      # TODO: we could simplify by using nested theme_font :toc_dot_leader #BYB: Original note from ink_toc
+      if (dot_leader_font_style = @theme.toc_dot_leader_font_style&.to_sym || :normal) != font_style
+        font_style dot_leader_font_style
+      end
+      font_size @theme.toc_dot_leader_font_size
+      {
+        font_color: @theme.toc_dot_leader_font_color || @font_color,
+        font_style: dot_leader_font_style,
+        font_size: font_size,
+        levels: ((dot_leader_l = @theme.toc_dot_leader_levels) == 'none' ? ::Set.new :
+            (dot_leader_l && dot_leader_l != 'all' ? dot_leader_l.to_s.split.map(&:to_i).to_set : nil)),
+        text: (dot_leader_text = @theme.toc_dot_leader_content || DotLeaderTextDefault),
+        width: dot_leader_text.empty? ? 0 : (rendered_width_of_string dot_leader_text),
+        # TODO: spacer gives a little bit of room between dots and page number #BYB: Original note from ink_toc
+        spacer: { text: NoBreakSpace, size: (spacer_font_size = @font_size * 0.25) },
+        spacer_width: (rendered_width_of_char NoBreakSpace, size: spacer_font_size),
+      }
+    end
+
+    # 2025-07-17 BYB: Set toc_font_info
+    toc_font_info = theme_font :toc do
+      { font: font, size: @font_size }
+    end
+
+    # 2025-07-17 BYB: Set a dummy entry_level and entry_anchor
+    entry_level = 2
+    entry_anchor = nil
+
+    # 2025-07-17 BYB: Store the cursor position
+    start_cursor = cursor
+    start_dots = nil   
+
+    # 2025-07-17 BYB: left_side original
+    left_side_inherited = (apply_text_decoration ::Set.new, :toc, entry_level).merge anchor: entry_anchor, color: @font_color
+    # NOTE: use text formatter to add anchor overlay to avoid using inline format with synthetic anchor tag
+    left_side_fragments = text_formatter.format left_side, inherited: left_side_inherited
+    # warn "left_side_fragments: #{left_side_fragments.inspect}"
+    
+    # 2025-07-17 BYB: Try doing the same for the right side 
+    right_side_inherited = (apply_text_decoration ::Set.new, :toc, entry_level).merge anchor: entry_anchor, color: @font_color
+    # NOTE: use text formatter to add anchor overlay to avoid using inline format with synthetic anchor tag
+    right_side_fragments = text_formatter.format right_side, inherited: right_side_inherited
+
+    line_metrics = calc_line_metrics @base_line_height
+
+    # 2025-07-17 BYB: This needs to be modified
+    right_side_placeholder_width = rendered_width_of_string right_side * @toc_max_pagenum_digits
+    # puts right_side_placeholder_width.inspect # Various widths
+    right_side_placeholder_width = 0 # BYB: Not a problem for now
+    
+    right_side_placeholder_width = rendered_width_of_fragments right_side_fragments, scale, node.roles.to_a
+
+    left_side_test_width = rendered_width_of_fragments left_side_fragments, scale, node.roles.to_a
+    
+    # 2025-07-17 Set hanging_indent to toc; potentially this could be styled
+    hanging_indent = @theme.toc_hanging_indent
+    start_page_number = page_number
+
+    indent 0, right_side_placeholder_width do
+      fragment_positions = []
+      left_side_fragments.each do |fragment|
+        fragment_positions << (fragment_position = ::Asciidoctor::PDF::FormattedText::FragmentPositionRenderer.new)
+        (fragment[:callback] ||= []) << fragment_position
+      end
+
+      if right_side_placeholder_width > bounds.width
+        warn "WARN: dot-leader: The right side too wide to fit on a line; skipping: #{left_side} #{right_side}"
+        return nil
+      end
+
+      typeset_formatted_text left_side_fragments, line_metrics, hanging_indent: hanging_indent, normalize_line_height: true
+
+      break unless (last_fragment_position = fragment_positions.select(&:page_number)[-1])
+      start_dots = last_fragment_position.right + hanging_indent
+      last_fragment_cursor = last_fragment_position.top + line_metrics.padding_top
+      start_cursor = last_fragment_cursor if last_fragment_position.page_number > start_page_number || (start_cursor - last_fragment_cursor) > line_metrics.height
+    end
+    
+    # 2025-07-17 No loop
+    # NOTE: this will leave behind a gap where this entry would have been
+    # break unless start_dots
+    
+    end_cursor = cursor
+    move_cursor_to start_cursor
+    # NOTE: we're guaranteed to be on the same page as the final line of the entry
+
+    if dot_leader[:width] > 0 && (dot_leader[:levels] ? (dot_leader[:levels].include? entry_level.pred) : true)
+      # 2025-07-17 BYB: Needed to calculate the right side width
+      # right_side_width = rendered_width_of_string right_side
+      right_side_width = right_side_placeholder_width
+      
+      right_side_font_settings = { color: @font_color, font: font_family, size: @font_size, styles: font_styles }
+      save_font do
+        # NOTE: the same font is used for dot leaders throughout toc
+        set_font toc_font_info[:font], dot_leader[:font_size]
+        font_style dot_leader[:font_style]
+        # 2025-07-17 BYB: Add support for Multiple Columns https://asciidoctor.zulipchat.com/#narrow/channel/288690-users.2Fasciidoctor-pdf/topic/Implicit.20page.20break.20after.20column_box
+        if node.parent.parent.attributes['columns']
+          start_dots = start_dots - bounds.left
+        end
+        num_dots = [((bounds.width - start_dots - dot_leader[:spacer_width] - right_side_width) / dot_leader[:width]).floor, 0].max
+        # FIXME: dots don't line up in columns if width of page numbers differ # BYB: Original
+        fragment_positions = []
+        right_side_fragments.each do |fragment|
+          fragment_positions << (fragment_position = ::Asciidoctor::PDF::FormattedText::FragmentPositionRenderer.new)
+          (fragment[:callback] ||= []) << fragment_position
+        end
+        typeset_formatted_text [
+        { text: dot_leader[:text] * num_dots, color: dot_leader[:font_color] },
+        dot_leader[:spacer],
+        *right_side_fragments.map { |fragment|
+          fragment.dup.tap do |f|
+            f[:styles] = Array(f[:styles])
+            f[:styles] |= Array(right_side_font_settings[:styles]) if right_side_font_settings[:styles]
+            f[:font] ||= right_side_font_settings[:font] if right_side_font_settings[:font]
+            f[:size] ||= right_side_font_settings[:size] if right_side_font_settings[:size]
+            f[:color] ||= right_side_font_settings[:color] if right_side_font_settings[:color]
+            f[:anchor] = entry_anchor if entry_anchor
+          end
+        }
+      ], line_metrics, align: :right
+      end
+    else
+      typeset_formatted_text [{ text: right_side, color: @font_color, anchor: entry_anchor }], line_metrics, align: :right
+    end
+    move_cursor_to end_cursor
+
+    # Return nil to avoid numbers being printed out
+    nil
+
+  end
+end

data/lib/asciidoctor/dot_leader.rb

@@ -0,0 +1,19 @@
+# dot_leader.rb 2025-07-20 白一百 baiyibai
+# https://gitlab.com/baiyibai/asciidoctor-pdf-dot-leader
+# This gem is structured so that asciidoctor-pdf is not required for html5 output
+require_relative 'dot_leader/dot_leader_inline_macro'
+
+# Try to load the PDF converter support if available
+begin
+  require 'asciidoctor-pdf'
+  require_relative 'dot_leader/dot_leader_pdf'
+rescue LoadError
+  # PDF not available, do nothing
+end
+
+# Try to load the HTML backend support if Asciidoctor is available
+begin
+  require_relative 'dot_leader/dot_leader_html'
+rescue LoadError
+  # HTML-specific code couldn't be loaded — possibly not needed
+end

data/lib/asciidoctor-dot-leader.rb

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

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-dot-leader
+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: Extension for asciidoctor (pdf and html) for creating dot leaders using
+  the dot.leader["left","right"] syntax.
+email: rubygems@baiyibai.cyou
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.adoc
+- lib/asciidoctor-dot-leader.rb
+- lib/asciidoctor/dot_leader.rb
+- lib/asciidoctor/dot_leader/dot_leader_html.rb
+- lib/asciidoctor/dot_leader/dot_leader_inline_macro.rb
+- lib/asciidoctor/dot_leader/dot_leader_pdf.rb
+homepage: https://gitlab.com/baiyibai/asciidoctor-dot-leader
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://gitlab.com/baiyibai/asciidoctor-dot-leader.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: Extension for asciidoctor (pdf and html) for creating dot leaders
+test_files: []