prawn-git 2.0.1

data/spec/soft_mask_spec.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+module SoftMaskHelper
+  def make_soft_mask
+    @pdf.save_graphics_state do
+      @pdf.soft_mask do
+        if block_given?
+          yield
+        else
+          @pdf.fill_color '808080'
+          @pdf.fill_rectangle [100, 100], 200, 200
+        end
+      end
+
+      @pdf.fill_color '000000'
+      @pdf.fill_rectangle [0, 0], 200, 200
+    end
+  end
+end
+
+describe "Document with soft masks" do
+
+  include SoftMaskHelper
+
+  it "should have PDF version at least 1.4" do
+    create_pdf
+    make_soft_mask
+    str = @pdf.render
+    str[0,8].should == "%PDF-1.4"
+  end
+
+  it "should create a new extended graphics state for each unique soft mask" do
+    create_pdf
+
+    make_soft_mask do
+      @pdf.fill_color '808080'
+      @pdf.fill_rectangle [100, 100], 200, 200
+    end
+
+    make_soft_mask do
+      @pdf.fill_color '808080'
+      @pdf.fill_rectangle [10, 10], 200, 200
+    end
+
+    extgstates = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates
+    extgstates.length.should == 2
+  end
+
+  it "a new extended graphics state should contain soft mask with drawing instructions" do
+    create_pdf
+
+    make_soft_mask do
+      @pdf.fill_color '808080'
+      @pdf.fill_rectangle [100, 100], 200, 200
+    end
+
+    extgstate = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates.first
+    extgstate[:soft_mask][:G].data.should == "q\n/DeviceRGB cs\n0.000 0.000 0.000 scn\n/DeviceRGB CS\n0.000 0.000 0.000 SCN\n1 w\n0 J\n0 j\n[] 0 d\n/DeviceRGB cs\n0.502 0.502 0.502 scn\n100.0 -100.0 200.0 200.0 re\nf\nQ\n"
+  end
+
+  it "should not create duplicate extended graphics states" do
+    create_pdf
+
+    make_soft_mask do
+      @pdf.fill_color '808080'
+      @pdf.fill_rectangle [100, 100], 200, 200
+    end
+
+    make_soft_mask do
+      @pdf.fill_color '808080'
+      @pdf.fill_rectangle [100, 100], 200, 200
+    end
+
+    extgstates = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates
+    extgstates.length.should == 1
+  end
+end

data/spec/span_spec.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "drawing span" do
+
+  before do
+    Prawn.debug = false
+    create_pdf
+  end
+
+  after do
+    Prawn.debug = true
+  end
+
+  it "should only accept :position as option in debug mode" do
+    Prawn.debug = true
+    lambda { @pdf.span(350, {:x => 3}) {} }.should raise_error(Prawn::Errors::UnknownOption)
+  end
+
+  it "should have raise an error if :position is invalid" do
+    lambda { @pdf.span(350, :position => :x) {} }.should raise_error(ArgumentError)
+  end
+
+  it "should restore the margin box when bounding box exits" do
+    margin_box = @pdf.bounds
+
+    @pdf.span(350, :position => :center) do
+      @pdf.text "Here's some centered text in a 350 point column. " * 100
+    end
+
+    @pdf.bounds.should == margin_box
+  end
+
+  it "should do create a margin box" do
+    y = @pdf.y
+    margin_box = @pdf.span(350, :position => :center) do
+      @pdf.text "Here's some centered text in a 350 point column. " * 100
+    end
+
+    margin_box.top.should == 792.0
+    margin_box.bottom.should == 0
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+puts "Prawn specs: Running on Ruby Version: #{RUBY_VERSION}"
+
+require "bundler"
+Bundler.setup
+
+if ENV["COVERAGE"]
+  require "simplecov"
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
+require_relative "../lib/prawn"
+
+Prawn.debug = true
+Prawn::Font::AFM.hide_m17n_warning = true
+
+#require "test/spec"
+require "rspec"
+require "mocha/api"
+require "pdf/reader"
+require "pdf/inspector"
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/extensions/ and its subdirectories.
+Dir[File.dirname(__FILE__) + "/extensions/**/*.rb"].each {|f| require f }
+
+RSpec.configure do |config|
+  config.mock_framework = :mocha
+  config.include EncodingHelpers
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end
+
+def create_pdf(klass=Prawn::Document)
+  @pdf = klass.new(:margin => 0)
+end
+
+RSpec::Matchers.define :have_parseable_xobjects do
+  match do |actual|
+    expect { PDF::Inspector::XObject.analyze(actual.render) }.not_to raise_error
+    true
+  end
+  failure_message_for_should do |actual|
+    "expected that #{actual}'s XObjects could be successfully parsed"
+  end
+end
+
+# Make some methods public to assist in testing
+module Prawn::Graphics
+  public :map_to_absolute
+end
+

