asciidoctor-pdf 1.5.0.alpha.16 → 1.5.0.alpha.17

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

@@ -2,17 +2,17 @@
 #
 # This file was copied from Prawn (manual/syntax_highlight.rb) and
 # modified for use with Asciidoctor PDF.
-# 
+#
 # Prawn is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # Prawn is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU General Public License
 # along with Prawn. If not, see <http://www.gnu.org/licenses/>.
 #

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

@@ -2,13 +2,16 @@ Prawn::Font::AFM.instance_variable_set :@hide_m17n_warning, true
 
 require 'prawn/icon'
 
+Prawn::Icon::Compatibility.send :prepend, (::Module.new { def warning *args; end })
+
 module Asciidoctor
 module Prawn
 module Extensions
-  include ::Asciidoctor::Pdf::Measurements
-  include ::Asciidoctor::Pdf::Sanitizer
+  include ::Asciidoctor::PDF::Measurements
+  include ::Asciidoctor::PDF::Sanitizer
 
-  IconSets = ['fa', 'fi', 'octicon', 'pf'].to_set
+  FontAwesomeIconSets = %w(fab far fas)
+  IconSets = %w(fab far fas fi pf).to_set
   InitialPageContent = %(q\n)
 
   # - :height is the height of a line
@@ -76,7 +79,7 @@ module Extensions
     page.margins[:left]
   end
   # deprecated
-  alias :left_margin :page_margin_left
+  alias left_margin page_margin_left
 
   # Returns the width of the right margin for the current page
   #
@@ -84,7 +87,7 @@ module Extensions
     page.margins[:right]
   end
   # deprecated
-  alias :right_margin :page_margin_right
+  alias right_margin page_margin_right
 
   # Returns the width of the top margin for the current page
   #
@@ -147,7 +150,7 @@ module Extensions
     # ...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?
+  alias page_is_empty? empty_page?
 
   # Returns whether the current page is the last page in the document.
   #
@@ -179,7 +182,7 @@ module Extensions
   #    bold: 'fonts/roboto-bold.ttf',
   #    bold_italic: 'fonts/roboto-bold_italic.ttf'
   #  }
-  #  
+  #
   def register_font data
     font_families.update data.inject({}) {|accum, (key, val)| accum[key.to_s] = val; accum }
   end
@@ -190,8 +193,11 @@ module Extensions
   #
   def font name = nil, options = {}
     if name
-      ::Prawn::Icon::FontData.load self, name if IconSets.include? name
       options = { size: options } if ::Numeric === options
+      if IconSets.include? name
+        ::Prawn::Icon::FontData.load self, name
+        options = options.reject {|k| k == :style } if options.key? :style
+      end
     end
     super name, options
   end
@@ -202,7 +208,7 @@ module Extensions
     font.options[:family]
   end
 
-  alias :font_name :font_family
+  alias font_name font_family
 
   # Retrieves the current font info (family, style, size) as a Hash
   #
@@ -211,7 +217,7 @@ module Extensions
   end
 
   # Sets the font style for the scope of the block to which this method
-  # yields. If the style is nil and no block is given, return the current 
+  # yields. If the style is nil and no block is given, return the current
   # font style.
   #
   def font_style style = nil
@@ -303,6 +309,10 @@ module Extensions
     end
   end
 
+  def icon_font_data family
+    ::Prawn::Icon::FontData.load self, family
+  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
@@ -333,7 +343,7 @@ module Extensions
     options = options.dup
     if (format_option = options.delete :inline_format)
       format_option = [] unless ::Array === format_option
-      fragments = self.text_formatter.format string, *format_option 
+      fragments = self.text_formatter.format string, *format_option
     else
       fragments = [{text: string}]
     end
@@ -494,6 +504,21 @@ module Extensions
     #end
   end
 
+  # TODO memoize the result
+  def inflate_padding padding
+    padding = [*(padding || 0)].slice 0, 4
+    case padding.size
+    when 1
+      [padding[0], padding[0], padding[0], padding[0]]
+    when 2
+      [padding[0], padding[1], padding[0], padding[1]]
+    when 3
+      [padding[0], padding[1], padding[2], padding[1]]
+    else
+      padding
+    end
+  end
+
   # Stretch the current bounds to the left and right edges of the current page
   # while yielding the specified block if the verdict argument is true.
   # Otherwise, simply yield the specified block.
@@ -776,7 +801,7 @@ module Extensions
       # TODO set scratch number on scratch document
       scratch
     else
