prawn 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 287dd21a281ca025939e562e2d9d0dae14373d21
-  data.tar.gz: 0c08643d45840aad66a59661f7593bc3abb89302
+  metadata.gz: 98b52bd4123515071703b076cf87b787cd33ebff
+  data.tar.gz: 7d8c0d44d9a17975823452b1c95d81f81ace8d20
 SHA512:
-  metadata.gz: 013f40d6fa76d1cf34ed85578e8ce5700c3ba47bbf6b373b9856ae2a34fe42421d83da002604f1acb5bdfd7fdcf0acc85a1f58d9397c89d46254c2e01da5764a
-  data.tar.gz: b478644390db0dcd837063a79c126cf0d8d70a53746755dae3797bda11553b8520dd33d3ca983301a7627a76b74d824337d3497abba5966683eedd81efb5a2d5
+  metadata.gz: 20656b10430797d190dac2bebb0140e178bf1f35c6c98e92d1d9f1929ef5ec101a0fb41be5873a2b0b3b2a972c6c7932503ad619bc71588943573efac2453fa1
+  data.tar.gz: 511baa72ae16f53839675590c957ce49494b7180ab997bab2e189686f46a70a7ed4c761ca9de495f913f2b45fc74f013431da0fbb64517ce2ee4e3e4ec70a2d0

data/.yardopts

@@ -7,3 +7,4 @@ CONTRIBUTING.md
 COPYING
 LICENSE
 README.md
+CHANGELOG.md

data/Gemfile

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-if ENV["CI"] 
+if ENV["CI"]
   platforms :rbx do
     gem "rubysl-singleton", "~> 2.0"
     gem "rubysl-digest", "~> 2.0"

data/Rakefile

@@ -7,7 +7,7 @@ require 'yard'
 require 'rubygems/package_task'
 require 'rubocop/rake_task'
 
-task :default => [:rubocop, :spec]
+task :default => [:spec, :rubocop]
 
 desc "Run all rspec files"
 RSpec::Core::RakeTask.new("spec") do |c|
@@ -52,4 +52,4 @@ task :console do
   IRB.start
 end
 
-Rubocop::RakeTask.new
+RuboCop::RakeTask.new

data/lib/prawn.rb

@@ -78,7 +78,6 @@ require_relative "prawn/soft_mask"
 require_relative "prawn/security"
 require_relative "prawn/document"
 require_relative "prawn/font"
-require_relative "prawn/encoding"
 require_relative "prawn/measurements"
 require_relative "prawn/repeater"
 require_relative "prawn/outline"

data/lib/prawn/document.rb

@@ -66,7 +66,7 @@ module Prawn
 
     VALID_OPTIONS = [:page_size, :page_layout, :margin, :left_margin,
                      :right_margin, :top_margin, :bottom_margin, :skip_page_creation,
-                     :compress, :skip_encoding, :background, :info,
+                     :compress, :background, :info,
                      :text_formatter, :print_scaling]
 
     # Any module added to this array will be included into instances of
@@ -243,7 +243,7 @@ module Prawn
       if last_page = state.page
         last_page_size    = last_page.size
         last_page_layout  = last_page.layout
-        last_page_margins = last_page.margins
+        last_page_margins = last_page.margins.dup
       end
 
       page_options = {:size => options[:size] || last_page_size,

data/lib/prawn/document/internals.rb

@@ -26,7 +26,8 @@ module Prawn
       # Anyway, for now it's not clear what we should do w. them.
       delegate [ :graphic_state,
                  :save_graphics_state,
-                 :restore_graphics_state ] => :renderer
+                 :restore_graphics_state,
+                 :on_page_create ] => :renderer
 
       # FIXME: This is a circular reference, because in theory Prawn should
       # be passing instances of renderer to PDF::Core::Page, but it's

data/lib/prawn/encoding.rb

@@ -82,39 +82,6 @@ module Prawn
         oslash        ugrave         uacute         ucircumflex
         udieresis     yacute         thorn          ydieresis
       ]
-
-      def initialize
-        @mapping_file = "#{Prawn::DATADIR}/encodings/win_ansi.txt"
-        load_mapping if self.class.mapping.empty?
-      end
-
-      # Converts a Unicode codepoint into a valid WinAnsi single byte character.
-      #
-      # If there is no WinAnsi equivlant for a character, a _ will be substituted.
-      #
-      def [](codepoint)
-        # unicode codepoints < 255 map directly to the single byte value in WinAnsi
-        return codepoint if codepoint <= 255
-
-        # There are a handful of codepoints > 255 that have equivilants in WinAnsi.
-        # Replace anything else with an underscore
-        self.class.mapping[codepoint] || 95
-      end
-
-      def self.mapping
-        @mapping ||= {}
-      end
-
-      private
-
-      def load_mapping
-        File.open(@mapping_file, "r:BINARY") do |f|
-          f.each do |l|
-            _, single_byte, unicode = *l.match(/([0-9A-Za-z]+);([0-9A-F]{4})/)
-            self.class.mapping["0x#{unicode}".hex] = "0x#{single_byte}".hex if single_byte
-          end
-        end
-      end
     end
   end
 end

