prawn 2.3.0 → 2.4.0

data/lib/prawn/outline.rb

@@ -264,11 +264,12 @@ module Prawn
       counting_parent = parent
       while counting_parent
         counting_parent.data.count += 1
-        counting_parent = if counting_parent == root
-                            nil
-                          else
-                            counting_parent.data.parent
-                          end
+        counting_parent =
+          if counting_parent == root
+            nil
+          else
+            counting_parent.data.parent
+          end
       end
     end
 

data/lib/prawn/repeater.rb

@@ -115,7 +115,7 @@ module Prawn
         @document.stamp(@stamp_name) if match?(page_number)
       elsif @block && match?(page_number)
         @document.save_graphics_state(@graphic_state) do
-          @document.send(:freeze_stamp_graphics)
+          @document.__send__(:freeze_stamp_graphics)
           @block.call
         end
       end

data/lib/prawn/security.rb

@@ -124,8 +124,8 @@ module Prawn
       def encryption_dictionary
         {
           Filter: :Standard, # default PDF security handler
-          V: 1,         # "Algorithm 3.1", PDF reference 1.3
-          R: 2,         # Revision 2 of the algorithm
+          V: 1, # "Algorithm 3.1", PDF reference 1.3
+          R: 2, # Revision 2 of the algorithm
           O: PDF::Core::ByteString.new(owner_password_hash),
           U: PDF::Core::ByteString.new(user_password_hash),
           P: permissions_value
@@ -181,21 +181,23 @@ module Prawn
       end
 
       def user_encryption_key
-        @user_encryption_key ||= begin
-          md5 = Digest::MD5.new
-          md5 << pad_password(@user_password)
-          md5 << owner_password_hash
-          md5 << [permissions_value].pack('V')
-          md5.digest[0, 5]
-        end
+        @user_encryption_key ||=
+          begin
+            md5 = Digest::MD5.new
+            md5 << pad_password(@user_password)
+            md5 << owner_password_hash
+            md5 << [permissions_value].pack('V')
+            md5.digest[0, 5]
+          end
       end
 
       # The O (owner) value in the encryption dictionary. Algorithm 3.3.
       def owner_password_hash
-        @owner_password_hash ||= begin
-          key = Digest::MD5.digest(pad_password(@owner_password))[0, 5]
-          Arcfour.new(key).encrypt(pad_password(@user_password))
-        end
+        @owner_password_hash ||=
+          begin
+            key = Digest::MD5.digest(pad_password(@owner_password))[0, 5]
+            Arcfour.new(key).encrypt(pad_password(@user_password))
+          end
       end
 
       # The U (user) value in the encryption dictionary. Algorithm 3.4.
@@ -219,19 +221,22 @@ module PDF
     def encrypted_pdf_object(obj, key, id, gen, in_content_stream = false)
       case obj
       when Array
-        '[' + obj.map do |e|
+        array_content = obj.map do |e|
           encrypted_pdf_object(e, key, id, gen, in_content_stream)
-        end.join(' ') + ']'
+        end.join(' ')
+        "[#{array_content}]"
       when LiteralString
-        obj = ByteString.new(
-          Prawn::Document::Security.encrypt_string(obj, key, id, gen)
-        ).gsub(/[\\\n\(\)]/) { |m| "\\#{m}" }
+        obj =
+          ByteString.new(
+            Prawn::Document::Security.encrypt_string(obj, key, id, gen)
+          ).gsub(/[\\\n()]/) { |m| "\\#{m}" }
         "(#{obj})"
       when Time
-        obj = obj.strftime('D:%Y%m%d%H%M%S%z').chop.chop + "'00'"
-        obj = ByteString.new(
-          Prawn::Document::Security.encrypt_string(obj, key, id, gen)
-        ).gsub(/[\\\n\(\)]/) { |m| "\\#{m}" }
+        obj = "#{obj.strftime('D:%Y%m%d%H%M%S%z').chop.chop}'00'"
+        obj =
+          ByteString.new(
+            Prawn::Document::Security.encrypt_string(obj, key, id, gen)
+          ).gsub(/[\\\n()]/) { |m| "\\#{m}" }
         "(#{obj})"
       when String
         pdf_object(
@@ -241,19 +246,16 @@ module PDF
           in_content_stream
         )
       when ::Hash
-        '<< ' +
-          obj.map do |k, v|
-            unless k.is_a?(String) || k.is_a?(Symbol)
-              raise PDF::Core::Errors::FailedObjectConversion,
-                'A PDF Dictionary must be keyed by names'
-            end
-            pdf_object(k.to_sym, in_content_stream) + ' ' +
-              encrypted_pdf_object(v, key, id, gen, in_content_stream) + "\n"
-          end.join('') +
-          '>>'
+        hash_content = obj.map do |k, v|
+          unless k.is_a?(String) || k.is_a?(Symbol)
+            raise PDF::Core::Errors::FailedObjectConversion,
+              'A PDF Dictionary must be keyed by names'
+          end
+          "#{pdf_object(k.to_sym, in_content_stream)} #{encrypted_pdf_object(v, key, id, gen, in_content_stream)}\n"
+        end.join('')
+        "<< #{hash_content}>>"
       when NameTree::Value
-        pdf_object(obj.name) + ' ' +
-          encrypted_pdf_object(obj.value, key, id, gen, in_content_stream)
+        "#{pdf_object(obj.name)} #{encrypted_pdf_object(obj.value, key, id, gen, in_content_stream)}"
       when PDF::Core::OutlineRoot, PDF::Core::OutlineItem
         encrypted_pdf_object(obj.to_hash, key, id, gen, in_content_stream)
       else # delegate back to pdf_object
@@ -265,10 +267,11 @@ module PDF
     class Stream
       def encrypted_object(key, id, gen)
         if filtered_stream
-          "stream\n" +
+          "stream\n#{
             Prawn::Document::Security.encrypt_string(
               filtered_stream, key, id, gen
-            ) + "\nendstream\n"
+            )
+          }\nendstream\n"
         else
           ''
         end

