prawn 2.0.1 → 2.0.2

data/lib/prawn/outline.rb

@@ -101,8 +101,8 @@ module Prawn
     #
     def add_subsection_to(title, position = :last, &block)
       @parent = items[title]
-      raise Prawn::Errors::UnknownOutlineTitle,
-        "\n No outline item with title: '#{title}' exists in the outline tree" unless @parent
+      fail Prawn::Errors::UnknownOutlineTitle,
+           "\n No outline item with title: '#{title}' exists in the outline tree" unless @parent
       @prev = position == :first ? nil : @parent.data.last
       nxt = position == :first ? @parent.data.first : nil
       insert_section(nxt, &block)
@@ -131,8 +131,8 @@ module Prawn
     #
     def insert_section_after(title, &block)
       @prev = items[title]
-      raise Prawn::Errors::UnknownOutlineTitle,
-        "\n No outline item with title: '#{title}' exists in the outline tree" unless @prev
+      fail Prawn::Errors::UnknownOutlineTitle,
+           "\n No outline item with title: '#{title}' exists in the outline tree" unless @prev
       @parent = @prev.data.parent
       nxt = @prev.data.next
       insert_section(nxt, &block)
@@ -195,8 +195,8 @@ module Prawn
       if options[:title]
         title = options[:title]
       else
-        raise Prawn::Errors::RequiredOption,
-          "\nTitle is a required option for page"
+        fail Prawn::Errors::RequiredOption,
+             "\nTitle is a required option for page"
       end
       add_outline_item(title, options)
     end

data/lib/prawn/repeater.rb

@@ -9,7 +9,6 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 module Prawn
-
   class Document
     # A list of all repeaters in the document.
     # See Document#repeat for details
@@ -75,7 +74,7 @@ module Prawn
     #
     #   end
     #
-    def repeat(page_filter, options={}, &block)
+    def repeat(page_filter, options = {}, &block)
       repeaters << Prawn::Repeater.new(self, page_filter, !!options[:dynamic], &block)
     end
   end
@@ -117,8 +116,5 @@ module Prawn
         end
       end
     end
-
   end
 end
-
-

data/lib/prawn/security.rb

@@ -14,11 +14,9 @@ require_relative 'security/arcfour'
 
 module Prawn
   class Document
-
     # Implements PDF encryption (password protection and permissions) as
     # specified in the PDF Reference, version 1.3, section 3.5 "Encryption".
     module Security
-
       # @group Experimental API
 
       # Encrypts the document, to protect confidential data or control
@@ -89,9 +87,9 @@ module Prawn
       #   not a limitation of Prawn, but is rather a built-in limitation of the
       #   PDF format.
       #
-      def encrypt_document(options={})
+      def encrypt_document(options = {})
         Prawn.verify_options [:user_password, :owner_password, :permissions],
-          options
+                             options
         @user_password = options.delete(:user_password) || ""
 
         @owner_password = options.delete(:owner_password) || @user_password
@@ -113,8 +111,8 @@ module Prawn
       # See Algorithm 3.1.
       def self.encrypt_string(str, key, id, gen)
         # Convert ID and Gen number into little-endian truncated byte strings
-        id = [id].pack('V')[0,3]
-        gen = [gen].pack('V')[0,2]
+        id = [id].pack('V')[0, 3]
+        gen = [gen].pack('V')[0, 2]
         extended_key = "#{key}#{id}#{gen}"
 
         # Compute the RC4 key from the extended key and perform the encryption
@@ -142,12 +140,12 @@ module Prawn
 
       FullPermissions = 0b1111_1111_1111_1111_1111_1111_1111_1111
 
-      def permissions=(perms={})
+      def permissions=(perms = {})
         @permissions ||= FullPermissions
         perms.each do |key, value|
           unless PermissionsBits[key]
-            raise ArgumentError, "Unknown permission :#{key}. Valid options: " +
-              PermissionsBits.keys.map { |k| k.inspect }.join(", ")
+            fail ArgumentError, "Unknown permission :#{key}. Valid options: " +
+              PermissionsBits.keys.map(&:inspect).join(", ")
           end
 
           # 0-based bit number, from LSB