data/spec/stamp_spec.rb

@@ -0,0 +1,160 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "create_stamp before any page is added" do
+  it "should work with the font class" do
+    @pdf = Prawn::Document.new(:skip_page_creation => true)
+
+    # If anything goes wrong, Prawn::Errors::NotOnPage will be raised
+    @pdf.create_stamp("my_stamp") do
+      @pdf.font.height
+    end
+  end
+
+  it "should work with setting color" do
+    @pdf = Prawn::Document.new(:skip_page_creation => true)
+
+    # If anything goes wrong, Prawn::Errors::NotOnPage will be raised
+    @pdf.create_stamp("my_stamp") do
+      @pdf.fill_color = 'ff0000'
+    end
+  end
+end
+
+describe "#stamp_at" do
+  it "should work" do
+    create_pdf
+    @pdf.create_stamp("MyStamp")
+    @pdf.stamp_at("MyStamp", [100, 200])
+    # I had modified PDF::Inspector::XObject to receive the
+    # invoke_xobject message and count the number of times it was
+    # called, but it was only called once, so I reverted checking the
+    # output with a regular expression
+    @pdf.render.should =~ /\/Stamp1 Do.*?/m
+  end
+end
+
+describe "Document with a stamp" do
+  it "should raise_error NameTaken error when attempt to create stamp "+
+     "with same name as an existing stamp" do
+    create_pdf
+    @pdf.create_stamp("MyStamp")
+    lambda {
+      @pdf.create_stamp("MyStamp")
+    }.should raise_error(Prawn::Errors::NameTaken)
+  end
+
+  it "should raise_error InvalidName error when attempt to create "+
+     "stamp with a blank name" do
+    create_pdf
+    lambda {
+      @pdf.create_stamp("")
+    }.should raise_error(Prawn::Errors::InvalidName)
+  end
+
+  it "a new XObject should be defined for each stamp created" do
+    create_pdf
+    @pdf.create_stamp("MyStamp")
+    @pdf.create_stamp("AnotherStamp")
+    @pdf.stamp("MyStamp")
+    @pdf.stamp("AnotherStamp")
+
+    inspector = PDF::Inspector::XObject.analyze(@pdf.render)
+    xobjects = inspector.page_xobjects.last
+    xobjects.length.should == 2
+  end
+
+  it "calling stamp with a name that does not match an existing stamp "+
+     "should raise_error UndefinedObjectName" do
+    create_pdf
+    @pdf.create_stamp("MyStamp")
+    lambda {
+      @pdf.stamp("OtherStamp")
+    }.should raise_error(Prawn::Errors::UndefinedObjectName)
+  end
+
+  it "stamp should be drawn into the document each time stamp is called" do
+    create_pdf
+    @pdf.create_stamp("MyStamp")
+    @pdf.stamp("MyStamp")
+    @pdf.stamp("MyStamp")
+    @pdf.stamp("MyStamp")
+    # I had modified PDF::Inspector::XObject to receive the
+    # invoke_xobject message and count the number of times it was
+    # called, but it was only called once, so I reverted checking the
+    # output with a regular expression
+    @pdf.render.should =~ /(\/Stamp1 Do.*?){3}/m
+  end
+
+  it "resources added during stamp creation should be added to the "+
+     "stamp XObject, not the page" do
+    create_pdf
+    @pdf.create_stamp("MyStamp") do
+      @pdf.transparent(0.5) { @pdf.circle([100, 100], 10)}
+    end
+    @pdf.stamp("MyStamp")
+
+    # Inspector::XObject does not give information about resources, so
+    # resorting to string matching
+
+    output = @pdf.render
+    objects = output.split("endobj")
+    objects.each do |object|
+      if object =~ /\/Type \/Page$/
+        object.should_not =~ /\/ExtGState/
+      elsif object =~ /\/Type \/XObject$/
+        object.should =~ /\/ExtGState/
+      end
+    end
+  end
+
+  it "stamp stream should be wrapped in a graphic state" do
+    create_pdf
+    @pdf.create_stamp("MyStamp") do
+      @pdf.text "This should have a 'q' before it and a 'Q' after it"
+    end
+    @pdf.stamp("MyStamp")
+    stamps = PDF::Inspector::XObject.analyze(@pdf.render)
+    stamps.xobject_streams[:Stamp1].data.chomp.should =~ /q(.|\s)*Q\Z/
+  end
+
+  it "should not add to the page graphic state stack " do
+    create_pdf
+    @pdf.state.page.stack.stack.size.should == 1
+
+    @pdf.create_stamp("MyStamp") do
+      @pdf.save_graphics_state
+      @pdf.save_graphics_state
+      @pdf.save_graphics_state
+      @pdf.text "This should have a 'q' before it and a 'Q' after it"
+      @pdf.restore_graphics_state
+    end
+    @pdf.state.page.stack.stack.size.should == 1
+  end
+
+  it "should be able to change fill and stroke colors within the stamp stream" do
+    create_pdf
+    @pdf.create_stamp("MyStamp") do
+      @pdf.fill_color(100, 100, 20, 0)
+      @pdf.stroke_color(100, 100, 20, 0)
+    end
+    @pdf.stamp("MyStamp")
+    stamps = PDF::Inspector::XObject.analyze(@pdf.render)
+    stamp_stream = stamps.xobject_streams[:Stamp1].data
+    stamp_stream.should include("/DeviceCMYK cs\n1.000 1.000 0.200 0.000 scn")
+    stamp_stream.should include("/DeviceCMYK CS\n1.000 1.000 0.200 0.000 SCN")
+  end
+
+  it "should save the color space even when same as current page color space" do
+    create_pdf
+    @pdf.stroke_color(100, 100, 20, 0)
+    @pdf.create_stamp("MyStamp") do
+      @pdf.stroke_color(100, 100, 20, 0)
+    end
+    @pdf.stamp("MyStamp")
+    stamps = PDF::Inspector::XObject.analyze(@pdf.render)
+    stamp_stream = stamps.xobject_streams[:Stamp1].data
+    stamp_stream.should include("/DeviceCMYK CS\n1.000 1.000 0.200 0.000 SCN")
+  end
+end

