prawn 1.0.0.rc2 → 1.0.0

data/lib/prawn/text/formatted/parser.rb

@@ -13,6 +13,7 @@ module Prawn
     module Formatted
 
       class Parser
+        # @group Extension API
 
         PARSER_REGEX = begin
           regex_string = "\n|" +
@@ -29,10 +30,10 @@ module Prawn
                          "<em>|</em>|" +
                          "<a[^>]*>|</a>|" +
                          "[^<\n]+"
-          regex = Regexp.new(regex_string, Regexp::MULTILINE)
+          Regexp.new(regex_string, Regexp::MULTILINE)
         end
 
-        def self.to_array(string)
+        def self.format(string, *args)
           tokens = string.gsub(/<br\s*\/?>/, "\n").scan(PARSER_REGEX)
           self.array_from_tokens(tokens)
         end
@@ -125,10 +126,11 @@ module Prawn
           colors = []
           link = nil
           anchor = nil
+          local = nil
           fonts = []
           sizes = []
           character_spacings = []
-          
+
           while token = tokens.shift
             case token
             when "<b>", "<strong>"
@@ -158,6 +160,7 @@ module Prawn
             when "</link>", "</a>"
               link = nil
               anchor = nil
+              local = nil
             when "</color>"
               colors.pop
             when "</font>"
@@ -171,6 +174,9 @@ module Prawn
 
                 matches = /anchor="([^"]*)"/.match(token) || /anchor='([^']*)'/.match(token)
                 anchor = matches[1] unless matches.nil?
+
+                matches = /local="([^"]*)"/.match(token) || /local='([^']*)'/.match(token)
+                local = matches[1] unless matches.nil?
               elsif token =~ /^<color[^>]*>$/
                 matches = /rgb="#?([^"]*)"/.match(token) || /rgb='#?([^']*)'/.match(token)
                 colors << matches[1] if matches
@@ -182,7 +188,7 @@ module Prawn
                 # intend to support rgb="#ffffff" or rgb='#ffffff',
                 # r="255" g="255" b="255" or r='255' g='255' b='255',
                 # and c="100" m="100" y="100" k="100" or
-                # c='100' m='100' y='100' k='100' 
+                # c='100' m='100' y='100' k='100'
                 # color = { :rgb => "#ffffff" }
                 # color = { :r => 255, :g => 255, :b => 255 }
                 # color = { :c => 100, :m => 100, :y => 100, :k => 100 }
