prawn 0.11.1 → 0.15.0

data/lib/prawn/soft_mask.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+#
+# soft_mask.rb : Implements soft-masking
+#
+# Copyright September 2012, Alexander Mankuta. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+
+module Prawn
+
+  # The Prawn::SoftMask module is used to create arbitrary transparency in
+  # document. Using a soft mask allows creating more visually rich documents.
+  #
+  # You must group soft mask and graphics it's applied to under
+  # save_graphics_state because soft mask is a part of graphic state in PDF.
+  #
+  # Example:
+  #   pdf.save_graphics_state do
+  #     pdf.soft_mask do
+  #       pdf.fill_color "444444"
+  #       pdf.fill_polygon [0, 40], [60, 10], [120, 40], [60, 68]
+  #     end
+  #     pdf.fill_color '000000'
+  #     pdf.fill_rectangle [0, 50], 120, 68
+  #   end
+  #
+  module SoftMask
+    # @group Stable API
+
+    def soft_mask(&block)
+      min_version(1.4)
+
+      group_attrs = ref!({
+        :Type => :Group,
+        :S => :Transparency,
+        :CS => :DeviceRGB,
+        :I => false,
+        :K => false
+      })
+
+      group = ref!({
+        :Type => :XObject,
+        :Subtype => :Form,
+        :BBox => state.page.dimensions,
+        :Group => group_attrs,
+      })
+
+      state.page.stamp_stream(group, &block)
+
+      mask = ref!({
+        :Type => :Mask,
+        :S => :Luminosity,
+        :G => group
+      })
+
+      g_state = ref!({
+        :Type => :ExtGState,
+        :SMask => mask,
+
+        :AIS => false,
+        :BM => :Normal,
+        :OP => false,
+        :op => false,
+        :OPM => 1,
+        :SA => true,
+      })
+
+      registry_key = {
+        :bbox => state.page.dimensions,
+        :mask => [group.stream.filters.normalized, group.stream.filtered_stream],
+        :page => state.page_count,
+      }.hash
+
+      if soft_mask_registry[registry_key]
+        [g_state, mask, group, group_attrs].each { |ref| ref.live = false }
+
+        add_content "/#{soft_mask_registry[registry_key]} gs"
+      else
+        masks = page.resources[:ExtGState] ||= {}
+        id = masks.empty? ? 'GS1' : masks.keys.sort.last.succ
+        masks[id] = g_state
+
+        soft_mask_registry[registry_key] = id
+
+        add_content "/#{id} gs"
+      end
+    end
+
+    private
+
+    def soft_mask_registry
+      @soft_mask_registry ||= {}
+    end
+  end
+end

data/lib/prawn/stamp.rb

@@ -28,6 +28,8 @@ module Prawn
   #
   module Stamp
 
+    # @group Stable API
+
     # Renders the stamp named <tt>name</tt> to the page
     # raises <tt>Prawn::Errors::InvalidName</tt> if name.empty?
     # raises <tt>Prawn::Errors::UndefinedObjectName</tt> if no stamp
@@ -80,7 +82,7 @@ module Prawn
 
       state.page.stamp_stream(dictionary, &block)
     end
-    
+
     private
 
     def stamp_dictionary_registry
@@ -121,12 +123,12 @@ module Prawn
                                           :stamp_dictionary      => dictionary }
       dictionary
     end
-    
+
     def freeze_stamp_graphics
       update_colors
       write_line_width
       write_stroke_cap_style
-      write_stroke_join_style     
+      write_stroke_join_style
       write_stroke_dash
     end
 