-      warn 'asciidoctor: WARNING: no scratch prototype available; instantiating fresh scratch document'
+      logger.warn 'no scratch prototype available; instantiating fresh scratch document'
       ::Prawn::Document.new
     end
   end
@@ -786,7 +811,7 @@ module Extensions
   rescue
     false # NOTE this method may get called before the state is initialized
   end
-  alias :is_scratch? :scratch?
+  alias is_scratch? scratch?
 
   # TODO document me
   def dry_run &block
@@ -827,7 +852,7 @@ module Extensions
     else
       started_new_page = false
     end
-    
+
     # HACK yield doesn't work here on JRuby (at least not when called from AsciidoctorJ)
     #yield remainder, started_new_page
     instance_exec(total_height, started_new_page, &block)

data/lib/asciidoctor-pdf/prawn_ext/formatted_text/fragment.rb

@@ -3,7 +3,7 @@ module Prawn
 module FormattedText
 module Fragment
   attr_reader :document
-  
+
   # Prevent fragment from being written by discarding the text.
   def conceal
     @text = ''
@@ -20,18 +20,17 @@ module Fragment
   def descender= val
     @descender = (format_state.key? :descender) ? format_state[:descender] : val
   end
-end
 
-class ::Prawn::Text::Formatted::Fragment
-  if respond_to? :prepend
-    prepend Fragment
-  else
-    # NOTE it's necessary to remove the accessor methods or else they won't get replaced
-    remove_method :ascender=
-    remove_method :descender=
-    include Fragment
+  def width
+    if (val = format_state[:width])
+      (val.end_with? 'em') ? val.to_f * @document.font_size : val
+    else
+      super
+    end
   end
 end
+
+::Prawn::Text::Formatted::Fragment.prepend Fragment
 end
 end
 end

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

@@ -12,7 +12,7 @@ module Images
     # FIXME handle case when SVG is a File or IO object
     if ::String === file && (file.downcase.end_with? '.svg')
       opts[:fallback_font_name] ||= default_svg_font if respond_to? :default_svg_font
-      svg((::IO.read file), opts)
+      svg((::File.read file), opts)
     else
       _initial_image file, opts
     end
@@ -24,7 +24,7 @@ module Images
   # intrinsic width and height values (in pixels)
   def intrinsic_image_dimensions path
     if path.end_with? '.svg'
-      img_obj = ::Prawn::Svg::Interface.new ::IO.read(path), self, {}
+      img_obj = ::Prawn::SVG::Interface.new ::File.read(path), self, {}
       img_size = img_obj.document.sizing
       { width: img_size.output_width, height: img_size.output_height }
     else

data/lib/asciidoctor-pdf/roman_numeral.rb

@@ -10,10 +10,10 @@
 # distribute, sublicense, and/or sell copies of the Software, and to
 # permit persons to whom the Software is furnished to do so, subject to
 # the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be
 # included in all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
@@ -23,12 +23,12 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 # Copyright (c) 2011 Andrew Vos
-# Copyright (c) 2014 OpenDevice, Inc.
+# Copyright (c) 2014 OpenDevise, Inc.
 #
 ########################################################################
 
 module Asciidoctor