@@ -200,6 +206,7 @@ module Prawn
                 array << { :text => string,
                            :styles => styles.dup,
                            :color => colors.last,
+                           :local => local,
                            :link => link,
                            :anchor => anchor,
                            :font => fonts.last,

data/lib/prawn/text/formatted/wrap.rb

@@ -0,0 +1,156 @@
+# wrap.rb: Handles text wrapping for for formatted text
+#
+# Contributed by Daniel Nelson
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require_relative "line_wrap"
+require_relative "arranger"
+
+module Prawn
+  module Text
+    module Formatted #:nodoc:
+      # @private
+
+      module Wrap #:nodoc:
+
+        def initialize(array, options)
+          @line_wrap = Prawn::Text::Formatted::LineWrap.new
+          @arranger = Prawn::Text::Formatted::Arranger.new(@document,
+            :kerning => options[:kerning])
+        end
+
+
+        # See the developer documentation for PDF::Core::Text#wrap
+        #
+        # Formatted#wrap should set the following variables:
+        #   <tt>@line_height</tt>::
+        #        the height of the tallest fragment in the last printed line
+        #   <tt>@descender</tt>::
+        #        the descender height of the tallest fragment in the last
+        #        printed line
+        #   <tt>@ascender</tt>::
+        #        the ascender heigth of the tallest fragment in the last
+        #        printed line
+        #   <tt>@baseline_y</tt>::
+        #       the baseline of the current line
+        #   <tt>@nothing_printed</tt>::
+        #       set to true until something is printed, then false
+        #   <tt>@everything_printed</tt>::
+        #       set to false until everything printed, then true
+        #
+        # Returns any formatted text that was not printed
+        #
+        def wrap(array) #:nodoc:
+          initialize_wrap(array)
+
+          stop = false
+          while !stop
+            # wrap before testing if enough height for this line because the
+            # height of the highest fragment on this line will be used to
+            # determine the line height
+            @line_wrap.wrap_line(:document => @document,
+                                 :kerning => @kerning,
+                                 :width => available_width,
+                                 :arranger => @arranger)
+
+            if enough_height_for_this_line?
+              move_baseline_down
+              print_line
+            else
+              stop = true
+            end
+
+            stop ||= @single_line || @arranger.finished?
+          end
+          @text = @printed_lines.join("\n")
+          @everything_printed = @arranger.finished?
+          @arranger.unconsumed
+        end
+
+        private
+
+        def print_line
+          @nothing_printed = false
+          printed_fragments = []
+          fragments_this_line = []
+
+          word_spacing = word_spacing_for_this_line
+          while fragment = @arranger.retrieve_fragment
+            fragment.word_spacing = word_spacing
+            if fragment.text == "\n"
+              printed_fragments << "\n" if @printed_lines.last == ""
+              break
+            end
+            printed_fragments << fragment.text
+            fragments_this_line << fragment
+          end
+
+          accumulated_width = 0
+          fragments_this_line.reverse! if @direction == :rtl
+          fragments_this_line.each do |fragment_this_line|
+            fragment_this_line.default_direction = @direction
+            format_and_draw_fragment(fragment_this_line, accumulated_width,
+                                     @line_wrap.width, word_spacing)
+            accumulated_width += fragment_this_line.width
+          end
+
+          @printed_lines << printed_fragments.map { |s| s.force_encoding(::Encoding::UTF_8) }.join
+        end
+
+        def word_spacing_for_this_line
+          if @align == :justify &&
+              @line_wrap.space_count > 0 &&
+              !@line_wrap.paragraph_finished?
+            (available_width - @line_wrap.width) / @line_wrap.space_count
+          else
+            0
+          end
+        end
+
+        def enough_height_for_this_line?
+          @line_height = @arranger.max_line_height
+          @descender   = @arranger.max_descender
+          @ascender    = @arranger.max_ascender
+          if @baseline_y == 0
+            diff = @ascender + @descender
+          else
+            diff = @descender + @line_height + @leading
+          end
+          require_relatived_total_height = @baseline_y.abs + diff
+          if require_relatived_total_height > @height + 0.0001
+            # no room for the full height of this line
+            @arranger.repack_unretrieved
+            false
+          else
+            true
+          end
+        end
+
+        def initialize_wrap(array)
+          @text = nil
+          @arranger.format_array = array
+
+          # these values will depend on the maximum value within a given line
+          @line_height = 0
+          @descender   = 0
+          @ascender    = 0
+          @baseline_y  = 0
+
+          @printed_lines = []
+          @nothing_printed = true
+          @everything_printed = false
+        end
+
+        def format_and_draw_fragment(fragment, accumulated_width,
+                                     line_width, word_spacing)
+          @arranger.apply_color_and_font_settings(fragment) do
+            draw_fragment(fragment, accumulated_width,
+                          line_width, word_spacing)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/prawn/utilities.rb

@@ -16,7 +16,8 @@ module Prawn
   # But at the same time, we don't want to throw away thread safety
   # We have two interchangeable thread-safe cache implementations:
 
-  class SynchronizedCache
+  # @private
+  class SynchronizedCache 
     # As an optimization, this could access the hash directly on VMs with a global interpreter lock (like MRI)
     def initialize
       @cache = {}
@@ -29,8 +30,9 @@ module Prawn
       @mutex.synchronize { @cache[key] = value }
     end
   end
-
-  class ThreadLocalCache
+  
+  # @private
+  class ThreadLocalCache     
     def initialize
       @cache_id = "cache_#{self.object_id}".to_sym
     end

data/manual/document_and_page_options/document_and_page_options.rb

@@ -14,7 +14,8 @@ Prawn::Example.generate("document_and_page_options.pdf",
     p.example "page_margins", :eval_source => false, :full_source => true
     p.example "background",   :eval_source => false, :full_source => true
     p.example "metadata",     :eval_source => false, :full_source => true
-    
+    p.example "print_scaling",:eval_source => false, :full_source => true
+
     p.intro do
       prose("So far we've already seen how to create new documents and start new pages. This chapter expands on the previous examples by showing other options avialable. Some of the options are only available when creating new documents.
 

data/manual/document_and_page_options/metadata.rb

@@ -2,6 +2,7 @@
 #
 # To set the document metadata just pass a hash to the <code>:info</code>
 # option when creating new documents.
+# The keys in the example below are arbitrary, so you may add whatever keys you want
 #
 require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
@@ -14,10 +15,9 @@ Prawn::Document.generate("metadata.pdf",
     :Keywords     => "test metadata ruby pdf dry",
     :Creator      => "ACME Soft App", 
     :Producer     => "Prawn",
-    :CreationDate => Time.now,
-    :Grok         => "Test Property"
+    :CreationDate => Time.now
   }) do
   
   text "This is a test of setting metadata properties via the info option."
-  text "It allows one to specify non standard properties like 'Grok'."
+  text "While the keys are arbitrary, the above example sets common attributes."
 end

data/manual/document_and_page_options/page_size.rb

@@ -2,9 +2,9 @@
 #
 # Prawn comes with support for most of the common page sizes so you'll only need
 # to provide specific values if your intended format is not supported. To see a
-# list with all supported sizes take a look at: https://github.com/prawnpdf/prawn/blob/master/lib/prawn/document/page_geometry.rb
+# list with all supported sizes take a look at PDF::Core::PageGeometry
 #
-# To define the size use <code>:page_size</code> when creating new documents
+# # To define the size use <code>:page_size</code> when creating new documents
 # and <code>:size</code> when starting new pages. The default page size for new
 # documents is LETTER (612.00 x 792.00).
 #

data/manual/document_and_page_options/print_scaling.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+#
+# (Optional; PDF 1.6) The page scaling option to be selected when a print dialog is displayed for this document.
+# Valid values are <code>None</code>, which indicates that the print dialog should reflect no page scaling,
+# and <code>AppDefault</code>, which indicates that applications should use the current print scaling.
+# If this entry has an unrecognized value, applications should use the current print scaling.
+# Default value: <code>AppDefault</code>.
+#
+# Note: If the print dialog is suppressed and its parameters are provided directly by the application, the value of this entry should still be used.
+#
+
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Document.generate("print_scaling.pdf",
+                         :page_layout => :landscape,
+                         :print_scaling => :none
+) do
+  text "When you print this document, the scale to fit in print preview should be disabled by default."
+end

data/manual/example_file.rb

@@ -103,13 +103,8 @@ module Prawn
     def read_file(folder_name, filename)
       data = File.read(File.expand_path(File.join(
         File.dirname(__FILE__), folder_name, filename)))
-      
-      # XXX If we ever have manual files with source encodings other than
-      # UTF-8, we will need to fix this to work on Ruby 1.9.
-      if data.respond_to?(:encode!)
-        data.encode!("UTF-8")
-      end
-      data
+
+      data.encode(::Encoding::UTF_8)
     end
     
   end

data/manual/example_helper.rb

@@ -18,7 +18,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'syntax_highlight'))
 Prawn.debug = true
 
 module Prawn
