asciidoctor-pdf 1.5.0.alpha.8 → 1.5.0.alpha.9

data/lib/asciidoctor-pdf/core_ext/quantifiable_stdout.rb

@@ -0,0 +1,20 @@
+require 'delegate'
+
+# A delegator that allows the size method to be used on the STDOUT object.
+#
+# The size of the content written to STDOUT cannot be measured normally. This
+# class wraps the STDOUT object so the cumulative size of the content passed to
+# the write method (while wrapped in this decorator) can be measured.
+class QuantifiableStdout < SimpleDelegator
+  attr_reader :size
+
+  def initialize delegate
+    @size = 0
+    super
+  end
+
+  def write content
+    @size += content.bytesize
+    super
+  end
+end

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

@@ -3,6 +3,7 @@ module Pdf
 module FormattedText
 class Formatter
   FormattingSnifferPattern = /[<&]/
+  EOL = "\n"
 
   def initialize options = {}
     @parser = MarkupParser.new
@@ -10,14 +11,14 @@ class Formatter
   end
 
   def format string, *args
-    options = args.first || {}
-    string = string.tr_s("\n", ' ') if options[:normalize]
+    options = args[0] || {}
+    string = string.tr_s(EOL, ' ') if options[:normalize]
     return [text: string] unless string.match(FormattingSnifferPattern)
-    if (parsed = @parser.parse(string)) == nil
+    if (parsed = @parser.parse(string))
+      @transform.apply(parsed.content)
+    else
       warn %(Failed to parse formatted text: #{string})
       [text: string]
-    else
-      @transform.apply(parsed.content)
     end
   end
 end

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

@@ -1,6 +1,6 @@
 module Asciidoctor::Pdf::FormattedText
 module InlineImageArranger
-  #ImagePlaceholderChar = [0x00a0].pack 'U*'
+  #ImagePlaceholderChar = %(\u00a0)
   ImagePlaceholderChar = '.'
   begin
     require 'thread_safe' unless defined? ::ThreadSafe
@@ -9,7 +9,7 @@ module InlineImageArranger
     PlaceholderWidthCache = {}
   end
 
-  if ::RUBY_MIN_VERSION_2
+  if respond_to? :prepend
     def wrap fragments
       arrange_images fragments
       super
@@ -115,7 +115,7 @@ module InlineImageArranger
   end
 end
 
-if ::RUBY_MIN_VERSION_2
+if respond_to? :prepend
   class ::Prawn::Text::Formatted::Box
     prepend InlineImageArranger
   end

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

@@ -10,7 +10,7 @@ class Transform
     :quot => '"',
     :apos => '\''
   }
-  #ZeroWidthSpace = [0x200b].pack 'U*'
+  #ZeroWidthSpace = %(\u200b)
 
   def initialize(options = {})
     @merge_adjacent_text_nodes = options[:merge_adjacent_text_nodes]
@@ -19,12 +19,23 @@ class Transform
       @monospaced_font_color = theme.literal_font_color
       @monospaced_font_family = theme.literal_font_family
       @monospaced_font_size = theme.literal_font_size
+      case theme.literal_font_style
+      when 'bold'
+        @monospaced_font_style = [:bold]
+      when 'italic'
+        @monospaced_font_style = [:italic]
+      when 'bold_italic'
+        @monospaced_font_style = [:bold, :italic]
+      else
+        @monospaced_font_style = nil
+      end
       #@monospaced_letter_spacing = theme.literal_letter_spacing
     else
       @link_font_color = '0000FF'
       @monospaced_font_color = nil
       @monospaced_font_family = 'Courier'
       @monospaced_font_size = 0.9
+      @monospaced_font_style = nil
       #@monospaced_letter_spacing = -0.1
     end
   end
@@ -34,7 +45,7 @@ class Transform
     fragments = []
     previous_fragment_is_text = false
     # NOTE we use each since using inject is slower than a manual loop
