prawn 0.2.3 → 0.3.0

data/lib/prawn/graphics/cell.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8   
 
-
 # cell.rb : Table support functions
 #
 # Copyright June 2008, Gregory Brown.  All Rights Reserved.
@@ -41,24 +40,33 @@ module Prawn
       # <tt>:point</tt>:: Absolute [x,y] coordinate of the top-left corner of the cell.
       # <tt>:document</tt>:: The Prawn::Document object to render on. 
       # <tt>:text</tt>:: The text to be flowed within the cell
+      # <tt>:text_color</tt>:: The color of the text to be displayed
       # <tt>:width</tt>:: The width in PDF points of the cell.
-      # <tt>:border</tt>:: The border line width. If omitted, no border will be drawn.
+      # <tt>:height</tt>:: The height in PDF points of the cell.
       # <tt>:horizontal_padding</tt>:: The horizontal padding in PDF points
       # <tt>:vertical_padding</tt>:: The vertical padding in PDF points
       # <tt>:padding</tt>:: Overrides both horizontal and vertical padding
-      # <tt>:border_style</tt>:: One of <tt>:all</tt>, <tt>:no_top</tt>, <tt>:no_bottom</tt>, <tt>:sides</tt>   
       # <tt>:align</tt>:: One of <tt>:left</tt>, <tt>:right</tt>, <tt>:center</tt>
+      # <tt>:borders</tt>:: An array of sides which should have a border. Any of <tt>:top</tt>, <tt>:left</tt>, <tt>:right</tt>, <tt>:bottom</tt>
+      # <tt>:border_width</tt>:: The border line width. Defaults to 1.
+      # <tt>:border_style</tt>:: One of <tt>:all</tt>, <tt>:no_top</tt>, <tt>:no_bottom</tt>, <tt>:sides</tt>, <tt>:none</tt>, <tt>:bottom_only</tt>. Defaults to :all.
+      # <tt>:border_color</tt>:: The color of the cell border.
+      # <tt>:font_size</tt>:: The font size for the cell text.
       #
       def initialize(options={})
         @point        = options[:point]
         @document     = options[:document]
         @text         = options[:text].to_s
+        @text_color   = options[:text_color]
         @width        = options[:width]
+        @height       = options[:height]
         @borders      = options[:borders]
         @border_width = options[:border_width] || 1
         @border_style = options[:border_style] || :all               
+        @border_color = options[:border_color]
         @background_color = options[:background_color] 
         @align            = options[:align] || :left
+        @font_size        = options[:font_size]
 
         @horizontal_padding = options[:horizontal_padding] || 0
         @vertical_padding   = options[:vertical_padding]   || 0
@@ -70,7 +78,7 @@ module Prawn
 
       attr_accessor :point, :border_style, :border_width, :background_color,
                     :document, :horizontal_padding, :vertical_padding, :align,
-                    :borders
+                    :borders, :text_color, :border_color
                     
       attr_writer   :height, :width #:nodoc:   
            
@@ -90,7 +98,7 @@ module Prawn
       #
       def width
         @width || (@document.font.metrics.string_width(@text,
-          @document.font.size)) + 2*@horizontal_padding
+          @font_size || @document.font.size)) + 2*@horizontal_padding
       end
 
       # The height of the cell in PDF points
@@ -125,26 +133,30 @@ module Prawn
           @document.mask(:line_width) do
             @document.line_width = @border_width
 
