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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33a408180f820e2def56daa216f2993e059faa37
-  data.tar.gz: a375982bb4846383206446e61b5151c0928f2f0a
+  metadata.gz: f8bc83ea1a53067222edc4efed9a4e23d7b98824
+  data.tar.gz: 55b679cc587279f0491af7aec91878c6acca01c9
 SHA512:
-  metadata.gz: 7fd089829761e7ba27f54cda90169aece0fa6e3f7bb564ad35ca9889b806e2685796cb26836e8ff8295bc4ec42d8aa1ea62a7fc81dad745c98dbd6d6e2dea3d4
-  data.tar.gz: cb2ffc4ae5b0d69538583e4a992787185b5bec827c64df6d7bf15cb619355e30740a929dfb91f7feea9231670bbe07c335557552e9f0658efea454f413b63981
+  metadata.gz: 632d25962bc66acf9b8b015a1e76b85e69a4f7a7b516cc9ea24c411e4b4db6e5280f23145c9beae321cfcd7b835821e86f0d81f6b4fa1731847eb6fa27e90bf7
+  data.tar.gz: 477e19845f08bba51aee292c662e2ec6cad47d814ba683959ec23c7eaf0615e7c32a6b1ebe4b565f036d47bc88b02971f7e83c6cfcb2083c26ef148ffe838ffc

data/CHANGELOG.adoc

@@ -5,10 +5,37 @@
 This document provides a high-level view of the changes to the {project-name} by release.
 For a detailed view of what has changed, refer to the {uri-repo}/commits/master[commit history] on GitHub.
 
