asciidoctor-pdf 2.0.7 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f836f6c86c31a3bbd792bba4608f397422361bcc5b297355eccab266a3a5ac0b
-  data.tar.gz: b31b434d0d7bede025b4f3c25e71a518f120a66840dfb7df72308d17fda9bd8e
+  metadata.gz: cd47554913fab2e3f8002491a92c430e0dbfe48b9177705470ffa7c64155289b
+  data.tar.gz: 580c0c9e6a46e5614927f42c4ad309e303dd69681bf10ddb674241cd930e6b31
 SHA512:
-  metadata.gz: 84899cfb74ce8ef2c97111d585e73529318c3f0a44756f75674338f58c1d46693925fe1f9d42b9666f07d8a1bed68f606ec3ec2b664816d0c92998494e90a39a
-  data.tar.gz: a50053c502cf572929c49802208e18faa9f1e5bf0a2f3e47972c3863fafa3c43e157425e7b3c5a1ad12cc0e301d8e461a108907e48f5b80aaa0f05938dc2e6a2
+  metadata.gz: 326e87435e664dde2e944b878d2c5c9a5b71cfd285da78115331a8cd14e20f2aaa0cb2b81779bc99ca8642df004ef03f60386a971e9176eb03d17755a9db951b
+  data.tar.gz: 7d7cd662e4bbe5df6d10c057e2f00a1a1c800f0e5a3e4f7731c94b657b0bf6ec51599e88d42dbd806a1e4bf991e54282c4efb820b0d39912ed34a74d25f89ff4

data/CHANGELOG.adoc

@@ -5,6 +5,26 @@
 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 {url-repo}/commits/main[commit history] on GitHub.
 
+== 2.0.8 (2022-06-08) - @mojavelinux
+
+Improvements::
+
+* encapsulate logic to adjust column box inside float and dry run
+* automatically set height on column box if not specified; update value automatically when reflowing margins
+
+Bug Fixes::
+
+* correctly compute value of to cursor on extent when column box starts below top of page (#2230)
+* fix crash in `ColumnBox#move_past_bottom` when `:reflow_margins` option is not set
+* fix x position of SVG when advanced to next column of column box
+* `at_page_top?` should consider top of column box to be top of page
+* prevent SVG image taller than column from being advanced to next column
+* don't push section that follows index section in article to new page if last page of index does not extend to bottom of page
+
+=== Details
+
+{url-repo}/releases/tag/v2.0.8[git tag] | {url-repo}/compare/v2.0.7\...v2.0.8[full diff]
+
 == 2.0.7 (2022-06-03) - @mojavelinux
 
 Improvements::

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]>
-v2.0.7, 2022-06-03
+v2.0.8, 2022-06-08
 // Settings:
 :experimental:
 :idprefix:
@@ -24,7 +24,7 @@ endif::[]
 :project-handle: asciidoctor-pdf
 // Variables:
 :release-line: 2.0.x
-:release-version: 2.0.7
+:release-version: 2.0.8
 // URLs:
 :url-gem: https://rubygems.org/gems/asciidoctor-pdf
 :url-project: https://github.com/asciidoctor/asciidoctor-pdf
@@ -62,7 +62,7 @@ Asciidoctor PDF converts an AsciiDoc document directly to a PDF document.
 The style and layout of the PDF are controlled by a dedicated theme file.
 To the degree possible, Asciidoctor PDF supports all the features of AsciiDoc that are supported by Asciidoctor.
 It also provides {url-project-docs}/features/[PDF-specific features].
-However, there are {url-project-docs}/features/#limitations[certain limits] imposed by the PDF format and the PDF library this extension uses.
+However, there are {url-project-docs}/features/#limitations[certain limitations] imposed by the PDF format and the PDF library this extension uses.
 
 Asciidoctor PDF uses the Prawn gem and Prawn's extensions, such as prawn-svg and prawn-table, to generate a PDF document.
 {url-prawn}[Prawn] is a general purpose PDF generator for Ruby that features high-level APIs for common needs like setting up the page and inserting images and low-level APIs for positioning and rendering text and graphics.
