prawn 0.11.1.pre → 0.11.1

data/lib/prawn/document/graphics_state.rb

@@ -8,6 +8,69 @@
 #
 
 module Prawn
+  class GraphicStateStack
+    attr_accessor :stack
+    
+    def initialize(previous_state = nil)
+      self.stack = [GraphicState.new(previous_state)]
+    end
+    
+    def save_graphic_state(graphic_state = nil)
+      stack.push(GraphicState.new(graphic_state || current_state))
+    end
+    
+    def restore_graphic_state
+      if stack.empty?
+        raise Prawn::Errors::EmptyGraphicStateStack, 
+          "\n You have reached the end of the graphic state stack" 
+      end
+      stack.pop
+    end
+    
+    def current_state
+      stack.last
+    end
+    
+    def present?
+      stack.size > 0
+    end
+
+    def empty?
+      stack.empty?
+    end
+      
+  end
+  
+  class GraphicState
+    attr_accessor :color_space, :dash, :cap_style, :join_style, :line_width, :fill_color, :stroke_color
+    
+    def initialize(previous_state = nil)
+      @color_space = previous_state ? previous_state.color_space.dup : {}
+      @fill_color = previous_state ? previous_state.fill_color : "000000"
+      @stroke_color = previous_state ? previous_state.stroke_color : "000000"
+      @dash = previous_state ? previous_state.dash : { :dash => nil, :space => nil, :phase => 0 }
+      @cap_style = previous_state ? previous_state.cap_style : :butt
+      @join_style = previous_state ? previous_state.join_style : :miter
+      @line_width = previous_state ? previous_state.line_width : 1
+    end
+    
+    def dash_setting
+      "[#{@dash[:dash]} #{@dash[:space]}] #{@dash[:phase]} d"
+    end
+  end
+  
+  module Core
+    class Page
+      module GraphicsState
+      
+        def graphic_state
+          stack.current_state
+        end
+    
+      end
+    end
+  end
+  
   class Document
     module GraphicsState
 
@@ -30,8 +93,18 @@ module Prawn
       #     text "rotated text"
       #   end
       #
-      def save_graphics_state
+      
+      def open_graphics_state
         add_content "q"
+      end
+      
+      def close_graphics_state
+        add_content "Q"
+      end
+        
+      def save_graphics_state(graphic_state = nil)
+        graphic_stack.save_graphic_state(graphic_state)
+        open_graphics_state
         if block_given?
           yield
           restore_graphics_state
@@ -41,8 +114,23 @@ module Prawn
       # Pops the last saved graphics state off the graphics state stack and
       # restores the state to those values
       def restore_graphics_state
-        add_content "Q"
+        if graphic_stack.empty?
+          raise Prawn::Errors::EmptyGraphicStateStack, 
+            "\n You have reached the end of the graphic state stack" 
+        end
+        close_graphics_state 
+        graphic_stack.restore_graphic_state
+      end
+      
+      def graphic_stack
+        state.page.stack
+      end
+      
+      def graphic_state
+        save_graphics_state unless graphic_stack.current_state
+        graphic_stack.current_state 
       end
+      
     end
   end
 end

data/lib/prawn/document/internals.rb

@@ -54,6 +54,7 @@ module Prawn
       #  pdf.add_content("S") # stroke                    
       #
       def add_content(str)
+        save_graphics_state if graphic_state.nil?
         state.page.content << str << "\n"
       end  
 
@@ -97,8 +98,7 @@ module Prawn
           go_to_page i
           state.page.new_content_stream
           apply_margin_options(options)
-          use_graphic_settings
-          save_graphics_state
+          use_graphic_settings(options[:template])
         end
       end
 
@@ -106,7 +106,9 @@ module Prawn
         (1..page_count).each do |i|
           go_to_page i
           repeaters.each { |r| r.run(i) }
-          restore_graphics_state
+          while graphic_stack.present?
+            restore_graphics_state
+          end
           state.page.finalize
         end
       end

data/lib/prawn/errors.rb

@@ -82,5 +82,10 @@ module Prawn
     # This error is raised when Prawn fails to load a template file
     #
     TemplateError = Class.new(StandardError)
