prawn 1.0.0 → 1.1.0

data/lib/prawn/text.rb

@@ -27,7 +27,7 @@ module Prawn
     Prawn::Text::SHY = "­"
 
     # @group Stable API
-    
+
     # If you want text to flow onto a new page or between columns, this is the
     # method to use. If, instead, if you want to place bounded text outside of
     # the flow of a document (for captions, labels, charts, etc.), use Text::Box

data/lib/prawn/text/formatted.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require_relative "formatted/wrap"
 
 require_relative "formatted/box"

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

@@ -12,7 +12,7 @@ module Prawn
     module Formatted #:nodoc:
 
       # @private
-      
+
       class Arranger #:nodoc:
         attr_reader :max_line_height
         attr_reader :max_descender

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

@@ -11,7 +11,7 @@ module Prawn
   module Text
     module Formatted
       # @group Stable API
-      
+
       # Draws the requested formatted text into a box. When the text overflows
       # the rectangle shrink to fit or truncate the text. Text boxes are
       # independent of the document y position.
@@ -107,13 +107,13 @@ module Prawn
         # used, the text that would have been successfully printed)
         attr_reader :text
 
-        # True iff nothing printed (or, if <tt>dry_run</tt> was
+        # True if nothing printed (or, if <tt>dry_run</tt> was
         # used, nothing would have been successfully printed)
         def nothing_printed?
           @nothing_printed
         end
 
-        # True iff everything printed (or, if <tt>dry_run</tt> was
+        # True if everything printed (or, if <tt>dry_run</tt> was
         # used, everything would have been successfully printed)
         def everything_printed?
           @everything_printed
@@ -293,7 +293,7 @@ module Prawn
         end
 
         # @group Extension API
-        
+
         # Example (see Prawn::Text::Core::Formatted::Wrap for what is required
         # of the wrap method if you want to override the default wrapping
         # algorithm):
@@ -493,7 +493,7 @@ module Prawn
         end
 
         def process_options
-          # must be performed within a save_font bock because
+          # must be performed within a save_font block because
           # document.process_text_options sets the font
           @document.process_text_options(@options)
           @font_size = @options[:size]

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

@@ -79,7 +79,7 @@ module Prawn
           result
         end
 
-        # returns true iff all text was printed without running into the end of
+        # returns true if all text was printed without running into the end of
         # the line
         #
         def add_fragment_to_line(fragment)

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

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 # wrap.rb: Handles text wrapping for for formatted text
 #
 # Contributed by Daniel Nelson

data/lib/prawn/utilities.rb

@@ -17,7 +17,7 @@ module Prawn
   # We have two interchangeable thread-safe cache implementations:
 
   # @private
-  class SynchronizedCache 
+  class SynchronizedCache
     # As an optimization, this could access the hash directly on VMs with a global interpreter lock (like MRI)
     def initialize
       @cache = {}
@@ -30,9 +30,9 @@ module Prawn
       @mutex.synchronize { @cache[key] = value }
     end
   end
-  
+
   # @private
-  class ThreadLocalCache     
+  class ThreadLocalCache
     def initialize
       @cache_id = "cache_#{self.object_id}".to_sym
     end

data/manual/basic_concepts/adding_pages.rb

@@ -17,11 +17,11 @@ require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   text "We are still on the initial page for this example. Now I'll ask " +
        "Prawn to gently start a new page. Please follow me to the next page."
-  
+
   start_new_page
-  
+
   text "See. We've left the previous page behind."
 end

data/manual/basic_concepts/basic_concepts.rb

@@ -2,20 +2,20 @@
 #
 # Examples for Prawn basic concepts.
 #
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
 
-Prawn::Example.generate("basic_concepts.pdf", :page_size => "FOLIO") do
-  
+require_relative "../example_helper"
+
+Prawn::ManualBuilder::Example.generate("basic_concepts.pdf", :page_size => "FOLIO") do
+
   package "basic_concepts" do |p|
-    
+
     p.example "creation", :eval_source => false, :full_source => true
     p.example "origin"
     p.example "cursor"
     p.example "other_cursor_helpers"
     p.example "adding_pages"
     p.example "measurement"