-module Pdf
+module PDF
 class RomanNumeral
   BaseDigits = {
     1    => 'I',
@@ -88,9 +88,9 @@ class RomanNumeral
 
   def self.int_to_roman value
     result = []
-    BaseDigits.keys.reverse.each do |ival|
+    BaseDigits.keys.reverse_each do |ival|
       while value >= ival
-        value -= ival 
+        value -= ival
         result << BaseDigits[ival]
       end
     end
@@ -100,7 +100,7 @@ class RomanNumeral
   def self.roman_to_int value
     value = value.upcase
     result = 0
-    BaseDigits.values.reverse.each do |rval|
+    BaseDigits.values.reverse_each do |rval|
       while value.start_with? rval
         offset = rval.length
         value = value[offset..offset]

data/lib/asciidoctor-pdf/rouge_ext.rb

@@ -1,4 +1,4 @@
 require 'rouge'
 require_relative 'rouge_ext/formatters/prawn'
-require_relative 'rouge_ext/css_theme'
-require_relative 'rouge_ext/themes/pastie'
+require_relative 'rouge_ext/themes/asciidoctor_pdf_default'
+require_relative 'rouge_ext/themes/bw' unless Rouge::Theme.find 'bw'

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

@@ -1,17 +1,23 @@
 module Rouge
 module Formatters
-# Transforms a token stream into an array of 
+# Transforms a token stream into an array of
 # formatted text fragments for use with Prawn.
 class Prawn < Formatter
   tag 'prawn'
 
   Tokens = ::Rouge::Token::Tokens
+  LineOrientedTokens = [
+    ::Rouge::Token::Tokens::Generic::Inserted,
+    ::Rouge::Token::Tokens::Generic::Deleted,
+    ::Rouge::Token::Tokens::Generic::Heading,
+    ::Rouge::Token::Tokens::Generic::Subheading
+  ]
 
-  LF = %(\n)
-  NoBreakSpace = %(\u00a0)
-  InnerIndent = %(\n )
-  GuardedIndent = %(\u00a0)
-  GuardedInnerIndent = %(\n\u00a0)
+  LF = ?\n
+  NoBreakSpace = ?\u00a0
+  InnerIndent = %(#{LF} )
+  GuardedIndent = NoBreakSpace
+  GuardedInnerIndent = %(#{LF}#{NoBreakSpace})
   BoldStyle = [:bold].to_set
   ItalicStyle = [:italic].to_set
   BoldItalicStyle = [:bold, :italic].to_set
@@ -20,7 +26,7 @@ class Prawn < Formatter
   def initialize opts = {}
     unless ::Rouge::Theme === (theme = opts[:theme])
       unless theme && (theme = ::Rouge::Theme.find theme)
-        theme = ::Rouge::Themes::Pastie
+        theme = ::Rouge::Themes::AsciidoctorPDFDefault
       end
       theme = theme.new
     end
@@ -106,8 +112,13 @@ class Prawn < Formatter
       if (bg = normalize_color style_rules.bg) && bg != @background_color
         fragment[:background_color] = bg
         fragment[:callback] = @background_colorizer
-        fragment[:inline_block] = true if style_rules[:inline_block]
-        fragment[:extend] = true if style_rules[:extend]
+        if LineOrientedTokens.include? tok
+          fragment[:inline_block] = true unless style_rules[:inline_block] == false
+          fragment[:extend] = true unless style_rules[:extend] == false
+        else
+          fragment[:inline_block] = true if style_rules[:inline_block]
+          fragment[:extend] = true if style_rules[:extend]
+        end
       end
       if (fg = normalize_color style_rules.fg)
         fragment[:color] = fg

data/lib/asciidoctor-pdf/rouge_ext/themes/{pastie.rb → asciidoctor_pdf_default.rb}

@@ -1,9 +1,9 @@
 module Rouge
   module Themes
-    # A port of the pastie style from Pygments.
+    # A variation on the pastie style from Pygments, customized for Asciidoctor PDF
     # See https://bitbucket.org/birkenfeld/pygments-main/src/default/pygments/styles/pastie.py
-    class Pastie < CSSTheme
-      name 'pastie' 
+    class AsciidoctorPDFDefault < CSSTheme
+      name 'asciidoctor_pdf_default'
 
       # Deviate from pastie here since our italic is actually a thinner font
       style Comment,                   fg: '#888888' #, italic: true
@@ -17,8 +17,8 @@ module Rouge
       style Generic::Heading,          fg: '#333333'
       style Generic::Subheading,       fg: '#666666'
 
-      style Generic::Deleted,          fg: '#000000', bg: '#ffdddd', inline_block: true, extend: true
-      style Generic::Inserted,         fg: '#000000', bg: '#ddffdd', inline_block: true, extend: true
+      style Generic::Deleted,          fg: '#000000', bg: '#ffdddd'
+      style Generic::Inserted,         fg: '#000000', bg: '#ddffdd'
 
       style Generic::Emph,             italic: true
       style Generic::Strong,           bold: true

data/lib/asciidoctor-pdf/rouge_ext/themes/bw.rb

@@ -0,0 +1,38 @@
+module Rouge
+  module Themes
+    # A port of the bw style from Pygments.
+    # See https://bitbucket.org/birkenfeld/pygments-main/src/default/pygments/styles/bw.py
+    class BlackWhiteTheme < CSSTheme
+      name 'bw'
+
+      style Text,                        fg: '#000000', bg: '#ffffff'
+
+      style Comment,                     italic: true
+      style Comment::Preproc,            italic: false
+
+      style Keyword,                     bold: true
+      style Keyword::Pseudo,             bold: false
+      style Keyword::Type,               bold: false
+
+      style Operator,                    bold: true
+
+      style Name::Class,                 bold: true
+      style Name::Namespace,             bold: true
+      style Name::Exception,             bold: true
+      style Name::Entity,                bold: true
+      style Name::Tag,                   bold: true
+
+      style Literal::String,             italic: true
+      style Literal::String::Interpol,   bold: true
+      style Literal::String::Escape,     bold: true
+
+      style Generic::Heading,            bold: true
+      style Generic::Subheading,         bold: true
+      style Generic::Emph,               italic: true
+      style Generic::Strong,             bold: true
+      style Generic::Prompt,             bold: true
+
+      style Error,                       fg: '#FF0000'
+    end
+  end
+end

data/lib/asciidoctor-pdf/sanitizer.rb

@@ -1,26 +1,36 @@
-begin
-  require 'unicode' unless defined? Unicode::VERSION
-rescue LoadError
+unless RUBY_VERSION >= '2.4'
   begin
-    require 'active_support/multibyte' unless defined? ActiveSupport::Multibyte
-  rescue LoadError; end
+    require 'unicode' unless defined? Unicode::VERSION
+  rescue LoadError
+    begin
+      require 'active_support/multibyte' unless defined? ActiveSupport::Multibyte
+    rescue LoadError; end
+  end
 end
 
 module Asciidoctor
-module Pdf
+module PDF
 module Sanitizer
-  BuiltInEntityChars = {
-    '&lt;' => '<',
-    '&gt;' => '>',
-    '&amp;' => '&'
+  XMLSpecialChars = {
+    '&lt;' => ?<,
+    '&gt;' => ?>,
+    '&amp;' => ?&,
   }
-  BuiltInEntityCharRx = /(?:#{BuiltInEntityChars.keys * '|'})/
-  BuiltInEntityCharOrTagRx = /(?:#{BuiltInEntityChars.keys * '|'}|<)/
-  InverseBuiltInEntityChars = BuiltInEntityChars.invert
-  InverseBuiltInEntityCharRx = /[#{InverseBuiltInEntityChars.keys.join}]/
-  NumericCharRefRx = /&#(\d{2,6});/
-  XmlSanitizeRx = /<[^>]+>/
-  SegmentPcdataRx = /(?:(&[a-z]+;|<[^>]+>)|([^&<]+))/
+  XMLSpecialCharsRx = /(?:#{XMLSpecialChars.keys * ?|})/
+  InverseXMLSpecialChars = XMLSpecialChars.invert
+  InverseXMLSpecialCharsRx = /[#{InverseXMLSpecialChars.keys.join}]/
+  (BuiltInNamedEntities = {
+    'amp' => ?&,
+    'apos' => ?',
+    'gt' => ?>,
+    'lt' => ?<,
+    'nbsp' => ' ',
+    'quot' => ?",
+  }).default = ??
+  SanitizeXMLRx = /<[^>]+>/
+  XMLMarkupRx = /&#?[a-z\d]+;|</
+  CharRefRx = /&(?:([a-z][a-z]+\d{0,2})|#(?:(\d\d\d{0,4})|x([a-f\d][a-f\d][a-f\d]{0,3})));/
+  SiftPCDATARx = /(&#?[a-z\d]+;|<[^>]+>)|([^&<]+)/
 
   # Strip leading, trailing and repeating whitespace, remove XML tags and
   # resolve all entities in the specified string.
@@ -29,19 +39,22 @@ module Sanitizer
   # FIXME add option to control escaping entities, or a filter mechanism in general
   def sanitize string
     string.strip
-        .gsub(XmlSanitizeRx, '')
+        .gsub(SanitizeXMLRx, '')
         .tr_s(' ', ' ')
-        .gsub(NumericCharRefRx) { [$1.to_i].pack('U*') }
-        .gsub(BuiltInEntityCharRx, BuiltInEntityChars)
+        .gsub(CharRefRx) { $1 ? BuiltInNamedEntities[$1] : [$2 ? $2.to_i : ($3.to_i 16)].pack('U1') }
   end
 
   def escape_xml string
-    string.gsub InverseBuiltInEntityCharRx, InverseBuiltInEntityChars
+    string.gsub InverseXMLSpecialCharsRx, InverseXMLSpecialChars
+  end
+
+  def encode_quotes string
+    (string.include? ?") ? (string.gsub ?", '&quot;') : string
   end
 
   def uppercase_pcdata string
-    if BuiltInEntityCharOrTagRx =~ string
-      string.gsub(SegmentPcdataRx) { $2 ? (uppercase_mb $2) : $1 }
+    if XMLMarkupRx.match? string
+      string.gsub(SiftPCDATARx) { $2 ? (uppercase_mb $2) : $1 }
     else
       uppercase_mb string
     end