@@ -167,7 +165,7 @@ module Prawn
 
       PasswordPadding =
         "28BF4E5E4E758A4164004E56FFFA01082E2E00B6D0683E802F0CA9FE6453697A".
-        scan(/../).map{|x| x.to_i(16)}.pack("c*")
+        scan(/../).map{ |x| x.to_i(16) }.pack("c*")
 
       # Pads or truncates a password to 32 bytes as per Alg 3.2.
       def pad_password(password)
@@ -197,9 +195,7 @@ module Prawn
       def user_password_hash
         Arcfour.new(user_encryption_key).encrypt(PasswordPadding)
       end
-
     end
-
   end
 end
 
@@ -213,11 +209,11 @@ module PDF
     # from the indirect object referencing obj.
     #
     # @private
-    def EncryptedPdfObject(obj, key, id, gen, in_content_stream=false)
+    def EncryptedPdfObject(obj, key, id, gen, in_content_stream = false)
       case obj
       when Array
         "[" << obj.map { |e|
-            EncryptedPdfObject(e, key, id, gen, in_content_stream)
+          EncryptedPdfObject(e, key, id, gen, in_content_stream)
         }.join(' ') << "]"
       when LiteralString
         obj = ByteString.new(Prawn::Document::Security.encrypt_string(obj, key, id, gen)).gsub(/[\\\n\(\)]/) { |m| "\\#{m}" }
@@ -233,13 +229,12 @@ module PDF
           in_content_stream)
       when ::Hash
         output = "<< "
-        obj.each do |k,v|
+        obj.each do |k, v|
           unless String === k || Symbol === k
-            raise PDF::Core::Errors::FailedObjectConversion,
-              "A PDF Dictionary must be keyed by names"
+            fail PDF::Core::Errors::FailedObjectConversion,
+                 "A PDF Dictionary must be keyed by names"
           end
-          output << PdfObject(k.to_sym, in_content_stream) << " " <<
-                    EncryptedPdfObject(v, key, id, gen, in_content_stream) << "\n"
+          output << PdfObject(k.to_sym, in_content_stream) << " " << EncryptedPdfObject(v, key, id, gen, in_content_stream) << "\n"
         end
         output << ">>"
       when NameTree::Value
@@ -252,7 +247,6 @@ module PDF
       end
     end
 
-
     # @private
     class Stream
       def encrypted_object(key, id, gen)
@@ -266,23 +260,21 @@ module PDF
 
     # @private
     class Reference
-
       # Returns the object definition for the object this references, keyed from
       # +key+.
       def encrypted_object(key)
         @on_encode.call(self) if @on_encode
 
         output = "#{@identifier} #{gen} obj\n"
-        unless @stream.empty?
+        if @stream.empty?
+          output << PDF::Core::EncryptedPdfObject(data, key, @identifier, gen) << "\n"
+        else
           output << PDF::Core::EncryptedPdfObject(data.merge(@stream.data), key, @identifier, gen) << "\n" <<
             @stream.encrypted_object(key, @identifier, gen)
-        else
-          output << PDF::Core::EncryptedPdfObject(data, key, @identifier, gen) << "\n"
         end
 
         output << "endobj\n"
       end
-
     end
   end
 end

data/lib/prawn/security/arcfour.rb

@@ -39,7 +39,7 @@ class Arcfour
   end
 
   def encrypt(string)
-    string.unpack('c*').map{|byte| byte ^ key_byte}.pack('c*')
+    string.unpack('c*').map{ |byte| byte ^ key_byte }.pack('c*')
   end
 
   private

data/lib/prawn/soft_mask.rb

@@ -8,7 +8,6 @@
 #
 
 module Prawn
-
   # The Prawn::SoftMask module is used to create arbitrary transparency in
   # document. Using a soft mask allows creating more visually rich documents.
   #
@@ -31,30 +30,30 @@ module Prawn
     def soft_mask(&block)
       renderer.min_version(1.4)
 
-      group_attrs = ref!({
+      group_attrs = ref!(
         :Type => :Group,
         :S => :Transparency,
         :CS => :DeviceRGB,
         :I => false,
         :K => false
-      })
+      )
 
