prawn-core 0.7.1 → 0.7.2

data/HACKING

@@ -22,7 +22,7 @@ If you are running on Ruby 1.9.1, you will need Test::Unit 1.2.3
 
    http://github.com/sandal/prawn/issues
    http://github.com/sandal/prawn-layout/issues
-   http://github.com/sandal/prawn-format/issues
+   http://github.com/sandal/prawn-security/issues
 
   2. Fork any necessary repositories on Github, make your changes
   3. Submit pull request so Gregory is notified

data/README

@@ -8,7 +8,7 @@ the many people who donated to the Ruby Mendicant project:
 http://rubymendicant.wikidot.com 
 
 The project is currently maintained by Gregory Brown, with lots of help from
-the community.
+Prawn's core developers and the community.
 
 == Quick Start
 
@@ -103,28 +103,22 @@ For tables and grid based layout:
 
 http://github.com/sandal/prawn-layout/tree/stable/examples
 
-For inline styling and advanced formatting:
-
-http://github.com/sandal/prawn-format/tree/stable/examples
-
 For encryption, password protection, and permissions:
 
 http://github.com/madriska/prawn-security/tree/stable/examples
 
-(or gem unpack prawn-core, prawn-format, prawn-security and prawn-layout if you want to run them locally)
+(or gem unpack prawn-core, prawn-security and prawn-layout if you want to run them locally)
 
 === Bug Tracker / Wiki:
 
 http://github.com/sandal/prawn/issues
 http://github.com/sandal/prawn-layout/issues
-http://github.com/sandal/prawn-format/issues
 http://github.com/madriska/prawn-security/issues
 
 === Source Code:
 
 http://github.com/sandal/prawn
 http://github.com/sandal/prawn-layout
-http://github.com/sandal/prawn-format
 http://github.com/madriska/prawn-security
 
 === Mailing List:
@@ -136,6 +130,8 @@ http://groups.google.com/group/prawn-ruby
 Find us in #prawn on irc.freenode.net
   Gregory Brown: <sandal>
   James Healy: <yob>               
+  Brad Ediger: <bradediger>
+  Daniel Nelson: <bluejade>
   
 == Notes to Developers: 
 

data/Rakefile

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

data/lib/prawn/compatibility.rb

@@ -4,9 +4,22 @@
 # as simple as this?
 #
 class String  #:nodoc:
+  def first_line
+    self.each_line { |line| return line }
+  end
   unless "".respond_to?(:lines)
     alias_method :lines, :to_a
   end
+  unless "".respond_to?(:each_char)
+    def each_char
+      # copied from jcode
+      if block_given?
+        scan(/./m) { |x| yield x }
+      else
+        scan(/./m)
+      end
+    end
+  end
 end
 
 unless File.respond_to?(:binread)

data/lib/prawn/core.rb

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

data/lib/prawn/document.rb

@@ -395,7 +395,7 @@ module Prawn
     # Sets Document#bounds to the BoundingBox provided.  See above for a brief
     # description of what a bounding box is.  This function is useful if you 
     # really need to change the bounding box manually, but usually, just entering
-    # and existing bounding box code blocks is good enough.
+    # and exiting bounding box code blocks is good enough.
     #
     def bounds=(bounding_box)
       @bounding_box = bounding_box

data/lib/prawn/document/snapshot.rb

@@ -46,6 +46,7 @@ module Prawn
       def take_snapshot
         {:page_content    => Marshal.load(Marshal.dump(page_content)),
          :current_page    => Marshal.load(Marshal.dump(current_page)),
+         :page_number     => @page_number,
          :page_kids       => @store.pages.data[:Kids].map{|kid| kid.identifier},
          :dests           => names? && 
                              Marshal.load(Marshal.dump(names.data[:Dests]))}
@@ -64,6 +65,8 @@ module Prawn
         current_page.replace shot[:current_page]
         current_page.data[:Contents] = page_content
 
+        @page_number = shot[:page_number]
+
         @store.pages.data[:Kids] = shot[:page_kids].map{|id| @store[id]}
         @store.pages.data[:Count] = shot[:page_kids].size
 

data/lib/prawn/errors.rb

@@ -28,6 +28,10 @@ module Prawn
      #
      UnknownFont = Class.new(StandardError)   
 
