prawn 0.12.0 → 0.13.0

data/lib/prawn/graphics/cap_style.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8   
+# encoding: utf-8
 
 # cap_style.rb : Implements stroke cap styling
 #
@@ -30,11 +30,11 @@ module Prawn
 
       private
 
-      def current_cap_style  
+      def current_cap_style
         graphic_state.cap_style
       end
 
-      def current_cap_style=(style)  
+      def current_cap_style=(style)
         graphic_state.cap_style = style
       end
 

data/lib/prawn/graphics/color.rb

@@ -95,7 +95,14 @@ module Prawn
         when String
           :RGB
         when Array
-          :CMYK
+          case color.length
+          when 3
+            :RGB
+          when 4
+            :CMYK
+          else
+            raise ArgumentError, "Unknown type of color: #{color.inspect}"
+          end
         end
       end
 
@@ -159,7 +166,7 @@ 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)
           write_color(color, operator)
@@ -167,7 +174,7 @@ module Prawn
       end
 
       def set_fill_color(color = nil)
-        set_color :fill, color || current_fill_color        
+        set_color :fill, color || current_fill_color
       end
 
       def set_stroke_color(color = nil)
@@ -185,7 +192,7 @@ module Prawn
         graphic_state.color_space[type]
       end
 
-      def set_current_color_space(color_space, type)                
+      def set_current_color_space(color_space, type)
         save_graphics_state if graphic_state.nil?
         graphic_state.color_space[type] = color_space
       end
@@ -194,7 +201,7 @@ module Prawn
         graphic_state.fill_color
       end
 
-      def current_fill_color=(color)        
+      def current_fill_color=(color)
         graphic_state.fill_color = color
       end
 

data/lib/prawn/graphics/dash.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8   
+# encoding: utf-8
 
 # dash.rb : Implements stroke dashing
 #
@@ -10,34 +10,57 @@ module Prawn
   module Graphics
     module Dash
 
-      # Sets the dash pattern for stroked lines and curves
+      # Sets the dash pattern for stroked lines and curves or return the
+      # current dash pattern setting if +length+ is nil.
       #
-      #   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
+      # There are two ways to set the dash pattern:
       #
-      #   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
+      # * If the parameter +length+ is an Integer/Float, it specifies
+      #   the length of the dash and of the gap. The length of the gap
+      #   can be customized by setting the :space option.
       #
-      #   integers or floats may be used for length and the options
+      #   Examples:
       #
-      #   dash units are in PDF points ( 1/72 in )
-      #   
-      def dash(length=nil, options={})        
-        return current_dash_state || undash_hash if length.nil?
+      #     length = 3
+      #       3 on, 3 off, 3 on, 3 off, ...
+      #     length = 3, :space =2
+      #       3 on, 2 off, 3 on, 2 off, ...
+      #
+      # * If the parameter +length+ is an array, it specifies the
+      #   lengths of alternating dashes and gaps. The :space option is
+      #   ignored in this case.
+      #
+      #   Examples:
+      #
+      #     length = [2, 1]
+      #       2 on, 1 off, 2 on, 1 off, ...
+      #     length = [3, 1, 2, 3]
+      #       3 on, 1 off, 2 on, 3 off, 3 on, 1 off, ...
+      #
+      # Options may contain the keys :space and :phase
+      #
+      # :space:: The space between the dashes (only used when +length+
+      #          is not an array)
+      #
+      # :phase:: The distance into the dash pattern at which to start
+      #          the dash. 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 option values.
+      # Dash units are in PDF points (1/72 inch).
+      #
+      def dash(length=nil, options={})
+        return current_dash_state if length.nil?
 
