davebenvenuti-prawn 0.11.1.pre

data/spec/formatted_text_fragment_spec.rb

@@ -0,0 +1,211 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "Text::Formatted::Fragment#word_spacing=" do
+  before(:each) do
+    create_pdf
+    format_state = { :styles => [:bold, :italic],
+                     :color => nil,
+                     :link => nil,
+                     :anchor => nil,
+                     :font => nil,
+                     :size => nil }
+    @fragment = Prawn::Text::Formatted::Fragment.new("hello world",
+                                                     format_state,
+                                                     @pdf)
+    @fragment.width = 100
+    @fragment.left = 50
+    @fragment.baseline = 200
+    @fragment.line_height = 27
+    @fragment.descender = 7
+    @fragment.ascender = 17
+    @fragment.word_spacing = 10
+  end
+  
+  it "should account for word_spacing in #width" do
+    @fragment.width.should == 110
+  end
+  it "should account for word_spacing in #bounding_box" do
+    target_box = [50, 193, 160, 217]
+    @fragment.bounding_box.should == target_box
+  end
+  it "should account for word_spacing in #absolute_bounding_box" do
+    target_box = [50, 193, 160, 217]
+    target_box[0] += @pdf.bounds.absolute_left
+    target_box[1] += @pdf.bounds.absolute_bottom
+    target_box[2] += @pdf.bounds.absolute_left
+    target_box[3] += @pdf.bounds.absolute_bottom
+    @fragment.absolute_bounding_box.should == target_box
+  end
+  it "should account for word_spacing in #underline_points" do
+    y = 198.75
+    target_points = [[50, y], [160, y]]
+    @fragment.underline_points.should == target_points
+  end
+  it "should account for word_spacing in #strikethrough_points" do
+    y = 200 + @fragment.ascender * 0.3
+    target_points = [[50, y], [160, y]]
+    @fragment.strikethrough_points.should == target_points
+  end
+end
+
+describe "Text::Formatted::Fragment" do
+  before(:each) do
+    create_pdf
+    format_state = { :styles => [:bold, :italic],
+                     :color => nil,
+                     :link => nil,
+                     :anchor => nil,
+                     :font => nil,
+                     :size => nil }
+    @fragment = Prawn::Text::Formatted::Fragment.new("hello world",
+                                                     format_state,
+                                                     @pdf)
+    @fragment.width = 100
+    @fragment.left = 50
+    @fragment.baseline = 200
+    @fragment.line_height = 27
+    @fragment.descender = 7
+    @fragment.ascender = 17
+  end
+  
+  describe "#width" do
+    it "should return the width" do
+      @fragment.width.should == 100
+    end
+  end
+
+  describe "#styles" do
+    it "should return the styles array" do
+      @fragment.styles.should == [:bold, :italic]
+    end
+    it "should never return nil" do
+      format_state = { :styles => nil,
+                       :color => nil,
+                       :link => nil,
+                       :anchor => nil,
+                       :font => nil,
+                       :size => nil }
+      fragment = Prawn::Text::Formatted::Fragment.new("hello world",
+                                                      format_state,
+                                                      @pdf)
+      fragment.styles.should == []
+    end
+  end
+
+  describe "#line_height" do
+    it "should return the line_height" do
+      @fragment.line_height.should == 27
+    end
+  end
+
+  describe "#ascender" do
+    it "should return the ascender" do
+      @fragment.ascender.should == 17
+    end
+  end
+
+  describe "#descender" do
+    it "should return the descender" do
+      @fragment.descender.should == 7
+    end
+  end
+
+  describe "#y_offset" do
+    it "should be zero" do
+      @fragment.y_offset.should == 0
+    end
+  end
+
+  describe "#bounding_box" do
+    it "should return the bounding box surrounding the fragment" do
+      target_box = [50, 193, 150, 217]
+      @fragment.bounding_box.should == target_box
+    end
+  end
+
+  describe "#absolute_bounding_box" do
+    it "should return the bounding box surrounding the fragment" +
+       " in absolute coordinates" do
+      target_box = [50, 193, 150, 217]
+        target_box[0] += @pdf.bounds.absolute_left
+        target_box[1] += @pdf.bounds.absolute_bottom
+        target_box[2] += @pdf.bounds.absolute_left
+        target_box[3] += @pdf.bounds.absolute_bottom
+      @fragment.absolute_bounding_box.should == target_box
+    end
+  end
+
+  describe "#underline_points" do
+    it "should define a line under the fragment" do
+      y = 198.75
+      target_points = [[50, y], [150, y]]
+      @fragment.underline_points.should == target_points
+    end
+  end
+
+  describe "#strikethrough_points" do
+    it "should define a line through the fragment" do
+      y = 200 + @fragment.ascender * 0.3
+      target_points = [[50, y], [150, y]]
+      @fragment.strikethrough_points.should == target_points
+    end
+  end
+end
+
+describe "Text::Formatted::Fragment that is a subscript" do
+  before(:each) do
+    create_pdf
+    format_state = { :styles => [:subscript],
+                     :color => nil,
+                     :link => nil,
+                     :anchor => nil,
+                     :font => nil,
+                     :size => nil }
+    @fragment = Prawn::Text::Formatted::Fragment.new("hello world",
+                                                     format_state,
+                                                     @pdf)
+    @fragment.line_height = 27
+    @fragment.descender = 7
+    @fragment.ascender = 17
+  end
+  describe "#subscript?" do
+    it "should be true" do
+      @fragment.should.be.subscript
+    end
+  end
+  describe "#y_offset" do
+    it "should return a negative value" do
+      @fragment.y_offset.should.be < 0
+    end
+  end
+end
+
+describe "Text::Formatted::Fragment that is a superscript" do
+  before(:each) do
+    create_pdf
+    format_state = { :styles => [:superscript],
+                     :color => nil,
+                     :link => nil,
+                     :anchor => nil,
+                     :font => nil,
+                     :size => nil }
+    @fragment = Prawn::Text::Formatted::Fragment.new("hello world",
+                                                     format_state,
+                                                     @pdf)
+    @fragment.line_height = 27
+    @fragment.descender = 7
+    @fragment.ascender = 17
+  end
+  describe "#superscript?" do
+    it "should be true" do
+      @fragment.should.be.superscript
+    end
+  end
+  describe "#y_offset" do
+    it "should return a positive value" do
+      @fragment.y_offset.should.be > 0
+    end
+  end
+end