data/lib/prawn/font/afm.rb

@@ -6,7 +6,7 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require_relative '../../prawn/encoding'
+require_relative "../encoding"
 
 module Prawn
   class Font
@@ -14,6 +14,12 @@ module Prawn
     # @private
 
     class AFM < Font
+      class << self
+        attr_accessor :hide_m17n_warning
+      end
+
+      self.hide_m17n_warning = false
+
       BUILT_INS = %w[ Courier Helvetica Times-Roman Symbol ZapfDingbats
                       Courier-Bold Courier-Oblique Courier-BoldOblique
                       Times-Bold Times-Italic Times-BoldItalic
@@ -44,7 +50,6 @@ module Prawn
 
         super
 
-        @@winansi   ||= Prawn::Encoding::WinAnsi.new # parse data/encodings/win_ansi.txt once only
         @@font_data ||= SynchronizedCache.new        # parse each ATM font file once only
 
         file_name = @name.dup
@@ -94,11 +99,17 @@ module Prawn
       # is replaced with a string in WinAnsi encoding.
       #
       def normalize_encoding(text)
-        enc = @@winansi
-        text.unpack("U*").collect { |i| enc[i] }.pack("C*")
-      rescue ArgumentError
+        text.encode("windows-1252")
+      rescue ::Encoding::InvalidByteSequenceError,
+             ::Encoding::UndefinedConversionError
+
         raise Prawn::Errors::IncompatibleStringEncoding,
-          "Arguments to text methods must be UTF-8 encoded"
+          "Your document includes text that's not compatible with the Windows-1252 character set.\n"+
+          "If you need full UTF-8 support, use TTF fonts instead of PDF's built-in fonts\n."
+      end
+
+      def to_utf8(text)
+        text.encode("UTF-8")
       end
 
       # Returns the number of characters in +str+ (a WinAnsi-encoded string).
@@ -124,11 +135,9 @@ module Prawn
       end
 
       def glyph_present?(char)
-        if char == "_"
-          true
-        else
-          normalize_encoding(char) != "_"
-        end
+        !!normalize_encoding(char)
+      rescue Prawn::Errors::IncompatibleStringEncoding
+        false
       end
 
       private

data/lib/prawn/font/ttf.rb

@@ -173,6 +173,10 @@ module Prawn
         end
       end
 
+      def to_utf8(text)
+        text.encode("UTF-8")
+      end
+
       def glyph_present?(char)
         code = char.codepoints.first
         cmap[code] > 0

data/lib/prawn/font_metric_cache.rb

@@ -26,8 +26,7 @@ module Prawn
     def width_of( string, options )
       f = if options[:style]
             # override style with :style => :bold
-            @document.find_font(@document.font ? @document.font.name : 'Helvetica',
-                      :style => options[:style])
+            @document.find_font(@document.font.family, :style => options[:style])
           else
             @document.font
           end

data/lib/prawn/graphics.rb

@@ -46,8 +46,8 @@ module Prawn
     #   pdf.move_to(100,50)
     #
     def move_to(*point)
-      x,y = map_to_absolute(point)
-      renderer.add_content("%.3f %.3f m" % [ x, y ])
+      xy = PDF::Core.real_params(map_to_absolute(point))
+      renderer.add_content("#{xy} m")
     end
 
     # Draws a line from the current drawing position to the specified point.
@@ -57,8 +57,8 @@ module Prawn
     #   pdf.line_to(50,50)
     #
     def line_to(*point)
-      x,y = map_to_absolute(point)
-      renderer.add_content("%.3f %.3f l" % [ x, y ])
+      xy = PDF::Core.real_params(map_to_absolute(point))
+      renderer.add_content("#{xy} l")
     end
 
     # Draws a Bezier curve from the current drawing position to the
@@ -71,9 +71,10 @@ module Prawn
          "Bounding points for bezier curve must be specified "+
          "as :bounds => [[x1,y1],[x2,y2]]"
 
-       curve_points = (options[:bounds] << dest).map { |e| map_to_absolute(e) }
-       renderer.add_content("%.3f %.3f %.3f %.3f %.3f %.3f c" %
-                     curve_points.flatten )
+       curve_points = PDF::Core.real_params(
+        (options[:bounds] << dest).flat_map { |e| map_to_absolute(e) })
+
+       renderer.add_content("#{curve_points} c")
     end
 
     # Draws a rectangle given <tt>point</tt>, <tt>width</tt> and
@@ -83,7 +84,9 @@ module Prawn
     #
     def rectangle(point,width,height)
       x,y = map_to_absolute(point)
-      renderer.add_content("%.3f %.3f %.3f %.3f re" % [ x, y - height, width, height ])
+      box = PDF::Core.real_params([x, y - height, width, height])
+
+      renderer.add_content("#{box} re")
     end
 
     # Draws a rounded rectangle given <tt>point</tt>, <tt>width</tt> and

data/lib/prawn/graphics/dash.rb

@@ -55,6 +55,11 @@ module Prawn
       def dash(length=nil, options={})
         return current_dash_state if length.nil?
 
+        if length == 0 || length.kind_of?(Array) && length.any? { |e| e == 0 }
+          raise ArgumentError,
+            "Zero length dashes are invalid. Call #undash to disable dashes."
+        end
+
         self.current_dash_state = { :dash  => length,
                   :space => length.kind_of?(Array) ? nil : options[:space] || length,
                   :phase => options[:phase] || 0 }

data/lib/prawn/images.rb

@@ -121,9 +121,8 @@ module Prawn
       label = "I#{next_image_id}"
       state.page.xobjects.merge!(label => pdf_obj)
 
-      # add the image to the current page
-      instruct = "\nq\n%.3f 0 0 %.3f %.3f %.3f cm\n/%s Do\nQ"
-      renderer.add_content instruct % [ w, h, x, y - h, label ]
+      cm_params = PDF::Core.real_params([ w, 0, 0, h, x, y - h])
+      renderer.add_content("\nq\n#{cm_params} cm\n/#{label} Do\nQ")
     end
 
     private

data/lib/prawn/images/png.rb

@@ -68,13 +68,9 @@ module Prawn
             @transparency = {}
             case @color_type
             when 3
-              # Indexed colour, RGB. Each byte in this chunk is an alpha for
-              # the palette index in the PLTE ("palette") chunk up until the
-              # last non-opaque entry. Set up an array, stretching over all
-              # palette entries which will be 0 (opaque) or 1 (transparent).
-              @transparency[:indexed]  = data.read(chunk_size).unpack("C*")
-              short = 255 - @transparency[:indexed].size
-              @transparency[:indexed] += ([255] * short) if short > 0
+              raise Errors::UnsupportedImageType,
+                "Pallete-based transparency in PNG is not currently supported.\n" +
+                "See https://github.com/prawnpdf/prawn/issues/783"
             when 0
               # Greyscale. Corresponding to entries in the PLTE chunk.
               # Grey is two bytes, range 0 .. (2 ^ bit-depth) - 1
@@ -208,11 +204,6 @@ module Prawn
           #   components.
           rgb = transparency[:rgb]
           obj.data[:Mask] = rgb.collect { |x| [x,x] }.flatten
-        elsif transparency[:indexed]
-          # TODO: broken. I was attempting to us Color Key Masking, but I think
-          #       we need to construct an SMask i think. Maybe do it inside
-          #       the PNG class, and store it in alpha_channel
-          #obj.data[:Mask] = transparency[:indexed]
         end
 
         # For PNG color types 4 and 6, the transparency data is stored as a alpha

data/lib/prawn/text.rb

@@ -116,7 +116,7 @@ module Prawn
     #                   the current font familly. [current style]
     # <tt>:indent_paragraphs</tt>:: <tt>number</tt>. The amount to indent the
     #                               first line of each paragraph. Omit this
-    #                               option if you do not want indenting
+    #                               option if you do not want indenting.
     # <tt>:direction</tt>::
     #     <tt>:ltr</tt>, <tt>:rtl</tt>, Direction of the text (left-to-right
     #     or right-to-left) [value of document.text_direction]
@@ -199,17 +199,13 @@ module Prawn
 
       if @indent_paragraphs
         self.text_formatter.array_paragraphs(array).each do |paragraph|
-          options[:skip_encoding] = false
           remaining_text = draw_indented_formatted_line(paragraph, options)
-          options[:skip_encoding] = true
 
           if @no_text_printed
             # unless this paragraph was an empty line
             unless @all_text_printed
               @bounding_box.move_past_bottom
-              options[:skip_encoding] = false
               remaining_text = draw_indented_formatted_line(paragraph, options)
-              options[:skip_encoding] = true
             end
           end
 
@@ -218,7 +214,6 @@ module Prawn
         end
       else
         remaining_text = fill_formatted_text_box(array, options)
-        options[:skip_encoding] = true
         draw_remaining_formatted_text_on_new_pages(remaining_text, options)
       end
     end
@@ -292,6 +287,16 @@ module Prawn
     # should already be set
     #
     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"+
+             "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)
     end
@@ -354,7 +359,10 @@ module Prawn
     end
 
     def draw_indented_formatted_line(string, options)
-      indent(@indent_paragraphs) do
+      gap = options.fetch(:direction, text_direction) == :ltr ?
+              [@indent_paragraphs, 0] : [0, @indent_paragraphs]
+
+      indent(*gap) do
         fill_formatted_text_box(string, options.dup.merge(:single_line => true))
       end
     end

data/lib/prawn/text/box.rb

@@ -72,7 +72,6 @@ module Prawn
     # <tt>:valign</tt>::
     #     <tt>:top</tt>, <tt>:center</tt>, or <tt>:bottom</tt>. Vertical
     #     alignment within the bounding box [:top]
-    #
     # <tt>:rotate</tt>::
     #     <tt>number</tt>. The angle to rotate the text
     # <tt>:rotate_around</tt>::
@@ -84,8 +83,6 @@ module Prawn
     #     document.default_leading]
     # <tt>:single_line</tt>::
     #     <tt>boolean</tt>. If true, then only the first line will be drawn [false]
-    # <tt>:skip_encoding</tt>::
-    #     <tt>boolean</tt> [false]
     # <tt>:overflow</tt>::
     #     <tt>:truncate</tt>, <tt>:shrink_to_fit</tt>, or <tt>:expand</tt>
     #     This controls the behavior when the amount of text
@@ -99,14 +96,9 @@ module Prawn
     #
     # Returns any text that did not print under the current settings.
     #
-    # NOTE: if an AFM font is used, then the returned text is encoded in
-    # WinAnsi. Subsequent calls to text_box that pass this returned text back
-    # into text box must include a :skip_encoding => true option. This is
-    # unnecessary when using TTF fonts because those operate on UTF-8 encoding.
-    #
     # == Exceptions
     #
-    # Raises <tt>Prawn::Errrors::CannotFit</tt> if not wide enough to print
+    # Raises <tt>Prawn::Errors::CannotFit</tt> if not wide enough to print
     # any text
     #
     def text_box(string, options={})

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

@@ -85,7 +85,7 @@ module Prawn
       #
       # Raises "Bad font family" if no font family is defined for the current font
       #
-      # Raises <tt>Prawn::Errrors::CannotFit</tt> if not wide enough to print
+      # Raises <tt>Prawn::Errors::CannotFit</tt> if not wide enough to print
       # any text
       #
       def formatted_text_box(array, options={})
@@ -168,7 +168,6 @@ module Prawn
           @rotate            = options[:rotate] || 0
           @rotate_around     = options[:rotate_around] || :upper_left
           @single_line       = options[:single_line]
-          @skip_encoding     = options[:skip_encoding] || @document.skip_encoding
           @draw_text_callback = options[:draw_text_callback]
 
           # if the text rendering mode is :unknown, force it back to :fill
@@ -229,7 +228,9 @@ module Prawn
             end
           end
 
-          unprinted_text
+          unprinted_text.map do |e|
+            e.merge(:text => @document.font.to_utf8(e[:text]))
+          end
         end
 
         # The width available at this point in the box
@@ -335,7 +336,6 @@ module Prawn
                                               :disable_wrap_by_char,
                                               :leading, :character_spacing,
                                               :mode, :single_line,
-                                              :skip_encoding,
                                               :document,
                                               :direction,
                                               :fallback_fonts,
@@ -345,11 +345,7 @@ module Prawn
         private
 
         def normalized_text(flags)
-          if @skip_encoding
-            text = original_text
-          else
-            text = normalize_encoding
-          end
+          text = normalize_encoding
 
           text.each { |t| t.delete(:color) } if flags[:dry_run]
 
@@ -484,14 +480,16 @@ module Prawn
           @vertical_alignment_processed = true
 
           return if @vertical_align == :top
+
           wrap(text)
 
           case @vertical_align
           when :center
-            @at[1] = @at[1] - (@height - height) * 0.5
+            @at[1] -= (@height - height + @descender) * 0.5
           when :bottom
-            @at[1] = @at[1] - (@height - height) + @descender
+            @at[1] -= (@height - height)
           end
+
           @height = height
         end