+    
+    # This error is raise when trying to restore a graphic state that 
+    #
+    EmptyGraphicStateStack = Class.new(StandardError)
+    
   end
 end   

data/lib/prawn/font.rb

@@ -240,10 +240,10 @@ module Prawn
     #
     def self.load(document,name,options={})
       case name
-      when /\.ttf$/   then TTF.new(document, name, options)
-      when /\.dfont$/ then DFont.new(document, name, options)
-      when /\.afm$/   then AFM.new(document, name, options)
-      else                 AFM.new(document, name, options)
+      when /\.ttf$/i   then TTF.new(document, name, options)
+      when /\.dfont$/i then DFont.new(document, name, options)
+      when /\.afm$/i   then AFM.new(document, name, options)
+      else                  AFM.new(document, name, options)
       end
     end
 

data/lib/prawn/font/afm.rb

@@ -89,6 +89,9 @@ module Prawn
       def normalize_encoding(text)
         enc = Prawn::Encoding::WinAnsi.new
         text.unpack("U*").collect { |i| enc[i] }.pack("C*")
+      rescue ArgumentError
+        raise Prawn::Errors::IncompatibleStringEncoding,
+          "Arguments to text methods must be UTF-8 encoded"
       end
 
       # Perform any changes to the string that need to happen
@@ -107,6 +110,14 @@ module Prawn
         [[0, options[:kerning] ? kern(text) : text]]
       end
 
+      def glyph_present?(char)
+        if char == "_"
+          true
+        else
+          normalize_encoding(char) != "_"
+        end
+      end
+
       private
 
       def register(subset)

data/lib/prawn/font/ttf.rb

@@ -185,6 +185,11 @@ module Prawn
         end
       end
 
+      def glyph_present?(char)
+        code = char.unpack("U*").first
+        cmap[code] > 0
+      end
+
       private
 
       def cmap

data/lib/prawn/graphics.rb

@@ -12,6 +12,7 @@ require "prawn/graphics/cap_style"
 require "prawn/graphics/join_style"
 require "prawn/graphics/transparency"
 require "prawn/graphics/transformation"
+require "prawn/graphics/gradient"
 
 module Prawn
 
@@ -29,6 +30,7 @@ module Prawn
     include JoinStyle
     include Transparency
     include Transformation
+    include Gradient
 
     #######################################################################
     # Low level drawing operations must map the point to absolute coords! #
@@ -100,8 +102,8 @@ module Prawn
     # Sets line thickness to the <tt>width</tt> specified.
     #
     def line_width=(width)
-      @line_width = width
-      add_content("#{width} w")
+      self.current_line_width = width
+      write_line_width
     end
 
     # When called without an argument, returns the current line thickness.
@@ -116,7 +118,7 @@ module Prawn
       if width
         self.line_width = width
       else
-        (defined?(@line_width) && @line_width) || 1
+        current_line_width
       end
     end
 
@@ -179,15 +181,28 @@ module Prawn
     #
     KAPPA = 4.0 * ((Math.sqrt(2) - 1.0) / 3.0)
 
-    # Draws a circle of radius <tt>:radius</tt> with the centre-point at <tt>point</tt>
+    # <b>DEPRECATED:</b> Please use <tt>circle</tt> instead.
+    def circle_at(point, options)
+      warn "[DEPRECATION] 'circle_at' is deprecated in favor of 'circle'. " +
+           "'circle_at' will be removed in release 1.1"
+      circle(point, options[:radius])
+    end
+
+    # Draws a circle of radius <tt>radius</tt> with the centre-point at <tt>point</tt>
     # as a complete subpath. The drawing point will be moved to the
     # centre-point upon completion of the drawing the circle.
     #
-    #    pdf.circle_at [100,100], :radius => 25
+    #    pdf.circle [100,100], 25
     #