-  
+
   # The Prawn::Example class holds all the helper methods used to generate the
   # Prawn by example manual.
   #
@@ -37,22 +37,22 @@ module Prawn
   # whole load of manuals)
   #
   class Example < Prawn::Document
-    
+
     # Values used for the manual design:
-    
+
     # This is the default value for the margin box
     #
     BOX_MARGIN   = 36
-    
+
     # Additional indentation to keep the line measure with a reasonable size
-    # 
+    #
     INNER_MARGIN = 30
-    
+
     # Vertical Rhythm settings
     #
     RHYTHM  = 10
     LEADING = 2
-    
+
     # Colors
     #
     BLACK      = "000000"
@@ -64,18 +64,18 @@ module Prawn
     LIGHT_GOLD = "FBFBBE"
     DARK_GOLD  = "EBE389"
     BLUE       = "0000D0"
-    
+
     # Used to generate the url for the example files
     #
     MANUAL_URL = "http://github.com/prawnpdf/prawn/tree/master/manual"
-    
-    
+
+
     # Loads a package. Used on the manual.
     #
     def load_package(package)
       load_file(package, package)
     end
-    
+
     # Loads a page with outline support. Used on the manual.
     #
     def load_page(page)
@@ -93,8 +93,8 @@ module Prawn
       example = ExampleFile.new(package, "#{file}.rb")
       eval example.generate_block_source
     end