-        self.current_dash_state = { :dash  => length, 
-                  :space => options[:space] || length, 
+        self.current_dash_state = { :dash  => length,
+                  :space => length.kind_of?(Array) ? nil : options[:space] || length,
                   :phase => options[:phase] || 0 }
 
         write_stroke_dash
       end
-      
+
       alias_method :dash=, :dash
 
       # Stops dashing, restoring solid stroked lines and curves
@@ -46,37 +69,35 @@ module Prawn
         self.current_dash_state = undashed_setting
         write_stroke_dash
       end
-      
+
       # Returns when stroke is dashed, false otherwise
       #
       def dashed?
         current_dash_state != undashed_setting
       end
-      
+
       def write_stroke_dash
         add_content dash_setting
       end
 
-    private
-      
+      private
+
       def undashed_setting
         { :dash => nil, :space => nil, :phase => 0 }
       end
-      
-      private 
-        
-      def current_dash_state=(dash_options)  
+
+      def current_dash_state=(dash_options)
         graphic_state.dash = dash_options
       end
-      
+
       def current_dash_state
         graphic_state.dash
       end
-      
+
       def dash_setting
         graphic_state.dash_setting
       end
-      
+
     end
   end
 end

data/lib/prawn/graphics/join_style.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8   
+# encoding: utf-8
 
 # join_style.rb : Implements stroke join styling
 #
@@ -10,7 +10,7 @@ module Prawn
   module Graphics
     module JoinStyle
       JOIN_STYLES = { :miter => 0, :round => 1, :bevel => 2 }
-      
+
       # Sets the join style for stroked lines and curves
       #
       # style is one of :miter, :round, or :bevel
@@ -25,19 +25,19 @@ module Prawn
 
         write_stroke_join_style
       end
-      
+
       alias_method :join_style=, :join_style
 
       private
-      
-      def current_join_style  
+
+      def current_join_style
         graphic_state.join_style
       end
 
-      def current_join_style=(style)  
+      def current_join_style=(style)
         graphic_state.join_style = style
       end
-      
+
 
       def write_stroke_join_style
         add_content "#{JOIN_STYLES[current_join_style]} j"

data/lib/prawn/graphics/patterns.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+
+# patterns.rb : Implements axial & radial gradients
+#
+# Originally implemented by Wojciech Piekutowski. November, 2009
+# Copyright September 2012, Alexander Mankuta. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+module Prawn
+  module Graphics
+    module Patterns
+
+      # Sets the fill gradient from color1 to color2.
+      # old arguments: point, width, height, color1, color2, options = {}
+      # new arguments: from, to, color1, color1
+      #            or  from, r1, to, r2, color1, color2
+      def fill_gradient(*args)
+        if args[1].is_a?(Array) || args[2].is_a?(Array)
+          set_gradient(:fill, *args)
+        else
+          warn "[DEPRECATION] 'fill_gradient(point, width, height,...)' is deprecated in favor of 'fill_gradient(from, to,...)'. " +
+               "Old arguments will be removed in release 1.1"
+          set_gradient :fill, args[0], [args[0].first, args[0].last - args[2]], args[3], args[4]
+        end
+      end
+
+      # Sets the stroke gradient from color1 to color2.
+      # old arguments: point, width, height, color1, color2, options = {}
+      # new arguments: from, to, color1, color2
+      #            or  from, r1, to, r2, color1, color2
+      def stroke_gradient(*args)
+        if args[1].is_a?(Array) || args[2].is_a?(Array)
+          set_gradient(:stroke, *args)
+        else
+          warn "[DEPRECATION] 'stroke_gradient(point, width, height,...)' is deprecated in favor of 'stroke_gradient(from, to,...)'. " +
+               "Old arguments will be removed in release 1.1"
+          set_gradient :stroke, args[0], [args[0].first, args[0].last - args[2]], args[3], args[4]
+        end
+      end
+
+      private
+
+      def set_gradient(type, *grad)
+        patterns = page.resources[:Pattern] ||= {}
+
+        registry_key = gradient_registry_key grad
+
+        if patterns["SP#{registry_key}"]
+          shading = patterns["SP#{registry_key}"]
+        else
+          unless shading = gradient_registry[registry_key]
+            shading = gradient(*grad)
+            gradient_registry[registry_key] = shading
+          end
+
+          patterns["SP#{registry_key}"] = shading
+        end
+
+        operator = case type
+        when :fill
+          'scn'
+        when :stroke
+          'SCN'
+        else
+          raise ArgumentError, "unknown type '#{type}'"
+        end
+
+        set_color_space type, :Pattern
+        add_content "/SP#{registry_key} #{operator}"
+      end
+
+      def gradient_registry_key(gradient)
+        if gradient[1].is_a?(Array) # axial
+          [
+            map_to_absolute(gradient[0]),
+            map_to_absolute(gradient[1]),
+            gradient[2], gradient[3]
+          ]
+        else # radial
+          [
+            map_to_absolute(gradient[0]),
+            gradient[1],
+            map_to_absolute(gradient[2]),
+            gradient[3],
+            gradient[4], gradient[5]
+          ]
+        end.hash
+      end
+
+      def gradient_registry
+        @gradient_registry ||= {}
+      end
+
+      def gradient(*args)
+        if args.length != 4 && args.length != 6
+          raise ArgumentError, "Unknown type of gradient: #{args.inspect}"
+        end
+
+        color1 = normalize_color(args[-2]).dup.freeze
+        color2 = normalize_color(args[-1]).dup.freeze
+
+        if color_type(color1) != color_type(color2)
+          raise ArgumentError, "Both colors must be of the same color space: #{color1.inspect} and #{color2.inspect}"
+        end
+
+        process_color color1
+        process_color color2
+
+        shader = ref!({
+          :FunctionType => 2,
+          :Domain => [0.0, 1.0],
+          :C0 => color1,
+          :C1 => color2,
+          :N => 1.0,
+        })
+
+        shading = ref!({
+          :ShadingType => args.length == 4 ? 2 : 3, # axial : radial shading
+          :ColorSpace => color_space(color1),
+          :Coords => args.length == 4 ?
+                        [0, 0, args[1].first - args[0].first, args[1].last - args[0].last] :
+                        [0, 0, args[1], args[2].first - args[0].first, args[2].last - args[0].last, args[3]],
+          :Function => shader,
+          :Extend => [true, true],
+        })
+
+        ref!({
+          :PatternType => 2, # shading pattern
+          :Shading => shading,
+          :Matrix => [1, 0,
+                      0, 1] + map_to_absolute(args[0]),
+        })
+      end
+    end
+  end
+end

data/lib/prawn/graphics/transformation.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 #
 # transformation.rb: Implements rotate, translate, skew, scale and a generic
-#                     transformation_matrix 
+#                     transformation_matrix
 #
 # Copyright January 2010, Michael Witrant. All Rights Reserved.
 #
@@ -10,7 +10,7 @@
 module Prawn
   module Graphics
     module Transformation
-      
+
       # Rotate the user space.  If a block is not provided, then you must save
       # and restore the graphics state yourself.
       #
@@ -22,7 +22,7 @@ module Prawn
       # provided, but no block is given
       #
       # Example without a block:
-      #   
+      #
       #   save_graphics_state
       #   rotate 30
       #   text "rotated text"
@@ -62,7 +62,7 @@ module Prawn
       # and restore the graphics state yourself.
       #
       # Example without a block: move the text up and over 10
-      #   
+      #
       #   save_graphics_state
       #   translate(10, 10)
       #   text "scaled text"
@@ -82,7 +82,7 @@ module Prawn
       def translate(x, y, &block)
         transformation_matrix(1, 0, 0, 1, x, y, &block)
       end
-      
+
       # Scale the user space.  If a block is not provided, then you must save
       # and restore the graphics state yourself.
       #
@@ -94,7 +94,7 @@ module Prawn
       # provided, but no block is given
       #
       # Example without a block:
-      #   
+      #
       #   save_graphics_state
       #   scale 1.5
       #   text "scaled text"
@@ -126,7 +126,7 @@ module Prawn
           end
         end
       end
-      
+
       # The following definition of skew would only work in a clearly
       # predicatable manner when if the document had no margin. don't provide
       # this shortcut until it behaves in a clearly understood manner
@@ -137,7 +137,7 @@ module Prawn
       #                         Math.tan(degree_to_rad(b)),
       #                         1, 0, 0, &block)
       # end
-      
+
       # Transform the user space (see notes for rotate regarding graphics state)
       # Generally, one would use the rotate, scale, translate, and skew
       # convenience methods instead of calling transformation_matrix directly
@@ -150,7 +150,7 @@ module Prawn
           restore_graphics_state
         end
       end
-      
+
     end
   end
 end