prawn 0.15.0 → 1.0.0.rc1

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

@@ -10,27 +10,39 @@ module Prawn
   module Text
     module Formatted
 
-
       # Prawn::Text::Formatted::Fragment is a state store for a formatted text
       # fragment. It does not render anything.
       #
-      # @private
       class Fragment
 
-        attr_reader :format_state, :text
+        attr_reader :format_state
         attr_writer :width
         attr_accessor :line_height, :descender, :ascender
         attr_accessor :word_spacing, :left, :baseline
 
         def initialize(text, format_state, document)
+          @text = text
           @format_state = format_state
           @document = document
           @word_spacing = 0
+        end
 
-          # keep the original value of "text", so we can reinitialize @text if formatting parameters
-          #   like text direction are changed
-          @original_text = text
-          @text = process_text(@original_text)
+        def text
+          string = strip_zero_width_spaces(@text)
+          if exclude_trailing_white_space?
+            string = string.rstrip
+            string = process_soft_hyphens(string)
+          end
+          case direction
+          when :rtl
+            if ruby_18 { true }
+              string.scan(/./mu).reverse.join
+            else
+              string.reverse
+            end
+          else
+            string
+          end
         end
 
         def width
@@ -93,10 +105,6 @@ module Prawn
           @format_state[:anchor]
         end
 
-        def local
-          @format_state[:local]
-        end
-
         def color
           @format_state[:color]
         end
@@ -119,19 +127,16 @@ module Prawn
         end
 
         def default_direction=(direction)
-          unless @format_state[:direction]
-            @format_state[:direction] = direction
-            @text = process_text(@original_text)
-          end
+          @format_state[:direction] = direction unless @format_state[:direction]
         end
 
         def include_trailing_white_space!
           @format_state.delete(:exclude_trailing_white_space)
-          @text = process_text(@original_text)
         end
 
         def space_count
-          @text.count(" ")
+          string = exclude_trailing_white_space? ? @text.rstrip : @text
+          string.count(" ")
         end
 
         def callback_objects
@@ -207,19 +212,6 @@ module Prawn
 
         private
 
-        def process_text(text)
-          string = strip_zero_width_spaces(text)
-          if exclude_trailing_white_space?
-            string = process_soft_hyphens(string.rstrip)
-          end
-          case direction
-          when :rtl
-            string.reverse
-          else
-            string
-          end
-        end
-
         def exclude_trailing_white_space?
           @format_state[:exclude_trailing_white_space]
         end
@@ -230,9 +222,6 @@ module Prawn
 
         def process_soft_hyphens(string)
           if string.length > 0 && normalized_soft_hyphen
-            if string.encoding != normalized_soft_hyphen.encoding
-              string.force_encoding(normalized_soft_hyphen.encoding)
-            end
             string[0..-2].gsub(normalized_soft_hyphen, "") + string[-1..-1]
           else
             string
@@ -240,7 +229,7 @@ module Prawn
         end
 
         def strip_zero_width_spaces(string)
-          if string.encoding == ::Encoding::UTF_8
+          if !"".respond_to?(:encoding) || string.encoding.to_s == "UTF-8"
             string.gsub(Prawn::Text::ZWSP, "")
           else
             string

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

@@ -13,9 +13,8 @@ module Prawn
     module Formatted
 
       class Parser
-        # @group Extension API
 
-        PARSER_REGEX = begin
+        def self.to_array(string)
           regex_string = "\n|" +
                          "<b>|</b>|" +
                          "<i>|</i>|" +
@@ -30,11 +29,8 @@ module Prawn
                          "<em>|</em>|" +
                          "<a[^>]*>|</a>|" +
                          "[^<\n]+"
-          Regexp.new(regex_string, Regexp::MULTILINE)
-        end
-
-        def self.format(string, *args)
-          tokens = string.gsub(/<br\s*\/?>/, "\n").scan(PARSER_REGEX)
+          regex = Regexp.new(regex_string, Regexp::MULTILINE)
+          tokens = string.gsub(/<br\s*\/?>/, "\n").scan(regex)
           self.array_from_tokens(tokens)
         end
 
@@ -126,11 +122,10 @@ module Prawn
           colors = []
           link = nil
           anchor = nil
-          local = nil
           fonts = []
           sizes = []
           character_spacings = []
-
+          
           while token = tokens.shift
             case token
             when "<b>", "<strong>"
@@ -160,7 +155,6 @@ module Prawn
             when "</link>", "</a>"
               link = nil
               anchor = nil
-              local = nil
             when "</color>"
               colors.pop
             when "</font>"