data/spec/stroke_styles_spec.rb

@@ -0,0 +1,211 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "When stroking with default settings" do
+  before(:each) { create_pdf }
+  it "cap_style should be :butt" do
+    @pdf.cap_style.should == :butt
+  end
+
+  it "join_style should be :miter" do
+    @pdf.join_style.should == :miter
+  end
+
+  it "dashed? should be_false" do
+    @pdf.should_not be_dashed
+  end
+end
+
+describe "Cap styles" do
+  before(:each) { create_pdf }
+
+  it "should be able to use assignment operator" do
+    @pdf.cap_style = :round
+    @pdf.cap_style.should == :round
+  end
+
+  describe "#cap_style(:butt)" do
+    it "rendered PDF should include butt style cap" do
+      @pdf.cap_style(:butt)
+      cap_style = PDF::Inspector::Graphics::CapStyle.analyze(@pdf.render).cap_style
+      cap_style.should == 0
+    end
+  end
+
+  describe "#cap_style(:round)" do
+    it "rendered PDF should include round style cap" do
+      @pdf.cap_style(:round)
+      cap_style = PDF::Inspector::Graphics::CapStyle.analyze(@pdf.render).cap_style
+      cap_style.should == 1
+    end
+  end
+
+  describe "#cap_style(:projecting_square)" do
+    it "rendered PDF should include projecting_square style cap" do
+      @pdf.cap_style(:projecting_square)
+      cap_style = PDF::Inspector::Graphics::CapStyle.analyze(@pdf.render).cap_style
+      cap_style.should == 2
+    end
+  end
+
+  it "should carry the current cap style settings over to new pages" do
+    @pdf.cap_style(:round)
+    @pdf.start_new_page
+    cap_styles = PDF::Inspector::Graphics::CapStyle.analyze(@pdf.render)
+    cap_styles.cap_style_count.should == 2
+    cap_styles.cap_style.should == 1
+  end
+end
+
+describe "Join styles" do
+  before(:each) { create_pdf }
+
+  it "should be able to use assignment operator" do
+    @pdf.join_style = :round
+    @pdf.join_style.should == :round
+  end
+
+  describe "#join_style(:miter)" do
+    it "rendered PDF should include miter style join" do
+      @pdf.join_style(:miter)
+      join_style = PDF::Inspector::Graphics::JoinStyle.analyze(@pdf.render).join_style
+      join_style.should == 0
+    end
+  end
+
+  describe "#join_style(:round)" do
+    it "rendered PDF should include round style join" do
+      @pdf.join_style(:round)
+      join_style = PDF::Inspector::Graphics::JoinStyle.analyze(@pdf.render).join_style
+      join_style.should == 1
+    end
+  end
+
+  describe "#join_style(:bevel)" do
+    it "rendered PDF should include bevel style join" do
+      @pdf.join_style(:bevel)
+      join_style = PDF::Inspector::Graphics::JoinStyle.analyze(@pdf.render).join_style
+      join_style.should == 2
+    end
+  end
+
+  it "should carry the current join style settings over to new pages" do
+    @pdf.join_style(:round)
+    @pdf.start_new_page
+    join_styles = PDF::Inspector::Graphics::JoinStyle.analyze(@pdf.render)
+    join_styles.join_style_count.should == 2
+    join_styles.join_style.should == 1
+  end
+end
+
+describe "Dashes" do
+  before(:each) { create_pdf }
+
+   it "should be able to use assignment operator" do
+     @pdf.dash = 2
+     @pdf.should be_dashed
+  end
+
+  describe "setting a dash" do
+    it "dashed? should be_true" do
+      @pdf.dash(2)
+      @pdf.should be_dashed
+    end
+    it "rendered PDF should include a stroked dash" do
+      @pdf.dash(2)
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[2, 2], 0]
+    end
+  end
+
+  describe "setting a dash by passing a single argument" do
+    it "space between dashes should be the same length as the dash in the rendered PDF" do
+      @pdf.dash(2)
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[2, 2], 0]
+    end
+  end
+
+  describe "with a space option that differs from the first argument" do
+    it "space between dashes in the rendered PDF should be different length than the length of the dash" do
+      @pdf.dash(2, :space => 3)
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[2, 3], 0]
+    end
+  end
+
+  describe "with a non-zero phase option" do
+    it "rendered PDF should include a non-zero phase" do
+      @pdf.dash(2, :phase => 1)
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[2, 2], 1]
+    end
+  end
+
+  describe "setting a dash by using an array" do
+    it "dash and spaces should be set from the array" do
+      @pdf.dash([1,2,3,4])
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[1, 2, 3, 4], 0]
+    end
+    it "space options has to be ignored" do
+      @pdf.dash([1,2,3,4], :space => 3)
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[1, 2, 3, 4], 0]
+    end
+    it "phase options should be correctly used" do
+      @pdf.dash([1,2,3,4], :phase => 3)
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[1, 2, 3, 4], 3]
+    end
+  end
+
+  describe "clearing stroke dash" do
+    it "should restore solid line" do
+      @pdf.dash(2)
+      @pdf.undash
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[], 0]
+    end
+  end
+
+  it "should carry the current dash settings over to new pages" do
+    @pdf.dash(2)
+    @pdf.start_new_page
+    dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+    dashes.stroke_dash_count.should == 2
+    dashes.stroke_dash.should == [[2, 2], 0]
+  end
+
+  describe "#dashed?" do
+
+    it "an initial document should not be dashed" do
+      @pdf.dashed?.should == false
+    end
+
+    it "should return true if any of the currently active settings are dashed" do
+      @pdf.dash(2)
+      @pdf.save_graphics_state
+      @pdf.dashed?.should == true
+    end
+
+    it "should return false if the document was most recently undashed" do
+      @pdf.dash(2)
+      @pdf.save_graphics_state
+      @pdf.undash
+      @pdf.save_graphics_state
+      @pdf.dashed?.should == false
+    end
+
+    it "should return true when restoring to a state that was dashed" do
+      @pdf.dash(2)
+      @pdf.save_graphics_state
+      @pdf.undash
+      @pdf.restore_graphics_state
+      @pdf.dashed?.should == true
+    end
+
+  end
+
+end