asciidoctor-pdf 1.5.0.beta.1 → 1.5.0

data/lib/{asciidoctor-pdf/asciidoctor_ext → asciidoctor/pdf/ext/asciidoctor}/abstract_block.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Asciidoctor::AbstractBlock
   def sections?
     !sections.empty?

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Asciidoctor::AbstractNode
+  def remove_attr name
+    @attributes.delete name
+  end unless method_defined? :remove_attr
+end

data/lib/{asciidoctor-pdf/asciidoctor_ext → asciidoctor/pdf/ext/asciidoctor}/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Asciidoctor::Document
   alias catalog references unless method_defined? :catalog
 end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Image
+    DataUriRx = /^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
+    end
+
+    def format
+      (attr 'format', nil, false) || ((ext = ::File.extname(inline? ? target : (attr 'target'))).downcase.slice 1, ext.length)
+    end
+
+    def target_and_format
+      image_path = inline? ? target : (attr 'target')
+      if (image_path.start_with? 'data:') && (m = DataUriRx.match image_path)
+        [(m[:data].extend ::Base64), (FormatAliases.fetch m[:fmt], m[:fmt])]
+      else
+        [image_path, (attr 'format', nil, false) || ((ext = ::File.extname image_path).downcase.slice 1, ext.length)]
+      end
+    end
+  end
+end

data/lib/{asciidoctor-pdf/asciidoctor_ext → asciidoctor/pdf/ext/asciidoctor}/list.rb

@@ -1,4 +1,6 @@
-# TODO add these methods to Asciidoctor core
+# frozen_string_literal: true
+
+# TODO: add these methods to Asciidoctor core
 class Asciidoctor::List
   # Check whether this list is an outline list (unordered or ordered).
   #
@@ -23,7 +25,7 @@ class Asciidoctor::List
   def outline_level
     l = 1
     ancestor = self
-    # FIXME does not cross out of AsciiDoc table cell
+    # FIXME: does not cross out of AsciiDoc table cell
     while (ancestor = ancestor.parent)
       l += 1 if Asciidoctor::List === ancestor && ancestor.outline?
     end

data/lib/{asciidoctor-pdf/asciidoctor_ext → asciidoctor/pdf/ext/asciidoctor}/list_item.rb

