asciidoctor-pdf 1.6.1 → 2.0.0.alpha.2

data/lib/asciidoctor/pdf/ext/asciidoctor/document.rb

@@ -1,5 +1,26 @@
 # frozen_string_literal: true
 
 class Asciidoctor::Document
-  alias catalog references unless method_defined? :catalog
+  # promote preface block (i.e., preamble block with title in book doctype) to preface section
+  # FIXME: this should be handled by core
+  def promote_preface_block
+    if doctype == 'book' && (blk0 = blocks[0])&.context == :preamble && blk0.title? && !blk0.title.nil_or_empty? &&
+        blk0.blocks[0]&.style != 'abstract' && (blk1 = blocks[1])&.context == :section
+      preface = Asciidoctor::Section.new self, blk1.level, false, attributes: { 1 => 'preface', 'style' => 'preface' }
+      preface.special = true
+      preface.sectname = 'preface'
+      preface.title = blk0.instance_variable_get :@title
+      preface.id = preface.generate_id
+      if (first_child = blk0.blocks[0])&.option? 'notitle'
+        preface.set_option 'notitle'
+        first_child.role = 'lead' if first_child.context == :paragraph && !first_child.role?
+      end
+      preface.blocks.replace (blk0.blocks.map do |b|
+        b.parent = preface
+        b
+      end)
+      blocks[0] = preface
+    end
+    nil
+  end
 end

data/lib/asciidoctor/pdf/ext/asciidoctor/image.rb

@@ -2,25 +2,19 @@
 
 module Asciidoctor
   module Image
-    DataUriRx = /^data:image\/(?<fmt>png|jpe?g|gif|pdf|bmp|tiff|svg\+xml);base64,(?<data>.*)$/
+    DataUriRx = %r(^data:image/(?<fmt>png|jpe?g|gif|pdf|bmp|tiff|svg\+xml);base64,(?<data>.*)$)
     FormatAliases = { 'jpg' => 'jpeg', 'svg+xml' => 'svg' }
 
-    class << self
-      def format image_path, attributes = nil
-        (attributes && attributes['format']) || ((ext = ::File.extname image_path).downcase.slice 1, ext.length)
-      end
-
-      def target_and_format image_path, attributes = nil
-        if (image_path.start_with? 'data:') && (m = DataUriRx.match image_path)
-          [(m[:data].extend ::Base64), (FormatAliases.fetch m[:fmt], m[:fmt])]
-        else
-          [image_path, (attributes && attributes['format']) || ((ext = ::File.extname image_path).downcase.slice 1, ext.length)]
-        end
-      end
+    def self.format image_path
+      ((ext = ::File.extname image_path).downcase.slice 1, ext.length)
     end
 
-    def format
-      (attr 'format', nil, false) || ((ext = ::File.extname(inline? ? target : (attr 'target'))).downcase.slice 1, ext.length)
+    def self.target_and_format image_path, attributes = nil
+      if (image_path.start_with? 'data:') && (m = DataUriRx.match image_path)
+        [(m[:data].extend ::Base64), (FormatAliases.fetch m[:fmt], m[:fmt])]
+      else
+        [image_path, attributes&.[]('format') || ((ext = ::File.extname image_path).downcase.slice 1, ext.length)]
+      end
     end
 
     def target_and_format

data/lib/asciidoctor/pdf/ext/asciidoctor/list.rb

@@ -2,13 +2,6 @@
 
 # TODO: add these methods to Asciidoctor core
 class Asciidoctor::List
-  # Check whether this list is an outline list (unordered or ordered).
-  #
-  # Return true if this list is an outline list. Otherwise, return false.
-  def outline?
-    @context == :ulist || @context == :olist
-  end unless method_defined? :outline?
-
   # Check whether this list is nested inside the item of another list.
   #
   # Return true if the parent of this list is a list item. Otherwise, return false.
@@ -16,19 +9,19 @@ class Asciidoctor::List
     Asciidoctor::ListItem === @parent
   end unless method_defined? :nested?
 
-  # Get the level of this list within the broader outline list (unordered or ordered) structure.
+  # Get the nesting level of this list within the broader list (unordered or ordered) structure.
   #