-    
+
     p.intro do
       prose("This chapter covers the minimum amount of functionality you'll need to start using Prawn.
 

data/manual/basic_concepts/cursor.rb

@@ -16,18 +16,18 @@ require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
-  
+
   text "the cursor is here: #{cursor}"
   text "now it is here: #{cursor}"
-  
+
   move_down 200
   text "on the first move the cursor went down to: #{cursor}"
-  
+
   move_up 100
   text "on the second move the cursor went up to: #{cursor}"
-  
+
   move_cursor_to 50
   text "on the last move the cursor went directly to: #{cursor}"
 end

data/manual/basic_concepts/measurement.rb

@@ -15,9 +15,9 @@ require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   require "prawn/measurement_extensions"
-  
+
   [:mm, :cm, :dm, :m, :in, :yd, :ft].each do |measurement|
     text "1 #{measurement} in PDF Points: #{1.send(measurement)} pt"
     move_down 5.mm

data/manual/basic_concepts/origin.rb

@@ -26,11 +26,11 @@ require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
-  
+
   stroke_circle [0, 0], 10
-  
+
   bounding_box([100, 300], :width => 300, :height => 200) do
     stroke_bounds
     stroke_circle [0, 0], 10

data/manual/basic_concepts/other_cursor_helpers.rb

@@ -13,21 +13,21 @@ require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_horizontal_rule
   pad(20) { text "Text padded both before and after." }
-  
+
   stroke_horizontal_rule
   pad_top(20) { text "Text padded on the top." }
-  
+
   stroke_horizontal_rule
   pad_bottom(20) { text "Text padded on the bottom." }
-  
+
   stroke_horizontal_rule
   move_down 30
-  
+
   text "Text written before the float block."
-  
+
   float do
     move_down 30
     bounding_box([0, cursor], :width => 200) do

data/manual/bounding_box/bounding_box.rb

@@ -5,15 +5,15 @@
 require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
-Prawn::Example.generate("bounding_box.pdf", :page_size => "FOLIO") do
-  
+Prawn::ManualBuilder::Example.generate("bounding_box.pdf", :page_size => "FOLIO") do
+
   package "bounding_box" do |p|
-    
+
     p.section "Basics" do |s|
       s.example "creation"
       s.example "bounds"
     end
-    
+
     p.section "Advanced" do |s|
       s.example "stretchy"
       s.example "nesting"
@@ -21,7 +21,7 @@ Prawn::Example.generate("bounding_box.pdf", :page_size => "FOLIO") do
       s.example "canvas"
       s.example "russian_boxes"
     end
-    
+
     p.intro do
       prose("Bounding boxes are the basic containers for structuring the content flow. Even being low level building blocks sometimes their simplicity is very welcome.
 
@@ -34,6 +34,6 @@ Prawn::Example.generate("bounding_box.pdf", :page_size => "FOLIO") do
             "Indent blocks"
           )
     end
-    
+
   end
 end

data/manual/bounding_box/bounds.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# 
+#
 # The <code>bounds</code> method returns the current bounding box. This is
 # useful because the <code>Prawn::BoundinBox</code> exposes some nice boundary
 # helpers.
@@ -21,25 +21,25 @@ require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   def print_coordinates
     text "top: #{bounds.top}"
     text "bottom: #{bounds.bottom}"
     text "left: #{bounds.left}"
     text "right: #{bounds.right}"
-    
+
     move_down 10
-    
+
     text "absolute top: #{sprintf "%.2f", bounds.absolute_top}"
     text "absolute bottom: #{sprintf "%.2f", bounds.absolute_bottom}"
     text "absolute left: #{sprintf "%.2f", bounds.absolute_left}"
     text "absolute right: #{sprintf "%.2f", bounds.absolute_right}"
   end
-  
+
   text "Margin box bounds:"
   move_down 5
   print_coordinates
-  
+
   bounding_box([250, cursor + 140], :width => 200, :height => 150) do
     text "This bounding box bounds:"
     move_down 5

data/manual/bounding_box/canvas.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# 
+#
 # The origin example already mentions that a new document already comes with
 # a margin box whose bottom left corner is used as the origin for calculating
 # coordinates.
@@ -14,7 +14,7 @@ require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   canvas do
     fill_circle [bounds.left, bounds.top],     30
     fill_circle [bounds.right, bounds.top],    30

data/manual/bounding_box/creation.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# 
+#
 # If you've read the basic concepts examples you probably know that the origin
 # of a page is on the bottom left corner and that the content flows from top to
 # bottom.
@@ -14,10 +14,10 @@ require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   bounding_box([200, cursor - 100], :width => 200, :height => 100) do
     text "Just your regular bounding box"
-    
+
     transparent(0.5) { stroke_bounds }
   end
 end

data/manual/bounding_box/indentation.rb

@@ -1,44 +1,44 @@
 # encoding: utf-8
-# 
+#
 # Sometimes you just need to indent a portion of the contents of a bounding box,
 # and using a nested bounding box is pure overkill. The <code>indent</code>
 # method is what you might need.
 #
 # Just provide a number for it to indent all content generated inside the
-# block. 
+# block.
 #
 require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   text "No indentation on the margin box."
   indent(20) do
     text "Some indentation inside an indent block."
   end
   move_down 20
-  
+
   bounding_box([50, cursor], :width => 400, :height => cursor) do
     transparent(0.5) { stroke_bounds }
-    
+
     move_down 10
     text "No indentation inside this bounding box."
     indent(40) do
       text "Inside an indent block. And so is this horizontal line:"
-      
+
       stroke_horizontal_rule
     end
     move_down 10
     text "No indentation"
-    
+
     move_down 20
     indent(60) do
       text "Another indent block."
-      
+
       bounding_box([0, cursor], :width => 200) do
         text "Note that this bounding box coordinates are relative to the " +
              "indent block"
-        
+
         transparent(0.5) { stroke_bounds }
       end
     end

data/manual/bounding_box/nesting.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# 
+#
 # Normally when we provide the top left corner of a bounding box we
 # express the coordinates relative to the margin box. This is not the
 # case when we have nested bounding boxes. Once nested the inner bounding box
@@ -13,31 +13,31 @@ require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   def box_content(string)
     text string
     transparent(0.5) { stroke_bounds }
   end
-  
+
   gap = 20
   bounding_box([50, cursor], :width => 400, :height => 200) do
     box_content("Fixed height")
-    
+
     bounding_box([gap, cursor - gap], :width => 300) do
       text "Stretchy height"
-      
+
       bounding_box([gap, bounds.top - gap], :width => 100) do
         text "Stretchy height"
         transparent(0.5) { dash(1); stroke_bounds; undash }
       end
-      
+
       bounding_box([gap * 7, bounds.top - gap], :width => 100, :height => 50) do
         box_content("Fixed height")
       end
-      
+
       transparent(0.5) { dash(1); stroke_bounds; undash }
     end
-    
+
     bounding_box([gap, cursor - gap], :width => 300, :height => 50) do
       box_content("Fixed height")
     end

data/manual/bounding_box/russian_boxes.rb

@@ -8,7 +8,7 @@ require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   def combine(a1, a2)
     output = []
     a1.each do |i1|