@@ -1,4 +1,6 @@
-# TODO add these methods to Asciidoctor core
+# frozen_string_literal: true
+
+# TODO: add these methods to Asciidoctor core
 class Asciidoctor::ListItem
   # Check whether this list item has complex content (i.e., nested blocks other than an outline list).
   #

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  class StubLogger
+    class << self
+      def info message = nil
+        # ignore since this isn't a real logger
+      end
+
+      def info?
+        false
+      end
+
+      def warn message = nil
+        ::Kernel.warn %(asciidoctor: WARNING: #{message || (block_given? ? yield : '???')})
+      end
+
+      def error message = nil
+        ::Kernel.warn %(asciidoctor: ERROR: #{message || (block_given? ? yield : '???')})
+      end
+    end
+  end
+
+  module Logging
+    def logger
+      StubLogger
+    end
+
+    def message_with_context text, _context = {}
+      text
+    end
+  end
+end

data/lib/{asciidoctor-pdf/asciidoctor_ext → asciidoctor/pdf/ext/asciidoctor}/section.rb

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
 class Asciidoctor::Section
   def numbered_title opts = {}
-    unless (@cached_numbered_title ||= nil)
+    @cached_numbered_title ||= nil
+    unless @cached_numbered_title
       slevel = @level == 0 && @special ? 1 : @level
       if @numbered && !@caption && slevel <= (@document.attr 'sectnumlevels', 3).to_i
         @is_numbered = true
-        @cached_formal_numbered_title = if @document.doctype == 'book'
+        if @document.doctype == 'book'
           if slevel == 0
             @cached_numbered_title = %(#{sectnum nil, ':'} #{title})
-            %(#{@document.attr 'part-signifier', 'Part'} #{@cached_numbered_title}).lstrip
+            @cached_formal_numbered_title = %(#{@document.attr 'part-signifier', 'Part'} #{@cached_numbered_title}).lstrip
           elsif slevel == 1
             @cached_numbered_title = %(#{sectnum} #{title})
-            %(#{@document.attr 'chapter-signifier', (@document.attr 'chapter-label', 'Chapter')} #{@cached_numbered_title}).lstrip
+            @cached_formal_numbered_title = %(#{@document.attr 'chapter-signifier', (@document.attr 'chapter-label', 'Chapter')} #{@cached_numbered_title}).lstrip
           else
-            @cached_numbered_title = %(#{sectnum} #{title})
+            @cached_formal_numbered_title = @cached_numbered_title = %(#{sectnum} #{title})
           end
         else
-          @cached_numbered_title = %(#{sectnum} #{title})
+          @cached_formal_numbered_title = @cached_numbered_title = %(#{sectnum} #{title})
         end
       elsif slevel == 0
         @is_numbered = false

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

@@ -0,0 +1,11 @@
+# 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'
+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/core_ext → asciidoctor/pdf/ext/core}/array.rb

@@ -1,5 +1,11 @@
+# frozen_string_literal: true
+
 class Array
   def delete_all *entries
     entries.map {|entry| delete entry }.compact
   end unless method_defined? :delete_all
+
+  def sum
+    reduce(&:+)
+  end unless method_defined? :sum
 end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class File
+  class << self
+    def absolute_path? path
+      (path.start_with? '/') || (ALT_SEPARATOR && (path.start_with? (absolute_path path).slice 0, 3))
+    end unless method_defined? :absolute_path?
+  end
+end

data/lib/{asciidoctor-pdf/core_ext → asciidoctor/pdf/ext/core}/hash.rb

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

data/lib/{asciidoctor-pdf/core_ext → asciidoctor/pdf/ext/core}/numeric.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # NOTE remove once minimum required Ruby version is at least 2.4
 Float.prepend (Module.new do
   def truncate *args
@@ -5,10 +7,10 @@ Float.prepend (Module.new do
       if (precision = Integer args.shift) == 0
         super
       elsif precision > 0
-        precision_factor = 10.0 ** precision
+        precision_factor = 10.0**precision
         (self * precision_factor).to_i / precision_factor
       else
-        precision_factor = 10 ** precision.abs
+        precision_factor = 10**precision.abs
         (self / precision_factor).to_i * precision_factor
       end
     else
@@ -18,7 +20,7 @@ Float.prepend (Module.new do
 end) if (Float.instance_method :truncate).arity == 0
 
 Integer.prepend (Module.new do
-  def truncate *args
+  def truncate *_args
     super()
   end
 end) if (Integer.instance_method :truncate).arity == 0

data/lib/{asciidoctor-pdf/core_ext → asciidoctor/pdf/ext/core}/object.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 class Object
   # Convert the object to a serialized PDF object.
-  def to_pdf
+  def to_pdf_object
     ::PDF::Core.pdf_object self
   end
 end

data/lib/{asciidoctor-pdf/core_ext → asciidoctor/pdf/ext/core}/quantifiable_stdout.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'delegate'
 
 # A delegator that allows the size method to be used on the STDOUT object.
@@ -11,10 +13,16 @@ class QuantifiableStdout < SimpleDelegator
   def initialize delegate
     @size = 0
     super
+    delegate.binmode
+  end
+
+  def << content
+    @size += content.to_s.bytesize
+    super
   end
 
   def write content
-    @size += content.bytesize
+    @size += content.to_s.bytesize
     super
   end
 end

data/lib/{asciidoctor-pdf/core_ext → asciidoctor/pdf/ext/core}/regexp.rb

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

data/lib/{asciidoctor-pdf/core_ext → asciidoctor/pdf/ext/core}/string.rb

@@ -1,26 +1,22 @@
+# frozen_string_literal: true
+
 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 'U1')
-    end
+    # integers
+    ((Integer self) - 1).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
 
   # If the string is ASCII only, convert it to a PDF LiteralString object. Otherwise, return self.
   def as_pdf
-    if ascii_only?
-      ::PDF::Core::LiteralString.new(encode ::Encoding::ASCII_8BIT)
-    else
-      self
-    end
+    ascii_only? ? (::PDF::Core::LiteralString.new encode ::Encoding::ASCII_8BIT) : self
   end
 
   # Convert the string to a serialized PDF object. If the string can be encoded as ASCII-8BIT, first convert it to a PDF
   # LiteralString object.
-  def to_pdf
+  def to_pdf_object
     ::PDF::Core.pdf_object as_pdf
   end
 end

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

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

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

@@ -0,0 +1,54 @@
+# 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
+  # 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
+  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
+      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
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+unless (defined? PDF::Core.pdf_object) == 'method'
+  module PDF::Core
+    alias pdf_object PdfObject
+    module_function :pdf_object # rubocop:disable Style/AccessModifierDeclarations
+  end
+end

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'pdf-core/pdf_object'
+require_relative 'pdf-core/page'

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+######################################################################
+#
+# 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/>.
+#
+# Copyright (C) Felipe Doria
+# Copyright (C) 2014 OpenDevise Inc. and the Asciidoctor Project
+#
+######################################################################
+
+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).
+#
+# Usage:
+#
+# CodeRay.scan(string, :ruby).to_prawn
+#
+module Asciidoctor
+  module Prawn
+    class CodeRayEncoder < ::CodeRay::Encoders::Encoder
+      register_for :to_prawn
+
+      # Manni theme from Pygments
+      COLORS = {
+        default: '333333',
+        annotation: '9999FF',
+        attribute_name: '4F9FCF',
+        attribute_value: 'D44950',
+        class: '00AA88',
+        class_variable: '003333',
+        color: 'FF6600',
+        comment: '999999',
+        constant: '336600',
+        directive: '006699',
+        doctype: '009999',
+        entity: '999999',
+        float: 'FF6600',
+        function: 'CC00FF',
+        important: '9999FF',
+        inline_delimiter: 'EF804F',
+        instance_variable: '003333',
+        integer: 'FF6600',
+        key: '006699',
+        keyword: '006699',
+        method: 'CC00FF',
+        namespace: '00CCFF',
+        predefined_type: '007788',
+        regexp: '33AAAA',
+        string: 'CC3300',
+        symbol: 'FFCC33',
+        tag: '2F6F9F',
+        type: '007788',
+        value: '336600',
+      }
+
+      LF = ?\n
+      NoBreakSpace = ?\u00a0
+      InnerIndent = LF + ' '
+      GuardedIndent = ?\u00a0
+      GuardedInnerIndent = LF + GuardedIndent
+
+      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
+        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
+        elsif text
+          # 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[-1]] || COLORS[:default]) }
+          end
+          @start_of_line = text.end_with? LF
+        end
+      end
+
+      def begin_group kind
+        @open << kind
+      end
+
+      def end_group _kind
+        @open.pop
+      end
+    end
+  end
+end