asciidoctor-pdf 1.5.0.beta.8 → 1.5.0.rc.1

data/lib/asciidoctor/pdf/ext/rouge/themes/asciidoctor_pdf_default.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Rouge
   module Themes
     # A variation on the pastie style from Pygments, customized for Asciidoctor PDF

data/lib/asciidoctor/pdf/formatted_text.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'treetop'
 require 'set' unless defined? Set
 require_relative 'formatted_text/parser'
@@ -9,4 +10,5 @@ require_relative 'formatted_text/inline_destination_marker'
 require_relative 'formatted_text/inline_image_arranger'
 require_relative 'formatted_text/inline_image_renderer'
 require_relative 'formatted_text/inline_text_aligner'
+require_relative 'formatted_text/source_wrap'
 require_relative 'formatted_text/text_background_and_border_renderer'

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

@@ -1,43 +1,44 @@
 # frozen_string_literal: true
+
 module Asciidoctor
-module PDF
-module FormattedText
-class Formatter
-  if defined? ::Asciidoctor::Logging
-    include ::Asciidoctor::Logging
-  else
-    include ::Asciidoctor::LoggingShim
-  end
+  module PDF
+    module FormattedText
+      class Formatter
+        if defined? ::Asciidoctor::Logging
+          include ::Asciidoctor::Logging
+        else
+          include ::Asciidoctor::LoggingShim
+        end
 
-  FormattingSnifferPattern = /[<&]/
-  WHITESPACE = " \t\n"
+        FormattingSnifferPattern = /[<&]/
+        WHITESPACE = %( \t\n)
 
-  def initialize options = {}
-    @parser = MarkupParser.new
-    @transform = Transform.new merge_adjacent_text_nodes: true, theme: options[:theme]
-  end
+        def initialize options = {}
+          @parser = MarkupParser.new
+          @transform = Transform.new merge_adjacent_text_nodes: true, theme: options[:theme]
+        end
 
