asciidoctor-pdf 1.5.0.alpha.11 → 1.5.0.alpha.12

data/lib/asciidoctor-pdf/converter.rb

@@ -299,9 +299,9 @@ class Converter < ::Prawn::Document
   end
 
   def convert_section sect, opts = {}
-    heading_level = sect.level + 1
-    theme_font :heading, level: heading_level do
+    theme_font :heading, level: (h_level = sect.level + 1) do
       title = sect.numbered_title formal: true
+      align = (@theme[%(heading_h#{h_level}_align)] || @theme.heading_align || :left).to_sym
       unless at_page_top?
         if sect.chapter?
           start_new_chapter sect
@@ -315,9 +315,9 @@ class Converter < ::Prawn::Document
       sect.set_attr 'page_start', page_number
       # NOTE auto-generate an anchor if one doesn't exist so TOC works
       # QUESTION should we just assign the section this generated id?
-      sect.set_attr 'anchor', (sect_anchor = sect.id || %(section-#{page_number}-#{dest_y.ceil}))
+      sect.set_attr 'anchor', (sect_anchor = sect.id || %(__autoid-#{page_number}-#{y.ceil}))
       add_dest_for_block sect, sect_anchor
-      sect.chapter? ? (layout_chapter_title sect, title) : (layout_heading title)
+      sect.chapter? ? (layout_chapter_title sect, title, align: align) : (layout_heading title, align: align)
     end
 
     convert_content_for_block sect
@@ -327,8 +327,9 @@ class Converter < ::Prawn::Document
 
   def convert_floating_title node
     add_dest_for_block node if node.id
-    theme_font :heading, level: (node.level + 1) do
-      layout_heading node.title
+    # QUESTION should we decouple styles from section titles?
+    theme_font :heading, level: (h_level = node.level + 1) do
+      layout_heading node.title, align: (@theme[%(heading_h#{h_level}_align)] || @theme.heading_align || :left).to_sym
     end
   end
 
@@ -808,85 +809,94 @@ class Converter < ::Prawn::Document
 
     theme_margin :block, :top
 
-    # NOTE image is scaled proportionally based on width (height is ignored)
     # TODO support cover (aka canvas) image layout using "canvas" (or "cover") role
     width = resolve_explicit_width node.attributes, bounds.width
+    if (width_relative_to_page = (node.attr? 'pdfwidth') && ((node.attr 'pdfwidth').end_with? 'vw'))
+      overflow = [bounds_margin_left, bounds_margin_right]
+    else
+      overflow = 0
+    end
 
-    case image_type
-    when 'svg'
-      begin
-        svg_data = ::IO.read image_path
-        svg_obj = ::Prawn::Svg::Interface.new svg_data, self, position: position, width: width, fallback_font_name: default_svg_font
-        svg_size = svg_obj.document.sizing
-        rendered_w = svg_size.output_width
-        if !width && (svg_obj.document.root.attributes.key? 'width')
-          # NOTE scale native width & height by 75% to convert px to pt; restrict width to bounds.width
-          if (adjusted_w = [bounds.width, rendered_w * 0.75].min) != rendered_w
-            # FIXME would be nice to have a resize/recalculate method; instead, just reconstruct
-            svg_obj = ::Prawn::Svg::Interface.new svg_data, self, position: position, width: (rendered_w = adjusted_w), fallback_font_name: default_svg_font
-            svg_size = svg_obj.document.sizing
+    span_page_width_if width_relative_to_page do
+      case image_type
+      when 'svg'
+        begin
+          svg_data = ::IO.read image_path
+          svg_obj = ::Prawn::Svg::Interface.new svg_data, self, position: position, width: width, fallback_font_name: default_svg_font, enable_file_requests_with_root: (::File.dirname image_path)
+          rendered_w = (svg_size = svg_obj.document.sizing).output_width
+          if !width && (svg_obj.document.root.attributes.key? 'width')
+            # NOTE scale native width & height by 75% to convert px to pt; restrict width to bounds.width
+            if (adjusted_w = [bounds.width, rendered_w * 0.75].min) != rendered_w
+              # FIXME would be nice to have a resize/recalculate method; instead, just reconstruct
+              svg_obj = ::Prawn::Svg::Interface.new svg_data, self, position: position, width: (rendered_w = adjusted_w), fallback_font_name: default_svg_font, enable_file_requests_with_root: (::File.dirname image_path)
+              svg_size = svg_obj.document.sizing
+            end
           end
-        end
-        # TODO shrink image to fit on a single page if height exceeds page height
-        rendered_h = svg_size.output_height
-        # TODO layout SVG without using keep_together (since we know the dimensions already); always render caption
-        keep_together do |box_height = nil|
-          svg_obj.instance_variable_set :@prawn, self
-          svg_obj.draw
-          if box_height && (link = node.attr 'link')
-            link_annotation [(abs_left = svg_obj.position[0] + bounds.absolute_left), y, (abs_left + rendered_w), (y + rendered_h)],
-                Border: [0, 0, 0],
-                A: { Type: :Action, S: :URI, URI: (str2pdfval link) }
+          # TODO shrink image to fit on a single page if height exceeds page height
+          rendered_h = svg_size.output_height
+          # TODO layout SVG without using keep_together (since we know the dimensions already); always render caption
+          keep_together do |box_height = nil|
+            svg_obj.instance_variable_set :@prawn, self
+            svg_obj.draw
+            if box_height && (link = node.attr 'link')
+              link_annotation [(abs_left = svg_obj.position[0] + bounds.absolute_left), y, (abs_left + rendered_w), (y + rendered_h)],
+                  Border: [0, 0, 0],
+                  A: { Type: :Action, S: :URI, URI: (str2pdfval link) }
+            end
+            indent *overflow do
+              layout_caption node, position: :bottom
+            end if node.title?
           end
-          layout_caption node, position: :bottom if node.title?
+        rescue => e
+          warn %(asciidoctor: WARNING: could not embed image: #{image_path}; #{e.message})
         end
-      rescue => e
-        warn %(asciidoctor: WARNING: could not embed image: #{image_path}; #{e.message})
-      end
-    else
-      begin
-        # FIXME this code really needs to be better organized!
-        # FIXME temporary workaround to group caption & image
-        # NOTE use low-level API to access intrinsic dimensions; build_image_object caches image data previously loaded
-        image_obj, image_info = build_image_object image_path
-        if width
-          rendered_w, rendered_h = image_info.calc_image_dimensions width: width
-        else
-          # NOTE scale native width & height by 75% to convert px to pt; restrict width to bounds.width
-          rendered_w = [bounds.width, image_info.width * 0.75].min
-          rendered_h = (rendered_w * image_info.height) / image_info.width
-        end
-        # TODO move this calculation into a method
-        caption_height = node.title? ?
-            (@theme.caption_margin_inside + @theme.caption_margin_outside + @theme.base_line_height_length) : 0
-        if rendered_h > (available_height = cursor - caption_height)
-          start_new_page unless at_page_top?
-          # NOTE shrink image so it fits on a single page if height exceeds page height
+      else
+        begin
+          # FIXME this code really needs to be better organized!
+          # FIXME temporary workaround to group caption & image
+          # NOTE use low-level API to access intrinsic dimensions; build_image_object caches image data previously loaded
+          image_obj, image_info = build_image_object image_path
+          if width
+            rendered_w, rendered_h = image_info.calc_image_dimensions width: width
+          else
+            # NOTE scale native width & height by 75% to convert px to pt; restrict width to bounds.width
+            rendered_w = [bounds.width, image_info.width * 0.75].min
+            rendered_h = (rendered_w * image_info.height) / image_info.width
+          end
+          # TODO move this calculation into a method
+          caption_height = node.title? ?
+              (@theme.caption_margin_inside + @theme.caption_margin_outside + @theme.base_line_height_length) : 0
           if rendered_h > (available_height = cursor - caption_height)
-            rendered_w = (rendered_w * available_height) / rendered_h
-            rendered_h = available_height
-            # FIXME workaround to fix Prawn not adding fill and stroke commands
-            # on page that only has an image; breakage occurs when line numbers are added
-            # NOTE this no longer seems to be an issue
-            fill_color self.fill_color
-            stroke_color self.stroke_color
+            start_new_page unless at_page_top?
+            # NOTE shrink image so it fits on a single page if height exceeds page height
+            if rendered_h > (available_height = cursor - caption_height)
+              rendered_w = (rendered_w * available_height) / rendered_h
+              rendered_h = available_height
+              # FIXME workaround to fix Prawn not adding fill and stroke commands
+              # on page that only has an image; breakage occurs when line numbers are added
+              # NOTE this no longer seems to be an issue
+              fill_color self.fill_color
+              stroke_color self.stroke_color
+            end
           end
+          # NOTE must calculate link position before embedding to get proper boundaries
+          if (link = node.attr 'link')
+            img_x, img_y = image_position rendered_w, rendered_h, position: position
+            link_box = [img_x, (img_y - rendered_h), (img_x + rendered_w), img_y]
+          end
+          embed_image image_obj, image_info, width: rendered_w, position: position
+          if link
+            link_annotation link_box,
+              Border: [0, 0, 0],
+              A: { Type: :Action, S: :URI, URI: (str2pdfval link) }
+          end
+        rescue => e
+          warn %(asciidoctor: WARNING: could not embed image: #{image_path}; #{e.message})
         end
-        # NOTE must calculate link position before embedding to get proper boundaries
-        if (link = node.attr 'link')
-          img_x, img_y = image_position rendered_w, rendered_h, position: position
-          link_box = [img_x, (img_y - rendered_h), (img_x + rendered_w), img_y]
-        end
-        embed_image image_obj, image_info, width: rendered_w, position: position
-        if link
-          link_annotation link_box,
-            Border: [0, 0, 0],
-            A: { Type: :Action, S: :URI, URI: (str2pdfval link) }
-        end
-      rescue => e
-        warn %(asciidoctor: WARNING: could not embed image: #{image_path}; #{e.message})
+        indent *overflow do
+          layout_caption node, position: :bottom
+        end if node.title?
       end
-      layout_caption node, position: :bottom if node.title?
     end
     theme_margin :block, :bottom
   ensure
@@ -940,6 +950,12 @@ class Converter < ::Prawn::Document
       Helpers.require_library 'pygments', 'pygments.rb' unless defined? ::Pygments
       lexer = ::Pygments::Lexer[node.attr 'language', 'text', false] || ::Pygments::Lexer['text']
       pygments_config = { nowrap: true, noclasses: true, style: (node.document.attr 'pygments-style') || 'pastie' }
+      # TODO enable once we support background color on spans
+      #if node.attr? 'highlight', nil, false
+      #  unless (hl_lines = node.resolve_lines_to_highlight(node.attr 'highlight', nil, false)).empty?
+      #    pygments_config[:hl_lines] = hl_lines * ' '
+      #  end
+      #end
       source_string, conum_mapping = extract_conums source_string
       result = lexer.highlight source_string, options: pygments_config
       fragments = guard_indentation text_formatter.format result
@@ -1158,7 +1174,7 @@ class Converter < ::Prawn::Document
         cell_data = {
           content: cell.text,
           inline_format: [normalize: true],
-          text_color: (theme.table_body_font_color || @font_color),
+          text_color: (theme.table_font_color || @font_color),
           size: theme.table_font_size,
           font: theme.table_font_family,
           colspan: cell.colspan || 1,
@@ -1209,8 +1225,11 @@ class Converter < ::Prawn::Document
     end
 
     border = {}
+    table_border_color = theme.table_border_color
     table_border_width = theme.table_border_width
-    [:top, :bottom, :left, :right, :cols, :rows].each {|edge| border[edge] = table_border_width }
+    table_grid_width = theme.table_grid_width || theme.table_border_width
+    [:top, :bottom, :left, :right].each {|edge| border[edge] = table_border_width }
+    [:cols, :rows].each {|edge| border[edge] = table_grid_width }
 
     frame = (node.attr 'frame') || 'all'
     grid = (node.attr 'grid') || 'all'
@@ -1258,7 +1277,8 @@ class Converter < ::Prawn::Document
       cell_style: {
         padding: theme.table_cell_padding,
         border_width: 0,
-        border_color: theme.table_border_color
+        # NOTE the border color of edges is set later
+        border_color: theme.table_grid_color || theme.table_border_color
       },
       column_widths: column_widths,
       row_colors: [odd_row_bg_color, even_row_bg_color]
@@ -1270,6 +1290,7 @@ class Converter < ::Prawn::Document
     table table_data, table_settings do
       if grid == 'none' && frame == 'none'
         if table_header
+          # FIXME allow header border bottom width to be set by theme
           rows(0).border_bottom_width = 1.5
         end
       else
@@ -1277,17 +1298,33 @@ class Converter < ::Prawn::Document
         cells.border_width = [border[:rows], border[:cols], border[:rows], border[:cols]]
 
         if table_header
+          # FIXME allow header border bottom width to be set by theme
           rows(0).border_bottom_width = 1.5
+          # QUESTION should we use the table border color for the bottom border color of the header row?
+          #rows(0).border_bottom_color = table_border_color
+          #rows(1).border_top_width = 0 if row_length > 1
         end
 
         # top edge of table
-        rows(0).border_top_width = border[:top]
+        rows(0).tap do |r|
+          r.border_top_width = border[:top]
+          r.border_top_color = table_border_color
+        end
         # right edge of table
-        columns(num_cols - 1).border_right_width = border[:right]
+        columns(num_cols - 1).tap do |r|
+          r.border_right_width = border[:right]
+          r.border_right_color = table_border_color
+        end
         # bottom edge of table
-        rows(num_rows - 1).border_bottom_width = border[:bottom]
+        rows(num_rows - 1).tap do |r|
+          r.border_bottom_width = border[:bottom]
+          r.border_bottom_color = table_border_color
+        end
         # left edge of table
-        columns(0).border_left_width = border[:left]
+        columns(0).tap do |r|
+          r.border_left_width = border[:left]
+          r.border_left_color = table_border_color
+        end
       end
 
       # QUESTION should cell padding be configurable for foot row cells?
@@ -1337,9 +1374,9 @@ class Converter < ::Prawn::Document
       end
       #attrs << %( title="#{node.attr 'title'}") if node.attr? 'title'
       attrs << %( target="#{node.attr 'window'}") if node.attr? 'window'
-      if (node.document.attr? 'showlinks') && !(node.has_role? 'bare')
+      if (((doc = node.document).attr? 'media', 'print') || (doc.attr? 'show-link-uri')) && !(node.has_role? 'bare')
         # TODO allow style of visible link to be controlled by theme
-        %(<a href="#{target = node.target}"#{attrs.join}>#{node.text}</a> <font size="0.9"><em>(#{target})</em></font>)
+        %(<a href="#{target = node.target}"#{attrs.join}>#{node.text}</a> <font size="0.9em">[#{target}]</font>)
       else
         %(<a href="#{node.target}"#{attrs.join}>#{node.text}</a>)
       end
@@ -1460,10 +1497,11 @@ class Converter < ::Prawn::Document
 
   def convert_inline_menu node
     menu = node.attr 'menu'
+    caret = @theme.menu_caret_content || %( \u203a )
     if !(submenus = node.attr 'submenus').empty?
-      %(<strong>#{[menu, *submenus, (node.attr 'menuitem')] * ' | '}</strong>)
+      %(<strong>#{[menu, *submenus, (node.attr 'menuitem')] * caret}</strong>)
     elsif (menuitem = node.attr 'menuitem')
-      %(<strong>#{menu} | #{menuitem}</strong>)
+      %(<strong>#{menu}#{caret}#{menuitem}</strong>)
     else
       %(<strong>#{menu}</strong>)
     end
@@ -1543,7 +1581,7 @@ class Converter < ::Prawn::Document
       logo_image_attrs['align'] ||= (@theme.title_page_logo_align || title_align.to_s)
       logo_image_top = (logo_image_attrs['top'] || @theme.title_page_logo_top)
       # FIXME delegate to method to convert page % to y value
-      logo_image_top = [(page_height - page_height * (logo_image_top.to_i / 100.0)), bounds.absolute_top].min
+      logo_image_top = [(page_height - page_height * (logo_image_top.to_f / 100.0)), bounds.absolute_top].min
       float do
         @y = logo_image_top
         # FIXME add API to Asciidoctor for creating blocks like this (extract from extensions module?)
@@ -1559,7 +1597,7 @@ class Converter < ::Prawn::Document
       doctitle = doc.doctitle partition: true
       if (title_top = @theme.title_page_title_top)
         # FIXME delegate to method to convert page % to y value
-        @y = [(page_height - page_height * (title_top.to_i / 100.0)), bounds.absolute_top].min
+        @y = [(page_height - page_height * (title_top.to_f / 100.0)), bounds.absolute_top].min
       end
       move_down (@theme.title_page_title_margin_top || 0)
       theme_font :title_page_title do
@@ -1631,8 +1669,8 @@ class Converter < ::Prawn::Document
     start_new_page
   end
 
-  def layout_chapter_title node, title
-    layout_heading title
+  def layout_chapter_title node, title, opts = {}
+    layout_heading title, opts
   end
 
   # QUESTION why doesn't layout_heading set the font??
@@ -1720,7 +1758,7 @@ class Converter < ::Prawn::Document
     go_to_page toc_page_number unless (page_number == toc_page_number) || scratch?
     start_page_number = page_number
     theme_font :heading, level: 2 do
-      layout_heading doc.attr('toc-title')
+      layout_heading doc.attr('toc-title'), align: (@theme.toc_title_align || :left).to_sym
     end
     # QUESTION shouldn't we skip this whole method if num_levels == 0?
     if num_levels > 0
@@ -1973,10 +2011,10 @@ class Converter < ::Prawn::Document
               when ::Hash
                 # NOTE image placement respects padding; use negative image_vertical_align value to revert
                 trim_v_padding = trim_padding[0] + trim_padding[2]
-                # NOTE bounding_box is redundant if trim_v_padding is 0
-                bounding_box [0, cursor - trim_padding[0]], width: bounds.width, height: (bounds.height - trim_v_padding) do
-                  # NOTE float ensures cursor position is restored and returns us to current page if we overrun
-                  float do
+                # NOTE float ensures cursor position is restored and returns us to current page if we overrun
+                float do
+                  # NOTE bounding_box is redundant if trim_v_padding is 0
+                  bounding_box [0, cursor - trim_padding[0]], width: bounds.width, height: (bounds.height - trim_v_padding) do
                     #image content[:path], vposition: trim_img_valign, position: align, width: content[:width]
                     # NOTE use :fit to prevent image from overflowing page (at the cost of scaling it)
                     image content[:path], vposition: trim_img_valign, position: align, fit: [content[:width], bounds.height]
@@ -2357,7 +2395,7 @@ class Converter < ::Prawn::Document
     if (imagesdir = doc.attr 'imagesdir').nil_or_empty? || (imagesdir = imagesdir.chomp '/') == '.'
       nil
     else
-      %(#{imagesdir}/)
+      imagesdir
     end
   end
 
@@ -2380,7 +2418,7 @@ class Converter < ::Prawn::Document
     image_type ||= ::Asciidoctor::Image.image_type image_path
     # handle case when image is a URI
     if (node.is_uri? image_path) || (imagesdir && (node.is_uri? imagesdir) &&
-        (image_path = (node.normalize_web_path image_path, image_base_uri, false)))
+        (image_path = (node.normalize_web_path image_path, imagesdir, false)))
       unless doc.attr? 'allow-uri-read'
         unless scratch?
           warn %(asciidoctor: WARNING: allow-uri-read is not enabled; cannot embed remote image: #{image_path})
@@ -2389,6 +2427,8 @@ class Converter < ::Prawn::Document
       end
       if doc.attr? 'cache-uri'
         Helpers.require_library 'open-uri/cached', 'open-uri-cached' unless defined? ::OpenURI::Cache
+      else
+        ::OpenURI
       end
       tmp_image = ::Tempfile.new ['image-', %(.#{image_type})]
       tmp_image.binmode if (binary = image_type != 'svg')
@@ -2447,6 +2487,8 @@ class Converter < ::Prawn::Document
     if attrs.key? 'pdfwidth'
       if (pdfwidth = attrs['pdfwidth']).end_with? '%'
         (pdfwidth.to_f / 100) * max_width
+      elsif pdfwidth.end_with? 'vw'
+        (pdfwidth.to_f / 100) * page_width
       else
         str_to_pt pdfwidth
       end

data/lib/asciidoctor-pdf/formatted_text/formatter.rb

@@ -3,7 +3,7 @@ module Pdf
 module FormattedText
 class Formatter
   FormattingSnifferPattern = /[<&]/
-  EOL = "\n"
+  WHITESPACE = " \t\n"
 
   def initialize options = {}
     @parser = MarkupParser.new
@@ -12,7 +12,7 @@ class Formatter
 
   def format string, *args
     options = args[0] || {}
-    string = string.tr_s(EOL, ' ') if options[:normalize]
+    string = string.tr_s(WHITESPACE, ' ') if options[:normalize]
     return [text: string] unless string.match(FormattingSnifferPattern)
     if (parsed = @parser.parse(string))
       @transform.apply(parsed.content)

data/lib/asciidoctor-pdf/formatted_text/parser.rb

@@ -901,7 +901,7 @@ module Markup
       else
         break
       end
-      if s0.size == 4
+      if s0.size == 6
         break
       end
     end

data/lib/asciidoctor-pdf/formatted_text/parser.treetop

@@ -108,7 +108,8 @@ grammar Markup
   end
 
   rule entity_number
-    [0-9] 2..4
+    # NOTE 6 decimals only supported in Asciidoctor 1.5.5 and up
+    [0-9] 2..6
   end
 
   rule entity_name

data/lib/asciidoctor-pdf/formatted_text/transform.rb

@@ -3,13 +3,14 @@ module Pdf
 module FormattedText
 class Transform
   EOL = "\n"
-  NamedEntityTable = {
-    :lt => '<',
-    :gt => '>',
-    :amp => '&',
-    :quot => '"',
-    :apos => '\''
+  CharEntityTable = {
+    lt: '<',
+    gt: '>',
+    amp: '&',
+    quot: '"',
+    apos: '\''
   }
+  CharRefRx = /&(?:#(\d{2,6})|(#{CharEntityTable.keys * '|'}));/
   #ZeroWidthSpace = %(\u200b)
 
   def initialize(options = {})
@@ -103,7 +104,7 @@ class Transform
         previous_fragment_is_text = true
       when :entity
         if (name = node[:name])
-          text = NamedEntityTable[name]
+          text = CharEntityTable[name]
         else
           # FIXME AFM fonts do not include a thin space glyph; set fallback_fonts to allow glyph to be resolved
           text = [node[:number]].pack('U*')
@@ -183,15 +184,15 @@ class Transform
       #  fragment[:character_spacing] = value.to_f
       #end
     when :a
+      # QUESTION shouldn't anchor, link and name be mutually exclusive?
       if !fragment[:anchor] && (value = attrs[:anchor])
         fragment[:anchor] = value
       end
       if !fragment[:link] && (value = attrs[:href])
-        fragment[:link] = value
+        fragment[:link] = (value.include? '&') ? value.gsub(CharRefRx) {
+          $2 ? CharEntityTable[$2.to_sym] : [$1.to_i].pack('U*')
+        } : value
       end
-      #if !fragment[:local] && (value = attrs[:local])
-      #  fragment[:local] = value
-      #end
       if !fragment[:name] && (value = attrs[:name])
         fragment[:name] = value
         fragment[:callback] = InlineDestinationMarker