@@ -182,7 +182,7 @@ Asciidoctor creates the output file in the same directory as the input file by d
 Open the [.path]_basic-example.pdf_ file with a PDF viewer to see the result.
 
 .Example PDF document rendered in a PDF viewer
-image::docs/modules/ROOT/images/basic-example-pdf-screenshot.png[Screenshot of PDF document,960,540,pdfwidth=100%]
+image::docs/modules/ROOT/images/basic-example-pdf-screenshot.png[Screenshot of PDF document,960,pdfwidth=100%]
 
 For more information about how to use Asciidoctor PDF and PDF-specific AsciiDoc syntax, see the {url-project-docs}/[Asciidoctor PDF documentation].
 

data/lib/asciidoctor/pdf/converter.rb

@@ -162,7 +162,6 @@ module Asciidoctor
         doc.attributes['outline'] = '' unless (doc.attribute_locked? 'outline') || ((doc.instance_variable_get :@attributes_modified).include? 'outline')
         doc.attributes['outline-title'] = '' unless (doc.attribute_locked? 'outline-title') || ((doc.instance_variable_get :@attributes_modified).include? 'outline-title')
         doc.attributes['pagenums'] = '' unless (doc.attribute_locked? 'pagenums') || ((doc.instance_variable_get :@attributes_modified).include? 'pagenums')
-        #assign_missing_section_ids doc
 
         on_page_create(&(method :init_page))
 
@@ -703,6 +702,7 @@ module Asciidoctor
       def convert_index_section node
         space_needed_for_category = @theme.description_list_term_spacing + (2 * (height_of_typeset_text 'A'))
         pagenum_sequence_style = node.document.attr 'index-pagenum-sequence-style'
+        end_cursor = nil
         column_box [0, cursor], columns: @theme.index_columns, width: bounds.width, reflow_margins: true, spacer: @theme.index_column_gap do
           @index.categories.each do |category|
             bounds.move_past_bottom if space_needed_for_category > cursor
@@ -714,7 +714,10 @@ module Asciidoctor
             category.terms.each {|term| convert_index_list_item term, pagenum_sequence_style }
             @theme.prose_margin_bottom > cursor ? bounds.move_past_bottom : (move_down @theme.prose_margin_bottom)
           end
+          end_cursor = cursor if bounds.current_column == 0
         end
+        # Q: could we move this logic into column_box?
+        move_cursor_to end_cursor if end_cursor
         nil
       end
 
@@ -1752,6 +1755,7 @@ module Asciidoctor
               if (rendered_h = svg_size.output_height) > (available_h = cursor - caption_h)
                 unless pinned || at_page_top?
                   advance_page
+                  (svg_obj.options[:at] = svg_obj.position)[0] += bounds.left if ColumnBox === bounds
                   available_h = cursor - caption_h
                 end
                 rendered_w = (svg_obj.resize height: (rendered_h = available_h)).output_width if rendered_h > available_h

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

@@ -1,20 +1,35 @@
 # frozen_string_literal: true
 
 Prawn::Document::ColumnBox.prepend (Module.new do
-  def absolute_bottom
-    stretchy? ? @parent.absolute_bottom : super
-  end
+  attr_accessor :current_column
 
   def move_past_bottom
     (doc = @document).y = @y
     return if (@current_column = (@current_column + 1) % @columns) > 0
-    @y = (par = @parent).absolute_top if @reflow_margins
+    par = @parent
+    if (reset_y = @reflow_margins) && (reset_y == true || reset_y > doc.page_number)
+      @y = par.absolute_top
+      @height = par.height unless stretchy?
+    end
     initial_margins = doc.page.margins
     par.move_past_bottom
     if doc.page.margins != initial_margins
-      doc.bounds = self.class.new doc, par, (margin_box = doc.margin_box).absolute_top_left,
-        columns: @columns, reflow_margins: true, spacer: @spacer, width: margin_box.width
+      doc.bounds = self.class.new doc, par, [(margin_box = doc.margin_box).absolute_left, @y],
+        columns: @columns, reflow_margins: @reflow_margins, spacer: @spacer, width: margin_box.width, height: @height
+    end
+    nil
+  end
+
+  # Rearranges the column box into a single column, where the original columns are in a single file. Used
+  # for the purpose of computing the extent of content in a scratch document.
+  def single_file
+    if @reflow_margins && @parent.absolute_top > @y && @columns > @current_column + 1
+      # defer reflow margins until all columns on current page have been exhausted
+      @reflow_margins = @document.page_number + (@columns - @current_column)
     end
+    @width = bare_column_width
+    @columns = 1
+    @current_column = 0
     nil
   end
 end)

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