-      group = ref!({
+      group = ref!(
         :Type => :XObject,
         :Subtype => :Form,
         :BBox => state.page.dimensions,
-        :Group => group_attrs,
-      })
+        :Group => group_attrs
+      )
 
       state.page.stamp_stream(group, &block)
 
-      mask = ref!({
+      mask = ref!(
         :Type => :Mask,
         :S => :Luminosity,
         :G => group
-      })
+      )
 
-      g_state = ref!({
+      g_state = ref!(
         :Type => :ExtGState,
         :SMask => mask,
 
@@ -63,13 +62,13 @@ module Prawn
         :OP => false,
         :op => false,
         :OPM => 1,
-        :SA => true,
-      })
+        :SA => true
+      )
 
       registry_key = {
         :bbox => state.page.dimensions,
         :mask => [group.stream.filters.normalized, group.stream.filtered_stream],
-        :page => state.page_count,
+        :page => state.page_count
       }.hash
 
       if soft_mask_registry[registry_key]

data/lib/prawn/stamp.rb

@@ -6,9 +6,7 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 #
-
 module Prawn
-
   # The Prawn::Stamp module is used to create content that will be
   # included multiple times in a document. Using a stamp has three
   # advantages over creating content anew each time it is placed on
@@ -27,7 +25,6 @@ module Prawn
   #   pdf.stamp("my_stamp")
   #
   module Stamp
-
     # @group Stable API
 
     # Renders the stamp named <tt>name</tt> to the page
@@ -45,6 +42,7 @@ module Prawn
     def stamp(name)
       dictionary_name, dictionary = stamp_dictionary(name)
       renderer.add_content "/#{dictionary_name} Do"
+      update_annotation_references dictionary.data[:Annots]
       state.page.xobjects.merge!(dictionary_name => dictionary)
     end
 
@@ -94,9 +92,9 @@ module Prawn
     end
 
     def stamp_dictionary(name)
-      raise Prawn::Errors::InvalidName if name.empty?
+      fail Prawn::Errors::InvalidName if name.empty?
       if stamp_dictionary_registry[name].nil?
-        raise Prawn::Errors::UndefinedObjectName
+        fail Prawn::Errors::UndefinedObjectName
       end
 
       dict = stamp_dictionary_registry[name]
@@ -107,8 +105,8 @@ module Prawn
     end
 
     def create_stamp_dictionary(name)
-      raise Prawn::Errors::InvalidName if name.empty?
-      raise Prawn::Errors::NameTaken unless stamp_dictionary_registry[name].nil?
+      fail Prawn::Errors::InvalidName if name.empty?
+      fail Prawn::Errors::NameTaken unless stamp_dictionary_registry[name].nil?
       # BBox origin is the lower left margin of the page, so we need
       # it to be the full dimension of the page, or else things that
       # should appear near the top or right margin are invisible
@@ -124,6 +122,17 @@ module Prawn
       dictionary
     end
 
+    # Referencing annotations from a stamp XObject doesn't result
+    # in a working link. Instead, the references must be appended
+    # to the /Annot dictionary of the object that contains the
+    # call to the stamp object.
+    def update_annotation_references(annots)
+      if annots && annots.any?
+        state.page.dictionary.data[:Annots] ||= []
+        state.page.dictionary.data[:Annots] |= annots
+      end
+    end
+
     def freeze_stamp_graphics
       update_colors
       write_line_width
@@ -131,6 +140,5 @@ module Prawn
       write_stroke_join_style
       write_stroke_dash
     end
-
   end
 end

data/lib/prawn/text.rb

@@ -15,7 +15,6 @@ require_relative "text/box"
 
 module Prawn
   module Text
-
     include PDF::Core::Text
     include Prawn::Text::Formatted
 
@@ -152,7 +151,7 @@ module Prawn
     # Raises <tt>Prawn::Errrors::CannotFit</tt> if not wide enough to print
     # any text
     #
-    def text(string, options={})
+    def text(string, options = {})
       return false if string.nil?
       # we modify the options. don't change the user's hash
       options = options.dup
@@ -188,7 +187,7 @@ module Prawn
     #
     # Same as for #text
     #
-    def formatted_text(array, options={})
+    def formatted_text(array, options = {})
       options = inspect_options_for_text(options.dup)
 
       if color = options.delete(:color)
@@ -288,17 +287,17 @@ module Prawn
     #
     def draw_text!(text, options)
       unless font.unicode? || font.class.hide_m17n_warning || text.ascii_only?
-        warn "PDF's built-in fonts have very limited support for "+
-             "internationalized text.\nIf you need full UTF-8 support, "+
-             "consider using a TTF font instead.\n\nTo disable this "+
-             "warning, add the following line to your code:\n"+
+        warn "PDF's built-in fonts have very limited support for " \
+             "internationalized text.\nIf you need full UTF-8 support, " \
+             "consider using a TTF font instead.\n\nTo disable this " \
+             "warning, add the following line to your code:\n" \
              "Prawn::Font::AFM.hide_m17n_warning = true\n"
 
         font.class.hide_m17n_warning = true
       end
 
-      x,y = map_to_absolute(options[:at])
-      add_text_content(text,x,y,options)
+      x, y = map_to_absolute(options[:at])
+      add_text_content(text, x, y, options)
     end
 
     # Gets height of text in PDF points.
@@ -317,7 +316,7 @@ module Prawn
     # Raises <tt>Prawn::Errrors::CannotFit</tt> if not wide enough to print
     # any text
     #
-    def height_of(string, options={})
+    def height_of(string, options = {})
       height_of_formatted([{ :text => string }], options)
     end
 
@@ -331,15 +330,16 @@ module Prawn
     #                          :size => 24,
     #                          :styles => [:bold, :italic] }])
     #
-    def height_of_formatted(array, options={})
+    def height_of_formatted(array, options = {})
       if options[:indent_paragraphs]
-        raise NotImplementedError, ":indent_paragraphs option not available" +
+        fail NotImplementedError, ":indent_paragraphs option not available" \
           "with height_of"
       end
       process_final_gap_option(options)
-      box = Text::Formatted::Box.new(array,
-                          options.merge(:height   => 100000000,
-                                        :document => self))
+      box = Text::Formatted::Box.new(
+        array,
+        options.merge(:height => 100000000, :document => self)
+      )
       box.render(:dry_run => true)
 
       height = box.height
@@ -359,8 +359,11 @@ module Prawn
     end
 
     def draw_indented_formatted_line(string, options)
-      gap = options.fetch(:direction, text_direction) == :ltr ?
-              [@indent_paragraphs, 0] : [0, @indent_paragraphs]
+      if options.fetch(:direction, text_direction) == :ltr
+        gap = [@indent_paragraphs, 0]
+      else
+        gap = [0, @indent_paragraphs]
+      end
 
       indent(*gap) do
         fill_formatted_text_box(string, options.dup.merge(:single_line => true))
@@ -392,9 +395,9 @@ module Prawn
 
     def inspect_options_for_draw_text(options)
       if options[:at].nil?
-        raise ArgumentError, "The :at option is required for draw_text"
+        fail ArgumentError, "The :at option is required for draw_text"
       elsif options[:align]
-        raise ArgumentError, "The :align option does not work with draw_text"
+        fail ArgumentError, "The :align option does not work with draw_text"
       end
       if options[:kerning].nil? then
         options[:kerning] = default_kerning?
@@ -406,7 +409,7 @@ module Prawn
 
     def inspect_options_for_text(options)
       if options[:at]
-        raise ArgumentError, ":at is no longer a valid option with text." +
+        fail ArgumentError, ":at is no longer a valid option with text." \
                              "use draw_text or text_box instead"
       end
       process_final_gap_option(options)

data/lib/prawn/text/box.rb

@@ -101,7 +101,7 @@ module Prawn
     # Raises <tt>Prawn::Errors::CannotFit</tt> if not wide enough to print
     # any text
     #
-    def text_box(string, options={})
+    def text_box(string, options = {})
       options = options.dup
       options[:document] = self
 
@@ -125,17 +125,14 @@ module Prawn
     # consumed by the printed text
     #
     class Box < Prawn::Text::Formatted::Box
-
-      def initialize(string, options={})
+      def initialize(string, options = {})
         super([{ :text => string }], options)
       end
 
-      def render(flags={})
+      def render(flags = {})
         leftover = super(flags)
         leftover.collect { |hash| hash[:text] }.join
       end
-
     end
-
   end
 end