-            if borders.include?(:left)
-              @document.stroke_line [rel_point[0], rel_point[1] + (@border_width / 2.0)], 
-                [rel_point[0], rel_point[1] - height - @border_width / 2.0 ]
-            end
-
-            if borders.include?(:right)
-              @document.stroke_line( 
-                [rel_point[0] + width, rel_point[1] + (@border_width / 2.0)],
-                [rel_point[0] + width, rel_point[1] - height - @border_width / 2.0] )
-            end
-
-            if borders.include?(:top)
-              @document.stroke_line(
-                [ rel_point[0] + @border_width / 2.0, rel_point[1] ], 
-                [ rel_point[0] - @border_width / 2.0 + width, rel_point[1] ])
-            end
-
-            if borders.include?(:bottom)
-              @document.stroke_line [rel_point[0], rel_point[1] - height ],
-                                  [rel_point[0] + width, rel_point[1] - height]
+            @document.mask(:stroke_color) do
+              @document.stroke_color @border_color if @border_color
+
+              if borders.include?(:left)
+                @document.stroke_line [rel_point[0], rel_point[1] + (@border_width / 2.0)], 
+                  [rel_point[0], rel_point[1] - height - @border_width / 2.0 ]
+              end
+
+              if borders.include?(:right)
+                @document.stroke_line( 
+                  [rel_point[0] + width, rel_point[1] + (@border_width / 2.0)],
+                  [rel_point[0] + width, rel_point[1] - height - @border_width / 2.0] )
+              end
+
+              if borders.include?(:top)
+                @document.stroke_line(
+                  [ rel_point[0] + @border_width / 2.0, rel_point[1] ], 
+                  [ rel_point[0] - @border_width / 2.0 + width, rel_point[1] ])
+              end
+
+              if borders.include?(:bottom)
+                @document.stroke_line [rel_point[0], rel_point[1] - height ],
+                                    [rel_point[0] + width, rel_point[1] - height]
+              end
             end
 
           end
@@ -157,7 +169,16 @@ module Prawn
                                  @point[1] - @vertical_padding], 
                                 :width   => text_area_width,
                                 :height  => height - @vertical_padding) do
-          @document.text @text, :align => @align
+          @document.move_up @document.font.line_gap
+
+          options = {:align => @align}
+
+          options[:size] = @font_size if @font_size
+
+          @document.mask(:fill_color) do
+            @document.fill_color @text_color if @text_color                        
+            @document.text @text, options
+          end
         end
       end
 
@@ -173,6 +194,10 @@ module Prawn
           [:left,:right,:bottom]
         when :no_bottom
           [:left,:right,:top]
+        when :bottom_only
+          [:bottom]
+        when :none
+          []
         end
       end
 
@@ -189,8 +214,8 @@ module Prawn
         @height   = 0
       end
 
-      attr_reader :width, :height
-      attr_accessor :background_color
+      attr_reader :width, :height, :cells
+      attr_accessor :background_color, :text_color, :border_color
 
       def <<(cell)
         @cells << cell
@@ -208,6 +233,8 @@ module Prawn
                       y - @document.bounds.absolute_bottom]
           e.height = @height
           e.background_color ||= @background_color
+          e.text_color ||= @text_color
+          e.border_color ||= @border_color
           e.draw
           x += e.width
         end

data/lib/prawn/graphics/color.rb

@@ -1,3 +1,11 @@
+# encoding: utf-8   
+
+# color.rb : Implements color handling
+#
+# Copyright June 2008, Gregory Brown.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
 module Prawn
   module Graphics
     module Color   

data/lib/prawn/images.rb

@@ -18,11 +18,13 @@ module Prawn
     # <tt>file</tt>:: path to file or an object that responds to #read
     #
     # Options:
-    # <tt>:at</tt>:: the location of the top left corner of the image.
+    # <tt>:at</tt>:: an array [x,y] with the location of the top left corner of the image.
     # <tt>:position</tt>::  One of (:left, :center, :right) or an x-offset
+    # <tt>:vposition</tt>::  One of (:top, :center, :center) or an y-offset    
     # <tt>:height</tt>:: the height of the image [actual height of the image]
     # <tt>:width</tt>:: the width of the image [actual width of the image]
-    # <tt>:scale</tt>:: scale the dimensions of the image proportionally   
+    # <tt>:scale</tt>:: scale the dimensions of the image proportionally
+    # <tt>:fit</tt>:: scale the dimensions of the image proportionally to fit inside [width,height]
     # 
     #   Prawn::Document.generate("image2.pdf", :page_layout => :landscape) do     
     #     pigs = "#{Prawn::BASEDIR}/data/images/pigs.jpg" 
