asciidoctor-pdf 1.5.0.beta.1 → 1.5.0.beta.2

data/lib/asciidoctor-pdf/core_ext.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'core_ext/object'
 require_relative 'core_ext/array'
 require_relative 'core_ext/hash'

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Array
   def delete_all *entries
     entries.map {|entry| delete entry }.compact

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Hash
   def compact
     select {|_, val| val }

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # NOTE remove once minimum required Ruby version is at least 2.4
 Float.prepend (Module.new do
   def truncate *args

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Object
   # Convert the object to a serialized PDF object.
   def to_pdf

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'delegate'
 
 # A delegator that allows the size method to be used on the STDOUT object.

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Regexp
   alias match? === unless Regexp.method_defined? :match?
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class String
   def pred
     begin

data/lib/asciidoctor-pdf/formatted_text.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'treetop'
 require 'set' unless defined? Set
 require_relative 'formatted_text/parser'

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Asciidoctor
 module PDF
 module FormattedText

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Asciidoctor::PDF::FormattedText
 module InlineDestinationMarker
   module_function

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Asciidoctor::PDF::FormattedText
 module InlineImageArranger
   include ::Asciidoctor::PDF::Measurements
@@ -66,7 +67,7 @@ module InlineImageArranger
           svg_obj = ::Prawn::SVG::Interface.new ::File.read(image_path), doc,
               at: doc.bounds.top_left,
               width: image_w,
-              fallback_font_name: doc.default_svg_font,
+              fallback_font_name: doc.fallback_svg_font_name,
               enable_web_requests: doc.allow_uri_read,
               enable_file_requests_with_root: (::File.dirname image_path)
           svg_size = image_w ? svg_obj.document.sizing :

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Asciidoctor::PDF::FormattedText
 module InlineImageRenderer
   TemporaryPath = ::Asciidoctor::PDF::TemporaryPath

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Asciidoctor::PDF::FormattedText
 module InlineTextAligner
   module_function

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # regenerate parser.rb using `tt parser.treetop`
 # Autogenerated from a Treetop grammar. Edits may be lost.
 
@@ -433,11 +434,11 @@ module Markup
                     r8 = SyntaxNode.new(input, (index-1)...index) if r8 == true
                     r0 = r8
                   else
-                    if (match_len = has_terminal?('sub', false, index))
+                    if (match_len = has_terminal?('key', false, index))
                       r9 = instantiate_node(SyntaxNode,input, index...(index + match_len))
                       @index += match_len
                     else
-                      terminal_parse_failure('sub')
+                      terminal_parse_failure('key')
                       r9 = nil
                     end
                     if r9
@@ -455,19 +456,31 @@ module Markup
                         r10 = SyntaxNode.new(input, (index-1)...index) if r10 == true
                         r0 = r10
                       else
-                        if (match_len = has_terminal?('del', false, index))
+                        if (match_len = has_terminal?('sub', false, index))
                           r11 = instantiate_node(SyntaxNode,input, index...(index + match_len))
                           @index += match_len
                         else
-                          terminal_parse_failure('del')
+                          terminal_parse_failure('sub')
                           r11 = nil
                         end
                         if r11
                           r11 = SyntaxNode.new(input, (index-1)...index) if r11 == true
                           r0 = r11
                         else
-                          @index = i0
-                          r0 = nil
+                          if (match_len = has_terminal?('del', false, index))
+                            r12 = instantiate_node(SyntaxNode,input, index...(index + match_len))
+                            @index += match_len
+                          else
+                            terminal_parse_failure('del')
+                            r12 = nil
+                          end
+                          if r12
+                            r12 = SyntaxNode.new(input, (index-1)...index) if r12 == true
+                            r0 = r12
+                          else
+                            @index = i0
+                            r0 = nil
+                          end
                         end
                       end
                     end

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

@@ -49,9 +49,8 @@ grammar Markup
 
   rule tag_name
     # QUESTION faster to do regex?
-    # QUESTION can we cut stuff we aren't using? what about supporting hr?
-    #'a' / 'b' / 'code' / 'color' / 'del' / 'em' / 'font' / 'i' / 'img' / 'link' / 'span' / 'strikethrough' / 'strong' / 'sub' / 'sup' / 'u'
-    'a' / 'strong' / 'em' / 'code' / 'color' / 'font' / 'span' / 'button' / 'sub' / 'sup' / 'del'
+    # QUESTION what about supporting hr?
+    'a' / 'strong' / 'em' / 'code' / 'color' / 'font' / 'span' / 'button' / 'key' / 'sup' / 'sub' / 'del'
   end
 
   rule void_tag_name

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Asciidoctor::Pdf::FormattedText
 module TextBackgroundAndBorderRenderer
   module_function

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Asciidoctor
 module PDF
 module FormattedText
@@ -14,6 +15,12 @@ class Transform
   }
   CharRefRx = /&(?:(#{CharEntityTable.keys * ?|})|#(?:(\d\d\d{0,4})|x([a-f\d][a-f\d][a-f\d]{0,3})));/
   TextDecorationTable = { 'underline' => :underline, 'line-through' => :strikethrough }
+  ThemeKeyToFragmentProperty = {
+    'font_color' => :color,
+    'font_family' => :font,
+    'font_size' => :size,
+    'font_style' => :styles,
+  }
   #DummyText = ?\u0000
 
   def initialize(options = {})
@@ -45,18 +52,57 @@ class Transform
           border_radius: monospaced_bg_or_border && theme.literal_border_radius,
           callback: monospaced_bg_or_border && [TextBackgroundAndBorderRenderer],
         }.compact,
+        key: {
+          color: theme.key_font_color,
+          font: theme.key_font_family || theme.literal_font_family,
+          size: theme.key_font_size,
+          styles: to_styles(theme.key_font_style),
+          background_color: (key_bg_color = theme.key_background_color),
+          border_width: (key_border_width = theme.key_border_width),
+          border_color: key_border_width && (theme.key_border_color || theme.base_border_color),
+          border_offset: (key_bg_or_border = key_bg_color || key_border_width) && theme.key_border_offset,
+          border_radius: key_bg_or_border && theme.key_border_radius,
+          callback: key_bg_or_border && [TextBackgroundAndBorderRenderer],
+        }.compact,
         link: {
           color: theme.link_font_color,
           font: theme.link_font_family,
           size: theme.link_font_size,
-          styles: to_styles(theme.link_font_style, theme.link_text_decoration)
+          styles: to_styles(theme.link_font_style, theme.link_text_decoration),
         }.compact,
       }
+      theme.each_pair.reduce @theme_settings do |accum, (key, val)|
+        if (key = key.to_s).start_with? 'role_'
+          role, key = (key.slice 5, key.length).split '_', 2
+          if (prop = ThemeKeyToFragmentProperty[key])
+            val = to_styles val if prop == :styles
+            (accum[role] ||= {})[prop] = val
+          end
+        end
+        accum
+      end
+      unless @theme_settings.key? 'big'
+        if (base_font_size_large = theme.base_font_size_large)
+          @theme_settings['big'] = { size: %(#{(base_font_size_large / theme.base_font_size.to_f).round 4}em) }
+        else
+          @theme_settings['big'] = { size: '1.1667em' }
+        end
+      end
+      unless @theme_settings.key? 'small'
+        if (base_font_size_small = theme.base_font_size_small)
+          @theme_settings['small'] = { size: %(#{(base_font_size_small / theme.base_font_size.to_f).round 4}em) }
+        else
+          @theme_settings['small'] = { size: '0.8333em' }
+        end
+      end
     else
       @theme_settings = {
         button: { font: 'Courier', styles: [:bold].to_set },
-        code: { font: 'Courier', size: 0.9 },
+        code: { font: 'Courier' },
+        key: { font: 'Courier', styles: [:italic].to_set },
         link: { color: '0000FF' },
+        'big' => { size: '1.667em' },
+        'small' => { size: '0.8333em' },
       }
     end
   end
@@ -146,7 +192,7 @@ class Transform
       styles << :bold
     when :em
       styles << :italic
-    when :code, :button
+    when :code, :button, :key
       # NOTE prefer old value, except for styles and callback, which should be combined
       fragment.update(@theme_settings[tag_name]) {|k, oval, nval| k == :styles ? oval.merge(nval) : (k == :callback ? oval.union(nval) : oval) }
     when :color
@@ -265,6 +311,8 @@ class Transform
         styles << :underline
       when 'line-through'
         styles << :strikethrough
+      else
+        fragment.update(@theme_settings[class_name]) {|k, oval, nval| k == :styles ? oval.merge(nval) : oval } if @theme_settings.key? class_name
       end
     end if attrs.key?(:class)
     fragment.delete(:styles) if styles.empty?

data/lib/asciidoctor-pdf/implicit_header_processor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'asciidoctor/extensions'
 
 module Asciidoctor

data/lib/asciidoctor-pdf/index_catalog.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Asciidoctor; module PDF
   class IndexCatalog
     include Sanitizer

data/lib/asciidoctor-pdf/measurements.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Asciidoctor; module PDF
   module Measurements
     MeasurementValueRx = /(\d+|\d*\.\d+)(in|mm|cm|p[txc])?$/

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

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 require_relative 'pdf-core_ext/pdf_object'
 require_relative 'pdf-core_ext/page'

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

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
 class PDF::Core::Page
+  InitialPageContent = %(q\n)
+
   # Restore the new_content_stream method from PDF::Core::Page
   #
   # The prawn-templates gem relies on the new_content_stream method on
@@ -22,4 +25,27 @@ class PDF::Core::Page
   def imported_page?
     @imported_page
   end unless method_defined? :imported_page?
+
+  # Record the page's current state as the tare content stream (i.e., empty, meaning no content has been written).
+  def tare_content_stream
+    @tare_content_stream = content.stream.filtered_stream
+  end
+
+  # Returns whether the current page is empty based on tare content stream (i.e., no content has been written).
+  # Returns false if a page has not yet been created.
+  def empty?
+    content.stream.filtered_stream == (@tare_content_stream ||= InitialPageContent) && document.page_number > 0
+  end
+
+  # Reset the content of the page.
+  # Note that this method may leave behind an orphaned background image.
+  def reset_content
+    unless content.stream.filtered_stream == InitialPageContent
+      resources[:XObject].clear
+      new_content = document.state.store[document.ref({})]
+      new_content << 'q' << ?\n
+      content.replace new_content
+      @tare_content_stream = InitialPageContent
+    end
+  end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 unless (defined? PDF::Core.pdf_object) == 'method'
   module PDF::Core
     alias pdf_object PdfObject

data/lib/asciidoctor-pdf/pdfmark.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Asciidoctor
 module PDF
 class Pdfmark

data/lib/asciidoctor-pdf/prawn-svg_ext.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'prawn-svg' unless defined? Prawn::SVG::Interface
 require_relative 'prawn-svg_ext/interface'
 # NOTE disable system fonts since they're non-portable

data/lib/asciidoctor-pdf/prawn-svg_ext/interface.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prawn; module SVG
   class Interface
     def resize opts = {}

data/lib/asciidoctor-pdf/prawn-table_ext.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'prawn/table' unless defined? Prawn::Table::VERSION
 require_relative 'prawn-table_ext/cell'
 require_relative 'prawn-table_ext/cell/asciidoc'

data/lib/asciidoctor-pdf/prawn-table_ext/cell.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Prawn::Table::Cell
   remove_method :draw_borders
   # Draws borders around the cell. Borders are centered on the bounds of

data/lib/asciidoctor-pdf/prawn-table_ext/cell/asciidoc.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prawn; class Table; class Cell
   class AsciiDoc < Cell
     attr_accessor :align

data/lib/asciidoctor-pdf/prawn-table_ext/cell/text.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Prawn::Table::Cell::Text
   # Override draw_content method to drop cursor advancement
   remove_method :draw_content

data/lib/asciidoctor-pdf/prawn-templates_ext.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Prawn::Document
   # NOTE allows prawn-templates 0.0.4 to be used with prawn >= 2.2.0
   const_set :VALID_OPTIONS, (send :remove_const, :VALID_OPTIONS).dup if VALID_OPTIONS.frozen?

data/lib/asciidoctor-pdf/prawn_ext.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # the following are organized under the Asciidoctor::Prawn namespace
 require_relative 'prawn_ext/font/afm'
 require_relative 'prawn_ext/images'

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ######################################################################
 #
 # This file was copied from Prawn (manual/syntax_highlight.rb) and
@@ -68,11 +69,11 @@ class CodeRayEncoder < ::CodeRay::Encoders::Encoder
     value:             '336600'
   }
 
-  LF = %(\n)
-  NoBreakSpace = %(\u00a0)
-  InnerIndent = %(\n )
-  GuardedIndent = %(\u00a0)
-  GuardedInnerIndent = %(\n\u00a0)
+  LF = ?\n
+  NoBreakSpace = ?\u00a0
+  InnerIndent = LF + ' '
+  GuardedIndent = ?\u00a0
+  GuardedInnerIndent = LF + GuardedIndent
 
   def setup options
     super

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 Prawn::Font::AFM.instance_variable_set :@hide_m17n_warning, true
 
 require 'prawn/icon'
@@ -141,17 +142,6 @@ module Extensions
     @y == @margin_box.absolute_top
   end
 
-  # 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 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?
-
   # Returns whether the current page is the last page in the document.
   #
   def last_page?
@@ -313,6 +303,10 @@ module Extensions
     ::Prawn::Icon::FontData.load self, family
   end
 
+  def resolve_legacy_icon_name name
+    ::Prawn::Icon::Compatibility::SHIMS[%(fa-#{name})]
+  end
+
   def calc_line_metrics line_height = 1, font = self.font, font_size = self.font_size
     line_height_length = line_height * font_size
     leading = line_height_length - font_size
@@ -726,9 +720,11 @@ module Extensions
 
   # Import the specified page into the current document.
   #
-  # By default, advance to the subsequent page, creating one if necessary.
+  # By default, advance to the next page afterwards, creating it if necessary.
   # This behavior can be disabled by passing the option `advance: false`.
-  #
+  # However, due to how page creation works in Prawn, understand that advancing
+  # to the next page is necessary to prevent the size & layout of the imported
+  # page from affecting a newly created page.
   def import_page file, opts = {}
     prev_page_layout = page.layout
     prev_page_size = page.size
@@ -758,7 +754,7 @@ module Extensions
     else
       image file, (options.merge position: :center, vposition: :center, fit: [bounds.width, bounds.height])
     end
-    # NOTE advance to new page just in case the image function threw off the cursor
+    # NOTE advance to newly created page just in case the image function threw off the cursor
     go_to_page image_page_number
     nil
   end
@@ -787,9 +783,7 @@ module Extensions
   # Start a new page without triggering the on_page_create callback
   #
   def start_new_page_discretely options = {}
-    perform_discretely do
-      start_new_page options
-    end
+    perform_discretely { start_new_page options }
   end
 
   # Grouping