-    parsed.each {|node|
+    parsed.each do |node|
       case node[:type]
       when :element
         # case 1: non-void element
@@ -42,10 +53,10 @@ class Transform
           if pcdata.size > 0
             tag_name = node[:name]
             attributes = node[:attributes]
-            fragments << apply(pcdata).map {|fragment|
+            fragments << apply(pcdata).map do |fragment|
               # decorate child fragments with styles from this element
               build_fragment(fragment, tag_name, attributes)
-            }
+            end
             previous_fragment_is_text = false
           # NOTE skip element if it has no children
           #else
@@ -94,7 +105,7 @@ class Transform
         if (name = node[:name])
           text = NamedEntityTable[name]
         else
-          # NOTE AFM fonts do not include a thin space glyph; set fallback_fonts to allow glyph to be resolved
+          # FIXME AFM fonts do not include a thin space glyph; set fallback_fonts to allow glyph to be resolved
           text = [node[:number]].pack('U*')
         end
         # NOTE the remaining logic is shared with :text
@@ -105,13 +116,11 @@ class Transform
         end
         previous_fragment_is_text = true
       end
-    }
+    end
     fragments.flatten
   end
 
-  def build_fragment(fragment, tag_name = nil, attrs = {})
-    # QUESTION should we short-circuit if tag_name is nil?
-    #return { text: fragment } unless tag_name
+  def build_fragment(fragment, tag_name, attrs = {})
     styles = (fragment[:styles] ||= ::Set.new)
     case tag_name
     when :strong
@@ -129,6 +138,9 @@ class Transform
       if @monospaced_font_color
         fragment[:color] ||= @monospaced_font_color
       end
+      if @monospaced_font_style
+        styles.merge @monospaced_font_style
+      end
     when :color
       if !fragment[:color]
         if (rgb = attrs[:rgb])
@@ -177,9 +189,9 @@ class Transform
       if !fragment[:link] && (value = attrs[:href])
         fragment[:link] = value
       end
-      if !fragment[:local] && (value = attrs[:local])
-        fragment[:local] = value
-      end
+      #if !fragment[:local] && (value = attrs[:local])
+      #  fragment[:local] = value
+      #end
       if !fragment[:name] && (value = attrs[:name])
         fragment[:name] = value
         fragment[:callback] = InlineDestinationMarker
@@ -196,33 +208,31 @@ class Transform
     when :span
       # span logic with normal style parsing
       if (inline_styles = attrs[:style])
-        inline_styles.rstrip.chomp(';').split(';').each do |style|
+        # NOTE for our purposes, spaces inside the style attribute are superfluous
+        # NOTE split will ignore record after trailing ;
+        inline_styles.tr(' ', '').split(';').each do |style|
           pname, pvalue = style.split(':', 2)
           case pname
           when 'color'
-            fragment[:color] = pvalue.tr(' #', '') unless fragment[:color]
+            unless fragment[:color]
+              pvalue = pvalue[1..-1] if pvalue.start_with? '#'
+              #pvalue = pvalue.each_char.map {|c| c * 2 }.join if pvalue.size == 3
+              fragment[:color] = pvalue
+            end
           when 'font-weight'
-            if pvalue.lstrip == 'bold'
+            if pvalue == 'bold'
               styles << :bold
             end
           when 'font-style'
-            if pvalue.lstrip == 'italic'
+            if pvalue == 'italic'
               styles << :italic
             end
+          # TODO text-transform
           end
         end
       end
-
-      # quicker span logic that only honors font color
-      #if !fragment[:color] && (value = attrs[:style]) && value.start_with?('color:')
-      #  if value.include?(';')
-      #    value = value.split(';').first
-      #  end
-      #  fragment[:color] = value[6..-1].tr(' #', '')
-      #end
     end
-    # QUESTION should we remove styles if empty? Need test
-    #fragment.delete(:styles) if styles.empty?
+    fragment.delete(:styles) if styles.empty?
     fragment
   end
 end

data/lib/asciidoctor-pdf/pdf_core_ext.rb

@@ -1,2 +1,2 @@
-# the following modules / classes are organized under the Asciidoctor::PdfCore namespace
 require_relative 'pdf_core_ext/pdf_object'
+require_relative 'pdf_core_ext/page'

data/lib/asciidoctor-pdf/pdf_core_ext/page.rb