@@ -36,6 +38,11 @@ module Prawn
     # proportionally.  When both are provided, the image will be stretched to 
     # fit the dimensions without maintaining the aspect ratio.
     #
+    #
+    # If :at is provided, the image will be place in the current page but
+    # the text position will not be changed.
+    #
+    #
     # If instead of an explicit filename, an object with a read method is
     # passed as +file+, you can embed images from IO objects and things
     # that act like them (including Tempfiles and open-uri objects).
@@ -50,14 +57,15 @@ module Prawn
     # dimensions of an image object if needed. 
     # (See also: Prawn::Images::PNG , Prawn::Images::JPG)
     # 
-    def image(file, options={})     
-      Prawn.verify_options [:at,:position, :height, :width, :scale], options
-      
+    def image(file, options={})
+      Prawn.verify_options [:at, :position, :vposition, :height, 
+                            :width, :scale, :fit], options
+
       if file.respond_to?(:read)
         image_content = file.read
       else      
         raise ArgumentError, "#{file} not found" unless File.file?(file)  
-        image_content =  File.read_binary(file)
+        image_content =  File.binread(file)
       end
       
       image_sha1 = Digest::SHA1.hexdigest(image_content)
@@ -86,7 +94,8 @@ module Prawn
 
       # find where the image will be placed and how big it will be  
       w,h = calc_image_dimensions(info, options)
-      if options[:at]       
+
+      if options[:at]     
         x,y = translate(options[:at]) 
       else                  
         x,y = image_position(w,h,options) 
@@ -109,6 +118,7 @@ module Prawn
     
     def image_position(w,h,options)
       options[:position] ||= :left
+      
       x = case options[:position] 
       when :left
         bounds.absolute_left
@@ -118,8 +128,20 @@ module Prawn
         bounds.absolute_right - w
       when Numeric
         options[:position] + bounds.absolute_left
-      end       
-      
+      end
+
+      y = case options[:vposition]
+      when :top
+        bounds.absolute_top
+      when :center
+        bounds.absolute_top - (bounds.height - h) / 2.0
+      when :bottom
+        bounds.absolute_bottom + h
+      when Numeric
+        bounds.absolute_top - options[:vposition]
+      else
+        self.y
+      end
       return [x,y]
     end
 
@@ -127,10 +149,12 @@ module Prawn
       color_space = case jpg.channels
       when 1
         :DeviceGray
+      when 3
+        :DeviceRGB
       when 4
         :DeviceCMYK
       else
-        :DeviceRGB
+        raise ArgumentError, 'JPG uses an unsupported number of channels'
       end
       obj = ref(:Type       => :XObject,
           :Subtype          => :Image,
@@ -140,6 +164,14 @@ module Prawn
           :Width            => jpg.width,
           :Height           => jpg.height,
           :Length           => data.size ) 
+
+      # add extra decode params for CMYK images. By swapping the
+      # min and max values from the default, we invert the colours. See
+      # section 4.8.4 of the spec.
+      if color_space == :DeviceCMYK
+        obj.data[:Decode] = [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ]
+      end
+
       obj << data
       return obj
     end
@@ -252,7 +284,6 @@ module Prawn
     end
 
     def calc_image_dimensions(info, options)
-      # TODO: allow the image to be aligned in a box
       w = options[:width] || info.width
       h = options[:height] || info.height
 
@@ -267,8 +298,20 @@ module Prawn
       elsif options[:scale] 
         w = info.width * options[:scale]
         h = info.height * options[:scale]
+      elsif options[:fit] 
+        bw, bh = options[:fit]
+        bp = bw / bh.to_f
+        ip = info.width / info.height.to_f
+        if ip > bp
+          w = bw
+          h = bw / ip
+        else
+          h = bh
+          w = bh * ip
+        end
       end
-
+      info.scaled_width = w
+      info.scaled_height = h
       [w,h]
     end
 

data/lib/prawn/images/jpg.rb