data/lib/prawn/table/cell/image.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+# image.rb: Table image cells.
+#
+# Copyright September 2010, Brad Ediger. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+module Prawn
+  class Table
+    class Cell
+
+      # @private
+      class Image < Cell
+
+        def initialize(pdf, point, options={})
+          @image_options = {}
+          super
+
+          @pdf_object, @image_info = @pdf.build_image_object(@file)
+          @natural_width, @natural_height = @image_info.calc_image_dimensions(
+            @image_options)
+        end
+
+        def image=(file)
+          @file = file
+        end
+
+        def scale=(s)
+          @image_options[:scale] = s
+        end
+
+        def fit=(f)
+          @image_options[:fit] = f
+        end
+
+        def image_height=(h)
+          @image_options[:height] = h
+        end
+
+        def image_width=(w)
+          @image_options[:width] = w
+        end
+
+        def position=(p)
+          @image_options[:position] = p
+        end
+
+        def vposition=(vp)
+          @image_options[:vposition] = vp
+        end
+
+        def natural_content_width
+          @natural_width
+        end
+
+        def natural_content_height
+          @natural_height
+        end
+
+        # Draw the image on the page.
+        #
+        def draw_content
+          @pdf.embed_image(@pdf_object, @image_info, @image_options)
+        end
+
+      end
+    end
+  end
+end

data/lib/prawn/table/cell/in_table.rb

@@ -3,7 +3,9 @@
 # Accessors for using a Cell inside a Table.
 
 module Prawn
-  class Table    
+  class Table
+
+    # @private
     class Cell
 
       # This module extends Cell objects when they are used in a table (as
@@ -15,7 +17,7 @@ module Prawn
         # Row number (0-based).
         #
         attr_accessor :row
-        
+
         # Column number (0-based).
         #
         attr_accessor :column

data/lib/prawn/table/cell/span_dummy.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+
+# span_dummy.rb: Placeholder for non-master spanned cells.
+#
+# Copyright December 2011, Brad Ediger. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+module Prawn
+  class Table
+    class Cell
+
+      # A Cell object used to represent all but the topmost cell in a span
+      # group.
+      #
+      # @private
+      class SpanDummy < Cell
+        def initialize(pdf, master_cell)
+          super(pdf, [0, pdf.cursor])
+          @master_cell = master_cell
+          @padding = [0, 0, 0, 0]
+        end
+
+        # By default, a span dummy will never increase the height demand.
+        #
+        def natural_content_height
+          0
+        end
+
+        # By default, a span dummy will never increase the width demand.
+        #
+        def natural_content_width
+          0
+        end
+
+        def avg_spanned_min_width
+          @master_cell.avg_spanned_min_width
+        end
+
+        # Dummy cells have nothing to draw.
+        #
+        def draw_borders(pt)
+        end
+
+        # Dummy cells have nothing to draw.
+        #
+        def draw_bounded_content(pt)
+        end
+
+        def padding_right=(val)
+          @master_cell.padding_right = val if rightmost?
+        end
+
+        def padding_bottom=(val)
+          @master_cell.padding_bottom = val if bottommost?
+        end
+
+        def border_right_color=(val)
+          @master_cell.border_right_color = val if rightmost?
+        end
+
+        def border_bottom_color=(val)
+          @master_cell.border_bottom_color = val if bottommost?
+        end
+
+        def border_right_width=(val)
+          @master_cell.border_right_width = val if rightmost?
+        end
+
+        def border_bottom_width=(val)
+          @master_cell.border_bottom_width = val if bottommost?
+        end
+
+        def background_color
+          @master_cell.background_color
+        end
+
+        private
+
+        # Are we on the right border of the span?
+        #
+        def rightmost?
+          @column == @master_cell.column + @master_cell.colspan - 1
+        end
+
+        # Are we on the bottom border of the span?
+        #
+        def bottommost?
+          @row == @master_cell.row + @master_cell.rowspan - 1
+        end
+      end
+    end
+  end
+end

data/lib/prawn/table/cell/subtable.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8   
+# encoding: utf-8
 
 # subtable.rb: Yo dawg.
 #
@@ -47,7 +47,7 @@ module Prawn
           @subtable.cells.max_width
         end
 
-        # Proxied to subtable. 
+        # Proxied to subtable.
         #
         def natural_content_height
           @subtable.cells.height

data/lib/prawn/table/cell/text.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8   
+# encoding: utf-8
 
 # text.rb: Text table cells.
 #
