prawn 0.11.1 → 0.15.0

data/lib/prawn/graphics/patterns.rb

@@ -0,0 +1,138 @@
+# 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
+      # @group Stable API
+
+      # 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,8 @@
 module Prawn
   module Graphics
     module Transformation
-      
+      # @group Stable API
+
       # Rotate the user space.  If a block is not provided, then you must save
       # and restore the graphics state yourself.
       #
@@ -22,7 +23,7 @@ module Prawn
       # provided, but no block is given
       #
       # Example without a block:
-      #   
+      #
       #   save_graphics_state
       #   rotate 30
       #   text "rotated text"
@@ -62,7 +63,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 +83,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 +95,7 @@ module Prawn
       # provided, but no block is given
       #
       # Example without a block:
-      #   
+      #
       #   save_graphics_state
       #   scale 1.5
       #   text "scaled text"
@@ -126,7 +127,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 +138,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 +151,7 @@ module Prawn
           restore_graphics_state
         end
       end
-      
+
     end
   end
 end

data/lib/prawn/graphics/transparency.rb

@@ -30,6 +30,8 @@ module Prawn
     #
     module Transparency
 
+      # @group Stable API
+
       # Sets the <tt>opacity</tt> and <tt>stroke_opacity</tt> for all
       # the content within the <tt>block</tt>
       # If <tt>stroke_opacity</tt> is not provided, then it takes on
@@ -86,7 +88,7 @@ module Prawn
                                     )
 
           dictionary_name = "Tr#{next_opacity_dictionary_id}"
-          opacity_dictionary_registry[key] = { :name => dictionary_name, 
+          opacity_dictionary_registry[key] = { :name => dictionary_name,
                                                :obj  => dictionary }
         end