prawn-core 0.5.1 → 0.6.1

data/lib/prawn/font/ttf.rb

@@ -222,7 +222,7 @@ module Prawn
 
       def register(subset)
         temp_name = @ttf.name.postscript_name.gsub("\0","").to_sym
-        @document.ref(:Type => :Font, :BaseFont => temp_name) { |ref| embed(ref, subset) }
+        @document.ref!(:Type => :Font, :BaseFont => temp_name) { |ref| embed(ref, subset) }
       end
 
       def embed(reference, subset)
@@ -241,12 +241,12 @@ module Prawn
 
         compressed_font = Zlib::Deflate.deflate(font_content)
 
-        fontfile = @document.ref(:Length => compressed_font.size,
+        fontfile = @document.ref!(:Length => compressed_font.size,
                                  :Length1 => font_content.size,
                                  :Filter => :FlateDecode )
         fontfile << compressed_font
 
-        descriptor = @document.ref(:Type        => :FontDescriptor,
+        descriptor = @document.ref!(:Type        => :FontDescriptor,
                                    :FontName    => basename.to_sym,
                                    :FontFile2   => fontfile,
                                    :FontBBox    => bbox,
@@ -287,7 +287,7 @@ module Prawn
 
         to_unicode_cmap = UNICODE_CMAP_TEMPLATE % range_blocks.strip
 
-        cmap = @document.ref({})
+        cmap = @document.ref!({})
         cmap << to_unicode_cmap
         cmap.compress_stream
 
@@ -296,7 +296,7 @@ module Prawn
                               :FontDescriptor => descriptor,
                               :FirstChar => 32,
                               :LastChar => 255,
-                              :Widths => @document.ref(widths),
+                              :Widths => @document.ref!(widths),
                               :ToUnicode => cmap)
       end
 

data/lib/prawn/font.rb

@@ -28,9 +28,9 @@ module Prawn
     # make it more portable.
     #
     def font(name=nil, options={})
-      return @font || font("Helvetica") if name.nil?
+      return((defined?(@font) && @font) || font("Helvetica")) if name.nil?
 
-      raise Errors::NotOnPage unless @current_page
+      raise Errors::NotOnPage unless defined?(@current_page) && @current_page
       new_font = find_font(name, options)
 
       if block_given?
@@ -252,13 +252,16 @@ module Prawn
       "#{self.class.name}< #{name}: #{size} >"
     end
 
-    # Normalizes the encoding of the string to an encoding supported by the font.
-    # The string is expected to be UTF-8 going in, and will be reencoded in-place
-    # (the argument will be modified directly). The return value is not defined.
+    # Normalizes the encoding of the string to an encoding supported by the
+    # font. The string is expected to be UTF-8 going in. It will be re-encoded
+    # and the new string will be returned. For an in-place (destructive)
+    # version, see normalize_encoding!.
     def normalize_encoding(string)
       raise NotImplementedError, "subclasses of Prawn::Font must implement #normalize_encoding"
     end
 
+    # Destructive version of normalize_encoding; normalizes the encoding of a
+    # string in place.
     def normalize_encoding!(str)
       str.replace(normalize_encoding(str))
     end

data/lib/prawn/graphics/cap_style.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8   
+
+# cap_style.rb : Implements stroke cap styling
+#
+# Contributed by Daniel Nelson. October, 2009
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+module Prawn
+  module Graphics
+    module CapStyle
+      # Sets the cap_style for stroked lines and curves
+      #
+
+      CAP_STYLES = { :butt => 0, :round => 1, :projecting_square => 2 }
+      
+      # style is one of :butt, :round, or :projecting_square
+      def cap_style(style=nil)
+        return @cap_style || :butt if style.nil?
+
+        @cap_style = style
+
+        write_stroke_cap_style
+      end
+      
+      alias_method :cap_style=, :cap_style
+
+      private
+
+      def write_stroke_cap_style
+        add_content "#{CAP_STYLES[@cap_style]} J"
+      end
+    end
+  end
+end

data/lib/prawn/graphics/dash.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8   
+
+# dash.rb : Implements stroke dashing
+#
+# Contributed by Daniel Nelson. October, 2009
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+module Prawn
+  module Graphics
+    module Dash
+
+      # Sets the dash pattern for stroked lines and curves
+      #
+      #   length is the length of the dash. If options is not present,
+      #   or options[:space] is nil, then length is also the length of
+      #   the space between dashes
+      #
+      #   options may contain :space and :phase
+      #      :space is the space between the dashes
+      #      :phase is where in the cycle to begin dashing. For
+      #             example, a phase of 0 starts at the beginning of
+      #             the dash; whereas, if the phase is equal to the
+      #             length of the dash, then stroking will begin at
+      #             the beginning of the space. Default is 0
+      #
+      #   integers or floats may be used for length and the options
+      #
+      #   dash units are in PDF points ( 1/72 in )
+      #   
+      def dash(length=nil, options={})
+        return @dash || undash_hash if length.nil?
+
+        @dash = { :dash  => length, 
+                  :space => options[:space] || length, 
+                  :phase => options[:phase] || 0 }
+
+        write_stroke_dash
+      end
+      
+      alias_method :dash=, :dash
+
+      # Restores solid stroking
+      def undash
+        @dash = undash_hash
+        write_stroke_dash
+      end
+      
+      # Returns true iff the stroke is dashed
+      def dashed?
+        dash != undash_hash
+      end
+
+      private
+
+      def undash_hash
+        { :dash => nil, :space => nil, :phase => 0 }
+      end
+
+      def write_stroke_dash
+        if @dash[:dash].nil?
+          add_content "[] 0 d"
+          return
+        end
+        add_content "[#{@dash[:dash]} #{@dash[:space]}] #{@dash[:phase]} d"
+      end     
+    end
+  end
+end

data/lib/prawn/graphics/join_style.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8   
+
+# join_style.rb : Implements stroke join styling
+#
+# Contributed by Daniel Nelson. October, 2009
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+module Prawn
+  module Graphics
+    module JoinStyle
+      # Sets the join_style for stroked lines and curves
+      #
+
+      JOIN_STYLES = { :miter => 0, :round => 1, :bevel => 2 }
+      
+      # style is one of :miter, :round, or :bevel
+      def join_style(style=nil)
+        return @join_style || :miter if style.nil?
+
+        @join_style = style
+
+        write_stroke_join_style
+      end
+      
+      alias_method :join_style=, :join_style
+
+      private
+
+      def write_stroke_join_style
+        add_content "#{JOIN_STYLES[@join_style]} j"
+      end
+    end
+  end
+end

data/lib/prawn/graphics/transparency.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+#
+# transparency.rb : Implements transparency
+#
+# Copyright October 2009, Daniel Nelson. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+
+module Prawn
+  module Graphics
+    module Transparency
+
+      def transparent(opacity, stroke_opacity=opacity, &block)
+        min_version(1.4)
+
+        key = "#{opacity}_#{stroke_opacity}"
+
+        if opacity_dictionary_registry[key]
+          opacity_dictionary =  opacity_dictionary_registry[key][:obj]
+          opacity_dictionary_name =  opacity_dictionary_registry[key][:name]
+        else
+          opacity_dictionary = ref!(:Type => :ExtGState,
+                                    :CA   => stroke_opacity,
+                                    :ca   => opacity
+                                    )
+
+          opacity_dictionary_name = "Tr#{next_opacity_dictionary_id}"
+          opacity_dictionary_registry[key] = { :name => opacity_dictionary_name, 
+                                               :obj  => opacity_dictionary }
+        end
+
+        page_ext_gstates.merge!(opacity_dictionary_name => opacity_dictionary)
+
+        # push a new graphics context onto the graphics context stack
+        add_content "q"
+        add_content "/#{opacity_dictionary_name} gs"
+
+        yield if block_given?
+
+        add_content "Q"
+      end
+
+      private
+
+      def opacity_dictionary_registry
+        @opacity_dictionary_registry ||= {}
+      end
+
+      def next_opacity_dictionary_id
+        opacity_dictionary_registry.length + 1
+      end
+
+    end
+  end
+end

data/lib/prawn/graphics.rb

@@ -7,6 +7,10 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 require "prawn/graphics/color"
+require "prawn/graphics/dash"
+require "prawn/graphics/cap_style"
+require "prawn/graphics/join_style"
+require "prawn/graphics/transparency"
 
 module Prawn
 
@@ -19,6 +23,10 @@ module Prawn
   module Graphics
 
     include Color
+    include Dash
+    include CapStyle
+    include JoinStyle
+    include Transparency
 
     #######################################################################
     # Low level drawing operations must translate to absolute coords!     #
@@ -94,7 +102,7 @@ module Prawn
       if width
         self.line_width = width
       else
-        @line_width || 1
+        (defined?(@line_width) && @line_width) || 1
       end
     end
 

data/lib/prawn/images.rb

@@ -154,7 +154,7 @@ module Prawn
       else
         raise ArgumentError, 'JPG uses an unsupported number of channels'
       end
-      obj = ref(:Type       => :XObject,
+      obj = ref!(:Type       => :XObject,
           :Subtype          => :Image,
           :Filter           => :DCTDecode,
           :ColorSpace       => color_space,
@@ -202,7 +202,7 @@ module Prawn
       end
 
       # build the image dict
-      obj = ref(:Type             => :XObject,
+      obj = ref!(:Type             => :XObject,
                 :Subtype          => :Image,
                 :Height           => png.height,
                 :Width            => png.width,
@@ -226,7 +226,7 @@ module Prawn
         obj.data[:ColorSpace] = color
       else
         # embed the colour palette in the PDF as a object stream
-        palette_obj = ref(:Length => png.palette.size)
+        palette_obj = ref!(:Length => png.palette.size)
         palette_obj << png.palette
 
         # build the color space array for the image
@@ -266,7 +266,7 @@ module Prawn
       # channel mixed in with the main image data. The PNG class seperates
       # it out for us and makes it available via the alpha_channel attribute
       if png.alpha_channel
-        smask_obj = ref(:Type             => :XObject,
+        smask_obj = ref!(:Type             => :XObject,
                         :Subtype          => :Image,
                         :Height           => png.height,
                         :Width            => png.width,

data/lib/prawn/name_tree.rb

@@ -79,6 +79,7 @@ module Prawn
           split! if children.length > limit
         else
           fit = children.detect { |child| child >= value }
+          fit = children.last unless fit
           fit << value
         end
 
@@ -113,7 +114,7 @@ module Prawn
 
         def new_node(parent=nil)
           node = Node.new(document, limit, parent)
-          node.ref = document.ref(node)
+          node.ref = document.ref!(node)
           return node
         end
 

data/lib/prawn/object_store.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+# object_store.rb : Implements PDF object repository for Prawn
+#
+# Copyright August 2008, Brad Ediger.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+module Prawn
+  class ObjectStore
+    include Enumerable
+
+    def initialize(info={})
+      @objects = {}
+      @identifiers = []
+      
+      # Create required PDF roots
+      @info    = ref(info).identifier
+      @pages   = ref(:Type => :Pages, :Count => 0, :Kids => []).identifier
+      @root    = ref(:Type => :Catalog, :Pages => pages).identifier
+    end
+
+    def ref(data, &block)
+      push(size + 1, data, &block)
+    end                                               
+
+    %w[info pages root].each do |name|
+      define_method(name) do
+        @objects[instance_variable_get("@#{name}")]
+      end
+    end
+
+    # Adds the given reference to the store and returns the reference object.
+    # If the object provided is not a Prawn::Reference, one is created from the
+    # arguments provided.
+    def push(*args, &block)
+      reference = if args.first.is_a?(Prawn::Reference)
+              args.first
+            else
+              Prawn::Reference.new(*args, &block)
+            end
+      @objects[reference.identifier] = reference
+      @identifiers << reference.identifier
+      reference
+    end
+    alias_method :<<, :push
+
+    def each
+      @identifiers.each do |id|
+        yield @objects[id]
+      end
+    end
+
+    def [](id)
+      @objects[id]
+    end
+
+    def size
+      @identifiers.size
+    end
+    alias_method :length, :size
+
+  end
+end

data/lib/prawn/pdf_object.rb

@@ -6,6 +6,8 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
+require 'prawn/byte_string'
+
 # Top level Module
 #
 module Prawn 
@@ -41,6 +43,8 @@ module Prawn
       obj = obj.strftime("D:%Y%m%d%H%M%S%z").chop.chop + "'00'"
       obj = obj.gsub(/[\\\n\(\)]/) { |m| "\\#{m}" }
       "(#{obj})"
+    when Prawn::ByteString
+      "<" << obj.unpack("H*").first << ">"
     when String
       obj = "\xFE\xFF" + obj.unpack("U*").pack("n*") unless in_content_stream
       "<" << obj.unpack("H*").first << ">"

data/lib/prawn/reference.rb

@@ -12,15 +12,16 @@ module Prawn
   
   class Reference #:nodoc:
              
-   attr_accessor :gen, :data, :offset
-   attr_reader :identifier, :stream
+   attr_accessor :gen, :data, :offset, :stream
+   attr_reader :identifier
     
     def initialize(id, data, &block)
       @identifier = id 
-      @gen   = 0       
-      @data  = data     
+      @gen        = 0       
+      @data       = data     
       @compressed = false
-      @on_encode = block
+      @on_encode  = block
+      @stream     = nil
     end            
     
     def object 
@@ -48,6 +49,18 @@ module Prawn
       @data[:Length] ||= @stream.length
       @compressed = true
     end
+
+    def compressed?
+      @compressed
+    end
+    
+    # Replaces the data and stream with that of other_ref. Preserves compressed
+    # status.
+    def replace(other_ref)
+      @data       = other_ref.data
+      @stream     = other_ref.stream
+      @compressed = other_ref.compressed?
+    end
   end         
 
   module_function

data/lib/prawn/stamp.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+#
+# stamp.rb : Implements a repeatable stamp
+#
+# Copyright October 2009, Daniel Nelson. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+
+module Prawn
+  module Stamp
+
+    def stamp(user_defined_name)
+      stamp_at(user_defined_name, [0, 0])
+    end
+    
+    def stamp_at(user_defined_name, point)
+      raise Prawn::Errors::InvalidName if user_defined_name.empty?
+      unless stamp_dictionary_registry[user_defined_name]
+        raise Prawn::Errors::UndefinedObjectName
+      end
+      
+      add_content "q"
+
+      x,y = point
+      translate_position = "1 0 0 1 %.3f %.3f cm" % [x, y]
+      add_content translate_position
+
+      dict = stamp_dictionary_registry[user_defined_name]
+
+      stamp_dictionary_name = dict[:stamp_dictionary_name]
+      stamp_dictionary = dict[:stamp_dictionary]
+
+      add_content "/#{stamp_dictionary_name} Do"
+      add_content "Q"
+
+      page_xobjects.merge!(stamp_dictionary_name => stamp_dictionary)
+    end
+    
+    def create_stamp(user_defined_name="", &block)
+      raise Prawn::Errors::InvalidName if user_defined_name.empty?
+
+      if stamp_dictionary_registry[user_defined_name]
+        raise Prawn::Errors::NameTaken
+      end
+
+      stamp_dictionary = ref!(:Type    => :XObject,
+                              :Subtype => :Form,
+                              :BBox => [0, 0, bounds.width, bounds.height])
+
+      stamp_dictionary_name = "Stamp#{next_stamp_dictionary_id}"
+
+      stamp_dictionary_registry[user_defined_name] = 
+        { :stamp_dictionary_name => stamp_dictionary_name, 
+          :stamp_dictionary      => stamp_dictionary}
+
+      
+      @active_stamp_stream = ""
+      @active_stamp_dictionary = stamp_dictionary
+
+      yield if block_given?
+
+      stamp_dictionary.data[:Length] = @active_stamp_stream.length + 1
+      stamp_dictionary << @active_stamp_stream
+
+      @active_stamp_stream = nil
+      # The ProcSet needs to be assigned at the page level
+      procs = @active_stamp_dictionary.data[:ProcSet]
+      @active_stamp_dictionary.data.delete(:ProcSet)
+      @active_stamp_dictionary = nil
+
+      # The ProcSet needs to be assigned at the page level
+      proc_set(procs) if procs
+    end
+    
+    private
+
+    def stamp_dictionary_registry
+      @stamp_dictionary_registry ||= {}
+    end
+
+    def next_stamp_dictionary_id
+      stamp_dictionary_registry.length + 1
+    end
+
+  end
+end

data/spec/bounding_box_spec.rb

@@ -125,6 +125,15 @@ describe "drawing bounding boxes" do
     
     @pdf.y.should.be.close 458.384, 0.001 
   end
+
+  it "should keep track of the max height the box was stretched to" do
+    box = @pdf.bounding_box(@pdf.bounds.top_left, :width => 100) do
+      @pdf.move_down 100
+      @pdf.move_up 15
+    end
+
+    assert_equal 100, box.height
+  end
   
 end
 

data/spec/document_spec.rb

@@ -11,6 +11,14 @@ describe "The cursor" do
     pdf.y = 300
     pdf.cursor.should == pdf.y - pdf.bounds.absolute_bottom 
   end
+
+  it "should be able to move relative to the bottom margin" do
+    pdf = Prawn::Document.new
+    pdf.move_cursor_to(10)
+
+    pdf.cursor.should == 10
+    pdf.y.should == pdf.cursor + pdf.bounds.absolute_bottom
+  end
 end 
 
 describe "when generating a document from a subclass" do
@@ -18,7 +26,7 @@ describe "when generating a document from a subclass" do
     custom_document = Class.new(Prawn::Document)
     custom_document.generate(Tempfile.new("generate_test").path) do |e| 
       e.class.should == custom_document
-      assert e.kind_of?(Prawn::Document)
+      e.should.be.kind_of(Prawn::Document)
     end
   end
 end
@@ -71,11 +79,11 @@ describe "When ending each page" do
   it "should not compress the page content stream if compression is disabled" do
 
     pdf = Prawn::Document.new(:compress => false)
-    content_stub = pdf.ref({})
+    content_stub = pdf.ref!({})
     content_stub.stubs(:compress_stream).returns(true)
     content_stub.expects(:compress_stream).never
 
-    pdf.instance_variable_set("@page_content", content_stub)
+    pdf.instance_variable_set("@page_content", content_stub.identifier)
     pdf.text "Hi There" * 20
     pdf.render
   end
@@ -83,11 +91,11 @@ describe "When ending each page" do
   it "should compress the page content stream if compression is enabled" do
 
     pdf = Prawn::Document.new(:compress => true)
-    content_stub = pdf.ref({})
+    content_stub = pdf.ref!({})
     content_stub.stubs(:compress_stream).returns(true)
     content_stub.expects(:compress_stream).once
 
-    pdf.instance_variable_set("@page_content", content_stub)
+    pdf.instance_variable_set("@page_content", content_stub.identifier)
     pdf.text "Hi There" * 20
     pdf.render
   end
@@ -151,6 +159,51 @@ describe "The mask() feature" do
   end
 end
 
+describe "The group() feature" do
+  it "should group a simple block on a single page" do
+    pdf = Prawn::Document.new do
+      self.y = 50
+      group do
+        text "Hello"
+        text "World"
+      end
+    end
+    
+    pages = PDF::Inspector::Page.analyze(pdf.render).pages
+    pages.size.should == 2
+    pages[0][:strings].should == []
+    pages[1][:strings].should == ["Hello", "World"]
+  end
+
+  it "should raise CannotGroup if the content is too tall" do
+    lambda {
+      Prawn::Document.new do
+        group do
+          100.times { text "Too long" }
+        end
+      end.render
+    }.should.raise(Prawn::Document::CannotGroup)
+  end
+
+  it "should group within individual column boxes" do
+    pdf = Prawn::Document.new do
+      # Set up columns with grouped blocks of 0..49. 0 to 49 is slightly short
+      # of the height of one page / column, so each column should get its own
+      # group (every column should start with zero).
+      column_box([0, bounds.top], :width => bounds.width, :columns => 7) do
+        10.times do
+          group { 50.times { |i| text(i.to_s) } }
+        end
+      end
+    end
+
+    # Second page should start with a 0 because it's a new group.
+    pages = PDF::Inspector::Page.analyze(pdf.render).pages
+    pages.size.should == 2
+    pages[1][:strings].first.should == '0'
+  end
+end
+
 describe "The render() feature" do
   if "spec".respond_to?(:encode!)
     it "should return a 8 bit encoded string on a m17n aware VM" do