@@ -251,16 +251,17 @@ module Asciidoctor
       # Returns whether the cursor is at the top of the page (i.e., margin box).
       #
       def at_page_top?
-        @y == @margin_box.absolute_top
+        @y == (ColumnBox === bounds ? bounds : @margin_box).absolute_top
       end
 
       # Prevents at_page_top? from returning true while yielding to the specified block.
       #
       def conceal_page_top
-        @margin_box.instance_variable_set :@y, (old_top = @margin_box.absolute_top) + 0.0001
+        old_top = (outer_bounds = ColumnBox === bounds ? bounds : @margin_box).absolute_top
+        outer_bounds.instance_variable_set :@y, old_top + 0.0001
         yield
       ensure
-        @margin_box.instance_variable_set :@y, old_top
+        outer_bounds.instance_variable_set :@y, old_top
       end
 
       # Returns whether the current page is the last page in the document.
@@ -560,11 +561,11 @@ module Asciidoctor
       def float
         original_page_number = page_number
         original_y = y
-        original_column = bounds.instance_variable_get :@current_column if ColumnBox === bounds
+        original_column = bounds.current_column if ColumnBox === bounds
         yield
         go_to_page original_page_number unless page_number == original_page_number
         self.y = original_y
-        bounds.instance_variable_set :@current_column, original_column if original_column
+        bounds.current_column = original_column if original_column
       end
 
       # Short-circuits the call to the built-in move_up operation
@@ -721,6 +722,12 @@ module Asciidoctor
         end
       end
 
+      # Wraps the column_box method and automatically sets the height unless the :height option is specified.
+      def column_box point, options, &block
+        options[:height] = cursor unless options.key? :height
+        super
+      end
+
       # A flowing version of bounding_box. If the content runs to another page, the cursor starts at
       # the top of the page instead of from the original cursor position. Similar to span, except
       # the :position option is limited to a numeric value and additional options are passed through
@@ -1146,10 +1153,7 @@ module Asciidoctor
         scratch_pdf.bounds = bounds.dup.tap do |bounds_copy|
           bounds_copy.instance_variable_set :@document, scratch_pdf
           bounds_copy.instance_variable_set :@parent, saved_bounds
-          if ColumnBox === bounds_copy
-            bounds_copy.instance_variable_set :@width, bounds_copy.bare_column_width
-            bounds_copy.instance_variable_set :@current_column, (bounds_copy.instance_variable_set :@columns, 1) - 1
-          end
+          bounds_copy.single_file if ColumnBox === bounds_copy
         end
         scratch_pdf.move_cursor_to cursor unless (scratch_start_at_top = keep_together || pages_advanced > 0 || at_page_top?)
         scratch_start_cursor = scratch_pdf.cursor

data/lib/asciidoctor/pdf/theme_loader.rb

@@ -69,7 +69,7 @@ module Asciidoctor
       # NOTE: base theme is loaded "as is" (no post-processing)
       def self.load_base_theme
         ::File.open BaseThemePath, mode: 'r:UTF-8' do |io|
-          (::OpenStruct.new ::YAML.safe_load io, aliases: true, filename: BaseThemePath).tap {|theme| theme.__dir__ = ThemesDir }
+          (::OpenStruct.new ::YAML.safe_load io, filename: BaseThemePath).tap {|theme| theme.__dir__ = ThemesDir }
         end
       end
 

data/lib/asciidoctor/pdf/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module PDF
-    VERSION = '2.0.7'
+    VERSION = '2.0.8'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-pdf
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.8
 platform: ruby
 authors:
 - Dan Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-03 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor