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

data/lib/asciidoctor-pdf/core_ext.rb

@@ -1,2 +1,3 @@
 require_relative 'core_ext/array'
 require_relative 'core_ext/numeric'
+require_relative 'core_ext/string'

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

@@ -2,10 +2,10 @@ class Array
   if RUBY_VERSION < '2.1.0'
     def to_h
       Hash[to_a]
-    end unless respond_to? :to_h
+    end unless method_defined? :to_h
   end
 
   def delete_all *entries
     entries.map {|entry| delete entry }.compact
-  end unless respond_to? :delete_all
+  end unless method_defined? :delete_all
 end

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

@@ -7,5 +7,5 @@ class Numeric
     else
       self.truncate
     end
-  end unless respond_to? :with_precision
+  end unless method_defined? :with_precision
 end

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

@@ -1,9 +1,17 @@
 class OpenStruct
   def [] key
     send key
-  end unless respond_to? :[]
+  end unless method_defined? :[]
 
   def []= key, val
     send %(#{key}=), val
-  end unless respond_to? :[]=
+  end unless method_defined? :[]=
 end if RUBY_ENGINE == 'rbx' || RUBY_VERSION < '2.0.0'
+
+class OpenStruct
+  def delete key
+    begin
+      delete_field key
+    rescue ::NameError; end
+  end
+end

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

@@ -0,0 +1,11 @@
+class String
+  def pred
+    begin
+      # integers
+      %(#{(Integer self) - 1})
+    rescue ::ArgumentError
+      # chars (upper alpha, lower alpha, lower greek)
+      ([65, 97, 945].include? ord) ? '0' : ([ord - 1].pack 'U*')
+    end
+  end unless method_defined? :pred
+end

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

@@ -57,7 +57,7 @@ module InlineImageArranger
         end
 
         # TODO make helper method to calculate width and height of image
-        if fragment[:image_type] == 'svg'
+        if fragment[:image_format] == 'svg'
           svg_obj = ::Prawn::Svg::Interface.new (::IO.read image_path), doc, at: doc.bounds.top_left, width: image_w, fallback_font_name: doc.default_svg_font
           if image_w
             fragment[:image_width] = svg_obj.document.sizing.output_width
@@ -69,7 +69,7 @@ module InlineImageArranger
           fragment[:image_obj] = svg_obj
         else
           # TODO cache image info based on path (Prawn cached based on SHA1 of content)
-          image_obj, image_info = doc.build_image_object image_path
+          image_obj, image_info = ::File.open(image_path, 'rb') {|fd| doc.build_image_object fd }
           if image_w
             fragment[:image_width], fragment[:image_height] = image_info.calc_image_dimensions width: image_w
           else

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

@@ -24,12 +24,12 @@ module InlineImageRenderer
       fragment.top - ((fragment.height - data[:image_height]) / 2.0)
     end
     image_left = fragment.left + ((fragment.width - data[:image_width]) / 2.0)
-    case data[:image_type]
+    case data[:image_format]
     when 'svg'
-      # prawn-svg messes with the cursor; use float as a workaround
-      pdf.float do
-        data[:image_obj].tap {|obj| obj.options[:at] = [image_left, image_top] }.draw
-      end
+      (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]
     end

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

@@ -2,7 +2,7 @@ module Asciidoctor
 module Pdf
 module FormattedText
 class Transform
-  EOL = "\n"
+  LF = %(\n)
   CharEntityTable = {
     lt: '<',
     gt: '>',
@@ -72,16 +72,16 @@ class Transform
           case node[:name]
           when :br
             if @merge_adjacent_text_nodes && previous_fragment_is_text
-              fragments << { text: %(#{fragments.pop[:text]}#{EOL}) }
+              fragments << { text: %(#{fragments.pop[:text]}#{LF}) }
             else
-              fragments << { text: EOL }
+              fragments << { text: LF }
             end
             previous_fragment_is_text = true
           when :img
             attributes = node[:attributes]
             fragment = {
               image_path: attributes[:src],
-              image_type: attributes[:type],
+              image_format: attributes[:format],
               image_tmp: (attributes[:tmp] == 'true'),
               text: attributes[:alt],
               callback: InlineImageRenderer
@@ -194,6 +194,8 @@ class Transform
         } : value
       end
       if !fragment[:name] && (value = attrs[:name])
+        # NOTE ZeroWidthSpace is used as placeholder text so Prawn doesn't drop fragment
+        #fragment[:text] = ZeroWidthSpace
         fragment[:name] = value
         fragment[:callback] = InlineDestinationMarker
       end

data/lib/asciidoctor-pdf/implicit_header_processor.rb

@@ -12,7 +12,7 @@ class ImplicitHeaderProcessor < ::Asciidoctor::Extensions::IncludeProcessor
       if (first_line = fd.readline) && (first_line.start_with? '= ')
         # HACK reset counters for each article for Editions
         if doc.attr? 'env', 'editions'
-          doc.counters.each do |(counter_key, counter_val)|
+          doc.counters.each do |counter_key, counter_val|
             doc.attributes.delete counter_key
           end
           doc.counters.clear

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

@@ -16,7 +16,7 @@ class Page
     @content = document.ref({})
     dictionary.data[:Contents] << document.state.store[@content]
     document.renderer.open_graphics_state
-  end unless respond_to? :new_content_stream
+  end unless method_defined? :new_content_stream
 end
 end
 end

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

@@ -68,7 +68,7 @@ class CodeRayEncoder < ::CodeRay::Encoders::Encoder
     value:             '336600'
   }
 
-  EOL = %(\n)
+  LF = %(\n)
   NoBreakSpace = %(\u00a0)
   InnerIndent = %(\n )
   GuardedIndent = %(\u00a0)
@@ -83,7 +83,7 @@ class CodeRayEncoder < ::CodeRay::Encoders::Encoder
   end
 
   def text_token text, kind
-    if text == EOL
+    if text == LF
       @out << { text: text }
       @start_of_line = true
     # NOTE text is nil and kind is :error when CodeRay ends parsing on an error
@@ -99,7 +99,7 @@ class CodeRayEncoder < ::CodeRay::Encoders::Encoder
         # 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
+      @start_of_line = text.end_with? LF
     end
   end
 

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

@@ -11,6 +11,7 @@ module Extensions
 
   IconSets = ['fa', 'fi', 'octicon', 'pf'].to_set
   MeasurementValueRx = /(\d+|\d*\.\d+)(in|mm|cm|px|pt)?$/
+  InitialPageContent = %(q\n)
 
   # - :height is the height of a line
   # - :leading is spacing between adjacent lines
@@ -53,6 +54,20 @@ module Extensions
     reference_bounds.height
   end
 
+  # Set the margins for the current page.
+  #
+  def set_page_margin margin
+    # FIXME is there a cleaner way to set margins? does it make sense to override create_new_page?
+    apply_margin_options margin: margin
+    generate_margin_box
+  end
+
+  # Returns the margins for the current page as a 4 element array (top, right, bottom, left)
+  #
+  def page_margin
+    [page.margins[:top], page.margins[:right], page.margins[:bottom], page.margins[:left]]
+  end
+
   # Returns the width of the left margin for the current page
   #
   def page_margin_left
@@ -93,20 +108,38 @@ module Extensions
     page.dimensions[2] - bounds.absolute_right
   end
 
-  # Returns whether the cursor is at the top of the page (i.e., margin box)
+  # Returns the side the current page is facing, :recto or :verso.
+  #
+  def page_side pgnum = nil
+    (recto_page? pgnum) ? :recto : :verso
+  end
+
+  # Returns whether the page is a recto page.
+  #
+  def recto_page? pgnum = nil
+    (pgnum || page_number).odd?
+  end
+
+  # Returns whether the page is a verso page.
+  #
+  def verso_page? pgnum = nil
+    (pgnum || page_number).even?
+  end
+
+  # Returns whether the cursor is at the top of the page (i.e., margin box).
   #
   def at_page_top?
     @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.
+  # Returns whether the current page is empty (i.e., no content has been written).
+  # Returns false if a page has not yet been created.
   #
   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
+    # ...or use more robust, low-level check (initial value of content is "q\n")
+    page_number > 0 && page.content.stream.filtered_stream == InitialPageContent
   end
   alias :page_is_empty? :empty_page?
 
@@ -119,17 +152,21 @@ module Extensions
   # 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
-    case units
-    when nil, 'pt'
+    if units.nil_or_empty?
       num
-    when 'in'
-      num * 72
-    when 'mm'
-      num * (72 / 25.4)
-    when 'cm'
-      num * (720 / 25.4)
-    when 'px'
-      num * 0.75
+    else
+      case units
+      when 'pt'
+        num
+      when 'in'
+        num * 72
+      when 'mm'
+        num * (72 / 25.4)
+      when 'cm'
+        num * (720 / 25.4)
+      when 'px'
+        num * 0.75
+      end
     end
   end
 
@@ -158,15 +195,6 @@ module Extensions
     dest_xyz 0, page_height, nil, (page_num ? state.pages[page_num - 1] : page)
   end
 
-  # Text
-
-=begin
-  # Draws a disc bullet as float text
-  def draw_bullet
-    float { text '•' }
-  end
-=end
-
   # Fonts
 
   # Registers a new custom font described in the data parameter
@@ -474,7 +502,7 @@ module Extensions
   #
   def span_page_width_if verdict
     if verdict
-      indent -bounds_margin_left, -bounds_margin_right do
+      indent(-bounds_margin_left, -bounds_margin_right) do
         yield
       end
     else
@@ -482,6 +510,20 @@ module Extensions
     end
   end
 
+  # A flowing version of the bounding_box. If the content runs to another page, the cursor starts
+  # at the top of the page instead of the original cursor position. Similar to span, except
+  # you can specify an absolute left position and pass additional options through to bounding_box.
+  #
+  def flow_bounding_box left = 0, opts = {}
+    original_y = self.y
+    canvas do
+      bounding_box [margin_box.absolute_left + left, margin_box.absolute_top], opts do
+        self.y = original_y
+        yield
+      end
+    end
+  end
+
   # Graphics
 
   # Fills the current bounding box with the specified fill color. Before
@@ -616,7 +658,12 @@ module Extensions
     pdf_store.pages.data[:Kids].pop
     pdf_store.pages.data[:Count] -= 1
     state.pages.pop
-    go_to_page(pg - 1)
+    if pg > 1
+      go_to_page pg - 1
+    else
+      @page_number = 0
+      state.page = nil
+    end
   end
 
   # Import the specified page into the current document.
@@ -743,10 +790,12 @@ module Extensions
     scratch.font font_family, style: font_style, size: font_size do
       scratch.instance_exec(&block)
     end
+    # NOTE don't count excess if cursor exceeds writable area (due to padding)
+    partial_page_height = [effective_page_height, start_y - scratch.y].min
     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)]
+    [(whole_pages * bounds.height + partial_page_height), whole_pages, partial_page_height]
   end
 
   # Attempt to keep the objects generated in the block on the same page
@@ -783,7 +832,7 @@ module Extensions
 =begin
   def run_with_trial &block
     available_space = cursor
-    whole_pages, remainder = dry_run(&block)
+    total_height, whole_pages, remainder = dry_run(&block)
     if whole_pages > 0 || remainder > available_space
       started_new_page = true
     else

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

@@ -1,4 +1,6 @@
 class Prawn::Font::AFM
+  undef_method :normalize_encoding
+
   # Patch normalize_encoding method to handle conversion more gracefully.
   #
   # Any valid utf-8 characters that cannot be encoded to windows-1252 are
@@ -9,11 +11,10 @@ class Prawn::Font::AFM
   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"
+    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.)
+          %(Your document includes text which is not compatible with the Windows-1252 character set.
+If you need full UTF-8 support, use TTF fonts instead of the built-in PDF (AFM) fonts.)
   end
 end

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

@@ -30,7 +30,7 @@ module Images
       { width: img_size.output_width, height: img_size.output_height }
     else
       # NOTE build_image_object caches image data previously loaded
-      _, img_size = build_image_object path
+      _, img_size = ::File.open(path, 'rb') {|fd| build_image_object fd }
       { width: img_size.width, height: img_size.height }
     end
   end

data/lib/asciidoctor-pdf/roman_numeral.rb

@@ -62,7 +62,10 @@ class RomanNumeral
   end
 
   def to_r
-    roman = RomanNumeral.int_to_roman @integer_value
+    if (int = @integer_value) < 1
+      return int.to_s
+    end
+    roman = RomanNumeral.int_to_roman int
     @letter_case == :lower ? roman.downcase : roman
   end
 
@@ -79,15 +82,19 @@ class RomanNumeral
     self
   end
 
+  def pred
+    RomanNumeral.new @integer_value - 1, @letter_case
+  end
+
   def self.int_to_roman value
-    result = ''
+    result = []
     BaseDigits.keys.reverse.each do |ival|
       while value >= ival
         value -= ival 
-        result += BaseDigits[ival]
+        result << BaseDigits[ival]
       end
     end
-    result
+    result.join
   end
 
   def self.roman_to_int value

data/lib/asciidoctor-pdf/rouge_ext/formatters/prawn.rb

@@ -5,7 +5,7 @@ module Formatters
 class Prawn < Formatter
   tag 'prawn'
 
-  EOL = %(\n)
+  LF = %(\n)
   NoBreakSpace = %(\u00a0)
   InnerIndent = %(\n )
   GuardedIndent = %(\u00a0)
@@ -39,15 +39,15 @@ class Prawn < Formatter
       fragments = []
       fragments << (create_linenum_fragment linenum += 1)
       tokens.each do |tok, val|
-        if val == EOL
-          fragments << { text: EOL }
+        if val == LF
+          fragments << { text: LF }
           fragments << (create_linenum_fragment linenum += 1)
-        elsif val.include? EOL
+        elsif val.include? LF
           base_fragment = create_fragment tok, val
           val.each_line do |line|
             fragments << (base_fragment.merge text: line)
             # NOTE append linenum fragment if there's a next line; only works if source doesn't have trailing endline
-            if line.end_with? EOL
+            if line.end_with? LF
               fragments << (create_linenum_fragment linenum += 1)
             end
           end
@@ -58,7 +58,7 @@ class Prawn < Formatter
       # NOTE drop orphaned linenum fragment (due to trailing endline in source)
       fragments.pop if (last_fragment = fragments[-1]) && last_fragment[:linenum]
       # NOTE pad numbers that have less digits than the largest line number
-      if (linenum_w = (linenum / 10) + 1) > 1
+      if (linenum_w = linenum.to_s.size) > 1
         # NOTE extra column is the trailing space after the line number
         linenum_w += 1
         fragments.each do |fragment|
@@ -70,13 +70,13 @@ class Prawn < Formatter
       start_of_line = true
       tokens.map do |tok, val|
         # match one or more consecutive endlines
-        if val == EOL || (val == (EOL * val.length))
+        if val == LF || (val == (LF * val.length))
           start_of_line = true
           { text: val }
         else
           val[0] = GuardedIndent if start_of_line && (val.start_with? ' ')
           val.gsub! InnerIndent, GuardedInnerIndent if val.include? InnerIndent
-          start_of_line = val.end_with? EOL
+          start_of_line = val.end_with? LF
           # NOTE this optimization assumes we don't support/use background colors
           val.rstrip.empty? ? { text: val } : (create_fragment tok, val)
         end
@@ -85,7 +85,7 @@ class Prawn < Formatter
     end
   end
 
-  # TODO method could still be optimized (for instance, check if val is EOL or empty)
+  # TODO method could still be optimized (for instance, check if val is LF or empty)
   def create_fragment tok, val = nil
     fragment = val ? { text: val } : {}
     if (style_rules = @theme.style_for tok)