asciidoctor-pdf 1.5.0.alpha.4 → 1.5.0.alpha.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73e7e92814ff51684ded60ff7a193bad01bccdca
-  data.tar.gz: 72f6cdbb47f6af5520df5f62d23f60760dac57ab
+  metadata.gz: 3ddd0f5ebfe16661dfd20e0ef1718ea6aaa7f9fb
+  data.tar.gz: 05a6512716b3f7f203c7ebb14e6774385eaca13a
 SHA512:
-  metadata.gz: 78a6e3b0d72c21db30dc9545fbe1f91c6467bf7660910fa2461f3e3487658f87214d524401629d0cc0fb6111e433d6af17570cd23970dc9a4983e942e987ebe6
-  data.tar.gz: d468f5310e4589bfee6292fa9ac40c5b39b9498135a44f03a2cd5d2706b20cf06cbeb053fd6b5b3f561ab3767a3716ce009efbf36be97fde14ea706ef65fbb98
+  metadata.gz: 83698c58c5acf41e3c38e8d0c4657afe51d2aa99001d2bc278a2faefa42227534d66353aa80760d0e6ab669c30b879384599025bf97c72da730878cef0655cbc
+  data.tar.gz: a30d39c1ae441ebe4a3e2042343b2a8bb75cbbac931a2e9d4622692283dc09d928195b9770b314b84e96cd92dc5f42c99ac870588e38c93d21ff7d494826c786

data/README.adoc

@@ -98,6 +98,11 @@ The {project-name} project is published in pre-release on RubyGems.org.
 You can either install the pre-release version using the following command:
 
  $ gem install --pre asciidoctor-pdf
+ 
+If you want to syntax highlight source listings, you'll also want to install CodeRay or Pygments.
+To be safe, go ahead and install both gems:
+
+ $ gem install coderay pygments.rb
 
 Assuming all the required gems install properly, verify you can run the +asciidoctor-pdf+ script:
 
@@ -204,7 +209,10 @@ Converting to PDF is a simple as running the +./bin/asciidoctor-pdf+ script usin
  $ ruby ./bin/asciidoctor-pdf example.adoc
 
 When the script completes, you should see the file [file]_example.pdf_ in the same directory.
-Open that file with a PDF viewer to see the result.
+
+IMPORTANT: You'll need to the `coderay` gem installed to run this example since it uses the `source-highlighter` attribute with the value of `coderay`.
+
+Open the [file]_example.pdf_ file with a PDF viewer to see the result.
 
 .Example PDF document rendered in a PDF viewer
 image::examples/example-pdf-screenshot.png[Screenshot of PDF document,width=800,scaledwidth=100%]

data/examples/edge-cases.adoc

@@ -0,0 +1,60 @@
+= Edge Cases
+:doctype: book
+
+== Long code listing
+
+Here's a long listing block that spans multiple pages.
+
+.Long listing
+----
+Line 1
+Line 2
+Line 3
+Line 4
+Line 5
+Line 6
+Line 7
+Line 8
+Line 9
+Line 10
+Line 11
+Line 12
+Line 13
+Line 14
+Line 15
+Line 16
+Line 17
+Line 18
+Line 19
+Line 20
+Line 21
+Line 22
+Line 23
+Line 24
+Line 25
+Line 26
+Line 27
+Line 28
+Line 29
+Line 30
+Line 31
+Line 32
+Line 33
+Line 34
+Line 35
+Line 36
+Line 37
+Line 38
+Line 39
+Line 40
+Line 41
+Line 42
+Line 43
+Line 44
+Line 45
+Line 46
+Line 47
+Line 48
+Line 49
+Line 50
+----

data/lib/asciidoctor-pdf/asciidoctor_ext/section.rb