@@ -174,9 +168,6 @@ 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
@@ -188,7 +179,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 }
@@ -206,7 +197,6 @@ module Prawn
                 array << { :text => string,
                            :styles => styles.dup,
                            :color => colors.last,
-                           :local => local,
                            :link => link,
                            :anchor => anchor,
                            :font => fonts.last,

data/prawn.gemspec

@@ -1,37 +1,26 @@
+PRAWN_VERSION = "1.0.0.rc1"
+
 Gem::Specification.new do |spec|
   spec.name = "prawn"
-  spec.version = File.read(File.expand_path('VERSION', File.dirname(__FILE__))).strip
+  spec.version = PRAWN_VERSION
   spec.platform = Gem::Platform::RUBY
   spec.summary = "A fast and nimble PDF generator for Ruby"
-  spec.files =  Dir.glob("{examples,lib,spec,manual}/**/**/*") +
-                Dir.glob("data/{encodings,images,pdfs}/*") +
-                Dir.glob("data/fonts/{MustRead.html,*.afm}") +
-                ["data/shift_jis_text.txt"] +
-                ["Rakefile", "prawn.gemspec", "Gemfile",
-                 "COPYING", "LICENSE", "GPLv2", "GPLv3",
-                 ".yardopts"]
+  spec.files =  Dir.glob("{examples,lib,spec,data}/**/**/*") +
+    ["Rakefile", "prawn.gemspec", "COPYING", "LICENSE", "GPLv2", "GPLv3"]
   spec.require_path = "lib"
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 1.8.7'
   spec.required_rubygems_version = ">= 1.3.6"
 
   spec.test_files = Dir[ "spec/*_spec.rb" ]
+  spec.extra_rdoc_files = %w{README.md LICENSE COPYING GPLv2 GPLv3}
+  spec.rdoc_options << '--title' << 'Prawn Documentation' <<
+                       '--main'  << 'README.md' << '-q'
   spec.authors = ["Gregory Brown","Brad Ediger","Daniel Nelson","Jonathan Greenberg","James Healy"]
   spec.email = ["gregory.t.brown@gmail.com","brad@bradediger.com","dnelson@bluejade.com","greenberg@entryway.net","jimmy@deefa.com"]
   spec.rubyforge_project = "prawn"
-  spec.licenses = ['RUBY', 'GPL-2', 'GPL-3']
-
-  spec.add_dependency('ttfunk', '~> 1.1.0')
-  spec.add_dependency('pdf-core', "~> 0.1.3")
-
-  spec.add_development_dependency('pdf-inspector', '~> 1.1.0')
-  spec.add_development_dependency('coderay', '~> 1.0.7')
-  spec.add_development_dependency('yard')
-  spec.add_development_dependency('rspec')
-  spec.add_development_dependency('mocha')
-  spec.add_development_dependency('rake')
-  spec.add_development_dependency('simplecov')
-  spec.add_development_dependency('pdf-reader', '~>1.2')
-
+  spec.add_dependency('pdf-reader', '>=0.9.0')
+  spec.add_dependency('ttfunk', '~>1.0.3')
+  spec.add_development_dependency('pdf-inspector', '~> 1.0.1')
   spec.homepage = "http://prawn.majesticseacreature.com"
   spec.description = <<END_DESC
   Prawn is a fast, tiny, and nimble PDF generator for Ruby
@@ -45,7 +34,7 @@ END_DESC
 
   Please read the changelog for details:
 
-  https://github.com/prawnpdf/prawn/wiki/CHANGELOG
+  https://github.com/sandal/prawn/wiki/CHANGELOG
 
 
   ********************************************

data/spec/annotations_spec.rb

@@ -1,19 +1,35 @@
 # encoding: utf-8
 
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")  
+                               
+class PageAnnotations
+  attr_reader :pages
+
+  def self.parse(document)
+    receiver = new
+    PDF::Reader.string(document.render, receiver)
+    return receiver
+  end
 
+  def initialize
+    @pages = []
+  end
 
-describe "When creating annotations" do
+  def begin_page(params)
+    @pages << params
+  end
+end
 
+describe "When creating annotations" do 
+ 
   before(:each) { create_pdf }
-
-  it "should append annotation to current page" do
+  
+  it "should append annotation to current page" do 
     @pdf.start_new_page
     @pdf.annotate(:Rect => [0,0,10,10], :Subtype => :Text, :Contents => "Hello world!")
-    PDF::Reader.open(StringIO.new(@pdf.render)) do |pdf|
-      pdf.page(1).attributes[:Annots].should be_nil
-      pdf.page(2).attributes[:Annots].size.should == 1
-    end
+    obj = PageAnnotations.parse(@pdf)
+    obj.pages[0][:Annots].nil?.should == true
+    obj.pages[1][:Annots].length.should == 1
   end
 
   it "should force :Type to be :Annot" do
@@ -26,14 +42,14 @@ describe "When creating annotations" do
 end
 
 describe "When creating text annotations" do
-
+ 
   before(:each) do
     @rect = [0,0,10,10]
     @content = "Hello, world!"
     create_pdf
   end
-
-  it "should build appropriate annotation" do
+  
+  it "should build appropriate annotation" do 
     opts = @pdf.text_annotation(@rect, @content)
     opts[:Type].should == :Annot
     opts[:Subtype].should == :Text
@@ -41,7 +57,7 @@ describe "When creating text annotations" do
     opts[:Contents].should == @content
   end
 
-  it "should merge extra options" do
+  it "should merge extra options" do 
     opts = @pdf.text_annotation(@rect, @content, :Open => true, :Subtype => :Bogus)
     opts[:Subtype].should == :Text
     opts[:Open].should == true
@@ -50,14 +66,14 @@ describe "When creating text annotations" do
 end
 
 describe "When creating link annotations" do
-
+ 
   before(:each) do
     @rect = [0,0,10,10]
     @dest = "home"
     create_pdf
   end
-
-  it "should build appropriate annotation" do
+  
+  it "should build appropriate annotation" do 
     opts = @pdf.link_annotation(@rect, :Dest => @dest)
     opts[:Type].should == :Annot
     opts[:Subtype].should == :Link
@@ -65,7 +81,7 @@ describe "When creating link annotations" do
     opts[:Dest].should == @dest
   end
 
-  it "should merge extra options" do
+  it "should merge extra options" do 
     opts = @pdf.link_annotation(@rect, :Dest => @dest, :Subtype => :Bogus)
     opts[:Subtype].should == :Link
     opts[:Dest].should == @dest

data/spec/bounding_box_spec.rb

@@ -84,14 +84,14 @@ describe "A bounding box" do
   it "should require width to be set" do
     lambda do
       Prawn::Document::BoundingBox.new(nil, nil, [100,100])
-    end.should raise_error(ArgumentError)
+    end.should.raise(ArgumentError)
   end
 
-  it "should raise_error an ArgumentError if a block is not passed" do
+  it "should raise an ArgumentError if a block is not passed" do
     pdf = Prawn::Document.new
     lambda do
       pdf.bounding_box([0, 0], :width => 200)
-    end.should raise_error(ArgumentError)
+    end.should.raise(ArgumentError)
   end
 
 end
@@ -100,15 +100,6 @@ describe "drawing bounding boxes" do
 
   before(:each) { create_pdf }
 
-  it "should not stomp on the arguments to bounding_box" do
-    pdf = Prawn::Document.new
-    x = [100, 500]
-    pdf.bounding_box x, :width => 100 do
-      pdf.text "bork-bork-bork"
-    end
-    x.should == [100, 500]
-  end
-
   it "should restore the margin box when bounding box exits" do
     margin_box = @pdf.bounds
 
@@ -144,7 +135,7 @@ describe "drawing bounding boxes" do
       @pdf.text "The rain in Spain falls mainly on the plains."
     end
 
-    @pdf.y.should be_within(0.001).of(458.384)
+    @pdf.y.should.be.close 458.384, 0.001
   end
 
   it "should keep track of the max height the box was stretched to" do
@@ -162,7 +153,7 @@ describe "drawing bounding boxes" do
         :height => 30 do
       @pdf.text "hello"
     end
-    @pdf.y.should be_within(0.001).of(orig_y - 30)
+    @pdf.y.should.be.close(orig_y - 30, 0.001)
   end
 
   it "should not advance y-position if passed :hold_position => true" do
@@ -172,7 +163,7 @@ describe "drawing bounding boxes" do
       @pdf.text "hello"
     end
     # y only advances by height of one line ("hello")
-    @pdf.y.should be_within(0.001).of(orig_y - @pdf.height_of("hello"))
+    @pdf.y.should.be.close(orig_y - @pdf.height_of("hello"), 0.001)
   end
 
   it "should not advance y-position of a stretchy bbox if it would stretch " +
@@ -188,8 +179,9 @@ describe "drawing bounding boxes" do
     # the bottom of the page, which we don't want. This should be equivalent to
     # a bbox with :hold_position => true, where we only advance by the amount
     # that was actually drawn.
-    @pdf.y.should be_within(0.001).of(
-      @pdf.margin_box.absolute_top - @pdf.height_of("hello")
+    @pdf.y.should.be.close(
+      @pdf.margin_box.absolute_top - @pdf.height_of("hello"),
+      0.001
     )
   end
 
@@ -269,7 +261,7 @@ describe "Indentation" do
                       :height => 200, :columns => 2, :spacer => 20) do
         width = @pdf.bounds.width
         @pdf.indent(20) do
-          @pdf.bounds.width.should be_within(0.01).of(width - 20)
+          @pdf.bounds.width.should.be.close(width - 20, 0.01)
         end
       end
     end
@@ -279,93 +271,11 @@ describe "Indentation" do
                       :height => 200, :columns => 2, :spacer => 20) do
         width = @pdf.bounds.width
         @pdf.indent(20, 30) do