data/spec/graphics_spec.rb

@@ -0,0 +1,446 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "When drawing a line" do
+
+  before(:each) { create_pdf }
+
+  it "should draw a line from (100,600) to (100,500)" do
+    @pdf.line([100,600],[100,500])
+
+    line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+
+    line_drawing.points.should == [[100,600],[100,500]]
+  end
+
+  it "should draw two lines at (100,600) to (100,500) " +
+     "and (75,100) to (50,125)" do
+    @pdf.line(100,600,100,500)
+    @pdf.line(75,100,50,125)
+
+    line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+
+    line_drawing.points.should ==
+      [[100.0, 600.0], [100.0, 500.0], [75.0, 100.0], [50.0, 125.0]]
+  end
+
+  it "should properly set line width via line_width=" do
+     @pdf.line_width = 10
+     line = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+     line.widths.first.should == 10
+  end
+
+  it "should properly set line width via line_width(width)" do
+     @pdf.line_width(10)
+     line = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+     line.widths.first.should == 10
+  end
+
+  it "should carry the current line width settings over to new pages" do
+    @pdf.line_width(10)
+    @pdf.start_new_page
+    line = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+    line.widths.length.should == 2
+    line.widths[1].should == 10
+  end
+
+  describe "(Horizontally)" do
+    it "should draw from [x1,pdf.y],[x2,pdf.y]" do
+      @pdf.horizontal_line(100,150)
+      @line = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+      @line.points.should == [[100.0 + @pdf.bounds.absolute_left, @pdf.y],
+                              [150.0 + @pdf.bounds.absolute_left, @pdf.y]]
+    end
+
+    it "should draw a line from (200, 250) to (300, 250)" do
+      @pdf.horizontal_line(200,300,:at => 250)
+      line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+      line_drawing.points.should == [[200,250],[300,250]]
+    end
+  end
+
+  describe "(Vertically)" do
+    it "should draw a line from (350, 300) to (350, 400)" do
+      @pdf.vertical_line(300,400,:at => 350)
+      line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+      line_drawing.points.should == [[350,300],[350,400]]
+    end
+    it "should require a y coordinate" do
+      lambda { @pdf.vertical_line(400,500) }.
+        should.raise(ArgumentError)
+    end
+  end
+
+end
+
+describe "When drawing a polygon" do
+
+  before(:each) { create_pdf }
+
+  it "should draw each line passed to polygon()" do
+    @pdf.polygon([100,500],[100,400],[200,400])
+
+    line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render)
+    line_drawing.points.should == [[100,500],[100,400],[200,400],[100,500]]
+  end
+
+end
+
+describe "When drawing a rectangle" do
+
+  before(:each) { create_pdf }
+
+  it "should use a point, width, and height for coords" do
+    @pdf.rectangle [200,200], 50, 100
+
+    rectangles = PDF::Inspector::Graphics::Rectangle.
+      analyze(@pdf.render).rectangles
+    # PDF uses bottom left corner
+    rectangles[0][:point].should  == [200,100]
+    rectangles[0][:width].should  == 50
+    rectangles[0][:height].should == 100
+
+  end
+
+end
+
+describe "When drawing a curve" do
+
+  before(:each) { create_pdf }
+
+  it "should draw a bezier curve from 50,50 to 100,100" do
+    @pdf.move_to  [50,50]
+    @pdf.curve_to [100,100],:bounds => [[20,90], [90,70]]
+    curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render)
+    curve.coords.should == [50.0, 50.0, 20.0, 90.0, 90.0, 70.0, 100.0, 100.0]
+  end
+
+  it "should draw a bezier curve from 100,100 to 50,50" do
+    @pdf.curve [100,100], [50,50], :bounds => [[20,90], [90,75]]
+    curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render)
+    curve.coords.should == [100.0, 100.0, 20.0, 90.0, 90.0, 75.0, 50.0, 50.0]
+  end
+  
+
+end
+
+describe "When drawing a rounded rectangle" do
+  before(:each) do
+    create_pdf
+    @pdf.rounded_rectangle([50, 550], 50, 100, 10)
+    curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render)
+    curve_points = []
+    curve.coords.each_slice(2) {|p| curve_points << p}
+    @original_point = curve_points.shift
+    curves = []
+    curve_points.each_slice(3) {|c| curves << c}
+    line_points = PDF::Inspector::Graphics::Line.analyze(@pdf.render).points
+    line_points.shift
+    @all_coords = []
+    line_points.zip(curves).flatten.each_slice(2) {|p| @all_coords << p }
+    @all_coords.unshift @original_point
+  end
+  
+  it "should draw a rectangle by connecting lines with rounded bezier curves" do
+    @all_coords.should == [[60.0, 550.0],[90.0, 550.0], [95.523, 550.0], [100.0, 545.523], [100.0, 540.0], 
+                           [100.0, 460.0], [100.0, 454.477], [95.523, 450.0], [90.0, 450.0], 
+                           [60.0, 450.0], [54.477, 450.0], [50.0, 454.477], [50.0, 460.0], 
+                           [50.0, 540.0], [50.0, 545.523], [54.477, 550.0], [60.0, 550.0]]
+  end
+  
+  it "should start and end with the same point" do
+    @original_point.should == @all_coords.last
+  end
+     
+  
+end
+
+describe "When drawing an ellipse" do
+  before(:each) do
+    create_pdf
+    @pdf.ellipse_at [100,100], 25, 50
+    @curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render)
+  end
+
+  it "should move the pointer to the center of the ellipse after drawing" do
+    @curve.coords[-2..-1].should == [100,100]
+  end
+
+end
+
+describe "When drawing a circle" do
+  before(:each) do
+    create_pdf
+    @pdf.circle_at [100,100], :radius => 25
+    @pdf.ellipse_at [100,100], 25, 25
+    @curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render)
+  end
+
+  it "should stroke the same path as the equivalent ellipse" do
+    middle = @curve.coords.length / 2
+    @curve.coords[0...middle].should == @curve.coords[middle..-1]
+  end
+end
+
+describe "When setting colors" do
+
+  before(:each) { create_pdf }
+
+  it "should set stroke colors" do
+    @pdf.stroke_color "ffcccc"
+    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render)
+    # 100% red, 80% green, 80% blue
+    colors.stroke_color.should == [1.0, 0.8, 0.8]
+  end
+
+  it "should set fill colors" do
+    @pdf.fill_color "ccff00"
+    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render)
+    # 80% red, 100% green, 0% blue
+    colors.fill_color.should == [0.8,1.0,0]
+  end
+
+  it "should reset the colors on each new page if they have been defined" do
+    @pdf.fill_color "ccff00"
+    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render)
+
+    colors.fill_color_count.should == 2
+    colors.stroke_color_count.should == 1
+    @pdf.start_new_page
+    @pdf.stroke_color "ff00cc"
+
+    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render)
+    colors.fill_color_count.should == 3
+    colors.stroke_color_count.should == 3
+
+    @pdf.start_new_page
+    colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render)
+    colors.fill_color_count.should == 4
+    colors.stroke_color_count.should == 4
+
+    colors.fill_color.should   == [0.8,1.0,0.0]
+    colors.stroke_color.should == [1.0,0.0,0.8]
+  end
+
+end
+
+describe "When using painting shortcuts" do
+  before(:each) { create_pdf }
+
+  it "should convert stroke_some_method(args) into some_method(args); stroke" do
+    @pdf.expects(:line_to).with([100,100])
+    @pdf.expects(:stroke)
+
+    @pdf.stroke_line_to [100,100]
+  end
+
+  it "should convert fill_some_method(args) into some_method(args); fill" do
+    @pdf.expects(:line_to).with([100,100])
+    @pdf.expects(:fill)
+
+    @pdf.fill_line_to [100,100]
+  end
+
+  it "should not break method_missing" do
+    lambda { @pdf.i_have_a_pretty_girlfriend_named_jia }.
+      should.raise(NoMethodError)
+  end
+end
+
+describe "When using graphics states" do
+  before(:each) { create_pdf }
+  
+  it "should add the right content on save_graphics_state" do
+    @pdf.expects(:add_content).with('q')
+    
+    @pdf.save_graphics_state
+  end
+
+  it "should add the right content on restore_graphics_state" do
+    @pdf.expects(:add_content).with('Q')
+    
+    @pdf.restore_graphics_state
+  end
+  
+  it "should save and restore when save_graphics_state is used with a block" do
+    state = sequence "state"
+    @pdf.expects(:add_content).with('q').in_sequence(state)
+    @pdf.expects(:foo).in_sequence(state)
+    @pdf.expects(:add_content).with('Q').in_sequence(state)
+    
+    @pdf.save_graphics_state do
+      @pdf.foo
+    end
+  end
+end
+
+describe "When using transformation matrix" do
+  before(:each) { create_pdf }
+
+  # Note: The (approximate) number of significant decimal digits of precision in fractional
+  # part is 5 (PDF Reference, Third Edition, p. 706)
+  
+  it "should send the right content on transformation_matrix" do
+    @pdf.expects(:add_content).with('1.00000 0.00000 0.12346 -1.00000 5.50000 20.00000 cm')
+    @pdf.transformation_matrix 1, 0, 0.123456789, -1.0, 5.5, 20
+  end
+    
+  it "should use fixed digits with very small number" do
+    values = Array.new(6, 0.000000000001)
+    string = Array.new(6, "0.00000").join " "
+    @pdf.expects(:add_content).with("#{string} cm")
+    @pdf.transformation_matrix *values
+  end
+    
+  it "should be received by the inspector" do
+    @pdf.transformation_matrix 1, 0, 0, -1, 5.5, 20
+    matrices = PDF::Inspector::Graphics::Matrix.analyze(@pdf.render)
+    matrices.matrices.should == [[1, 0, 0, -1, 5.5, 20]]
+  end
+
+  it "should save the graphics state inside the given block" do
+    values = Array.new(6, 0.000000000001)
+    string = Array.new(6, "0.00000").join " "
+    process = sequence "process"
+    
+    @pdf.expects(:save_graphics_state).with().in_sequence(process)
+    @pdf.expects(:add_content).with("#{string} cm").in_sequence(process)
+    @pdf.expects(:do_something).with().in_sequence(process)
+    @pdf.expects(:restore_graphics_state).with().in_sequence(process)
+    @pdf.transformation_matrix(*values) do
+      @pdf.do_something
+    end
+  end
+    
+end
+
+describe "When using transformations shortcuts" do
+  before(:each) do
+    create_pdf
+    @x, @y = 12, 54.32
+    @angle = 12.32
+    @cos = Math.cos(@angle * Math::PI / 180)
+    @sin = Math.sin(@angle * Math::PI / 180)
+    @factor = 0.12
+  end
+
+  describe "#rotate" do
+    it "should rotate" do
+      @pdf.expects(:transformation_matrix).with(@cos, @sin, -@sin, @cos, 0, 0)
+      @pdf.rotate(@angle)
+    end
+  end
+
+  describe "#rotate with :origin option" do
+    it "should rotate around the origin" do
+      x_prime = @x * @cos - @y * @sin
+      y_prime = @x * @sin + @y * @cos
+
+      @pdf.rotate(@angle, :origin => [@x, @y]) { @pdf.text('hello world') }
+
+      matrices = PDF::Inspector::Graphics::Matrix.analyze(@pdf.render)
+      matrices.matrices[0].should == [1, 0, 0, 1,
+                                      reduce_precision(@x - x_prime),
+                                      reduce_precision(@y - y_prime)]
+      matrices.matrices[1].should == [reduce_precision(@cos),
+                                      reduce_precision(@sin),
+                                      reduce_precision(-@sin),
+                                      reduce_precision(@cos), 0, 0]
+    end
+
+    it "should rotate around the origin in a document with a margin" do
+      @pdf = Prawn::Document.new
+
+      @pdf.rotate(@angle, :origin => [@x, @y]) { @pdf.text('hello world') }
+
+      x = @x + @pdf.bounds.absolute_left
+      y = @y + @pdf.bounds.absolute_bottom
+      x_prime = x * @cos - y * @sin
+      y_prime = x * @sin + y * @cos
+
+      matrices = PDF::Inspector::Graphics::Matrix.analyze(@pdf.render)
+      matrices.matrices[0].should == [1, 0, 0, 1,
+                                      reduce_precision(x - x_prime),
+                                      reduce_precision(y - y_prime)]
+      matrices.matrices[1].should == [reduce_precision(@cos),
+                                      reduce_precision(@sin),
+                                      reduce_precision(-@sin),
+                                      reduce_precision(@cos), 0, 0]
+    end
+
+    it "should raise BlockRequired if no block is given" do
+      lambda {
+        @pdf.rotate(@angle, :origin => [@x, @y])
+      }.should.raise(Prawn::Errors::BlockRequired)
+    end
+
+    def reduce_precision(float)
+      ("%.5f" % float).to_f
+    end
+  end
+
+  describe "#translate" do
+    it "should translate" do
+      x, y = 12, 54.32
+      @pdf.expects(:transformation_matrix).with(1, 0, 0, 1, x, y)
+      @pdf.translate(x, y)
+    end
+  end
+
+  describe "#scale" do
+    it "should scale" do
+      @pdf.expects(:transformation_matrix).with(@factor, 0, 0, @factor, 0, 0)
+      @pdf.scale(@factor)
+    end
+  end
+
+  describe "#scale with :origin option" do
+    it "should scale from the origin" do
+      x_prime = @factor * @x
+      y_prime = @factor * @y
+
+      @pdf.scale(@factor, :origin => [@x, @y]) { @pdf.text('hello world') }
+
+      matrices = PDF::Inspector::Graphics::Matrix.analyze(@pdf.render)
+      matrices.matrices[0].should == [1, 0, 0, 1,
+                                      reduce_precision(@x - x_prime),
+                                      reduce_precision(@y - y_prime)]
+      matrices.matrices[1].should == [@factor, 0, 0, @factor, 0, 0]
+    end
+
+    it "should scale from the origin in a document with a margin" do
+      @pdf = Prawn::Document.new
+      x = @x + @pdf.bounds.absolute_left
+      y = @y + @pdf.bounds.absolute_bottom
+      x_prime = @factor * x
+      y_prime = @factor * y
+
+      @pdf.scale(@factor, :origin => [@x, @y]) { @pdf.text('hello world') }
+
+      matrices = PDF::Inspector::Graphics::Matrix.analyze(@pdf.render)
+      matrices.matrices[0].should == [1, 0, 0, 1,
+                                      reduce_precision(x - x_prime),
+                                      reduce_precision(y - y_prime)]
+      matrices.matrices[1].should == [@factor, 0, 0, @factor, 0, 0]
+    end
+
+    it "should raise BlockRequired if no block is given" do
+      lambda {
+        @pdf.scale(@factor, :origin => [@x, @y])
+      }.should.raise(Prawn::Errors::BlockRequired)
+    end
+
+    def reduce_precision(float)
+      ("%.5f" % float).to_f
+    end
+  end
+
+  # describe "skew" do
+  #   it "should skew" do
+  #     a, b = 30, 50.2
+  #     @pdf.expects(:transformation_matrix).with(1, Math.tan(a * Math::PI / 180), Math.tan(b * Math::PI / 180), 1, 0, 0)
+  #     @pdf.skew(a, b)
+  #   end
+  # end
+end