-  # This method differs from the level property in that it considers all outline list ancestors.
+  # This method differs from the level property in that it considers only list ancestors.
   # It's important for selecting the marker for an unordered list.
   #
-  # Return the 1-based level of this list within the outline list structure.
-  def outline_level
+  # Return the 1-based level of this list within the list structure.
+  def list_level
     l = 1
     ancestor = self
     # FIXME: does not cross out of AsciiDoc table cell
     while (ancestor = ancestor.parent)
-      l += 1 if Asciidoctor::List === ancestor && ancestor.outline?
+      l += 1 if Asciidoctor::List === ancestor && (ancestor.context == :ulist || ancestor.context == :olist)
     end
     l
-  end unless method_defined? :outline_level
+  end unless method_defined? :list_level
 end

data/lib/asciidoctor/pdf/ext/asciidoctor/section.rb

@@ -4,8 +4,7 @@ class Asciidoctor::Section
   def numbered_title opts = {}
     @cached_numbered_title ||= nil
     unless @cached_numbered_title
-      slevel = @level == 0 && @special ? 1 : @level
-      if @numbered && !@caption && slevel <= (@document.attr 'sectnumlevels', 3).to_i
+      if @numbered && !@caption && (slevel = @level) <= (@document.attr 'sectnumlevels', 3).to_i
         @is_numbered = true
         if @document.doctype == 'book'
           case slevel