-    
-    
+
+
     # Creates a new ExamplePackage object and yields it to a block in order for
     # it to be populated with examples, sections and some introduction text.
     # Used on the package files.
@@ -104,7 +104,7 @@ module Prawn
       ep.instance_eval(&block)
       ep.render(self)
     end
-    
+
     # Renders an ExamplePackage cover page.
     #
     # Starts a new page and renders the package introduction text.
@@ -117,16 +117,16 @@ module Prawn
         section(package.name, :destination => page_number, :closed => true)
       end
     end
-    
+
     # Add the ExampleSection to the document outline within the appropriate
     # package.
     #
     def render_section(section)
-      outline.add_subsection_to(section.package_name) do 
+      outline.add_subsection_to(section.package_name) do
         outline.section(section.name, :closed => true)
       end
     end
-    
+
     # Renders an ExampleFile.
     #
     # Starts a new page and renders an introductory text, the example source and
@@ -135,26 +135,26 @@ module Prawn
     #
     def render_example(example)
       start_new_page
-      
-      outline.add_subsection_to(example.parent_name) do 
+
+      outline.add_subsection_to(example.parent_name) do
         outline.page(:destination => page_number, :title => example.name)
       end
-      
+
       example_header(example.parent_folder_name, example.filename)
-  
+
       prose(example.introduction_text)
-      
+
       code(example.source)
-      
+
       if example.eval?
-        eval_code(example.source) 
+        eval_code(example.source)
       else
         source_link(example)
       end
-      
+
       reset_settings
     end
-    
+
     # Render the example header. Used on the example pages of the manual
     #
     def example_header(package, example)
@@ -168,7 +168,7 @@ module Prawn
         end
       end
     end
-    
+
     # Register fonts used on the manual
     #
     def register_fonts
@@ -182,7 +182,7 @@ module Prawn
         :normal => { :file => dejavu_file, :font => "DejaVu" }
       }
     end
-    
+
     # Render a block of text after processing code tags and URLs to be used with
     # the inline_format option.
     #
@@ -190,7 +190,7 @@ module Prawn
     # package pages intro
     #
     def prose(str)
-      
+
       # Process the <code> tags
       str.gsub!(/<code>([^<]+?)<\/code>/,
           "<font name='Courier'><b>\\1<\/b><\/font>")
@@ -198,31 +198,31 @@ module Prawn
       # Process the links
       str.gsub!(/(https?:\/\/\S+)/,
                   "<color rgb='#{BLUE}'><link href=\"\\1\">\\1</link></color>")
-      
+
       inner_box do
         font("Helvetica", :size => 11) do
           str.split(/\n\n+/).each do |paragraph|
-            
+
             text(paragraph.gsub(/\s+/," "),
                  :align         => :justify,
                  :inline_format => true,
                  :leading       => LEADING,
                  :color         => DARK_GRAY)
-            
+
             move_down(RHYTHM)
           end
         end
       end
-      
+
       move_down(RHYTHM)
     end
-    
+
     # Render a code block. Used on the example pages of the manual
     #
     def code(str)
       pre_text = str.gsub(' ', Prawn::Text::NBSP)
       pre_text = ::CodeRay.scan(pre_text, :ruby).to_prawn
-      
+
       font('Courier', :size => 9.5) do
         colored_box(pre_text, :fill_color => DARK_GRAY)
       end
@@ -254,17 +254,17 @@ module Prawn
     #
     def source_link(example)
       url = "#{MANUAL_URL}/#{example.parent_folder_name}/#{example.filename}"
-      
+
       reason = [{ :text  => "This code snippet was not evaluated inline. " +
                             "You may see its output by running the " +
                             "example file located here:\n",
                   :color => DARK_GRAY },
-                  
+
                 { :text   => url,
                   :color  => BLUE,
                   :link   => url}
                ]
-      
+
       font('Helvetica', :size => 9) do
         colored_box(reason,
                     :fill_color   => LIGHT_GOLD,
@@ -272,7 +272,7 @@ module Prawn
                     :leading      => LEADING*3)
       end
     end
-    
+
     # Render a page header. Used on the manual lone pages and package
     # introductory pages
     #
