prawn 0.2.0 → 0.2.1

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/testtask'
 require "rake/rdoctask"
 require "rake/gempackagetask"  
 
-PRAWN_VERSION = "0.2.0" 
+PRAWN_VERSION = "0.2.1" 
 
 task :default => [:test]
        

data/examples/span.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require "prawn"
+
+Prawn::Document.generate("span.pdf") do
+  
+  # Spans will typically be used outside of bounding boxes as a way to build
+  # single columns of flowing text that span across pages.
+  #
+  span(350, :position => :center) do
+    text "Here's some centered text in a 350 point column. " * 100
+  end
+  
+  # Spans are not really compatible with bounding boxes because they break
+  # the nesting chain and also may position text outside of the bounding box
+  # boundaries, but sometimes you may wish to use them anyway for convenience
+  # Here's an example of how to do that dynamically.
+  # 
+  bounding_box([50,300], :width => 400) do
+    text "Here's some default bounding box text. " * 10 
+    span(bounds.width, 
+      :position => bounds.absolute_left - margin_box.absolute_left) do
+      text "The rain in spain falls mainly on the plains. " * 300
+    end
+  end
+end

data/lib/prawn.rb

@@ -20,7 +20,7 @@ module Prawn
   # The base source directory for Prawn as installed on the system
   BASEDIR = File.expand_path(File.join(dir, '..'))  
   
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
   
   extend self
   

data/lib/prawn/document.rb

@@ -12,6 +12,7 @@ require "prawn/document/bounding_box"
 require "prawn/document/text"      
 require "prawn/document/table"
 require "prawn/document/internals"
+require "prawn/document/span"
 
 module Prawn
   class Document  
@@ -78,7 +79,7 @@ module Prawn
     def initialize(options={},&block)   
        Prawn.verify_options [:page_size, :page_layout, :on_page_start,
          :on_page_stop, :left_margin, :right_margin, :top_margin,
-         :bottom_margin, :skip_page_creation, :compress ], options
+         :bottom_margin, :skip_page_creation, :compress, :skip_encoding, :text_options ], options
          
        @objects = []
        @info    = ref(:Creator => "Prawn", :Producer => "Prawn")

data/lib/prawn/document/span.rb

@@ -0,0 +1,31 @@
+module Prawn
+  class Document
+    def span(width, options={})
+      Prawn.verify_options [:position], options
+      original_position = self.y      
+      
+      # FIXME: How many effing times do I want to write this same code?
+      left_boundary = case(options[:position] || :left)
+      when :left
+        margin_box.absolute_left
+      when :center
+        margin_box.absolute_left + margin_box.width / 2.0 - width /2.0
+      when :right
+        margin_box.absolute_right - width
+      when Numeric
+        margin_box.absolute_left + options[:position]
+      else
+        raise ArgumentError, "Invalid option for :position"
+      end
+      
+      # we need to bust out of whatever nested bounding boxes we're in.
+      canvas do
+        bounding_box([left_boundary, 
+                      margin_box.absolute_top], :width => width) do
+          self.y = original_position
+          yield
+        end
+      end          
+    end
+  end
+end

data/lib/prawn/font.rb

@@ -39,7 +39,7 @@ module Prawn
        
     # Hash of Font objects keyed by names
     #
-    def font_registry
+    def font_registry #:nodoc:
       @font_registry ||= {}
     end     
      
@@ -94,14 +94,28 @@ module Prawn
                         
     DEFAULT_SIZE = 12
       
-    def self.register(name,options={})         
+    def self.register(name,options={})  #:nodoc:      
        options[:for].font_registry[name] = Font.new(name,options)
     end      
-      
-    attr_reader   :metrics, :identifier, :reference, :name, :family
+    
+    # The font metrics object  
+    attr_reader   :metrics
+    
+    # The current font name
+    attr_reader :name
+    
+    # The current font family
+    attr_reader :family
+  
+    attr_reader  :identifier, :reference #:nodoc:
+    
+    # Sets the size of the current font:
+    #
+    #   font.size = 16
+    #
     attr_writer   :size         
       
-    def initialize(name,options={}) 
+    def initialize(name,options={}) #:nodoc:
       @name       = name   
       @family     = options[:family]      
               
@@ -113,7 +127,7 @@ module Prawn
       @identifier = :"F#{@document.font_registry.size + 1}"  
       
       case(name)
-      when /\.ttf$/
+      when /\.ttf$/i
         embed_ttf(name)
       else
         register_builtin(name)
@@ -170,11 +184,15 @@ module Prawn
       @metrics.font_height(@size)       
     end   
     
-    def ascender # :nodoc:
+    # The height of the ascender at the current font size in PDF points
+    #
+    def ascender 
       @metrics.ascender / 1000.0 * @size
     end  
     
-    def descender # :nodoc:
+    # The height of the descender at the current font size in PDF points
+    #
+    def descender 
       @metrics.descender / 1000.0 * @size
     end
                            

data/lib/prawn/font/cmap.rb

@@ -7,7 +7,7 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 module Prawn
-  class Font #:nodoc:
+  class Font 
     class CMap #:nodoc:
 
       def initialize

data/lib/prawn/font/metrics.rb

@@ -10,13 +10,13 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 module Prawn
-  class Font #:nodoc:
+  class Font 
     class Metrics #:nodoc:
 
       include Prawn::Font::Wrapping
 
       def self.[](font)