-          @pdf.bounds.width.should be_within(0.01).of(width - 50)
-        end
-      end
-    end
-
-    it "should maintain the same left indentation across column breaks" do
-      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width, :columns => 3, :spacer => 15) do
-        3.times do |column|
-          x = @pdf.bounds.left_side
-          @pdf.indent(20) do
-            @pdf.bounds.left_side.should == x+20
-          end
-          @pdf.bounds.move_past_bottom
-        end
-      end
-    end
-
-    it "should not change the right margin if only left indentation is requested" do
-      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width, :columns => 3, :spacer => 15) do
-        3.times do |column|
-          x = @pdf.bounds.right_side
-          @pdf.indent(20) do
-            @pdf.bounds.right_side.should == x
-          end
-          @pdf.bounds.move_past_bottom
-        end
-      end
-    end
-
-    it "should maintain the same right indentation across columns" do
-      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width, :columns => 3, :spacer => 15) do
-        3.times do |column|
-          x = @pdf.bounds.right_side
-          @pdf.indent(20, 10) do
-            @pdf.bounds.right_side.should == x-10
-          end
-          @pdf.bounds.move_past_bottom
-        end
-      end
-    end
-
-    it "should keep the right indentation after nesting indents" do
-      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width, :columns => 3, :spacer => 15) do
-        3.times do |column|
-          # I am giving a right indent of 10...
-          @pdf.indent(20, 10) do
-            x = @pdf.bounds.right_side
-            # ...and no right indent here...
-            @pdf.indent(20) do
-              # right indent is inherited from the parent!
-              @pdf.bounds.right_side.should == x
-            end
-          end
-          @pdf.bounds.move_past_bottom
+          @pdf.bounds.width.should.be.close(width - 50, 0.01)
         end
       end
     end
 