@@ -284,19 +284,19 @@ module Prawn
         end
       end
     end
-    
+
     # Render the arguments as a bulleted list. Used on the manual package
     # introductory pages
     #
     def list(*items)
       move_up(RHYTHM)
-      
+
       inner_box do
         font("Helvetica", :size => 11) do
           items.each do |li|
             float { text("•", :color => DARK_GRAY) }
             indent(RHYTHM) do
-              text(li.gsub(/\s+/," "), 
+              text(li.gsub(/\s+/," "),
                    :inline_format => true,
                    :color         => DARK_GRAY,
                    :leading       => LEADING)
@@ -307,30 +307,30 @@ module Prawn
         end
       end
     end
-    
+
     # Renders the page-wide headers
     #
     def header_box(&block)
       bounding_box([-bounds.absolute_left, cursor + BOX_MARGIN],
                    :width  => bounds.absolute_left + bounds.absolute_right,
                    :height => BOX_MARGIN*2 + RHYTHM*2) do
-        
+
         fill_color LIGHT_GRAY
         fill_rectangle([bounds.left, bounds.top],
                         bounds.right,
                         bounds.top - bounds.bottom)
         fill_color BLACK
-        
+
         indent(BOX_MARGIN + INNER_MARGIN, &block)
       end
-      
+
       stroke_color GRAY
       stroke_horizontal_line(-BOX_MARGIN, bounds.width + BOX_MARGIN, :at => cursor)
       stroke_color BLACK
-      
+
       move_down(RHYTHM*3)
     end
-    
+
     # Renders a Bounding Box for the inner margin
     #
     def inner_box(&block)
@@ -338,7 +338,7 @@ module Prawn
                    :width => bounds.width - INNER_MARGIN*2,
                    &block)
     end
-    
+
     # Renders a Bounding Box with some background color and the formatted text
     # inside it
     #
@@ -348,17 +348,17 @@ module Prawn
                   :text_color   => LIGHT_GRAY,
                   :leading      => LEADING
                 }.merge(options)
-      
+
       register_fonts
-      text_options = { :leading        => options[:leading], 
+      text_options = { :leading        => options[:leading],
                        :fallback_fonts => ["DejaVu", "Kai"]
                      }
-      
+
       box_height = height_of_formatted(box_text, text_options)
-      
+
       bounding_box([INNER_MARGIN + RHYTHM, cursor],
                    :width => bounds.width - (INNER_MARGIN+RHYTHM)*2) do
-        
+
         fill_color   options[:fill_color]
         stroke_color options[:stroke_color] || options[:fill_color]
         fill_and_stroke_rounded_rectangle(
@@ -369,54 +369,35 @@ module Prawn
         )
         fill_color   BLACK
         stroke_color BLACK
-        
+
         pad(RHYTHM) do
           formatted_text(box_text, text_options)
         end
       end
-      
+
       move_down(RHYTHM*2)
     end
-    
+
     # Draws X and Y axis rulers beginning at the margin box origin. Used on
     # examples.
     #
     def stroke_axis(options={})
-      options = { :height => (cursor - 20).to_i,
-                  :width => bounds.width.to_i
-                }.merge(options)
-      
-      dash(1, :space => 4)
-      stroke_horizontal_line(-21, options[:width], :at => 0)
-      stroke_vertical_line(-21, options[:height], :at => 0)
-      undash
-      
-      fill_circle [0, 0], 1
-      
-      (100..options[:width]).step(100) do |point|
-        fill_circle [point, 0], 1
-        draw_text point, :at => [point-5, -10], :size => 7
-      end
-
-      (100..options[:height]).step(100) do |point|
-        fill_circle [0, point], 1
-        draw_text point, :at => [-17, point-2], :size => 7
-      end
+      super({:height => (cursor - 20).to_i}.merge(options))
     end
-    
+
     # Reset some of the Prawn settings including graphics and text to their
     # defaults.
-    # 
+    #
     # Used after rendering examples so that each new example starts with a clean
     # slate.
     #
     def reset_settings
-      
+
       # Text settings
       font("Helvetica", :size => 12)
       default_leading 0
       self.text_direction = :ltr
-      
+
       # Graphics settings
       self.line_width = 1
       self.cap_style  = :butt