-  def format string, *args
-    options = args[0] || {}
-    string = string.tr_s(WHITESPACE, ' ') if options[:normalize]
-    inherited = options[:inherited]
-    if FormattingSnifferPattern.match? string
-      if (parsed = @parser.parse(string))
-        return @transform.apply(parsed.content, [], inherited)
-      else
-        logger.error %(failed to parse formatted text: #{string})
+        def format string, *args
+          options = args[0] || {}
+          string = string.tr_s WHITESPACE, ' ' if options[:normalize]
+          inherited = options[:inherited]
+          if FormattingSnifferPattern.match? string
+            if (parsed = @parser.parse string)
+              return @transform.apply parsed.content, [], inherited
+            else
+              logger.error %(failed to parse formatted text: #{string})
+            end
+          end
+          [inherited ? (inherited.merge text: string) : { text: string }]
+        end
+
+        # The original purpose of this method is to split paragraphs, but our formatter only works on paragraphs that have
+        # been presplit. Therefore, we just need to wrap the fragments in a single-element array (representing a single
+        # paragraph) and return them.
+        def array_paragraphs fragments
+          [fragments]
+        end
       end
     end
-    [inherited ? (inherited.merge text: string) : { text: string }]
   end
-
-  # The original purpose of this method is to split paragraphs, but our formatter only works on paragraphs that have
-  # been presplit. Therefore, we just need to wrap the fragments in a single-element array (representing a single
-  # paragraph) and return them.
-  def array_paragraphs fragments
-    [fragments]
-  end
-end
-end
-end
 end

data/lib/asciidoctor/pdf/formatted_text/fragment_position_renderer.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
+
 module Asciidoctor::PDF::FormattedText
-class FragmentPositionRenderer
-  attr_reader :top, :right, :bottom, :left
+  class FragmentPositionRenderer
+    attr_reader :top, :right, :bottom, :left
 
-  def render_behind fragment
-    @top = fragment.top
-    @right = (@left = fragment.left) + fragment.width
-    @bottom = fragment.bottom
+    def render_behind fragment
+      @top = fragment.top
+      @right = (@left = fragment.left) + fragment.width
+      @bottom = fragment.bottom
+    end
   end
 end
-end

data/lib/asciidoctor/pdf/formatted_text/inline_destination_marker.rb

@@ -1,22 +1,21 @@
 # frozen_string_literal: true
+
 module Asciidoctor::PDF::FormattedText
-module InlineDestinationMarker
-  module_function
+  module InlineDestinationMarker
+    module_function
 
-  # render_behind is called before the text is printed
-  def render_behind fragment
-    unless (pdf = fragment.document).scratch?
-      if (name = fragment.format_state[:name])
-        if fragment.format_state[:type] == :indexterm
-          (pdf.instance_variable_get :@index).link_dest_to_page name, pdf.page_number
+    # render_behind is called before the text is printed
+    def render_behind fragment
+      unless (pdf = fragment.document).scratch?
+        if (name = fragment.format_state[:name])
+          (pdf.instance_variable_get :@index).link_dest_to_page name, pdf.page_number if fragment.format_state[:type] == :indexterm
+          # get precise position of the reference (x, y)
+          dest_rect = fragment.absolute_bounding_box
+          pdf.add_dest name, (pdf.dest_xyz dest_rect[0], dest_rect[-1])
+          # prevent any text from being written
+          fragment.conceal
         end
-        # get precise position of the reference (x, y)
-        dest_rect = fragment.absolute_bounding_box
-        pdf.add_dest name, (pdf.dest_xyz dest_rect[0], dest_rect[-1])
-        # prevent any text from being written
-        fragment.conceal
       end
     end
   end
 end
-end

data/lib/asciidoctor/pdf/formatted_text/inline_image_arranger.rb

@@ -1,159 +1,138 @@
 # frozen_string_literal: true
-module Asciidoctor::PDF::FormattedText
-module InlineImageArranger
-  include ::Asciidoctor::PDF::Measurements
-  if defined? ::Asciidoctor::Logging
-    include ::Asciidoctor::Logging
-  else
-    include ::Asciidoctor::LoggingShim
-  end
 
-  ImagePlaceholderChar = '.'
-  begin
-    require 'concurrent/map' unless defined? ::Concurrent::Map
-    PlaceholderWidthCache = ::Concurrent::Map.new
-  rescue
-    PlaceholderWidthCache = {}
-  end
-  TemporaryPath = ::Asciidoctor::PDF::TemporaryPath
+module Asciidoctor::PDF::FormattedText
+  module InlineImageArranger
+    include ::Asciidoctor::PDF::Measurements
+    if defined? ::Asciidoctor::Logging
+      include ::Asciidoctor::Logging
+    else
+      include ::Asciidoctor::LoggingShim
+    end
 
-  def wrap fragments
-    arrange_images fragments
-    super
-  end
+    # NOTE we must use a visible char or else Prawn won't allocate space for the fragment
+    ImagePlaceholderChar = '.'
+    TemporaryPath = ::Asciidoctor::PDF::TemporaryPath
 
-  # Iterates over the fragments that represent inline images and prepares the
-  # image data to be embedded into the document.
-  #
-  # This method populates the image_width, image_height, image_obj and
-  # image_info (PNG only) keys on the fragment. The text is replaced with
-  # placeholder text that will be used to reserve enough room in the line to
-  # fit the image.
-  #
-  # The image height is scaled down to 75% of the specified width (px to pt
-  # conversion). If the image height is more than 1.5x the height of the
-  # surrounding line of text, the font size and line metrics of the fragment
-  # are modified to fit the image in the line.
-  #
-  # If this is the scratch document, the image renderer callback is removed so
-  # that the image is not embedded.
-  #
-  # When this method is called, the cursor is positioned at start of where this
-  # group of fragments will be written (offset by the leading padding).
-  #
-  # This method is called each time the set of fragments overflow to another
-  # page, so it's necessary to short-circuit if that case is detected.
-  def arrange_images fragments
-    doc = @document
-    return if (raw_image_fragments = fragments.select {|f| (f.key? :image_path) && !(f.key? :image_obj) }).empty?
-    scratch = doc.scratch?
-    available_w = doc.bounds.width
-    available_h = doc.page.empty? ? doc.cursor : doc.bounds.height
-    raw_image_fragments.each do |fragment|
-      drop = scratch
-      begin
-        image_path = fragment[:image_path]
+    def wrap fragments
+      arrange_images fragments
+      super
+    end
 
-        # NOTE only attempt to convert an unresolved (i.e., String) value
-        if ::String === (image_w = fragment[:image_width])
-          image_w = [available_w, (image_w.end_with? '%') ? (image_w.to_f / 100 * available_w) : image_w.to_f].min
-        end
+    # Iterates over the fragments that represent inline images and prepares the
+    # image data to be embedded into the document.
+    #
+    # This method populates the image_width, image_height, image_obj and
+    # image_info (PNG only) keys on the fragment. The text is replaced with
+    # placeholder text that will be used to reserve enough room in the line to
+    # fit the image.
+    #
+    # The image height is scaled down to 75% of the specified width (px to pt
+    # conversion). If the image height is more than 1.5x the height of the
+    # surrounding line of text, the font size and line metrics of the fragment
+    # are modified to fit the image in the line.
+    #
+    # If this is the scratch document, the image renderer callback is removed so
+    # that the image is not embedded.
+    #
+    # When this method is called, the cursor is positioned at start of where this
+    # group of fragments will be written (offset by the leading padding).
+    #
+    # This method is called each time the set of fragments overflow to another
+    # page, so it's necessary to short-circuit if that case is detected.
+    def arrange_images fragments
+      doc = @document
+      return if (raw_image_fragments = fragments.select {|f| (f.key? :image_path) && !(f.key? :image_obj) }).empty?
+      scratch = doc.scratch?
+      available_w = doc.bounds.width
+      available_h = doc.page.empty? ? doc.cursor : doc.bounds.height
+      raw_image_fragments.each do |fragment|
+        drop = scratch
+        begin
+          image_path = fragment[:image_path]
 
-        # TODO make helper method to calculate width and height of image
-        if fragment[:image_format] == 'svg'
-          svg_obj = ::Prawn::SVG::Interface.new ::File.read(image_path, mode: 'r:UTF-8'), doc,
-              at: doc.bounds.top_left,
-              width: image_w,
-              fallback_font_name: doc.fallback_svg_font_name,
-              enable_web_requests: doc.allow_uri_read,
-              enable_file_requests_with_root: (::File.dirname image_path),
-              cache_images: doc.cache_uri
-          svg_size = image_w ? svg_obj.document.sizing :
-              # NOTE convert intrinsic dimensions to points; constrain to content width
-              (svg_obj.resize width: [(to_pt svg_obj.document.sizing.output_width, :px), available_w].min)
-          # NOTE the best we can do is make the image fit within full height of bounds
-          if (image_h = svg_size.output_height) > available_h
-            image_w = (svg_size = svg_obj.resize height: (image_h = available_h)).output_width
-          else
-            image_w = svg_size.output_width
+          # NOTE only attempt to convert an unresolved (i.e., String) value
+          if ::String === (image_w = fragment[:image_width])
+            image_w = [available_w, (image_w.end_with? '%') ? (image_w.to_f / 100 * available_w) : image_w.to_f].min
           end
-          fragment[:image_obj] = svg_obj
-        else
-          # TODO cache image info based on path (Prawn caches based on SHA1 of content)
-          # NOTE image_obj is constrained to image_width by renderer
-          image_obj, image_info = ::File.open(image_path, 'rb') {|fd| doc.build_image_object fd }
-          if image_w
-            if image_w == image_info.width
-              image_h = image_info.height.to_f
+
+          max_image_h = fragment[:image_fit] == 'line' ? [available_h, doc.font.height].min : available_h
+
+          # TODO: make helper method to calculate width and height of image
+          if fragment[:image_format] == 'svg'
+            svg_obj = ::Prawn::SVG::Interface.new ::File.read(image_path, mode: 'r:UTF-8'), doc,
+                at: doc.bounds.top_left,
+                width: image_w,
+                fallback_font_name: doc.fallback_svg_font_name,
+                enable_web_requests: doc.allow_uri_read,
+                enable_file_requests_with_root: (::File.dirname image_path),
+                cache_images: doc.cache_uri
+            svg_size = image_w ? svg_obj.document.sizing :
+                # NOTE convert intrinsic dimensions to points; constrain to content width
+                (svg_obj.resize width: [(to_pt svg_obj.document.sizing.output_width, :px), available_w].min)
+            # NOTE the best we can do is make the image fit within full height of bounds
+            if (image_h = svg_size.output_height) > max_image_h
+              image_w = (svg_obj.resize height: (image_h = max_image_h)).output_width
             else
-              image_h = image_w * (image_info.height.fdiv image_info.width)
+              image_w = svg_size.output_width
             end
+            fragment[:image_obj] = svg_obj
           else
+            # TODO: cache image info based on path (Prawn caches based on SHA1 of content)
+            # NOTE image_obj is constrained to image_width by renderer
+            image_obj, image_info = ::File.open(image_path, 'rb') {|fd| doc.build_image_object fd }
+            if image_w
+              if image_w == image_info.width
+                image_h = image_info.height.to_f
+              else
+                image_h = image_w * (image_info.height.fdiv image_info.width)
+              end
             # NOTE convert intrinsic dimensions to points; constrain to content width
-            if (image_w = to_pt image_info.width, :px) > available_w
+            elsif (image_w = to_pt image_info.width, :px) > available_w
               image_h = (image_w = available_w) * (image_info.height.fdiv image_info.width)
             else
               image_h = to_pt image_info.height, :px
             end
+            # NOTE the best we can do is make the image fit within full height of bounds
+            image_w = (image_h = max_image_h) * (image_info.width.fdiv image_info.height) if image_h > max_image_h
+            fragment[:image_obj] = image_obj
+            fragment[:image_info] = image_info
           end
-          # NOTE the best we can do is make the image fit within full height of bounds
-          image_w = (image_h = available_h) * (image_info.width.fdiv image_info.height) if image_h > available_h
-          fragment[:image_obj] = image_obj
-          fragment[:image_info] = image_info
-        end
 
-        spacer_w = nil
-        doc.fragment_font fragment do
-          # NOTE if image height exceeds line height by more than 1.5x, increase the line height
-          # FIXME we could really use a nicer API from Prawn here; this is an ugly hack
-          if (f_height = image_h) > (line_font = doc.font).height * 1.5
-            # align with descender (equivalent to vertical-align: bottom in CSS)
-            fragment[:ascender] = f_height - (fragment[:descender] = line_font.descender)
-            doc.font_size(fragment[:size] = f_height * (doc.font_size / line_font.height))
-            # align with baseline (roughly equivalent to vertical-align: baseline in CSS)
-            #fragment[:ascender] = f_height
-            #fragment[:descender] = 0
-            #doc.font_size(fragment[:size] = (f_height + line_font.descender) * (doc.font_size / line_font.height))
-            fragment[:line_height_increased] = true
-          end
-
-          unless (spacer_w = PlaceholderWidthCache[f_info = doc.font_info])
-            spacer_w = PlaceholderWidthCache[f_info] = doc.width_of ImagePlaceholderChar
+          doc.fragment_font fragment do
+            # NOTE if image height exceeds line height by more than 1.5x, increase the line height
+            # FIXME: we could really use a nicer API from Prawn here; this is an ugly hack
+            if (f_height = image_h) > (line_font = doc.font).height * 1.5
+              # align with descender (equivalent to vertical-align: bottom in CSS)
+              fragment[:ascender] = f_height - (fragment[:descender] = line_font.descender)
+              doc.font_size (fragment[:size] = f_height * (doc.font_size / line_font.height))
+              # align with baseline (roughly equivalent to vertical-align: baseline in CSS)
+              #fragment[:ascender] = f_height
+              #fragment[:descender] = 0
+              #doc.font_size(fragment[:size] = (f_height + line_font.descender) * (doc.font_size / line_font.height))
+              fragment[:line_height_increased] = true
+            end
           end
-        end
 
-        # NOTE make room for image by repeating image placeholder character, using character spacing to fine-tune
-        # NOTE image_width is constrained to available_w, so we don't have to check for overflow
-        spacer_cnt, remainder = image_w.divmod spacer_w
-        if spacer_cnt > 0
-          fragment[:text] = ImagePlaceholderChar * spacer_cnt
-          fragment[:character_spacing] = remainder.fdiv spacer_cnt if remainder > 0
-        else
           fragment[:text] = ImagePlaceholderChar
-          fragment[:character_spacing] = -(spacer_w - remainder)
-        end
-
-        # FIXME we could use a nicer API from Prawn here that lets us reserve a fragment width without text
-        #fragment[:image_width] = fragment[:width] = image_w
-        fragment[:image_width] = image_w
-        fragment[:image_height] = image_h
-      rescue
-        logger.warn %(could not embed image: #{image_path}; #{$!.message}#{::Prawn::Errors::UnsupportedImageType === $! ? '; install prawn-gmagick gem to add support' : ''})
-        drop = true # delegate to cleanup logic in ensure block
-      ensure
-        # NOTE skip rendering image in scratch document or if image can't be loaded
-        if drop
-          fragment.delete :callback
-          fragment.delete :image_info
-          # NOTE retain key to indicate we've visited fragment already
-          fragment[:image_obj] = nil
-          # NOTE in main document, temporary image path is unlinked by renderer
-          image_path.unlink if TemporaryPath === image_path && image_path.exist?
+          fragment[:image_width] = fragment[:width] = image_w
+          fragment[:image_height] = image_h
+        rescue
+          logger.warn %(could not embed image: #{image_path}; #{$!.message}#{::Prawn::Errors::UnsupportedImageType === $! ? '; install prawn-gmagick gem to add support' : ''})
+          drop = true # delegate to cleanup logic in ensure block
+        ensure
+          # NOTE skip rendering image in scratch document or if image can't be loaded
+          if drop
+            fragment.delete :callback
+            fragment.delete :image_info
+            # NOTE retain key to indicate we've visited fragment already
+            fragment[:image_obj] = nil
+            # NOTE in main document, temporary image path is unlinked by renderer
+            image_path.unlink if TemporaryPath === image_path && image_path.exist?
+          end
         end
       end
     end
   end
-end
 
-::Prawn::Text::Formatted::Box.prepend InlineImageArranger
+  ::Prawn::Text::Formatted::Box.prepend InlineImageArranger
 end

data/lib/asciidoctor/pdf/formatted_text/inline_image_renderer.rb

@@ -1,47 +1,49 @@
 # frozen_string_literal: true
+
 module Asciidoctor::PDF::FormattedText
-module InlineImageRenderer
-  TemporaryPath = ::Asciidoctor::PDF::TemporaryPath
-  module_function
+  module InlineImageRenderer
+    TemporaryPath = ::Asciidoctor::PDF::TemporaryPath
 
-  # Embeds the image object in this fragment into the document in place of the
-  # text that was previously used to reserve space for the image in the line.
-  #
-  # If the image height is less than 1.5x the height of the surrounding text,
-  # it is centered vertically in the line. If the image height is greater, then
-  # the image is aligned to the bottom of the text.
-  #
-  # Note that render_behind is called before the text is printed.
-  #
-  # This handler is only used on the main document (not the scratch document).
-  #
-  def render_behind fragment
-    pdf = fragment.document
-    data = fragment.format_state
-    image_top = if data.key? :line_height_increased
-      # align image to bottom of line (differs from fragment.top by descender value)
-      fragment.bottom + data[:image_height]
-    else
-      # center image in line
-      fragment.top - ((fragment.height - data[:image_height]) / 2.0)
-    end
-    image_left = fragment.left + ((fragment.width - data[:image_width]) / 2.0)
-    case data[:image_format]
-    when 'svg'
-      (image_obj = data[:image_obj]).options[:at] = [image_left, image_top]
-      # NOTE prawn-svg messes with the cursor; use float to workaround
-      # NOTE prawn-svg 0.24.0, 0.25.0, & 0.25.1 didn't restore font after call to draw (see mogest/prawn-svg#80)
-      pdf.float { image_obj.draw }
-    else
-      pdf.embed_image data[:image_obj], data[:image_info], at: [image_left, image_top], width: data[:image_width], height: data[:image_height]
-    end
-    # ...or use the public interface, loading the image again
-    #pdf.image data[:image_path], at: [image_left, image_top], width: data[:image_width]
+    module_function
 
-    # prevent any text from being written
-    fragment.conceal
-  ensure
-    data[:image_path].unlink if TemporaryPath === data[:image_path] && data[:image_path].exist?
+    # Embeds the image object in this fragment into the document in place of the
+    # text that was previously used to reserve space for the image in the line.
+    #
+    # If the image height is less than 1.5x the height of the surrounding text,
+    # it is centered vertically in the line. If the image height is greater, then
+    # the image is aligned to the bottom of the text.
+    #
+    # Note that render_behind is called before the text is printed.
+    #
+    # This handler is only used on the main document (not the scratch document).
+    #
+    def render_behind fragment
+      pdf = fragment.document
+      data = fragment.format_state
+      if data.key? :line_height_increased
+        # align image to bottom of line (differs from fragment.top by descender value)
+        image_top = fragment.bottom + data[:image_height]
+      else
+        # center image in line
+        image_top = fragment.top - ((fragment.height - data[:image_height]) / 2.0)
+      end
+      image_left = fragment.left + ((fragment.width - data[:image_width]) / 2.0)
+      case data[:image_format]
+      when 'svg'
+        (image_obj = data[:image_obj]).options[:at] = [image_left, image_top]
+        # NOTE prawn-svg messes with the cursor; use float to workaround
+        # NOTE prawn-svg 0.24.0, 0.25.0, & 0.25.1 didn't restore font after call to draw (see mogest/prawn-svg#80)
+        pdf.float { image_obj.draw }
+      else
+        pdf.embed_image data[:image_obj], data[:image_info], at: [image_left, image_top], width: data[:image_width], height: data[:image_height]
+      end
+      # ...or use the public interface, loading the image again
+      #pdf.image data[:image_path], at: [image_left, image_top], width: data[:image_width]
+
+      # prevent any text from being written
+      fragment.conceal
+    ensure
+      data[:image_path].unlink if TemporaryPath === data[:image_path] && data[:image_path].exist?
+    end
   end
 end
-end