-    it "should revert the right indentation if negative indent is given in nested indent" do
-      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width, :columns => 3, :spacer => 15) do
-        3.times do |column|
-          x = @pdf.bounds.right_side
-          @pdf.indent(20, 10) do
-            # requesting a negative right-indent of equivalent size...
-            @pdf.indent(20, -10) do
-              # ...resets the right margin to that of the column!
-              @pdf.bounds.right_side.should == x
-            end
-          end
-          @pdf.bounds.move_past_bottom
-        end
-      end
-    end
-
-    it "should reduce the available column width by the sum of all nested indents" do
-      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width, :columns => 3, :spacer => 15) do
-        3.times do |column|
-          w = @pdf.bounds.width
-          @pdf.indent(20, 10) do
-            @pdf.indent(20, 10) do
-              @pdf.bounds.width.should == w - 60
-            end
-          end
-          @pdf.bounds.move_past_bottom
-        end
-      end
-    end
   end
 end
 
@@ -378,28 +288,16 @@ describe "A canvas" do
     end
     @pdf.y.should == 450
   end
-
-  it "should restore the original ypos after execution", :issue => 523 do
-    doc = Prawn::Document.new(:skip_page_creation => true)
-    doc.start_new_page
-
-    original_ypos = doc.y
-
-    doc.canvas {}
-
-    doc.y.should == original_ypos
-  end
-
 end
 
 describe "Deep-copying" do
   it "should create a new object that does not copy @document" do
-    Prawn::Document.new do |pdf|
-      orig = pdf.bounds
+    Prawn::Document.new do
+      orig = bounds
       copy = orig.deep_copy
 
-      copy.should_not == pdf.bounds
-      copy.document.should be_nil
+      copy.should.not == bounds
+      copy.document.should.be.nil
     end
   end
 
@@ -414,7 +312,7 @@ describe "Deep-copying" do
         copy.parent.height.should == outside.height
 
         # but should not be the same object
-        copy.parent.should_not == outside
+        copy.parent.should.not == outside
       end
     end
   end
@@ -494,7 +392,7 @@ describe "BoundingBox#move_past_bottom" do
     @pdf.text "Foo"
 
     @pdf.bounds.move_past_bottom
-    @pdf.y.should be_within(0.001).of(top_y)
+    @pdf.y.should.be.close(top_y, 0.001) # we should be at the top
     @pdf.text "Bar"
 
     pages = PDF::Inspector::Page.analyze(@pdf.render).pages