data/lib/prawn/text.rb

@@ -192,21 +192,19 @@ module Prawn
 
       color = options.delete(:color)
       if color
-        array = array.map do |fragment|
-          fragment[:color] ? fragment : fragment.merge(color: color)
-        end
+        array =
+          array.map do |fragment|
+            fragment[:color] ? fragment : fragment.merge(color: color)
+          end
       end
 
       if @indent_paragraphs
         text_formatter.array_paragraphs(array).each do |paragraph|
           remaining_text = draw_indented_formatted_line(paragraph, options)
 
-          if @no_text_printed
-            # unless this paragraph was an empty line
-            unless @all_text_printed
-              @bounding_box.move_past_bottom
-              remaining_text = draw_indented_formatted_line(paragraph, options)
-            end
+          if @no_text_printed && !@all_text_printed
+            @bounding_box.move_past_bottom
+            remaining_text = draw_indented_formatted_line(paragraph, options)
           end
 
           unless @all_text_printed
@@ -337,8 +335,8 @@ module Prawn
     #
     def height_of_formatted(array, options = {})
       if options[:indent_paragraphs]
-        raise NotImplementedError, ':indent_paragraphs option not available' \
-          'with height_of'
+        raise NotImplementedError,
+          ':indent_paragraphs option not available with height_of'
       end
       process_final_gap_option(options)
       box = Text::Formatted::Box.new(
@@ -364,11 +362,12 @@ module Prawn
     end
 
     def draw_indented_formatted_line(string, options)
-      gap = if options.fetch(:direction, text_direction) == :ltr
-              [@indent_paragraphs, 0]
-            else
-              [0, @indent_paragraphs]
-            end
+      gap =
+        if options.fetch(:direction, text_direction) == :ltr
+          [@indent_paragraphs, 0]
+        else
+          [0, @indent_paragraphs]
+        end
 
       indent(*gap) do
         fill_formatted_text_box(string, options.dup.merge(single_line: true))
@@ -421,8 +420,9 @@ module Prawn
 
     def inspect_options_for_text(options)
       if options[:at]
-        raise ArgumentError, ':at is no longer a valid option with text.' \
-                             'use draw_text or text_box instead'
+        raise ArgumentError,
+          ':at is no longer a valid option with text.' \
+          'use draw_text or text_box instead'
       end
       process_final_gap_option(options)
       process_indent_paragraphs_option(options)

data/lib/prawn/text/box.rb

@@ -107,14 +107,15 @@ module Prawn
       options = options.dup
       options[:document] = self
 
-      box = if options[:inline_format]
-              p = options.delete(:inline_format)
-              p = [] unless p.is_a?(Array)
-              array = text_formatter.format(string, *p)
-              Text::Formatted::Box.new(array, options)
-            else
-              Text::Box.new(string, options)
-            end
+      box =
+        if options[:inline_format]
+          p = options.delete(:inline_format)
+          p = [] unless p.is_a?(Array)
+          array = text_formatter.format(string, *p)
+          Text::Formatted::Box.new(array, options)
+        else
+          Text::Box.new(string, options)
+        end
 
       box.render
     end
@@ -134,7 +135,7 @@ module Prawn
 
       def render(flags = {})
         leftover = super(flags)
-        leftover.collect { |hash| hash[:text] }.join
+        leftover.map { |hash| hash[:text] }.join
       end
     end
   end

data/lib/prawn/text/formatted/arranger.rb

@@ -13,6 +13,25 @@ module Prawn
       # @private
 
       class Arranger #:nodoc:
+        class NotFinalized < StandardError
+          DEFAULT_MESSAGE = 'Lines must be finalized'
+          MESSAGE_WITH_METHOD = 'Lines must be finalized before calling #%<method>s'
+
+          def initialize(message = DEFAULT_MESSAGE, method: nil)
+            if method && message == DEFAULT_MESSAGE
+              super format(MESSAGE_WITH_METHOD, method: method)
+            else
+              super message
+            end
+          end
+        end
+
+        class BadFontFamily < StandardError
+          def initialize(message = 'Bad font family')
+            super
+          end
+        end
+
         attr_reader :max_line_height
         attr_reader :max_descender
         attr_reader :max_ascender
@@ -33,30 +52,30 @@ module Prawn
 
         def space_count
           unless finalized
-            raise 'Lines must be finalized before calling #space_count'
+            raise NotFinalized.new(method: 'space_count')
           end
 
-          @fragments.inject(0) do |sum, fragment|
+          @fragments.reduce(0) do |sum, fragment|
             sum + fragment.space_count
           end
         end
 
         def line_width
           unless finalized
-            raise 'Lines must be finalized before calling #line_width'
+            raise raise NotFinalized.new(method: 'line_width')
           end
 
-          @fragments.inject(0) do |sum, fragment|
+          @fragments.reduce(0) do |sum, fragment|
             sum + fragment.width
           end
         end
 
         def line
           unless finalized
-            raise 'Lines must be finalized before calling #line'
+            raise NotFinalized.new(method: 'line')
           end
 
-          @fragments.collect do |fragment|
+          @fragments.map do |fragment|
             fragment.text.dup.encode(::Encoding::UTF_8)
           rescue ::Encoding::InvalidByteSequenceError,
                  ::Encoding::UndefinedConversionError
@@ -110,7 +129,7 @@ module Prawn
 
         def next_string
           if finalized
-            raise 'Lines must not be finalized when calling #next_string'
+            raise NotFinalized.new(method: 'next_string')
           end
 
           next_unconsumed_hash = @unconsumed.shift
@@ -163,7 +182,7 @@ module Prawn
 
           @document.character_spacing(character_spacing) do
             if font || font_style != :normal
-              raise 'Bad font family' unless @document.font.family
+              raise BadFontFamily unless @document.font.family
 
               @document.font(
                 font || @document.font.family, style: font_style
@@ -197,7 +216,7 @@ module Prawn
 
         def retrieve_fragment
           unless finalized
-            raise 'Lines must be finalized before fragments can be retrieved'
+            raise NotFinalized, 'Lines must be finalized before fragments can be retrieved'
           end
 
           @fragments.shift
@@ -215,9 +234,8 @@ module Prawn
         end
 
         def font_style(styles)
-          if styles.nil?
-            :normal
-          elsif styles.include?(:bold) && styles.include?(:italic)
+          styles = Array(styles)
+          if styles.include?(:bold) && styles.include?(:italic)
             :bold_italic
           elsif styles.include?(:bold)
             :bold
@@ -240,19 +258,20 @@ module Prawn
           end
         end
 
-        def apply_font_size(size, styles)
+        def apply_font_size(size, styles, &block)
           if subscript?(styles) || superscript?(styles)
             relative_size = 0.583
-            size = if size.nil?
-                     @document.font_size * relative_size
-                   else
-                     size * relative_size
-                   end
+            size =
+              if size.nil?
+                @document.font_size * relative_size
+              else
+                size * relative_size
+              end
           end
           if size.nil?
             yield
           else
-            @document.font_size(size) { yield }
+            @document.font_size(size, &block)
           end
         end
 

data/lib/prawn/text/formatted/box.rb

@@ -222,11 +222,12 @@ module Prawn
                   shrink_to_fit(text) if @overflow == :shrink_to_fit
                   process_vertical_alignment(text)
                   @inked = true unless flags[:dry_run]
-                  unprinted_text = if @rotate != 0 && @inked
-                                     render_rotated(text)
-                                   else
-                                     wrap(text)
-                                   end
+                  unprinted_text =
+                    if @rotate != 0 && @inked
+                      render_rotated(text)
+                    else
+                      wrap(text)
+                    end
                   @inked = false
                 end
               end
@@ -265,11 +266,12 @@ module Prawn
           when :right
             x = @at[0] + @width - line_width
           when :justify
-            x = if @direction == :ltr
-                  @at[0]
-                else
-                  @at[0] + @width - line_width
-                end
+            x =
+              if @direction == :ltr
+                @at[0]
+              else
+                @at[0] + @width - line_width
+              end
           else
             raise ArgumentError,
               'align must be one of :left, :right, :center or :justify symbols'
@@ -290,13 +292,15 @@ module Prawn
             @document.word_spacing(word_spacing) do
               if @draw_text_callback
                 @draw_text_callback.call(
-                  fragment.text, at: [x, y],
-                                 kerning: @kerning
+                  fragment.text,
+                  at: [x, y],
+                  kerning: @kerning
                 )
               else
                 @document.draw_text!(
-                  fragment.text, at: [x, y],
-                                 kerning: @kerning
+                  fragment.text,
+                  at: [x, y],
+                  kerning: @kerning
                 )
               end
             end
@@ -340,6 +344,7 @@ module Prawn
 
         # @private
         def self.inherited(base)
+          super
           extensions.each { |e| base.extensions << e }
         end
 
@@ -371,7 +376,7 @@ module Prawn
         end
 
         def original_text
-          @original_array.collect(&:dup)
+          @original_array.map(&:dup)
         end
 
         def original_text=(formatted_text)

data/lib/prawn/text/formatted/line_wrap.rb

@@ -86,18 +86,20 @@ module Prawn
         # the line
         #
         def add_fragment_to_line(fragment)
-          if fragment == ''
+          case fragment
+          when ''
             true
-          elsif fragment == "\n"
+          when "\n"
             @newline_encountered = true
             false
           else
             tokenize(fragment).each do |segment|
-              segment_width = if segment == zero_width_space(segment.encoding)
-                                0
-                              else
-                                @document.width_of(segment, kerning: @kerning)
-                              end
+              segment_width =
+                if segment == zero_width_space(segment.encoding)
+                  0
+                else
+                  @document.width_of(segment, kerning: @kerning)
+                end
 
               if @accumulated_width + segment_width <= @width
                 @accumulated_width += segment_width
@@ -151,9 +153,10 @@ module Prawn
         # word breaking is needed
         #
         def word_division_scan_pattern(encoding = ::Encoding::UTF_8)
-          common_whitespaces = ["\t", "\n", "\v", "\r", ' '].map do |c|
-            c.encode(encoding)
-          end
+          common_whitespaces =
+            ["\t", "\n", "\v", "\r", ' '].map do |c|
+              c.encode(encoding)
+            end
 
           Regexp.union(
             common_whitespaces +
@@ -254,12 +257,11 @@ module Prawn
 
         def pull_preceding_fragment_to_join_this_one?(current_fragment)
           if @fragment_output.empty? && !current_fragment.empty? &&
-              @line_contains_more_than_one_word
-            unless previous_fragment_ended_with_breakable? ||
-                fragment_begins_with_breakable?(current_fragment)
-              @fragment_output = @previous_fragment_output_without_last_word
-              update_output_based_on_last_fragment(@previous_fragment)
-            end
+              @line_contains_more_than_one_word &&
+              !(previous_fragment_ended_with_breakable? ||
+                fragment_begins_with_breakable?(current_fragment))
+            @fragment_output = @previous_fragment_output_without_last_word
+            update_output_based_on_last_fragment(@previous_fragment)
           end
         end