@@ -14,7 +14,8 @@ module Prawn
     # of a PNG image that we need to embed them in a PDF
     class JPG 
       attr_reader :width, :height, :bits, :channels
-
+      attr_accessor :scaled_width, :scaled_height
+      
       JPEG_SOF_BLOCKS = %W(\xc0 \xc1 \xc2 \xc3 \xc5 \xc6 \xc7 \xc9 \xca \xcb \xcd \xce \xcf)
       JPEG_APP_BLOCKS = %W(\xe0 \xe1 \xe2 \xe3 \xe4 \xe5 \xe6 \xe7 \xe8 \xe9 \xea \xeb \xec \xed \xee \xef)
 

data/lib/prawn/images/png.rb

@@ -19,7 +19,8 @@ module Prawn
       attr_reader :width, :height, :bits
       attr_reader :color_type, :compression_method, :filter_method
       attr_reader :interlace_method, :alpha_channel
-
+      attr_accessor :scaled_width, :scaled_height
+      
       # Process a new PNG image
       #
       # <tt>:data</tt>:: A string containing a full PNG file

data/lib/prawn/literal_string.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module Prawn
+  # This is used to differentiate strings that must be encoded as
+  # a *literal* string, versus those that can be encoded in
+  # the PDF hexadecimal format.
+  #
+  # Some features of the PDF format appear to require that literal
+  # strings be used. One such feature is the /Dest key of a link
+  # annotation; if a hex encoded string is used there, the links
+  # do not work (as tested in Mac OS X Preview, and Adobe Acrobat
+  # Reader).
+  class LiteralString < String #:nodoc:
+  end
+end

data/lib/prawn/measurement_extensions.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+# measurement_extensions.rb: Core extensions for Prawn::Measurements
+#
+# Copyright December 2008, Florian Witteler.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'prawn/measurements'
+
+class Numeric
+  include Prawn::Measurements        
+  # prawns' basic unit is PostScript-Point        
+  # 72 points per inch
+
+  def mm
+    return mm2pt(self)
+  end
+
+  def cm
+    return cm2pt(self)
+  end
+
+  def dm
+    return dm2pt(self)
+  end
+
+  def m
+    return m2pt(self)
+  end
+
+  def in
+    return in2pt(self)
+  end
+
+  def yd
+    return yd2pt(self)
+  end
+
+  def ft
+    return ft2pt(self)
+  end
+  
+  def pt
+    return self
+  end
+end        

data/lib/prawn/measurements.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+# measurements.rb: Conversions from other measurements to PDF points
+#
+# Copyright December 2008, Florian Witteler.  All Rights Reserved.
+#
+module Prawn  
+  module Measurements
+  
+    # ============================================================================
+    #metric conversions
+    def cm2mm(cm)
+      return cm*10
+    end
+  
+    def dm2mm(dm)
+      return dm*100  
+    end
+  
+    def m2mm(m)
+      return m*1000
+    end
+  
+    # ============================================================================
+    # imperial conversions    
+    # from http://en.wikipedia.org/wiki/Imperial_units
+  
+    def ft2in(ft)
+      return ft * 12
+    end  
+
+    def yd2in(yd)
+      return yd*36
+    end
+
+  
+    # ============================================================================
+    # PostscriptPoint-converisons
+  
+    def in2pt(inch)
+      return inch * 72    
+    end
+  
+    def ft2pt(ft)
+      return in2pt(ft2in(ft))
+    end
+  
+    def yd2pt(yd)
+      return in2pt(yd2in(yd))
+    end
+  
+    def mm2pt(mm)
+        return mm*(72 / 25.4)
+    end
+  
+    def cm2pt(cm)
+      return mm2pt(cm2mm(cm))
+    end
+  
+    def dm2pt(dm)
+      return mm2pt(dm2mm(dm))
+    end
+  
+    def m2pt(m)
+      return mm2pt(m2mm(m))
+    end
+  
+    def pt2mm(pt)    
+      return pt * 1 / mm2pt(1)# (25.4 / 72)
+    end
+  end
+end