@@ -8,7 +8,7 @@ class Asciidoctor::Section
         @is_numbered = true
         @cached_numbered_title = %(#{sectnum} #{title})
         @cached_formal_numbered_title = if slevel == 1 && @document.doctype == 'book'
-          %(Chapter #{@cached_numbered_title})
+          %(#{@document.attr 'chapter-label', 'Chapter'} #{@cached_numbered_title}).lstrip
         else
           @cached_numbered_title
         end

data/lib/asciidoctor-pdf/converter.rb

@@ -8,14 +8,9 @@ require 'prawn/templates'
 require_relative 'prawn_ext'
 require_relative 'pdfmarks'
 require_relative 'asciidoctor_ext'
-require_relative 'implicit_header_processor'
 require_relative 'theme_loader'
 require_relative 'roman_numeral'
 
-Asciidoctor::Extensions.register :pdf do
-  include_processor Asciidoctor::Pdf::ImplicitHeaderProcessor if @document.backend == 'pdf'
-end
-
 module Asciidoctor
 module Pdf
 class Converter < ::Prawn::Document
@@ -109,19 +104,33 @@ class Converter < ::Prawn::Document
     layout_title_page doc
 
     start_new_page
+
+    toc_start_page_num = page_number
+    num_toc_levels = (doc.attr 'toclevels', 2).to_i
+    if doc.attr? 'toc'
+      toc_page_nums = ()
+      dry_run do
+        toc_page_nums = layout_toc doc, num_toc_levels, 1
+      end
+      # reserve pages for the toc
+      toc_page_nums.each do
+        start_new_page
+      end
+    end
+
+    num_front_matter_pages = page_number - 1
     font @theme.base_font_family, size: @theme.base_font_size
     convert_content_for_block doc
 
-    num_toc_levels = (doc.attr 'toclevels', 2).to_i
     toc_page_nums = if doc.attr? 'toc'
-      layout_toc doc, num_toc_levels
+      layout_toc doc, num_toc_levels, toc_start_page_num, num_front_matter_pages
     else
       (0..-1)
     end
 
     # TODO enable pagenums by default (perhaps upstream?)
-    stamp_page_numbers skip: (toc_page_nums.to_a.size + 1) if doc.attr 'pagenums'
-    add_outline doc, num_toc_levels, toc_page_nums
+    stamp_page_numbers skip: num_front_matter_pages if doc.attr 'pagenums'
+    add_outline doc, num_toc_levels, toc_page_nums, num_front_matter_pages
     catalog.data[:ViewerPreferences] = [:FitWindow]
 
     layout_cover_page :back, doc
@@ -665,8 +674,18 @@ class Converter < ::Prawn::Document
       theme_font :code do
         if box_height
           float do
-            bounding_box [0, cursor], width: bounds.width, height: box_height - caption_height do
-              theme_fill_and_stroke_bounds :code
+            # FIXME don't use border / border radius at page boundaries
+            # TODO move this logic to theme_fill_and_stroke_bounds
+            remaining_height = box_height - caption_height
+            i = 0
+            while remaining_height > 0
+              start_new_page if 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
+              end
+              remaining_height -= fill_height
+              i += 1
             end
           end
         end
@@ -1074,37 +1093,44 @@ class Converter < ::Prawn::Document
     end
   end
 
-  def layout_toc doc, num_levels = 2, toc_page_number = 2
-    go_to_page toc_page_number - 1
-    start_new_page
+  def layout_toc doc, num_levels = 2, toc_page_number = 2, num_front_matter_pages = 0
+    go_to_page toc_page_number unless scratch? || page_number == toc_page_number
     theme_font :heading, level: 2 do
       layout_heading doc.attr('toc-title')
     end
     line_metrics = calc_line_metrics @theme.base_line_height
     dot_width = width_of DotLeader
     if num_levels > 0
-      layout_toc_level doc.sections, num_levels, line_metrics, dot_width
+      layout_toc_level doc.sections, num_levels, line_metrics, dot_width, num_front_matter_pages
     end
     toc_page_numbers = (toc_page_number..page_number)
-    go_to_page page_count - 1
+    go_to_page page_count - 1 unless scratch?
     toc_page_numbers
   end
 
-  def layout_toc_level sections, num_levels, line_metrics, dot_width
+  def layout_toc_level sections, num_levels, line_metrics, dot_width, num_front_matter_pages = 0
     sections.each do |sect|
       sect_title = sect.numbered_title
-      sect_page_num = (sect.attr 'page_start') - 1
-      # NOTE we do some cursor hacking so the dots don't affect vertical alignment
+      # NOTE we do some cursor hacking here so the dots don't affect vertical alignment
+      start_page_number = page_number
       start_cursor = cursor
       typeset_text %(<link anchor="#{sect.id}">#{sect_title}</link>), line_metrics, inline_format: true
-      end_cursor = cursor
-      move_cursor_to start_cursor
-      num_dots = ((bounds.width - (width_of %(#{sect_title} #{sect_page_num}), inline_format: true)) / dot_width).floor
-      typeset_formatted_text [text: %(#{DotLeader * num_dots} #{sect_page_num}), anchor: sect.id], line_metrics, align: :right
-      move_cursor_to end_cursor
+      # we only write the label if this is a dry run
+      unless scratch?
+        end_page_number = page_number
+        end_cursor = cursor
+        # TODO it would be convenient to have a cursor mark / placement utility that took page number into account
+        go_to_page start_page_number if start_page_number != end_page_number
+        move_cursor_to start_cursor
+        sect_page_num = (sect.attr 'page_start') - num_front_matter_pages
+        num_dots = ((bounds.width - (width_of %(#{sect_title} #{sect_page_num}), inline_format: true)) / dot_width).floor
+        typeset_formatted_text [text: %(#{DotLeader * num_dots} #{sect_page_num}), anchor: sect.id], line_metrics, align: :right
+        go_to_page end_page_number if start_page_number != end_page_number
+        move_cursor_to end_cursor
+      end
       if sect.level < num_levels
         indent @theme.horizontal_rhythm do
-          layout_toc_level sect.sections, num_levels, line_metrics, dot_width
+          layout_toc_level sect.sections, num_levels, line_metrics, dot_width, num_front_matter_pages
         end
       end
     end
@@ -1145,13 +1171,20 @@ class Converter < ::Prawn::Document
   end
 
   # FIXME we are assuming we always have exactly one title page
-  def add_outline doc, num_levels = 2, toc_page_nums = (0..-1)
+  def add_outline doc, num_levels = 2, toc_page_nums = (0..-1), num_front_matter_pages = 0
     front_matter_counter = RomanNumeral.new 0, :lower
 
     page_num_labels = {}
 
+    # FIXME account for cover page
+    # cover page (i)
+    #front_matter_counter.next!
+
     # title page (i)
-    page_num_labels[0] = { P: ::PDF::Core::LiteralString.new(front_matter_counter.next!.to_s) }
+    # TODO same conditional logic as in layout_title_page; consolidate
+    if doc.header? && !doc.noheader && !doc.notitle
+      page_num_labels[0] = { P: ::PDF::Core::LiteralString.new(front_matter_counter.next!.to_s) } 
+    end
 
     # toc pages (ii..?)
     toc_page_nums.each do
@@ -1173,7 +1206,7 @@ class Converter < ::Prawn::Document
       end
       #page title: 'Credits', destination: (document.dest_top toc_page_nums.first + 1)
       # QUESTION any way to get add_outline_level to invoke in the context of the outline?
-      document.add_outline_level self, doc.sections, num_levels, page_num_labels, numbering_offset
+      document.add_outline_level self, doc.sections, num_levels, page_num_labels, numbering_offset, num_front_matter_pages
     end
 
     catalog.data[:PageLabels] = state.store.ref Nums: page_num_labels.flatten
@@ -1182,17 +1215,17 @@ class Converter < ::Prawn::Document
   end
 
   # TODO only nest inside root node if doctype=article
-  def add_outline_level outline, sections, num_levels, page_num_labels, numbering_offset
+  def add_outline_level outline, sections, num_levels, page_num_labels, numbering_offset, num_front_matter_pages
     sections.each do |sect|
       sect_title = sanitize(sect.numbered_title formal: true)
       sect_destination = sect.attr 'destination'
-      sect_page_num = (sect.attr 'page_start') - 1
+      sect_page_num = (sect.attr 'page_start') - num_front_matter_pages
       page_num_labels[sect_page_num + numbering_offset] = { P: ::PDF::Core::LiteralString.new(sect_page_num.to_s) }
       if (subsections = sect.sections).empty? || sect.level == num_levels
         outline.page title: sect_title, destination: sect_destination
       elsif sect.level < num_levels + 1
         outline.section sect_title, { destination: sect_destination } do
-          add_outline_level outline, subsections, num_levels, page_num_labels, numbering_offset
+          add_outline_level outline, subsections, num_levels, page_num_labels, numbering_offset, num_front_matter_pages
         end
       end
     end

data/lib/asciidoctor-pdf/implicit_header_processor.rb

@@ -57,3 +57,7 @@ class ImplicitHeaderProcessor < ::Asciidoctor::Extensions::IncludeProcessor
 end
 end
 end
+
+Asciidoctor::Extensions.register :pdf do
+  include_processor Asciidoctor::Pdf::ImplicitHeaderProcessor if @document.backend == 'pdf'
+end

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

@@ -480,14 +480,13 @@ module Extensions
   def dry_run &block
     scratch = get_scratch_document
     scratch.start_new_page
+    start_page_number = scratch.page_number
     start_y = scratch.y
     scratch.font font_family, style: font_style, size: font_size do
       scratch.instance_exec(&block)
     end
-    start_y - scratch.y
-    #height_of_content = start_y - scratch.y
-    #scratch.render_file 'scratch.pdf'
-    #height_of_content
+    whole_pages = scratch.page_number - start_page_number
+    [(whole_pages * bounds.height + (start_y - scratch.y)), whole_pages, (start_y - scratch.y)]
   end
 
   # Attempt to keep the objects generated in the block on the same page
@@ -495,15 +494,17 @@ module Extensions
   # TODO short-circuit nested usage
   def keep_together &block
     available_space = cursor
-    if (height_of_content = dry_run(&block)) > available_space
-      started_new_page = true
+    total_height, _whole_pages, _remainder = dry_run(&block)
+    if total_height > available_space
       start_new_page
+      started_new_page = true
     else
       started_new_page = false
     end
+    
     # HACK yield doesn't work here on JRuby (at least not when called from AsciidoctorJ)
-    #yield height_of_content, started_new_page
-    instance_exec(height_of_content, started_new_page, &block)
+    #yield remainder, started_new_page
+    instance_exec(total_height, started_new_page, &block)
   end
 
   # Attempt to keep the objects generated in the block on the same page
@@ -517,15 +518,20 @@ module Extensions
     end
   end
 
+=begin
   def run_with_trial &block
     available_space = cursor
-    if (height_of_content = dry_run(&block)) > available_space
+    whole_pages, remainder = dry_run(&block)
+    if whole_pages > 0 || remainder > available_space
       started_new_page = true
     else
       started_new_page = false
     end
-    yield height_of_content, started_new_page
+    # HACK yield doesn't work here on JRuby (at least not when called from AsciidoctorJ)
+    #yield remainder, started_new_page
+    instance_exec(remainder, started_new_page, &block)
   end
+=end
 end
 end
 end

data/lib/asciidoctor-pdf/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-pdf
 version: !ruby/object:Gem::Version
-  version: 1.5.0.alpha.4
+  version: 1.5.0.alpha.5
 platform: ruby
 authors:
 - Dan Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2014-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -149,6 +149,7 @@ files:
 - data/themes/default-theme.yml
 - examples/chronicles.adoc
 - examples/chronicles.pdf
+- examples/edge-cases.adoc
 - examples/example-pdf-screenshot.png
 - examples/example.adoc
 - examples/example.pdf