@@ -0,0 +1,22 @@
+module PDF
+module Core
+class Page
+  # Restore the new_content_stream method from PDF::Core::Page
+  #
+  # The prawn-templates gem relies on the new_content_stream method on
+  # PDF::Core::Page, which was removed in pdf-core 0.3.1. prawn-templates is
+  # used for importing a single-page PDF into the current document.
+  #
+  # see https://github.com/prawnpdf/pdf-core/commit/67f9a08a03bcfcc5a24cf76b135c218d3d3ab05d
+  def new_content_stream
+    return if in_stamp_stream?
+    unless ::Array === dictionary.data[:Contents]
+      dictionary.data[:Contents] = [content]
+    end
+    @content = document.ref({})
+    dictionary.data[:Contents] << document.state.store[@content]
+    document.renderer.open_graphics_state
+  end unless respond_to? :new_content_stream
+end
+end
+end

data/lib/asciidoctor-pdf/prawn_ext.rb

@@ -1,4 +1,5 @@
 # the following are organized under the Asciidoctor::Prawn namespace
+require_relative 'prawn_ext/font/afm'
 require_relative 'prawn_ext/images'
 require_relative 'prawn_ext/formatted_text/fragment'
 require_relative 'prawn_ext/extensions'

data/lib/asciidoctor-pdf/prawn_ext/coderay_encoder.rb

@@ -68,18 +68,38 @@ class CodeRayEncoder < ::CodeRay::Encoders::Encoder
     value:             '336600'
   }
 
-  EOL = "\n"
+  EOL = %(\n)
+  NoBreakSpace = %(\u00a0)
+  InnerIndent = %(\n )
+  GuardedIndent = %(\u00a0)
+  GuardedInnerIndent = %(\n\u00a0)
 
   def setup options
     super
     @out  = []
     @open = []
+    # NOTE tracks whether text token begins at the start of a line
+    @start_of_line = true
   end
 
   def text_token text, kind
-    color = COLORS[kind] || COLORS[@open.last] || COLORS[:default]
-    
-    @out << (text == EOL ? { :text => text } : { :text => text, :color => color })
+    if text == EOL
+      @out << { text: text }
+      @start_of_line = true
+    else
+      # NOTE add guard character to prevent Prawn from trimming indentation
+      text[0] = GuardedIndent if @start_of_line && (text.start_with? ' ')
+      text.gsub! InnerIndent, GuardedInnerIndent if text.include? InnerIndent
+
+      # NOTE this optimization assumes we don't support/use background colors
+      if text.rstrip.empty?
+        @out << { text: text }
+      else
+        # QUESTION should we default to no color?
+        @out << { text: text, color: (COLORS[kind] || COLORS[@open.last] || COLORS[:default]) }
+      end
+      @start_of_line = text.end_with? EOL
+    end
   end
 
   def begin_group kind

data/lib/asciidoctor-pdf/prawn_ext/extensions.rb

@@ -1,3 +1,5 @@
+Prawn::Font::AFM.instance_variable_set :@hide_m17n_warning, true
+
 module Asciidoctor
 module Prawn
 module Extensions
@@ -82,6 +84,23 @@ module Extensions
     @y == @margin_box.absolute_top
   end
 
+  # Returns whether the current page is empty (no content is written).
+  # If at least one page has not yet been created, returns false.
+  #
+  def empty_page?
+    # if we are at the page top, assume we didn't write anything to the page
+    #at_page_top?
+    # ...or use low-level check (initial value is "q\n")
+    (page.content.stream || []).length <= 2 && page_number > 0
+  end
+  alias :page_is_empty? :empty_page?
+
+  # Returns whether the current page is the last page in the document.
+  #
+  def last_page?
+    page_number == page_count
+  end
+
   # Converts the specified float value to a pt value from the
   # specified unit of measurement (e.g., in, cm, mm, etc).
   def to_pt num, units
@@ -562,13 +581,45 @@ module Extensions
 
   # Pages
 
+  # Deletes the current page and move the cursor
+  # to the previous page.
+  def delete_page
+    pg = page_number
+    pdf_store = state.store
+    pdf_objs = pdf_store.instance_variable_get :@objects
+    pdf_ids = pdf_store.instance_variable_get :@identifiers
+    page_id = pdf_store.object_id_for_page pg
+    content_id = page.content.identifier
+    [page_id, content_id].each do |key|
+      pdf_objs.delete key
+      pdf_ids.delete key
+    end
+    pdf_store.pages.data[:Kids].pop
+    pdf_store.pages.data[:Count] -= 1
+    state.pages.pop
+    go_to_page(pg - 1)
+  end
+
   # Import the specified page into the current document.
   #
   def import_page file