-        data[font] ||= (font.match(/\.ttf$/) ? TTF : Adobe).new(font)
+        data[font] ||= (font.match(/\.ttf$/i) ? TTF : Adobe).new(font)
       end 
 
       def self.data

data/lib/prawn/font/wrapping.rb

@@ -6,17 +6,17 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 module Prawn
-  class Font #:nodoc:
+  class Font
     module Wrapping #:nodoc:                
       ruby_18 { $KCODE="U" }
       
       # TODO: Replace with TeX optimal algorithm
       def naive_wrap(string, line_width, font_size, options = {})
-        accumulated_width = 0
         scan_pattern = options[:mode] == :character ? /./ : /\S+|\s+/                                    
         
         output = ""                
-        string.lines.each do |line|         
+        string.lines.each do |line| 
+          accumulated_width = 0        
           segments = line.scan(scan_pattern)
                                         
           segments.each do |segment|    
@@ -24,7 +24,7 @@ module Prawn
               :kerning => options[:kerning]) 
       
             if (accumulated_width + segment_width).round > line_width.round
-              output = "#{output.rstrip}\n"
+              output = "#{output.sub(/[ \t]*\n?(\n*)\z/, "\n\\1")}"
               
               if segment =~ /\s/           
                 accumulated_width = 0

data/lib/prawn/images.rb

@@ -36,11 +36,15 @@ module Prawn
     # proportionally.  When both are provided, the image will be stretched to 
     # fit the dimensions without maintaining the aspect ratio.
     #
-    def image(filename, options={})     
+    def image(file, options={})     
       Prawn.verify_options [:at,:position, :height, :width, :scale], options
-      raise ArgumentError, "#{filename} not found" unless File.file?(filename)  
       
-      image_content =  File.read_binary(filename)
+      if file.kind_of?(IO)
+        image_content = file.read
+      else      
+        raise ArgumentError, "#{file} not found" unless File.file?(file)  
+        image_content =  File.read_binary(file)
+      end
       
       image_sha1 = Digest::SHA1.hexdigest(image_content)
 
@@ -83,6 +87,8 @@ module Prawn
       # add the image to the current page
       instruct = "\nq\n%.3f 0 0 %.3f %.3f %.3f cm\n/%s Do\nQ"
       add_content instruct % [ w, h, x, y - h, label ]
+      
+      return info
     end
 
     private   

data/spec/font_spec.rb

@@ -17,7 +17,29 @@ describe "Font Metrics" do
     comicsans = "#{Prawn::BASEDIR}/data/fonts/comicsans.ttf"
     @pdf.font(comicsans)
     @pdf.font.metrics.should == Prawn::Font::Metrics[comicsans]
-  end         
+  end 
+
+  it "should wrap text" do
+    @pdf = Prawn::Document.new
+    @pdf.font "Courier"
+    @pdf.font.metrics.naive_wrap("Please wrap this text about HERE. More text that should be wrapped", 220, @pdf.font.size).should ==
+				 "Please wrap this text about\nHERE. More text that should be\nwrapped"
+  end
+
+  it "should respect end of line when wrapping text" do
+    @pdf = Prawn::Document.new
+    @pdf.font "Courier"
+    text = "Please wrap only before\nTHIS word. Don't wrap this"
+    @pdf.font.metrics.naive_wrap(text, 220, @pdf.font.size).should == text
+  end
+
+  it "should respect end of line when wrapping text and mode is set to 'character'" do
+    @pdf = Prawn::Document.new
+    @pdf.font "Courier"
+    opts = {:mode => :character}
+    @pdf.font.metrics.naive_wrap("You can wrap this text HERE", 180, @pdf.font.size, opts).should ==
+				 "You can wrap this text HE\nRE"
+  end     
   
 end    
 

data/spec/images_spec.rb

@@ -5,7 +5,7 @@ require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 describe "the image() function" do
 
   before(:each) do
-    @filename = "#{Prawn::BASEDIR}/data/images/pigs.jpg"
+    @filename = "#{Prawn::BASEDIR}/data/images/pigs.jpg" 
     create_pdf
   end
 
@@ -21,5 +21,20 @@ describe "the image() function" do
     # but only 1 image xobject
     output.scan(/\/Type \/XObject/).size.should == 1
   end  
+  
+  it "should return the image info object" do
+    info =  @pdf.image(@filename)
+    
+    assert info.kind_of?(Prawn::Images::JPG)
+    
+    info.height.should == 453
+  end
+  
+  it "should accept IO objects" do
+    file = File.open(@filename, "rb")
+    info = @pdf.image(file)
+    
+    info.height.should == 453
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: prawn
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Gregory Brown
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-12 00:00:00 -04:00
+date: 2008-10-17 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -53,6 +53,7 @@ files:
 - examples/simple_text.rb
 - examples/simple_text_ttf.rb
 - examples/sjis.rb
+- examples/span.rb
 - examples/table.rb
 - examples/text_flow.rb
 - examples/utf8.rb
@@ -62,6 +63,7 @@ files:
 - lib/prawn/document/bounding_box.rb
 - lib/prawn/document/internals.rb
 - lib/prawn/document/page_geometry.rb
+- lib/prawn/document/span.rb
 - lib/prawn/document/table.rb
 - lib/prawn/document/text.rb
 - lib/prawn/document.rb