@@ -47,7 +47,7 @@ module Prawn
         # from the final width if the text is long.
         #
         def natural_content_width
-          [styled_width_of(@content), @pdf.bounds.width].min
+          @natural_content_width ||= [styled_width_of(@content), @pdf.bounds.width].min
         end
 
         # Returns the natural height of this block of text, wrapped to the
@@ -55,7 +55,7 @@ module Prawn
         #
         def natural_content_height
           with_font do
-            b = text_box(:width => content_width + FPTolerance)
+            b = text_box(:width => spanned_content_width + FPTolerance)
             b.render(:dry_run => true)
             b.height + b.line_gap
           end
@@ -64,52 +64,64 @@ module Prawn
         # Draws the text content into its bounding box.
         #
         def draw_content
-          with_font do 
+          with_font do
             @pdf.move_down((@pdf.font.line_gap + @pdf.font.descender)/2)
             with_text_color do
-              text_box(:width => content_width + FPTolerance, 
-                       :height => content_height + FPTolerance,
+              text_box(:width => spanned_content_width + FPTolerance,
+                       :height => spanned_content_height + FPTolerance,
                        :at => [0, @pdf.cursor]).render
             end
           end
         end
 
-        protected
-
         def set_width_constraints
           # Sets a reasonable minimum width. If the cell has any content, make
           # sure we have enough width to be at least one character wide. This is
           # a bit of a hack, but it should work well enough.
-          min_content_width = [natural_content_width, styled_width_of("M")].min
-          @min_width ||= padding_left + padding_right + min_content_width
-          super
+          unless defined?(@min_width) && @min_width
+            min_content_width = [natural_content_width, styled_width_of_single_character].min
+            @min_width = padding_left + padding_right + min_content_width
+            super
+          end
         end
 
+        protected
+
         def with_font
           @pdf.save_font do
             options = {}
             options[:style] = @text_options[:style] if @text_options[:style]
+            options[:style] ||= @pdf.font.options[:style] if @pdf.font.options[:style]
 
-            @pdf.font(@font || @pdf.font.name, options)
+            @pdf.font(defined?(@font) && @font || @pdf.font.family, options)
 
             yield
           end
         end
 
         def with_text_color
-          old_color = @pdf.fill_color || '000000'
-          @pdf.fill_color(@text_color) if @text_color
-          yield
-        ensure
-          @pdf.fill_color(old_color)
+          if defined?(@text_color) && @text_color
+            begin
+              old_color = @pdf.fill_color || '000000'
+              @pdf.fill_color(@text_color)
+              yield
+            ensure
+              @pdf.fill_color(old_color)
+            end
+          else
+            yield
+          end
         end
-        
+
         def text_box(extra_options={})
-          if @text_options[:inline_format]
+          if p = @text_options[:inline_format]
+            p = [] unless p.is_a?(Array)
             options = @text_options.dup
             options.delete(:inline_format)
+            options.merge!(extra_options)
+            options[:document] = @pdf
 
-            array = ::Prawn::Text::Formatted::Parser.to_array(@content)
+            array = @pdf.text_formatter.format(@content, *p)
             ::Prawn::Text::Formatted::Box.new(array,
               options.merge(extra_options).merge(:document => @pdf))
           else
@@ -121,14 +133,20 @@ module Prawn
         # Returns the width of +text+ under the given text options.
         #
         def styled_width_of(text)
-          with_font do
-            options = {}
-            options[:size] = @text_options[:size] if @text_options[:size]
-
-            @pdf.font.compute_width_of(text, options)
-          end
+          @pdf.width_of(text, @text_options)
         end
 
+        private
+
+        # Returns the greatest possible width of any single character
+        #   under the given text options.
+        # (We use this to determine the minimum width of a table cell)
+        # (Although we currently determine this by measuring "M", it should really
+        #   use whichever character is widest under the current font)
+        #
+        def styled_width_of_single_character
+          styled_width_of("M")
+        end
       end
     end
   end