-    prev_page_number = page_number
+    prev_page_layout = page.layout
+    prev_page_size = page.size
     state.compress = false if state.compress # can't use compression if using template
+    prev_text_rendering_mode = @text_rendering_mode
+    # NOTE use functionality provided by prawn-templates
     start_new_page_discretely template: file
-    go_to_page prev_page_number + 1
+    # prawn-templates sets text_rendering_mode to :unknown, which breaks running content; revert
+    @text_rendering_mode = prev_text_rendering_mode
+    if last_page?
+      # NOTE set page size & layout explicitly in case imported page differs
+      # I'm not sure it's right to start a new page here, but unfortunately there's no other
+      # way atm to prevent the size & layout of the imported page from affecting subsequent pages
+      start_new_page size: prev_page_size, layout: prev_page_layout
+    else
+      go_to_page page_number + 1
+    end
+    nil
   end
 
   # Create a new page for the specified image. If the
@@ -583,21 +634,33 @@ module Extensions
     else
       image file, fit: [bounds.width, bounds.height]
     end
+    # FIXME shouldn't this be `go_to_page prev_page_number + 1`?
     go_to_page page_count
+    nil
   end
 
   # Perform an operation (such as creating a new page) without triggering the on_page_create callback
   #
   def perform_discretely
     if (saved_callback = state.on_page_create_callback)
+      # equivalent to calling `on_page_create`
       state.on_page_create_callback = nil
       yield
+      # equivalent to calling `on_page_create &saved_callback`
       state.on_page_create_callback = saved_callback
     else
       yield
     end
   end
 
+  #def advance_or_start_new_page options = {}
+  #  if last_page?
+  #    start_new_page options
+  #  else
+  #    go_to_page page_number + 1
+  #  end
+  #end
+
   # Start a new page without triggering the on_page_create callback
   #
   def start_new_page_discretely options = {}
@@ -646,14 +709,18 @@ module Extensions
     scratch = get_scratch_document
     scratch.start_new_page
     start_page_number = scratch.page_number
-    # QUESTION is it enough to just set the padding or do we need to clone the bounds?
-    default_bounds = scratch.bounds
-    scratch.bounds = bounds.deep_copy.tap {|b| b.instance_variable_set :@document, scratch }
     start_y = scratch.y
+    if (left_padding = bounds.total_left_padding) > 0
+      scratch.bounds.add_left_padding left_padding
+    end
+    if (right_padding = bounds.total_right_padding) > 0
+      scratch.bounds.add_right_padding right_padding
+    end
     scratch.font font_family, style: font_style, size: font_size do
       scratch.instance_exec(&block)
     end
-    scratch.bounds = default_bounds
+    scratch.bounds.subtract_left_padding left_padding if left_padding > 0
+    scratch.bounds.subtract_right_padding right_padding if right_padding > 0
     whole_pages = scratch.page_number - start_page_number
     [(whole_pages * bounds.height + (start_y - scratch.y)), whole_pages, (start_y - scratch.y)]
   end

data/lib/asciidoctor-pdf/prawn_ext/font/afm.rb

@@ -0,0 +1,19 @@
+class Prawn::Font::AFM
+  # Patch normalize_encoding method to handle conversion more gracefully.
+  #
+  # Any valid utf-8 characters that cannot be encoded to windows-1252 are
+  # replaced with the logic "not" symbol and a warning is issued identifying
+  # the text that cannot be converted.
+  def normalize_encoding text
+    text.encode 'windows-1252'
+  rescue ::Encoding::UndefinedConversionError
+    warn 'The following text could not be fully converted to the Windows-1252 character set:'
+    warn %(#{text.gsub(/^/, '| ').rstrip})
+    warn ''
+    text.encode 'windows-1252', undef: :replace, replace: "\u00ac"
+  rescue ::Encoding::InvalidByteSequenceError
+    raise Prawn::Errors::IncompatibleStringEncoding,
+          %(Your document includes text that's not compatible with the Windows-1252 character set.
+If you need full UTF-8 support, use TTF fonts instead of PDF's built-in (AFM) fonts\n.)
+  end
+end