-    def circle_at(point, options)
-      x,y = point
-      ellipse_at [x, y], options[:radius]
+    def circle(center, radius)
+      ellipse(center, radius, radius)
+    end
+
+    # <b>DEPRECATED:</b> Please use <tt>ellipse</tt> instead.
+    def ellipse_at(point, r1, r2=r1)
+      warn "[DEPRECATION] 'ellipse_at' is deprecated in favor of 'ellipse'. " +
+           "'ellipse_at' will be removed in release 1.1"
+      ellipse(point, r1, r2)
     end
 
     # Draws an ellipse of +x+ radius <tt>r1</tt> and +y+ radius <tt>r2</tt>
@@ -196,9 +211,9 @@ module Prawn
     # drawing the ellipse.
     #
     #    # draws an ellipse with x-radius 25 and y-radius 50
-    #    pdf.ellipse_at [100,100], 25, 50
+    #    pdf.ellipse [100,100], 25, 50
     #
-    def ellipse_at(point, r1, r2 = r1)
+    def ellipse(point, r1, r2 = r1)
       x, y = point
       l1 = r1 * KAPPA
       l2 = r2 * KAPPA
@@ -268,12 +283,21 @@ module Prawn
       curve_to(radial_point_2, :bounds => [bezier_point_1, bezier_point_2])
     end      
 
-    # Strokes and closes the current path. See Graphic::Color for color details
+    # Strokes the current path. If a block is provided, yields to the block
+    # before closing the path. See Graphics::Color for color details.
     #
     def stroke
       yield if block_given?
       add_content "S"
     end
+
+    # Closes and strokes the current path. If a block is provided, yields to
+    # the block before closing the path. See Graphics::Color for color details.
+    #
+    def close_and_stroke
+      yield if block_given?
+      add_content "s"
+    end
     
     # Draws and strokes a rectangle represented by the current bounding box
     #
@@ -281,21 +305,60 @@ module Prawn
       stroke_rectangle bounds.top_left, bounds.width, bounds.height
     end
 
-    # Fills and closes the current path. See Graphic::Color for color details
+    # Closes and fills the current path. See Graphics::Color for color details.
     #
     def fill
       yield if block_given?
       add_content "f"
     end
 
-    # Fills, strokes, and closes the current path. See Graphic::Color for color details
+    # Closes, fills, and strokes the current path. If a block is provided,
+    # yields to the block before closing the path. See Graphics::Color for
+    # color details.
     #
     def fill_and_stroke
       yield if block_given?
       add_content "b"
     end
-    
+
+    # Closes the current path.
+    #
+    def close_path
+      add_content "h"
+    end
+
+    # Provides the following shortcuts:
+    #
+    #    stroke_some_method(*args) #=> some_method(*args); stroke
+    #    fill_some_method(*args) #=> some_method(*args); fill
+    #    fill_and_stroke_some_method(*args) #=> some_method(*args); fill_and_stroke
+    #
+    def method_missing(id,*args,&block)
+      case(id.to_s)
+      when /^fill_and_stroke_(.*)/
+        send($1,*args,&block); fill_and_stroke
+      when /^stroke_(.*)/
+        send($1,*args,&block); stroke
+      when /^fill_(.*)/
+        send($1,*args,&block); fill
+      else
+        super
+      end
+    end
+
     private
+    
+    def current_line_width
+      graphic_state.line_width
+    end
+    
+    def current_line_width=(width)
+      graphic_state.line_width = width
+    end
+    
+    def write_line_width
+      add_content("#{current_line_width} w")
+    end
 
     def map_to_absolute(*point)
       x,y = point.flatten

data/lib/prawn/graphics/cap_style.rb

@@ -11,7 +11,7 @@ module Prawn
     module CapStyle
 
       CAP_STYLES = { :butt => 0, :round => 1, :projecting_square => 2 }
-      
+
       # Sets the cap style for stroked lines and curves
       #
       # style is one of :butt, :round, or :projecting_square
@@ -19,19 +19,27 @@ module Prawn
       # NOTE: If this method is never called, :butt will be used by default.
       #
       def cap_style(style=nil)
-        return @cap_style || :butt if style.nil?
+        return current_cap_style || :butt if style.nil?
 
-        @cap_style = style
+        self.current_cap_style = style
 
         write_stroke_cap_style
       end
-      
+
       alias_method :cap_style=, :cap_style
 
       private
 