+     # Raised when Prawn is asked to draw something into a too-small box
+     #
+     CannotFit = Class.new(StandardError)
+
      # This error is raised when Prawn is being used on a M17N aware VM,
      # and the user attempts to add text that isn't compatible with UTF-8
      # to their document

data/lib/prawn/font.rb

@@ -13,20 +13,37 @@ module Prawn
 
   class Document
     # Without arguments, this returns the currently selected font. Otherwise,
-    # it sets the current font.
+    # it sets the current font. When a block is used, the font is applied
+    # transactionally and is rolled back when the block exits.
     #
-    # The single parameter must be a string. It can be one of the 14 built-in
+    #   Prawn::Document.generate("font.pdf") do
+    #     text "Default font is Helvetica"
+    #
+    #     font "Times-Roman"
+    #     text "Now using Times-Roman"
+    #
+    #     font("Chalkboard.ttf") do
+    #       text "Using TTF font from file Chalkboard.ttf"
+    #       font "Courier", :style => :bold
+    #       text "You see this in bold Courier"
+    #     end
+    #
+    #     text "Times-Roman, again"
+    #   end
+    #
+    # The :name parameter must be a string. It can be one of the 14 built-in
     # fonts supported by PDF, or the location of a TTF file. The Font::AFM::BUILT_INS
     # array specifies the valid built in font values.
     #
-    #   pdf.font "Times-Roman"
-    #   pdf.font "Chalkboard.ttf"
-    #
     # If a ttf font is specified, the glyphs necessary to render your document
     # will be embedded in the rendered PDF. This should be your preferred option
     # in most cases. It will increase the size of the resulting file, but also 
     # make it more portable.
     #
+    # The options parameter is an optional hash providing size and style. To use
+    # the :style option you need to map those font styles to their respective font files.
+    # See font_families for more information.
+    #
     def font(name=nil, options={})
       return((defined?(@font) && @font) || font("Helvetica")) if name.nil?
 
@@ -131,7 +148,7 @@ module Prawn
       @font_registry ||= {}
     end
 
-    # Hash that maps font family names to their styled individual font names
+    # Hash that maps font family names to their styled individual font names.
     #
     # To add support for another font family, append to this hash, e.g:
     #
@@ -151,6 +168,12 @@ module Prawn
     # This assumes that you have appropriate TTF fonts for each style you
     # wish to support.
     #