@@ -14,14 +13,14 @@ class Asciidoctor::Section
             @cached_formal_numbered_title = %(#{@document.attr 'part-signifier', 'Part'} #{@cached_numbered_title}).lstrip
           when 1
             @cached_numbered_title = %(#{sectnum} #{title})
-            @cached_formal_numbered_title = %(#{@document.attr 'chapter-signifier', (@document.attr 'chapter-label', 'Chapter')} #{@cached_numbered_title}).lstrip
+            @cached_formal_numbered_title = %(#{@document.attr 'chapter-signifier', 'Chapter'} #{@cached_numbered_title}).lstrip
           else
             @cached_formal_numbered_title = @cached_numbered_title = %(#{sectnum} #{title})
           end
         else
           @cached_formal_numbered_title = @cached_numbered_title = %(#{sectnum} #{title})
         end
-      elsif slevel == 0
+      elsif @level == 0
         @is_numbered = false
         @cached_numbered_title = @cached_formal_numbered_title = title
       else
@@ -31,16 +30,4 @@ class Asciidoctor::Section
     end
     opts[:formal] ? @cached_formal_numbered_title : @cached_numbered_title
   end unless method_defined? :numbered_title
-
-  def part?
-    @document.doctype == 'book' && @level == 0 && !@special
-  end unless method_defined? :part?
-
-  def chapter?
-    @document.doctype == 'book' && (@level == 1 || (@special && @level == 0))
-  end unless method_defined? :chapter?
-
-  def part_or_chapter?
-    @document.doctype == 'book' && @level < 2
-  end unless method_defined? :part_or_chapter?
 end

data/lib/asciidoctor/pdf/ext/asciidoctor.rb

@@ -1,11 +1,7 @@
 # frozen_string_literal: true
 
-# NOTE these are either candidates for inclusion in Asciidoctor core or backports
-require_relative 'asciidoctor/logging_shim' unless defined? Asciidoctor::Logging
-require_relative 'asciidoctor/abstract_node'
-require_relative 'asciidoctor/abstract_block'
+# NOTE: these are either candidates for inclusion in Asciidoctor core or backports
 require_relative 'asciidoctor/document'
 require_relative 'asciidoctor/section'
 require_relative 'asciidoctor/list'
-require_relative 'asciidoctor/list_item'
 require_relative 'asciidoctor/image'

data/lib/asciidoctor/pdf/ext/core/file.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class File
-  # NOTE: remove once minimum required Ruby version is at least 2.7
+  # NOTE: remove once minimum JRuby version is fully 2.7 compliant
   def self.absolute_path? path
     (::Pathname.new path).absolute?
   end unless respond_to? :absolute_path?

data/lib/asciidoctor/pdf/ext/core/quantifiable_stdout.rb

@@ -21,8 +21,5 @@ class QuantifiableStdout < SimpleDelegator
     super
   end
 
-  def write content
-    @size += content.to_s.bytesize
-    super
-  end
+  alias write <<
 end

data/lib/asciidoctor/pdf/ext/core/string.rb

@@ -3,11 +3,11 @@
 class String
   def pred
     # integers
-    ((Integer self) - 1).to_s
+    (Integer self).pred.to_s
   rescue ::ArgumentError
     # chars (upper alpha, lower alpha, lower greek)
     ([65, 97, 945].include? ord) ? '0' : ([ord - 1].pack 'U1')
-  end unless method_defined? :pred
+  end
 
   # If the string is ASCII only, convert it to a PDF LiteralString object. Otherwise, return self.
   def as_pdf

data/lib/asciidoctor/pdf/ext/core.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'core/object'
-require_relative 'core/array'
 require_relative 'core/file'
-require_relative 'core/hash'
+require_relative 'core/object'
 require_relative 'core/string'
-require_relative 'core/regexp'
 require_relative 'core/quantifiable_stdout'

data/lib/asciidoctor/pdf/ext/pdf-core/page.rb

@@ -3,31 +3,6 @@
 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
-  # 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?
-    dictionary.data[:Contents] = [content] unless Array === dictionary.data[:Contents]
-    @content = document.ref({})
-    dictionary.data[:Contents] << document.state.store[@content]
-    document.open_graphics_state
-  end unless method_defined? :new_content_stream
-
-  # NOTE alias method to avoid warning if another gem replaces this method
-  alias __new_content_stream new_content_stream
-
-  # Restore the imported_page? method from PDF::Core::Page
-  #
-  # see https://github.com/prawnpdf/pdf-core/commit/0e326a838e142061be8e062168190fae6b3b1dcf
-  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
@@ -42,13 +17,13 @@ class PDF::Core::Page
   # 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
-      xobjects.clear
-      ext_gstates.clear
-      new_content = document.state.store[document.ref({})]
-      new_content << 'q' << ?\n
-      content.replace new_content
-      @tare_content_stream = InitialPageContent
-    end
+    return if content.stream.filtered_stream == InitialPageContent
+    xobjects.clear
+    ext_gstates.clear
+    new_content = document.state.store[document.ref({})]
+    new_content << 'q' << ?\n
+    content.replace new_content
+    @tare_content_stream = InitialPageContent
+    nil
   end
 end

data/lib/asciidoctor/pdf/ext/pdf-core.rb

@@ -1,19 +1,3 @@
 # frozen_string_literal: true
 
-module PDF::Core
-  class << self
-    alias _initial_real real
-    def real num
-      num.to_f.round 4
-    end
-
-    alias _initial_real_params real_params
-    def real_params array
-      return array.map {|it| it.to_f.round 5 }.join ' ' if (caller_locations 1, 1)[0].base_label == 'transformation_matrix'
-      _initial_real_params array
-    end
-  end
-end
-
-require_relative 'pdf-core/pdf_object'
 require_relative 'pdf-core/page'

data/lib/asciidoctor/pdf/ext/prawn/coderay_encoder.rb

@@ -14,8 +14,6 @@
 #
 ######################################################################
 
-require 'coderay'
-
 # Registers a to_prawn method with CodeRay. The method returns an array of hashes to be
 # used with Prawn::Text.formatted_text(array).
 #
@@ -71,7 +69,7 @@ module Asciidoctor
         super
         @out  = []
         @open = []
-        # NOTE tracks whether text token begins at the start of a line
+        # NOTE: tracks whether text token begins at the start of a line
         @start_of_line = true
       end
 
@@ -79,17 +77,17 @@ module Asciidoctor
         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
+        # NOTE: text is nil and kind is :error when CodeRay ends parsing on an error
         elsif text
-          # NOTE add guard character to prevent Prawn from trimming indentation
+          # 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
+          # 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?
+            # QUESTION: should we default to no color?
             @out << { text: text, color: (COLORS[kind] || COLORS[@open[-1]] || COLORS[:default]) }
           end
           @start_of_line = text.end_with? LF