+      def current_cap_style  
+        graphic_state.cap_style
+      end
+
+      def current_cap_style=(style)  
+        graphic_state.cap_style = style
+      end
+
       def write_stroke_cap_style
-        add_content "#{CAP_STYLES[@cap_style]} J"
+        add_content "#{CAP_STYLES[current_cap_style]} J"
       end
     end
   end

data/lib/prawn/graphics/color.rb

@@ -25,8 +25,8 @@ module Prawn
       #   pdf.fill_color 0, 99, 95, 0
       #
       def fill_color(*color)
-        return @fill_color if color.empty?
-        @fill_color = process_color(*color)
+        return current_fill_color if color.empty?
+        self.current_fill_color = process_color(*color)
         set_fill_color
       end
 
@@ -47,32 +47,14 @@ module Prawn
       #   pdf.stroke_color 0, 99, 95, 0
       #
       def stroke_color(*color)
-        return @stroke_color if color.empty?
-        @stroke_color = process_color(*color)
-        set_stroke_color
+        return current_stroke_color if color.empty?
+        color = process_color(*color)
+        self.current_stroke_color = color
+        set_stroke_color(color)
       end
 
       alias_method :stroke_color=, :stroke_color
 
-      # Provides the following shortcuts:
-      #
-      #    stroke_some_method(*args) #=> some_method(*args); stroke
-      #    fill_some_method(*args) #=> some_method(*args); fill
-      #    fill_and_stroke_some_method(*args) #=> some_method(*args); fill_and_stroke
-      #
-      def method_missing(id,*args,&block)
-        case(id.to_s)
-        when /^fill_and_stroke_(.*)/
-          send($1,*args,&block); fill_and_stroke
-        when /^stroke_(.*)/
-          send($1,*args,&block); stroke
-        when /^fill_(.*)/
-          send($1,*args,&block); fill
-        else
-          super
-        end
-      end
-
       module_function
 
       # Converts RGB value array to hex string suitable for use with fill_color
@@ -145,8 +127,8 @@ module Prawn
 
       def set_color_space(type, color_space)
         # don't set the same color space again
-        return if @color_space[type] == color_space
-        @color_space[type] = color_space
+        return if current_color_space(type) == color_space && !state.page.in_stamp_stream?
+        set_current_color_space(color_space, type)
 
         unless COLOR_SPACES.include?(color_space)
           raise ArgumentError, "unknown color space: '#{color_space}'"
@@ -177,28 +159,65 @@ module Prawn
         if options[:pattern]
           set_color_space type, :Pattern
           add_content "/#{color} #{operator}"
-        else
+        else          
           set_color_space type, color_space(color)
           color = color_to_s(color)
-          add_content "#{color} #{operator}"
+          write_color(color, operator)
         end
       end
 
-      def set_fill_color
-        set_color :fill, @fill_color
+      def set_fill_color(color = nil)
+        set_color :fill, color || current_fill_color        
       end
 
-      def set_stroke_color
-        set_color :stroke, @stroke_color
+      def set_stroke_color(color = nil)
+        set_color :stroke, color || current_stroke_color
       end
 
       def update_colors
-        @color_space  = {}
-        @fill_color   ||= "000000"
-        @stroke_color ||= "000000"
         set_fill_color
         set_stroke_color
       end
+
+      private
+
+      def current_color_space(type)
+        graphic_state.color_space[type]
+      end
+
+      def set_current_color_space(color_space, type)                
+        save_graphics_state if graphic_state.nil?
+        graphic_state.color_space[type] = color_space
+      end
+
+      def current_fill_color
+        graphic_state.fill_color
+      end
+
+      def current_fill_color=(color)        
+        graphic_state.fill_color = color
+      end
+
+      def current_stroke_color
+        graphic_state.stroke_color
+      end
+
+      def current_stroke_color=(color)
+        graphic_state.stroke_color = color
+      end
+
+      def write_fill_color
+        write_color(current_fill_color, 'scn')
+      end
+
+      def write_stroke_color
+        write_color(current_fill_color, 'SCN')
+      end
+
+      def write_color(color, operator)
+        add_content "#{color} #{operator}"
+      end
+
     end
   end
 end