+    # By default the styles :bold, :italic, :bold_italic, and :normal are
+    # defined for fonts "Courier", "Times-Roman" and "Helvetica".
+    #
+    # You probably want to provide those four styles, but are free to define
+    # custom ones, like :thin, and use them in font calls.
+    #
     def font_families
       @font_families ||= Hash.new { |h,k| h[k] = {} }.merge!(
         { "Courier"     => { :bold        => "Courier-Bold",

data/lib/prawn/font/afm.rb

@@ -8,6 +8,10 @@ module Prawn
                       Times-Bold Times-Italic Times-BoldItalic
                       Helvetica-Bold Helvetica-Oblique Helvetica-BoldOblique ]
 
+      def unicode?
+        false
+      end
+
       def self.metrics_path
         if m = ENV['METRICS']
           @metrics_path ||= m.split(':')
@@ -98,10 +102,18 @@ module Prawn
       private
 
       def register(subset)
-        @document.ref!(:Type     => :Font,
-                      :Subtype  => :Type1,
-                      :BaseFont => name.to_sym,
-                      :Encoding => :WinAnsiEncoding)
+        font_dict = {:Type     => :Font,
+                     :Subtype  => :Type1,
+                     :BaseFont => name.to_sym}
+
+        # Symbolic AFM fonts (Symbol, ZapfDingbats) have their own encodings
+        font_dict.merge!(:Encoding => :WinAnsiEncoding) unless symbolic?
+
+        @document.ref!(font_dict)
+      end
+
+      def symbolic?
+        attributes["characterset"] == "Special"
       end
 
       def find_font(file)

data/lib/prawn/font/ttf.rb

@@ -5,6 +5,10 @@ module Prawn
   class Font
     class TTF < Font
       attr_reader :ttf, :subsets
+
+      def unicode?
+        true
+      end
       
       def initialize(document, name, options={})
         super

data/lib/prawn/graphics/color.rb

@@ -10,7 +10,9 @@ module Prawn
   module Graphics
     module Color
 
-      # Sets the fill color.
+      # Sets or returns the fill color.
+      #
+      # When called with no argument, it returns the current fill color.
       #
       # If a single argument is provided, it should be a 6 digit HTML color
       # code.
@@ -30,7 +32,9 @@ module Prawn
 
       alias_method :fill_color=, :fill_color
 
-      # Sets the line stroking color.  6 digit HTML color codes are used.
+      # Sets or returns the line stroking color.
+      #
+      # When called with no argument, it returns the current stroking color.
       #
       # If a single argument is provided, it should be a 6 digit HTML color
       # code.

data/lib/prawn/text/box.rb

@@ -234,6 +234,11 @@ module Prawn
                                            :kerning => @kerning,
                                            :size => @font_size,
                                            :width => @width)
+
+          if line_to_print.empty? && remaining_text.length > 0
+            raise Errors::CannotFit
+          end
+
           remaining_text = remaining_text.slice(line_to_print.length..
                                                 remaining_text.length)
           print_ellipses = (@overflow == :ellipses && last_line? &&
@@ -290,7 +295,8 @@ module Prawn
 
       def default_wrap_block
         lambda do |line, options|
-          scan_pattern = /\S+|\s+/
+          scan_pattern = options[:document].font.unicode? ? /\S+|\s+/ : /\S+|\s+/n
+          space_scan_pattern = options[:document].font.unicode? ? /\s/ : /\s/n
           output = ""
           accumulated_width = 0
           line.scan(scan_pattern).each do |segment|
@@ -304,9 +310,9 @@ module Prawn
             else
               # if the line contains white space, don't split the
               # final word that doesn't fit, just return what fits nicely
-              break if output =~ /\s/
+              break if output =~ space_scan_pattern
               
-              # if there is no white space on the curren tline, then just
+              # if there is no white space on the current line, then just
               # print whatever part of the last segment that will fit on the
               # line
               begin
@@ -319,6 +325,7 @@ module Prawn
                   output << char
                 end
               rescue
+                # not valid unicode
                 segment.each_char do |char|
                   accumulated_width += options[:document].width_of(char,
                                                   :size => options[:size],
@@ -335,10 +342,3 @@ module Prawn
     end
   end
 end
-
-
-class String
-  def first_line
-    self.each_line { |line| return line }
-  end
-end

data/spec/font_spec.rb

@@ -179,6 +179,12 @@ describe "AFM fonts" do
     end
 
   end
+
+  it "should omit /Encoding for symbolic fonts" do
+    zapf = @pdf.find_font "ZapfDingbats"
+    font_dict = zapf.send(:register, nil)
+    font_dict.data[:Encoding].should == nil
+  end
   
 end
 

data/spec/snapshot_spec.rb

@@ -123,5 +123,16 @@ describe "Prawn::Document#transaction" do
 
   end
 
+  it "should restore page_number on rollback" do
+    Prawn::Document.new do
+      transaction do
+        5.times { start_new_page }
+        rollback
+      end
+
+      page_number.should == 1
+    end
+  end
+
 end
 

data/spec/text_box_spec.rb

@@ -233,90 +233,118 @@ end
 
   
 describe 'Text::Box wrapping' do
-  
+  before(:each) do
+    create_pdf
+  end
 
   it "should wrap text" do
     text = "Please wrap this text about HERE. More text that should be wrapped"
     expect = "Please wrap this text about\nHERE. More text that should be\nwrapped"
 
-    @pdf = Prawn::Document.new
     @pdf.font "Courier"
-    @text_box = Prawn::Text::Box.new(text,
+    text_box = Prawn::Text::Box.new(text,
                                           :width    => 220,
                                           :overflow => :expand,
                                           :document => @pdf)
-    @text_box.render
-    @text_box.text.should == expect
+    text_box.render
+    text_box.text.should == expect
   end
 
   it "should respect end of line when wrapping text" do
     text = "Please wrap only before\nTHIS word. Don't wrap this"
     expect = text
 
-    @pdf = Prawn::Document.new
     @pdf.font "Courier"
-    @text_box = Prawn::Text::Box.new(text,
+    text_box = Prawn::Text::Box.new(text,
                                           :width    => 220,
                                           :overflow => :expand,
                                           :document => @pdf)
-    @text_box.render
-    @text_box.text.should == expect
+    text_box.render
+    text_box.text.should == expect
   end
 
   it "should respect multiple newlines when wrapping text" do
     text = "Please wrap only before THIS\n\nword. Don't wrap this"
     expect= "Please wrap only before\nTHIS\n\nword. Don't wrap this"
 
-    @pdf = Prawn::Document.new
     @pdf.font "Courier"
-    @text_box = Prawn::Text::Box.new(text,
+    text_box = Prawn::Text::Box.new(text,
                                           :width    => 200,
                                           :overflow => :expand,
                                           :document => @pdf)
-    @text_box.render
-    @text_box.text.should == expect
+    text_box.render
+    text_box.text.should == expect
   end
 
   it "should respect multiple newlines when wrapping text when those newlines coincide with a line break" do
     text = "Please wrap only before\n\nTHIS word. Don't wrap this"
     expect = text
 
-    @pdf = Prawn::Document.new
     @pdf.font "Courier"
-    @text_box = Prawn::Text::Box.new(text,
+    text_box = Prawn::Text::Box.new(text,
                                           :width    => 220,
                                           :overflow => :expand,
                                           :document => @pdf)
-    @text_box.render
-    @text_box.text.should == expect
+    text_box.render
+    text_box.text.should == expect
   end
 
   it "should respect initial newlines" do
     text = "\nThis should be on line 2"
     expect = text
 
-    @pdf = Prawn::Document.new
     @pdf.font "Courier"
-    @text_box = Prawn::Text::Box.new(text,
+    text_box = Prawn::Text::Box.new(text,
                                           :width    => 220,
                                           :overflow => :expand,
                                           :document => @pdf)
-    @text_box.render
-    @text_box.text.should == expect
+    text_box.render
+    text_box.text.should == expect
   end
 
   it "should wrap lines comprised of a single word of the bounds when wrapping text" do
     text = "You_can_wrap_this_text_HERE"
     expect = "You_can_wrap_this_text_HE\nRE"
 
-    @pdf = Prawn::Document.new
     @pdf.font "Courier"
-    @text_box = Prawn::Text::Box.new(text,
+    text_box = Prawn::Text::Box.new(text,
                                           :width    => 180,
                                           :overflow => :expand,
                                           :document => @pdf)
-    @text_box.render
-    @text_box.text.should == expect
-  end     
+    text_box.render
+    text_box.text.should == expect
+  end
+
+  it "should wrap lines comprised of a single word of the bounds when wrapping text" do
+    text = '©' * 30
+
+    @pdf.font "Courier"
+    text_box = Prawn::Text::Box.new(text, :width => 180,
+                                           :overflow => :expand,
+                                           :document => @pdf)
+
+    text_box.render
+
+    expected = '©'*25 + "\n" + '©' * 5
+    @pdf.font.normalize_encoding!(expected)
+
+    text_box.text.should == expected
+  end
+
+  it "should wrap non-unicode strings using single-byte word-wrapping" do
+    text = "continúa esforzandote " * 5
+    text_box = Prawn::Text::Box.new(text, :width => 180,
+                                     :document => @pdf)
+    text_box.render
+    results_with_accent = text_box.text
+
+    text = "continua esforzandote " * 5
+    text_box = Prawn::Text::Box.new(text, :width => 180,
+                                     :document => @pdf)
+    text_box.render
+    results_without_accent = text_box.text
+
+    results_with_accent.first_line.length.should == results_without_accent.first_line.length
+  end
   
 end

data/spec/text_spec.rb

@@ -12,6 +12,12 @@ describe "#height_of" do
     new_y = @pdf.y
     @pdf.height_of("Foo", :width => 300).should.be.close(original_y - new_y, 0.0001)
   end
+
+  it "should raise CannotFit if a too-small width is given" do
+    lambda do
+      @pdf.height_of("text", :width => 1)
+    end.should.raise(Prawn::Errors::CannotFit)
+  end
 end
 
 describe "when drawing text" do     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: prawn-core
 version: !ruby/object:Gem::Version 
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors: 
 - Gregory Brown
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-03 00:00:00 -05:00
+date: 2010-01-31 00:00:00 -05:00
 default_executable: 
 dependencies: []