+== 1.5.0.alpha.16 (2017-07-30) - @mojavelinux
+
+* add support for xrefstyle attribute (#464)
+* allow page side to be based on physical page number and/or be inverted (#813) (@fap-)
+* fix layout error caused by nested keep together blocks (#791)
+* upgrade prawn-svg to allow generic font names to be mapped in SVG (#777)
+* upgrade prawn-svg to fix issue with dotted lines (#741)
+* upgrade prawn-svg to enable linear gradients (#228)
+* don't attempt to parse text in literal cell (#816)
+* warn if theme variable cannot be resolved; don't replace (#801)
+* number appendix subsections based on appendix number when doctype is book (#627)
+* don't add break hints to URI when using AFM font (#795)
+* add rescue check for scratch document when state is not initialized
+* allow page margin to be a single number; fixes regression introduced by #749
+* check for margin as array, then as numeric, then as string
+* extend version range for prawn-templates (#803)
+* add missing part-title attribute to theming guide (#827)
+* clarify in theming guide that variables are defined in document order
+* clarify that the fallback font is only used when the primary font is a TrueType font
+* add more information about prawn-gmagick to README
+* fix warnings and incompatibility when using Ruby 1.9.3
+* document in README how to install Asciidoctor PDF on Ruby 2.0.0
+* enable Travis CI; configure CI-based deployment to RubyGems.org
+
+{uri-repo}/issues?q=milestone%3Av1.5.0.alpha.16[issues resolved] |
+{uri-repo}/releases/tag/v1.5.0.alpha.16[git tag]
+
 == 1.5.0.alpha.15 (2017-03-27) - @mojavelinux
 
 * fix compatibility with Prawn 2.2.0 (#775)
-* add workaround for TTFunk bug when font table has empty data
+* add workaround for TTFunk bug when font table has empty data (#619, #651)
 * take fallback font into account when calculating width of string (#651)
 * fill and stroke bounds of sidebar across all pages (#259) (@TobiasHector)
 * allow page margin to be set using pdf-page-margin attribute (#749)
@@ -36,6 +63,9 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * document that background images are scaled to fit bounds of page
 * add note in theming guide about using double quoted strings
 
+{uri-repo}/issues?q=milestone%3Av1.5.0.alpha.15[issues resolved] |
+{uri-repo}/releases/tag/v1.5.0.alpha.15[git tag]
+
 == 1.5.0.alpha.14 (2017-02-05) - @mojavelinux
 
 * add support for AsciiDoc table cells (including nested tables) (#6)

data/Gemfile

@@ -1,14 +1,19 @@
 source 'https://rubygems.org'
 
-if (Gem::Version.new RUBY_VERSION) < (Gem::Version.new '2.0.0')
-  gem 'addressable', '2.4.0'
-  gem 'prawn', '1.3.0'
-  gem 'prawn-svg', '0.21.0'
-end
-
 # Look in asciidoctor-pdf.gemspec for runtime and development dependencies
 gemspec
 
+if (ruby_version = Gem::Version.new RUBY_VERSION) < (Gem::Version.new '2.1.0')
+  if ruby_version < (Gem::Version.new '2.0.0')
+    gem 'addressable', '2.4.0'
+    gem 'prawn', '1.3.0'
+    gem 'prawn-svg', '0.21.0'
+  else
+    gem 'prawn', '2.1.0'
+    gem 'prawn-svg', '0.26.0'
+  end
+end
+
 group :examples do
   gem 'rouge', '2.0.7'
   # Add unicode (preferred) or activesupport to transform case of text containing multibyte chars on Ruby < 2.4

data/README.adoc

@@ -1,6 +1,6 @@
 = Asciidoctor PDF: A native PDF converter for AsciiDoc
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v1.5.0.alpha.15, 2017-03-27
+v1.5.0.alpha.16, 2017-07-30
 // Settings:
 :experimental:
 :idprefix:
@@ -121,19 +121,29 @@ To check if you have Ruby available, use the `ruby` command to query the version
 
 [WARNING]
 ====
-By default, Asciidoctor PDF selects the latest version of Prawn to install.
-Since version 2.0.0, Prawn requires Ruby >= 2.0.0 during installation (though it may still work with Ruby 1.9.3 if you get past installation).
-Therefore, to use Asciidoctor PDF with Ruby 1.9.3, you must first explicitly install the following dependencies, including Prawn 1.3.0:
+By default, Asciidoctor PDF automatically installs the latest version of Prawn if you don't already have Prawn installed.
+This will fail on older versions of Ruby.
+To workaround, you need to install certain dependencies first.
 
-  $ gem install prawn --version 1.3.0
-    gem install addressable --version 2.4.0
-    gem install prawn-svg --version 0.21.0
-    gem install prawn-templates --version 0.0.3
+Starting with Prawn 2.0.0, Prawn requires Ruby >= 2.0.0 during installation.
+Therefore, to use Asciidoctor PDF with Ruby 1.9.3, you must first explicitly install the following dependencies to lock the versions:
+
+ $ gem install prawn --version 1.3.0
+   gem install addressable --version 2.4.0
+   gem install prawn-svg --version 0.21.0
+   gem install prawn-templates --version 0.0.3
 
 You can then proceed with installation of Asciidoctor PDF on Ruby 1.9.3.
 
+Starting with Prawn 2.2.0, Prawn requires Ruby >= 2.1.0 during installation.
+Therefore, to use Asciidoctor PDF with Ruby 2.0.0, you must first explicitly install the following dependencies to lock the versions:
+
+ $ gem install prawn --version 2.1.0
+   gem install prawn-svg --version 0.26.0
+   gem install prawn-templates --version 0.0.4
+
 For all other versions of Ruby, you can simply install the Asciidoctor PDF gem.
-It will transitively install all required dependencies.
+It will transitively install the required dependencies.
 ====
 
 === System Encoding
@@ -454,8 +464,9 @@ To perform this work, Asciidoctor delegates to the underlying libraries.
 {uri-prawn-svg}[prawn-svg] brings support for SVG images.
 Without any additional libraries, those are the only supported image file formats.
 
-If you need support for additional file formats, such as GIF or TIFF, you must install the {uri-prawn-gmagick}[prawn-gmagick] Ruby gem.
-prawn-gmagick is an extension for Prawn based on {uri-graphicsmagick}[GraphicsMagick] and brings supports all the formats recognized by that library.
+If you need support for additional image formats, such as GIF, TIFF, or interlaced PNG--and you don't want to convert those images to a supported format--you must install the {uri-prawn-gmagick}[prawn-gmagick] Ruby gem.
+prawn-gmagick is an extension for Prawn based on {uri-graphicsmagick}[GraphicsMagick] that adds support for all the image formats recognized by that library.
+prawn-gmagick has the added benefit of significantly reducing the time it takes to generate a PDF containing a lot of images.
 
 The prawn-gmagick gem uses native extensions to compile against GraphicsMagick.
 This system prerequisite limits installation to Linux and OSX.

data/Rakefile

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('lib/asciidoctor-pdf/version', File.dirname(__FILE__))
+require_relative 'lib/asciidoctor-pdf/version'
 
 require 'rake/clean'
 

data/asciidoctor-pdf.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('lib/asciidoctor-pdf/version', File.dirname(__FILE__))
+require File.expand_path '../lib/asciidoctor-pdf/version', __FILE__
 require 'open3' unless defined? Open3
 
 Gem::Specification.new do |s|
@@ -43,9 +43,9 @@ An extension for Asciidoctor that converts AsciiDoc documents to PDF using the P
   s.add_runtime_dependency 'prawn', '>= 1.3.0', '< 2.3.0'
   s.add_runtime_dependency 'prawn-table', '0.2.2'
   # prawn-templates >= 0.0.5 requires prawn >= 2.2.0, so we must cast a wider net to support Ruby 1.9.3
-  s.add_runtime_dependency 'prawn-templates', '>= 0.0.3', '<= 0.0.5'
+  s.add_runtime_dependency 'prawn-templates', '>= 0.0.3', '<= 0.1.1'
   # prawn-svg >= 0.22.1 requires Ruby >= 2.0.0, so we must cast a wider net to support Ruby 1.9.3
-  s.add_runtime_dependency 'prawn-svg', '>= 0.21.0', '< 0.27.0'
+  s.add_runtime_dependency 'prawn-svg', '>= 0.21.0', '< 0.28.0'
   s.add_runtime_dependency 'prawn-icon', '1.3.0'
   s.add_runtime_dependency 'safe_yaml', '~> 1.0.4'
   s.add_runtime_dependency 'thread_safe', '~> 0.3.6'

data/data/themes/default-theme.yml

@@ -25,7 +25,7 @@ page:
   background_color: ffffff
   layout: portrait
   margin: [0.5in, 0.67in, 0.67in, 0.67in]
-  # margin_inner and margin_outer keys are used for recto/verso print margins when media=press
+  # margin_inner and margin_outer keys are used for recto/verso print margins when media=prepress
   margin_inner: 0.75in
   margin_outer: 0.59in
   size: A4

data/docs/theming-guide.adoc

@@ -201,10 +201,14 @@ Any setting from an enclosing context, such as a sidebar, is skipped.
 === Variables
 
 To save you from having to type the same value in your theme over and over, or to allow you to base one value on another, the theme language supports variables.
-Variables consist of the key name preceded by a dollar (`$`) (e.g., `$base_font_size`).
+Variables consist of the key name preceded by a dollar sign (`$`) (e.g., `$base_font_size`).
 Any qualified key that has already been defined can be referenced in the value of another key.
 (In order words, as soon as the key is assigned, it's available to be used as a variable).
 
+IMPORTANT: Variables are defined from top to bottom (i.e., in document order).
+Therefore, a variable must be defined before it is referenced.
+In other words, the path the variable refers to must be *above* the usage of that variable.
+
 For example, once the following line is processed,
 
 [source,yaml]
@@ -650,9 +654,9 @@ Asciidoctor PDF encodes the content into WINANSI when building the PDF.
 When using the built-in PDF (AFM) fonts on a block of content in your AsciiDoc document, any character that cannot be encoded to WINANSI is replaced with a logic "`not`" glyph (`¬`) and you'll see the following warning in your console:
 
  The following text could not be fully converted to the Windows-1252 character set:
- | <glyph>
+ | <string with unknown glyph>
 
-This behavior differs from the default behavior in Prawn.
+This behavior differs from the default behavior in Prawn, which simply crashes.
 
 For more information about how Prawn handles character encodings for built-in fonts, see https://github.com/prawnpdf/prawn/blob/master/CHANGELOG.md#vastly-improved-handling-of-encodings-for-pdf-built-in-afm-fonts[this note in the Prawn CHANGELOG].
 ****
@@ -765,8 +769,11 @@ This will allow you to use the same font names (aka families) in both your graph
 
 === Fallback Fonts
 
-If one of your fonts is missing a character that is used in a document, such as special symbols, you can tell Asciidoctor PDF to retrieve the character from a fallback font.
-You only need to specify one fallback font...typically one that has a full set of symbols.
+If a TrueType font is missing a character needed to render the document, such as a special symbol, you can have Asciidoctor PDF look for the character in a fallback font.
+You only need to specify a single fallback font, typically one that provides a full set of symbols.
+
+IMPORTANT: The fallback font is only used when the primary font is a TrueType font (i.e., TTF, DFont, TTC).
+Any glyph missing from an AFM font is simply replaced with the "`not`" glyph (`&#172;`).
 
 CAUTION: Using the fallback font slows down PDF generation slightly because it has to analyze every single character.
 It's use is not recommended for large documents.
@@ -817,31 +824,43 @@ font:
 
 TIP: If you are using more than one fallback font, add additional lines to the `fallbacks` key.
 
+Of course, make sure you've configured your theme to use your custom font:
+
+[source,yaml]
+----
+base:
+  font_family: Roboto
+----
+
 That's it!
 Now you're covered.
-You don't need to reference the fallback font anywhere else in your theme file to use it.
+If your custom font is missing a glyph, Asciidoctor PDF will look in your fallback font.
+You don't need to reference the fallback font anywhere else in your theme file.
 
 == Keys
 
 This section lists all the keys that are available when creating a custom theme.
-The keys in this section are organized by category.
+The keys are organized by category.
 Each category represents a common prefix under which the keys are typically nested.
 
-TIP: Keys can be partioned and nested wherever an underscore (`_`) appears in the name.
-This nested structure is flatted when the theme is loaded.
+TIP: Keys can be nested wherever an underscore (`_`) appears in the name.
+This nested structure is for organizational purposes only.
+All keys are flatted when the theme is loaded (e.g., `align` nested under `base` becomes `base_align`).
 
 The converter uses the values of these keys to control how most elements are arranged and styled in the PDF.
 The default values listed in this section get inherited from the https://github.com/asciidoctor/asciidoctor-pdf/blob/master/data/themes/base-theme.yml[base theme].
-(The https://github.com/asciidoctor/asciidoctor-pdf/blob/master/data/themes/default-theme.yml[default theme], which also inherits from the base theme, has a different set of values not shown in this guide).
+
+IMPORTANT: The https://github.com/asciidoctor/asciidoctor-pdf/blob/master/data/themes/default-theme.yml[default theme] has a different set of values which are not shown in this guide.
 
 When creating a theme, all keys are optional.
 Required keys are provided by the base theme.
-Therefore, you only have to assign values to keys you want to customize.
+Therefore, you only have to declare keys that you want to override.
 
 [#keys-page]
 === Page
 
 The keys in this category control the size, margins and background of each page (i.e., canvas).
+We recommended that you define this category before all other categories.
 
 NOTE: The background of the title page can be styled independently.
 See <<Title Page>> for details.
@@ -909,7 +928,9 @@ These margins and used when the value `prepress` is assigned to the `media` docu
 === Base
 
 The keys in this category provide generic theme settings and are often referenced throughout the theme file as variables.
-It's common to define additional keys in this category (e.g., `base_border_radius`) that serve as custom variables to help keep your theme DRY.
+We recommended that you define this category after the page category and before all other categories.
+
+NOTE: While it's common to define additional keys in this category (e.g., `base_border_radius`) to keep your theme DRY, we recommend using <<Custom Variables,custom variables>> instead.
 
 [cols="3,4,5l"]
 |===
@@ -3196,6 +3217,7 @@ The keys in this category control the arrangement and style of running header an
 . The background color spans the width of the page, as does the border when a background color is specified.
 . If the height is not set, the running content at this periphery is disabled.
 . `<side>` can be `recto` (right-hand, odd-numbered pages) or `verso` (left-hand, even-numbered pages).
+Where the page sides fall in relation to the physical or printed page number is controlled using the `pdf-folio-placement` attribute (except when `media=prepress`, which implies `physical`).
 . `<position>` can be `left`, `center` or `right`.
 
 IMPORTANT: You must define a height for the running header or footer, respectively, or it will not be shown.
@@ -3210,13 +3232,14 @@ For example, you can set the font color used for the right-hand column on recto
 
 ==== Attribute References
 
-You can use _any_ attribute defined in your AsciiDoc document in the content of the running header and footer.
+You can use _any_ attribute defined in your AsciiDoc document (such as `doctitle`) in the content of the running header and footer.
 In addition, the following attributes are also available when defining the content keys in the footer:
 
 * page-count
 * page-number
 * document-title
 * document-subtitle
+* part-title
 * chapter-title
 * section-title
 * section-or-chapter-title
@@ -3404,6 +3427,10 @@ These settings override equivalent keys defined in the theme file, where applica
 |https://github.com/prawnpdf/pdf-core/blob/0.6.0/lib/pdf/core/page_geometry.rb#L16-L68[Named size^] {vbar} <<measurement-units,Measurement[width, height]>>
 |:pdf-page-size: 6in x 9in
 
+|pdf-folio-placement
+|virtual {vbar} virtual-inverted {vbar} physical {vbar} physical-inverted
+|:pdf-folio-placement: physical
+
 |pdfmark^[6]^
 |flag (default: _not set_)
 |:pdfmark:
@@ -3471,14 +3498,14 @@ The first page in the document is a recto page.
 
 === Automatic Facing Pages
 
-If a document uses the book doctype, a blank page will be inserted, if necessary, to ensure the following pages are recto-facing pages:
+When converting the book doctype using the prepress media setting, a blank page will be inserted when necessary to ensure the following elements start on a recto page:
 
 * Title page
 * Table of contents
-* First page of body content
+* First page of body
 * Parts and chapters
 
-Other facing pages may be added in the future.
+Other "`facing`" pages may be added in the future.
 
 It's possible to disable the automatic facing feature for a given part or chapter.
 This can be done by adding the nonfacing option to the section node.

data/lib/asciidoctor-pdf/converter.rb

@@ -35,8 +35,8 @@ class Converter < ::Prawn::Document
   register_for 'pdf'
 
   # NOTE require_library doesn't support require_relative and we don't modify the load path for this gem
-  CodeRayRequirePath = ::File.join (::File.dirname __FILE__), 'prawn_ext/coderay_encoder'
-  RougeRequirePath = ::File.join (::File.dirname __FILE__), 'rouge_ext'
+  CodeRayRequirePath = ::File.join((::File.dirname __FILE__), 'prawn_ext/coderay_encoder')
+  RougeRequirePath = ::File.join((::File.dirname __FILE__), 'rouge_ext')
 
   AsciidoctorVersion = ::Gem::Version.create ::Asciidoctor::VERSION
   AdmonitionIcons = {
@@ -63,10 +63,8 @@ class Converter < ::Prawn::Document
   TabRx = /\t/
   TabIndentRx = /^\t+/
   NoBreakSpace = %(\u00a0)
-  NarrowSpace = %(\u2009)
   NarrowNoBreakSpace = %(\u202f)
   ZeroWidthSpace = %(\u200b)
-  HairSpace = %(\u200a)
   DummyText = %(\u0000)
   DotLeaderTextDefault = '. '
   EmDash = %(\u2014)
@@ -169,7 +167,7 @@ class Converter < ::Prawn::Document
     # NOTE on_page_create is called within a float context
     # NOTE on_page_create is not called for imported pages, front and back cover pages, and other image pages
     on_page_create do
-      # NOTE we assume here that physical page number reflects page side
+      # NOTE we assume in prepress that physical page number reflects page side
       if @media == 'prepress' && (next_page_margin = @page_margin_by_side[page_side]) != page_margin
         set_page_margin next_page_margin
       end
@@ -226,7 +224,7 @@ class Converter < ::Prawn::Document
     add_outline doc, num_toc_levels, toc_page_nums, num_front_matter_pages
     # TODO allow document (or theme) to override initial view magnification
     # NOTE add 1 to page height to force initial scroll to 0; a nil value also seems to work
-    catalog.data[:OpenAction] = dest_fit_horizontally (page_height + 1), state.pages[0] if state.pages.size > 0
+    catalog.data[:OpenAction] = dest_fit_horizontally((page_height + 1), state.pages[0]) if state.pages.size > 0
     catalog.data[:ViewerPreferences] = { DisplayDocTitle: true }
 
     layout_cover_page :back, doc
@@ -280,6 +278,11 @@ class Converter < ::Prawn::Document
 
   def build_pdf_options doc, theme
     case (page_margin = (doc.attr 'pdf-page-margin') || theme.page_margin)
+    when ::Array
+      page_margin = page_margin[0..3] if page_margin.length > 4
+      page_margin = page_margin.map {|v| ::Numeric === v ? v : (str_to_pt v.to_s) }
+    when ::Numeric
+      page_margin = [page_margin]
     when ::String
       if page_margin.empty?
         page_margin = nil
@@ -295,9 +298,6 @@ class Converter < ::Prawn::Document
       else
         page_margin = [(str_to_pt page_margin)]
       end
-    when ::Array
-      page_margin = page_margin[0..3] if page_margin.length > 4
-      page_margin = page_margin.map {|v| ::Numeric === v ? v : (str_to_pt v.to_s) }
     else
       page_margin = nil
     end
@@ -386,7 +386,7 @@ class Converter < ::Prawn::Document
   end
 
   def convert_section sect, opts = {}
-    if sect.special && sect.sectname == 'abstract'
+    if sect.sectname == 'abstract'
       # HACK cheat a bit to hide this section from TOC; TOC should filter these sections
       sect.context = :open
       return convert_abstract sect
@@ -423,7 +423,7 @@ class Converter < ::Prawn::Document
       end
     end
 
-    sect.special && sect.sectname == 'index' ? (convert_index_section sect) : (convert_content_for_block sect)
+    sect.sectname == 'index' ? (convert_index_section sect) : (convert_content_for_block sect)
     sect.set_attr 'pdf-page-end', page_number
   end
 
@@ -1333,7 +1333,7 @@ class Converter < ::Prawn::Document
       bg_color_override = formatter.background_color
       source_string, conum_mapping = extract_conums source_string
       # NOTE trailing endline is added to address https://github.com/jneen/rouge/issues/279
-      fragments = formatter.format (lexer.lex %(#{source_string}#{LF}), lexer_opts), formatter_opts
+      fragments = formatter.format((lexer.lex %(#{source_string}#{LF}), lexer_opts), formatter_opts)
       # NOTE cleanup trailing endline (handled in rouge_ext/formatters/prawn instead)
       #fragments[-1][:text] == LF ? fragments.pop : fragments[-1][:text].chop!
       conum_mapping ? (restore_conums fragments, conum_mapping) : fragments
@@ -1366,7 +1366,7 @@ class Converter < ::Prawn::Document
             remaining_height = box_height - caption_height
             i = 0
             while remaining_height > 0
-              start_new_page if (started_new_page = i > 0)
+              advance_page if (started_new_page = i > 0)
               fill_height = [remaining_height, cursor].min
               bounding_box [0, cursor], width: bounds.width, height: fill_height do
                 theme_fill_and_stroke_bounds :code, background_color: bg_color_override
@@ -1595,7 +1595,7 @@ class Converter < ::Prawn::Document
         when :literal
           # FIXME core should not substitute in this case
           cell_data[:content] = preserve_indentation((cell.instance_variable_get :@text), (node.document.attr 'tabsize'))
-          cell_data[:inline_format] = false
+          # NOTE the absence of the inline_format option implies it's disabled
           # QUESTION should we use literal_font_*, code_font_*, or introduce another category?
           cell_data[:font] = theme.code_font_family
           if (val = theme.code_font_size)
@@ -1880,26 +1880,24 @@ class Converter < ::Prawn::Document
       end
     when :xref
       # NOTE non-nil path indicates this is an inter-document xref that's not included in current document
-      if (path = node.attr 'path', nil, false)
+      if (path = node.attributes['path'])
         # NOTE we don't use local as that doesn't work on the web
         # NOTE for the fragment to work in most viewers, it must be #page=<N> <= document this!
         %(<a href="#{node.target}">#{node.text || path}</a>)
-      else
-        if (refid = node.attr 'refid', nil, false)
-          anchor = derive_anchor_from_id refid
-          # NOTE reference table is not comprehensive (we don't yet catalog all inline anchors)
-          if (reftext = node.document.references[:ids][refid])
-            %(<a anchor="#{anchor}">#{node.text || reftext}</a>)
+      elsif (refid = node.attributes['refid'])
+        unless (text = node.text)
+          if (refs = node.document.references[:refs])
+            if ::Asciidoctor::AbstractNode === (ref = refs[refid])
+              text = ref.xreftext((@xrefstyle ||= (node.document.attr 'xrefstyle')))
+            end
           else
-            # NOTE we don't yet catalog all inline anchors, so we can't warn here (maybe after conversion is complete)
-            #source = $VERBOSE ? %( in source:\n#{node.parent.lines * "\n"}) : nil
-            #warn %(asciidoctor: WARNING: reference '#{refid}' not found#{source})
-            #%[(see #{node.text || %([#{refid}])})]
-            %(<a anchor="#{anchor}">#{node.text || "[#{refid}]"}</a>)
+            # Asciidoctor < 1.5.6
+            text = node.document.references[:ids][refid]
           end
-        else
-          %(<a anchor="#{node.document.attr 'pdf-anchor'}">#{node.text || '[^top]'}</a>)
         end
+        %(<a anchor="#{derive_anchor_from_id refid}">#{text || "[#{refid}]"}</a>)
+      else
+        %(<a anchor="#{node.document.attr 'pdf-anchor'}">#{node.text || '[^top]'}</a>)
       end
     when :ref
       # NOTE destination is created inside callback registered by FormattedTextTransform#build_fragment
@@ -2132,26 +2130,26 @@ class Converter < ::Prawn::Document
         # FIXME delegate to method to convert page % to y value
         @y = title_top
       end
-      move_down (@theme.title_page_title_margin_top || 0)
+      move_down(@theme.title_page_title_margin_top || 0)
       theme_font :title_page_title do
         layout_heading doctitle.main,
           align: title_align,
           margin: 0,
           line_height: @theme.title_page_title_line_height
       end
-      move_down (@theme.title_page_title_margin_bottom || 0)
+      move_down(@theme.title_page_title_margin_bottom || 0)
       if doctitle.subtitle
-        move_down (@theme.title_page_subtitle_margin_top || 0)
+        move_down(@theme.title_page_subtitle_margin_top || 0)
         theme_font :title_page_subtitle do
           layout_heading doctitle.subtitle,
             align: title_align,
             margin: 0,
             line_height: @theme.title_page_subtitle_line_height
         end
-        move_down (@theme.title_page_subtitle_margin_bottom || 0)
+        move_down(@theme.title_page_subtitle_margin_bottom || 0)
       end
       if doc.attr? 'authors'
-        move_down (@theme.title_page_authors_margin_top || 0)
+        move_down(@theme.title_page_authors_margin_top || 0)
         # TODO provide an API in core to get authors as an array
         authors = (1..(doc.attr 'authorcount', 1).to_i).map {|idx|
           doc.attr(idx == 1 ? 'author' : %(author_#{idx}))
@@ -2162,11 +2160,11 @@ class Converter < ::Prawn::Document
             margin: 0,
             normalize: false
         end
-        move_down (@theme.title_page_authors_margin_bottom || 0)
+        move_down(@theme.title_page_authors_margin_bottom || 0)
       end
       revision_info = [(doc.attr? 'revnumber') ? %(#{doc.attr 'version-label'} #{doc.attr 'revnumber'}) : nil, (doc.attr 'revdate')].compact
       unless revision_info.empty?
-        move_down (@theme.title_page_revision_margin_top || 0)
+        move_down(@theme.title_page_revision_margin_top || 0)
         revision_text = revision_info * (@theme.title_page_revision_delimiter || ', ')
         theme_font :title_page_revision do
           layout_prose revision_text,
@@ -2174,7 +2172,7 @@ class Converter < ::Prawn::Document
             margin: 0,
             normalize: false
         end
-        move_down (@theme.title_page_revision_margin_bottom || 0)
+        move_down(@theme.title_page_revision_margin_bottom || 0)
       end
     end
   end
@@ -2670,15 +2668,23 @@ class Converter < ::Prawn::Document
 
     pagenums_enabled = doc.attr? 'pagenums'
     attribute_missing_doc = doc.attr 'attribute-missing'
-    repeat (content_start_page..page_count), dynamic: true do
+    case @media == 'prepress' ? 'physical' : (doc.attr 'pdf-folio-placement')
+    when 'physical'
+      folio_basis, invert_folio = :physical, false
+    when 'physical-inverted'
+      folio_basis, invert_folio = :physical, true
+    when 'virtual-inverted'
+      folio_basis, invert_folio = :virtual, true
+    else
+      folio_basis, invert_folio = :virtual, false
+    end
+    repeat((content_start_page..page_count), dynamic: true) do
       # NOTE don't write on pages which are imported / inserts (otherwise we can get a corrupt PDF)
       next if page.imported_page?
       pgnum_label = page_number - skip
-      # QUESTION should we respect physical page number or just look at the content page number?
-      side = page_side pgnum_label
+      side = page_side((folio_basis == :physical ? page_number : pgnum_label), invert_folio)
       # FIXME we need to have a content setting for chapter pages
-      content_by_position = content_dict[side]
-      colspec_by_position = colspec_dict[side]
+      content_by_position, colspec_by_position = content_dict[side], colspec_dict[side]
       # TODO populate chapter-number
       # TODO populate numbered and unnumbered chapter and section titles
       doc.set_attr 'page-number', pgnum_label.to_s if pagenums_enabled
@@ -2894,13 +2900,14 @@ class Converter < ::Prawn::Document
   # - 0 when side == :top
   # - @theme.vertical_spacing when side == :bottom
   def theme_margin category, side
-    margin (@theme[%(#{category}_margin_#{side})] || (side == :bottom ? @theme.vertical_spacing : 0)), side
+    margin((@theme[%(#{category}_margin_#{side})] || (side == :bottom ? @theme.vertical_spacing : 0)), side)
   end
 
   def theme_font category, opts = {}
     result = nil
     # TODO inheriting from generic category should be an option
-    if (level = opts[:level])
+    if opts.key? :level
+      level = opts[:level]
       family = @theme[%(#{category}_h#{level}_font_family)] || @theme[%(#{category}_font_family)] || @theme.base_font_family
       size = @theme[%(#{category}_h#{level}_font_size)] || @theme[%(#{category}_font_size)] || @theme.base_font_size
       style = @theme[%(#{category}_h#{level}_font_style)] || @theme[%(#{category}_font_style)]
@@ -3148,10 +3155,10 @@ class Converter < ::Prawn::Document
 
   # Resolve the system path of the specified image path.
   #
-  # Resolve and normalize the absolute system path of the specified image. If
-  # the image_path argument is not specified, the path is read from the target
-  # attribute of the specified document node. Resolve the path relative to the
-  # imagesdir if the relative_to_imagesdir option is specified (default: true).
+  # Resolve and normalize the absolute system path of the specified image,
+  # taking into account the imagesdir attribute. If an image path is not
+  # specified, the path is read from the target attribute of the specified
+  # document node.
   #
   # If the target is a URI and the allow-uri-read attribute is set on the
   # document, read the file contents to a temporary file and return the path to
@@ -3305,6 +3312,7 @@ class Converter < ::Prawn::Document
     scheme, address = uri.split UriSchemeBoundaryRx, 2
     address, scheme = scheme, address unless address
     address = address.gsub UriBreakCharsRx, UriBreakCharRepl
+    # NOTE require at least two characters after a break
     address.slice!(-2) if address[-2] == ZeroWidthSpace
     %(#{scheme}#{address})
   end

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

@@ -112,8 +112,12 @@ module Extensions
 
   # Returns the side the current page is facing, :recto or :verso.
   #
-  def page_side pgnum = nil
-    (recto_page? pgnum) ? :recto : :verso
+  def page_side pgnum = nil, invert = nil
+    if invert
+      (recto_page? pgnum) ? :verso : :recto
+    else
+      (recto_page? pgnum) ? :recto : :verso
+    end
   end
 
   # Returns whether the page is a recto page.
@@ -234,17 +238,17 @@ module Extensions
       super @font_size
     elsif String === points
       if points.end_with? 'rem'
-        super (@theme.base_font_size * points.to_f)
+        super(@theme.base_font_size * points.to_f)
       elsif points.end_with? 'em'
-        super (@font_size * points.to_f)
+        super(@font_size * points.to_f)
       elsif points.end_with? '%'
-        super (@font_size * (points.to_f / 100.0))
+        super(@font_size * (points.to_f / 100.0))
       else
         super points.to_f
       end
     # FIXME HACK assume em value
     elsif points < 1
-      super (@font_size * points)
+      super(@font_size * points)
     else
       super points
     end
@@ -693,14 +697,10 @@ module Extensions
     # prawn-templates sets text_rendering_mode to :unknown, which breaks running content; revert
     @text_rendering_mode = prev_text_rendering_mode
     if opts.fetch :advance, true
-      if last_page?
-        # NOTE set page size & layout explicitly in case imported page differs
-        # I'm not sure it's right to start a new page here, but unfortunately there's no other
-        # way atm to prevent the size & layout of the imported page from affecting subsequent pages
-        start_new_page size: prev_page_size, layout: prev_page_layout
-      else
-        go_to_page page_number + 1
-      end
+      # NOTE set page size & layout explicitly in case imported page differs
+      # I'm not sure it's right to start a new page here, but unfortunately there's no other
+      # way atm to prevent the size & layout of the imported page from affecting subsequent pages
+      advance_page size: prev_page_size, layout: prev_page_layout
     end
     nil
   end
@@ -739,8 +739,8 @@ module Extensions
   # This method is a smarter version of start_new_page. It calls start_new_page
   # if the current page is the last page of the document. Otherwise, it simply
   # advances to the next existing page.
-  def advance_page
-    last_page? ? start_new_page : (go_to_page page_number + 1)
+  def advance_page opts = {}
+    last_page? ? (start_new_page opts) : (go_to_page page_number + 1)
   end
 
   # Start a new page without triggering the on_page_create callback
@@ -783,12 +783,15 @@ module Extensions
 
   def scratch?
     (@_label ||= (state.store.info.data[:Scratch] ? :scratch : :primary)) == :scratch
+  rescue
+    false # NOTE this method may get called before the state is initialized
   end
   alias :is_scratch? :scratch?
 
   # TODO document me
   def dry_run &block
     scratch = get_scratch_document
+    # QUESTION should we use scratch.advance_page instead?
     scratch.start_new_page
     start_page_number = scratch.page_number
     start_y = scratch.y
@@ -819,7 +822,7 @@ module Extensions
     # NOTE technically, if we're at the page top, we don't even need to do the
     # dry run, except several uses of this method rely on the calculated height
     if total_height > available_space && !at_page_top? && total_height <= effective_page_height
-      start_new_page
+      advance_page
       started_new_page = true
     else
       started_new_page = false

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

@@ -1,5 +1,13 @@
 class Prawn::Font::AFM
-  undef_method :normalize_encoding
+  FALLBACK_CHARS = {
+    %(\u200b) => '',
+    %(\u202f) => %(\u00a0),
+    %(\u2009) => ' ',
+    %(\u25e6) => '-',
+    %(\u25aa) => %(\u00b7)
+  }
+
+  remove_method :normalize_encoding
 
   # Patch normalize_encoding method to handle conversion more gracefully.
   #
@@ -7,7 +15,7 @@ class Prawn::Font::AFM
   # replaced with the logic "not" symbol and a warning is issued identifying
   # the text that cannot be converted.
   def normalize_encoding text
-    text.encode 'windows-1252'
+    text.encode 'windows-1252', fallback: FALLBACK_CHARS
   rescue ::Encoding::UndefinedConversionError
     warn 'The following text could not be fully converted to the Windows-1252 character set:'
     warn %(#{text.gsub(/^/, '| ').rstrip})

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((::IO.read file), opts)
     else
       _initial_image file, opts
     end

data/lib/asciidoctor-pdf/theme_loader.rb

@@ -135,9 +135,21 @@ class ThemeLoader
   def expand_vars expr, vars
     if (idx = (expr.index '$'))
       if idx == 0 && expr =~ LoneVariableRx
-        vars[$1]
+        if vars.respond_to? $1
+          vars[$1]
+        else
+          warn %(asciidoctor: WARNING: unknown variable reference in PDF theme: $#{$1})
+          expr
+        end
       else
-        expr.gsub(VariableRx) { vars[$1] }
+        expr.gsub(VariableRx) {
+          if vars.respond_to? $1
+            vars[$1]
+          else
+            warn %(asciidoctor: WARNING: unknown variable reference in PDF theme: $#{$1})
+            $&
+          end
+        }
       end
     else
       expr

data/lib/asciidoctor-pdf/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
 module Pdf
-  VERSION = '1.5.0.alpha.15'
+  VERSION = '1.5.0.alpha.16'
 end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-pdf
 version: !ruby/object:Gem::Version
-  version: 1.5.0.alpha.15
+  version: 1.5.0.alpha.16
 platform: ruby
 authors:
 - Dan Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -82,7 +82,7 @@ dependencies:
         version: 0.0.3
     - - "<="
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -92,7 +92,7 @@ dependencies:
         version: 0.0.3
     - - "<="
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: prawn-svg
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +102,7 @@ dependencies:
         version: 0.21.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.27.0
+        version: 0.28.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -112,7 +112,7 @@ dependencies:
         version: 0.21.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.27.0
+        version: 0.28.0
 - !ruby/object:Gem::Dependency
   name: prawn-icon
   requirement: !ruby/object:Gem::Requirement
@@ -169,10 +169,8 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.5.3
-description: 'An extension for Asciidoctor that converts AsciiDoc documents to PDF
-  using the Prawn PDF library.
-
-'
+description: |
+  An extension for Asciidoctor that converts AsciiDoc documents to PDF using the Prawn PDF library.
 email: dan@opendevise.com
 executables:
 - asciidoctor-pdf
@@ -280,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Converts AsciiDoc documents to PDF using Prawn