prawn 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad2fdbe5f0c7d9075d0a6467217a996304aa4983
-  data.tar.gz: 6db5219bdb341f2c8d36c3cc0aca48720adbdccc
+  metadata.gz: d83c112e79d7d99ade30524585cf7d7cb7d4de52
+  data.tar.gz: a0143b1b1ebf8db3776daafe04dbceeedb62db6b
 SHA512:
-  metadata.gz: c2795eaa023f044fdf99b91f79a4e56f181c8dcb13fd73112dcf181156234230117e17221521634c728e60c92a7f05a607f16cec47cd72eff9a77995e91f750f
-  data.tar.gz: cdf2c886e7bea9946289a11fa1f33c4574884ca65d2eebbaec6967016bc31aee008a9048fccecb73756a4950a6b4e686c838ddbf5e3c3c258bd1dd2ed6fea379
+  metadata.gz: 6f9ac40edd92c31df1f2a63e73684f983069edcb8f1dd15ffb26f9bcc85256ac4adc0f476aa6ef5b4fa2248318515c56a39dc68e5f2352711e30dd4863aa4989
+  data.tar.gz: 7ecbae3e281cae29a8a7234fc32c0148eaae4d27dabc35cecba01073d28319c5480c50dcc1cce2f1bdb5b1c99b4a11e80168d62b8c7c94faa8a1a1f7995f0043

data/.yardopts

@@ -0,0 +1,9 @@
+--charset UTF-8
+--main README.md
+--title 'Prawn Documentation'
+lib/**/*.rb
+-
+CONTRIBUTING.md
+COPYING
+LICENSE
+README.md

data/Gemfile

@@ -1,18 +1,11 @@
 source "https://rubygems.org"
 
-gem "ttfunk", "~>1.0.3"
-gem "pdf-reader", "~> 1.2"
-gem "ruby-rc4"
-gem "afm"
+gemspec
 
-group :development do
-  gem "coderay", "~> 1.0.7"
-  gem "rdoc"
-end
-
-group :test do
-  gem "pdf-inspector", "~> 1.1.0", :require => "pdf/inspector"
-  gem "rspec"
-  gem "mocha", :require => false
-  gem "rake"
+if ENV["CI"] 
+  platforms :rbx do
+    gem "rubysl-singleton", "~> 2.0"
+    gem "rubysl-digest", "~> 2.0"
+    gem "rubysl-enumerator", "~> 2.0"
+  end
 end

data/Rakefile

@@ -3,7 +3,7 @@ Bundler.setup
 
 require 'rake'
 require 'rspec/core/rake_task'
-require 'rdoc/task'
+require 'yard'
 require 'rubygems/package_task'
 
 task :default => [:spec]
@@ -21,16 +21,11 @@ task :stats do
                       ["Specs", "spec"] ).to_s
 end
 
-desc "genrates documentation"
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_files.include( "README.md",
-                           "COPYING",
-                           "LICENSE",
-                           "lib/" )
-  rdoc.main     = "README.md"
-  rdoc.rdoc_dir = "doc/html"
-  rdoc.title    = "Prawn Documentation"
+YARD::Rake::YardocTask.new do |t|
+  t.options = ['--output-dir', 'doc/html']
 end
+task :docs => :yard
+
 
 desc "Generate the 'Prawn by Example' manual"
 task :manual do

data/lib/pdf/core/document_state.rb

@@ -5,10 +5,11 @@ module PDF
         normalize_metadata(options)
 
         if options[:template]
-          @store = PDF::Core::ObjectStore.new(:template => options[:template])
+          @store = PDF::Core::ObjectStore.new(:template => options[:template],
+                                                :print_scaling => options[:print_scaling])
           @store.info.data.merge!(options[:info]) if options[:info]
         else
-          @store = PDF::Core::ObjectStore.new(:info => options[:info])
+          @store = PDF::Core::ObjectStore.new(:info => options[:info], :print_scaling => options[:print_scaling])
         end
 
         @version                 = 1.3

data/lib/pdf/core/graphics_state.rb

@@ -43,17 +43,23 @@ module PDF
 
     end
 
+    # NOTE: This class may be a good candidate for a copy-on-write hash.
     class GraphicState
-      attr_accessor :color_space, :dash, :cap_style, :join_style, :line_width, :fill_color, :stroke_color
+      attr_accessor :color_space, :dash, :cap_style, :join_style, :line_width, 
+                    :fill_color, :stroke_color
 
       def initialize(previous_state = nil)
-        @color_space = previous_state ? previous_state.color_space.dup : {}
-        @fill_color = previous_state ? previous_state.fill_color : "000000"
-        @stroke_color = previous_state ? previous_state.stroke_color : "000000"
-        @dash = previous_state ? previous_state.dash : { :dash => nil, :space => nil, :phase => 0 }
-        @cap_style = previous_state ? previous_state.cap_style : :butt
-        @join_style = previous_state ? previous_state.join_style : :miter
-        @line_width = previous_state ? previous_state.line_width : 1
+        if previous_state
+          initialize_copy(previous_state)
+        else
+          @color_space  = {}
+          @fill_color   = "000000"
+          @stroke_color = "000000"
+          @dash         = { :dash => nil, :space => nil, :phase => 0 }
+          @cap_style    = :butt
+          @join_style   = :miter
+          @line_width   = 1
+        end
       end
 
       def dash_setting
@@ -63,6 +69,21 @@ module PDF
           "[#{@dash[:dash]} #{@dash[:space]}] #{@dash[:phase]} d"
         end
       end
+
+      private
+
+      def initialize_copy(other)
+        # mutable state
+        @color_space  = other.color_space.dup
+        @fill_color   = other.fill_color.dup
+        @stroke_color = other.stroke_color.dup
+        @dash         = other.dash.dup
+
+        # immutable state that doesn't need to be duped
+        @cap_style    = other.cap_style
+        @join_style   = other.join_style
+        @line_width   = other.line_width
+      end
     end
   end
 end

data/lib/pdf/core/object_store.rb

@@ -26,6 +26,9 @@ module PDF
 
         @info  ||= ref(opts[:info] || {}).identifier
         @root  ||= ref(:Type => :Catalog).identifier
+        if opts[:print_scaling] == :none
+          root.data[:ViewerPreferences] = {:PrintScaling => :None}
+        end
         if pages.nil?
           root.data[:Pages] = ref(:Type => :Pages, :Count => 0, :Kids => [])
         end
@@ -299,21 +302,9 @@ module PDF
         end
       end
 
-      ruby_18 do
-        def is_utf8?(str)
-          begin
-            str.unpack("U*")
-            true
-          rescue
-            false
-          end
-        end
-      end
-      ruby_19 do
-        def is_utf8?(str)
-          str.force_encoding("utf-8")
-          str.valid_encoding?
-        end
+      def is_utf8?(str)
+        str.force_encoding(::Encoding::UTF_8)
+        str.valid_encoding?
       end
     end
   end

data/lib/pdf/core/pdf_object.rb

@@ -12,40 +12,15 @@ module PDF
   module Core
     module_function
 
-    if "".respond_to?(:encode)
-      # Ruby 1.9+
-      def utf8_to_utf16(str)
-        "\xFE\xFF".force_encoding("UTF-16BE") + str.encode("UTF-16BE")
-      end
-
-      # encodes any string into a hex representation. The result is a string
-      # with only 0-9 and a-f characters. That result is valid ASCII so tag
-      # it as such to account for behaviour of different ruby VMs
-      def string_to_hex(str)
-        str.unpack("H*").first.force_encoding("ascii")
-      end
-    else
-      # Ruby 1.8
-      def utf8_to_utf16(str)
-        utf16 = "\xFE\xFF"
-
-        str.codepoints do |cp|
-          if cp < 0x10000 # Basic Multilingual Plane
-            utf16 << [cp].pack("n")
-          else
-            # pull out high/low 10 bits
-            hi, lo = (cp - 0x10000).divmod(2**10)
-            # encode a surrogate pair
-            utf16 << [0xD800 + hi, 0xDC00 + lo].pack("n*")
-          end
-        end
-
-        utf16
-      end
+    def utf8_to_utf16(str)
+      "\xFE\xFF".force_encoding(::Encoding::UTF_16BE) + str.encode(::Encoding::UTF_16BE)
+    end
 
-      def string_to_hex(str)
-        str.unpack("H*").first
-      end
+    # encodes any string into a hex representation. The result is a string
+    # with only 0-9 and a-f characters. That result is valid ASCII so tag
+    # it as such to account for behaviour of different ruby VMs
+    def string_to_hex(str)
+      str.unpack("H*").first.force_encoding(::Encoding::US_ASCII)
     end
 
     # Serializes Ruby objects to their PDF equivalents.  Most primitive objects

data/lib/prawn/document/bounding_box.rb

@@ -188,10 +188,21 @@ module Prawn
 
       parent_box = @bounding_box
 
+      original_ypos = y
+
       init_block.call(parent_box)
 
       self.y = @bounding_box.absolute_top
       user_block.call
+
+      # If the user actions did not modify the y position
+      # restore the original y position before the bounding
+      # box was created.
+      
+      if y == @bounding_box.absolute_top
+        self.y = original_ypos
+      end
+
       unless options[:hold_position] || @bounding_box.stretchy?
         self.y = @bounding_box.absolute_bottom
       end

data/lib/prawn/document/column_box.rb

@@ -4,7 +4,8 @@
 #
 # Author Paul Ostazeski.
 
-require "prawn/document/bounding_box"
+require_relative "bounding_box"
+
 module Prawn
   class Document
 
@@ -14,10 +15,13 @@ module Prawn
     # filled.
     #
     # column_box accepts the same parameters as bounding_box, as well as the
-    # number of :columns and a :spacer (in points) between columns.
-    #
-    # Defaults are :columns = 3 and :spacer = font_size
+    # number of :columns and a :spacer (in points) between columns. If resetting
+    # the top margin is desired on a new page (e.g. to allow for initial page 
+    # wide column titles) the option :reflow_margins => true can be set.
     #
+    # Defaults are :columns = 3, :spacer = font_size, and 
+    # :reflow_margins => false
+    # 
     # Under PDF::Writer, "spacer" was known as "gutter"
     #
     def column_box(*args, &block)
@@ -51,6 +55,7 @@ module Prawn
         @columns = options[:columns] || 3
         @spacer  = options[:spacer]  || @document.font_size
         @current_column = 0
+        @reflow_margins = options[:reflow_margins]
       end
 
       # The column width, not the width of the whole box,
@@ -103,6 +108,9 @@ module Prawn
         @current_column = (@current_column + 1) % @columns
         @document.y = @y
         if 0 == @current_column
+          if @reflow_margins
+            @y = @parent.absolute_top
+          end
           @document.start_new_page
         end
       end

data/lib/prawn/document.rb

@@ -7,12 +7,12 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 require "stringio"
-require "prawn/document/bounding_box"
-require "prawn/document/column_box"
-require "prawn/document/internals"
-require "prawn/document/span"
-require "prawn/document/snapshot"
-require "prawn/document/graphics_state"
+require_relative "document/bounding_box"
+require_relative "document/column_box"
+require_relative "document/internals"
+require_relative "document/span"
+require_relative "document/snapshot"
+require_relative "document/graphics_state"
 
 module Prawn
 
@@ -62,6 +62,14 @@ module Prawn
     include Prawn::Stamp
     include Prawn::SoftMask
 
+    # NOTE: We probably need to rethink the options validation system, but this
+    # constant temporarily allows for extensions to modify the list.
+
+    VALID_OPTIONS = [:page_size, :page_layout, :margin, :left_margin,
+                     :right_margin, :top_margin, :bottom_margin, :skip_page_creation,
+                     :compress, :skip_encoding, :background, :info,
+                     :optimize_objects, :text_formatter, :print_scaling]
+
     # Any module added to this array will be included into instances of
     # Prawn::Document at the per-object level.  These will also be inherited by
     # any subclasses.
@@ -138,7 +146,6 @@ module Prawn
     # <tt>:background</tt>:: An image path to be used as background on all pages [nil]
     # <tt>:background_scale</tt>:: Backgound image scale [1] [nil]
     # <tt>:info</tt>:: Generic hash allowing for custom metadata properties [nil]
-    # <tt>:template</tt>:: The path to an existing PDF file to use as a template [nil]
     # <tt>:text_formatter</tt>: The text formatter to use for <tt>:inline_format</tt>ted text [Prawn::Text::Formatted::Parser]
     #
     # Setting e.g. the :margin to 100 points and the :left_margin to 50 will result in margins
@@ -173,10 +180,7 @@ module Prawn
     def initialize(options={},&block)
       options = options.dup
 
-      Prawn.verify_options [:page_size, :page_layout, :margin, :left_margin,
-        :right_margin, :top_margin, :bottom_margin, :skip_page_creation,
-        :compress, :skip_encoding, :background, :info,
-        :optimize_objects, :template, :text_formatter], options
+      Prawn.verify_options VALID_OPTIONS, options
 
       # need to fix, as the refactoring breaks this
       # raise NotImplementedError if options[:skip_page_creation]
@@ -186,6 +190,8 @@ module Prawn
       @internal_state.populate_pages_from_store(self)
       min_version(state.store.min_version) if state.store.min_version
 
+      min_version(1.6) if options[:print_scaling] == :none
+
       @background = options[:background]
       @background_scale = options[:background_scale] || 1
       @font_size  = 12
@@ -200,16 +206,7 @@ module Prawn
       options[:size] = options.delete(:page_size)
       options[:layout] = options.delete(:page_layout)
 
-      if options[:template]
-        fresh_content_streams(options)
-        go_to_page(1)
-      else
-        if options[:skip_page_creation] || options[:template]
-          start_new_page(options.merge(:orphan => true))
-        else
-          start_new_page(options)
-        end
-      end
+      initialize_first_page(options)
 
       @bounding_box = @margin_box
 
@@ -232,6 +229,14 @@ module Prawn
       state.page
     end
 
+    def initialize_first_page(options)
+      if options[:skip_page_creation]
+        start_new_page(options.merge(:orphan => true))
+      else
+        start_new_page(options)
+      end
+    end
+
     # Creates and advances to a new page in the document.
     #
     # Page size, margins, and layout can also be set when generating a
@@ -242,14 +247,6 @@ module Prawn
     #   pdf.start_new_page(:left_margin => 50, :right_margin => 50)
     #   pdf.start_new_page(:margin => 100)
     #
-    # A template for a page can be specified by pointing to the path of and existing pdf.
-    # One can also specify which page of the template which defaults otherwise to 1.
-    #
-    #  pdf.start_new_page(:template => multipage_template.pdf, :template_page => 2)
-    #
-    # Note: templates get indexed by either the object_id of the filename or stream
-    # entered so that if you reuse the same template multiple times be sure to use the
-    # same instance for more efficient use of resources and smaller rendered pdfs.
     def start_new_page(options = {})
       if last_page = state.page
         last_page_size    = last_page.size
@@ -266,7 +263,6 @@ module Prawn
         new_graphic_state.color_space = {} if new_graphic_state
         page_options.merge!(:graphic_state => new_graphic_state)
       end
-      merge_template_options(page_options, options) if options[:template]
 
       state.page = PDF::Core::Page.new(self, page_options)
 
@@ -279,9 +275,7 @@ module Prawn
         @bounding_box = @margin_box
       end
 
-      state.page.new_content_stream if options[:template]
-      use_graphic_settings(options[:template])
-      forget_text_rendering_mode! if options[:template]
+      use_graphic_settings
 
       unless options[:orphan]
         state.insert_page(state.page, @page_number)
@@ -370,7 +364,7 @@ module Prawn
       render_trailer(output)
       if output.instance_of?(StringIO)
         str = output.string
-        str.force_encoding("ASCII-8BIT") if str.respond_to?(:force_encoding)
+        str.force_encoding(::Encoding::ASCII_8BIT)
         return str
       else
         return nil
@@ -382,8 +376,7 @@ module Prawn
     #   pdf.render_file "foo.pdf"
     #
     def render_file(filename)
-      Kernel.const_defined?("Encoding") ? mode = "wb:ASCII-8BIT" : mode = "wb"
-      File.open(filename,mode) { |f| render(f) }
+      File.open(filename, "wb") { |f| render(f) }
     end
 
     # The bounds method returns the current bounding box you are currently in,
@@ -652,13 +645,8 @@ module Prawn
 
     private
 
-    def merge_template_options(page_options, options)
-      object_id = state.store.import_page(options[:template], options[:template_page] || 1)
-      page_options.merge!(:object_id => object_id, :page_template => true)
-    end
-
     # setting override_settings to true ensures that a new graphic state does not end up using
-    # previous settings especially from imported template streams
+    # previous settings.
     def use_graphic_settings(override_settings = false)
       set_fill_color if current_fill_color != "000000" || override_settings
       set_stroke_color if current_stroke_color != "000000" || override_settings

data/lib/prawn/encoding.rb

@@ -108,8 +108,7 @@ module Prawn
       private
 
       def load_mapping
-        RUBY_VERSION >= "1.9" ? mode = "r:BINARY" : mode = "r"
-        File.open(@mapping_file, mode) do |f|
+        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

data/lib/prawn/font/afm.rb

@@ -6,8 +6,7 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require 'prawn/encoding'
-require 'afm'
+require_relative '../../prawn/encoding'
 
 module Prawn
   class Font
@@ -49,21 +48,23 @@ module Prawn
         file_name << ".afm" unless file_name =~ /\.afm$/
         file_name = file_name[0] == ?/ ? file_name : find_font(file_name)
 
-        font_data = @@font_data[file_name] ||= ::AFM::Font.new(file_name)
-        @glyph_table     = build_glyph_table(font_data)
-        @kern_pairs      = font_data.kern_pairs
-        @kern_pair_table = build_kern_pair_table(@kern_pairs)
-        @attributes      = font_data.metadata
+        font_data = @@font_data[file_name] ||= parse_afm(file_name)
+        @glyph_widths    = font_data[:glyph_widths]
+        @glyph_table     = font_data[:glyph_table]
+        @bounding_boxes  = font_data[:bounding_boxes]
+        @kern_pairs      = font_data[:kern_pairs]
+        @kern_pair_table = font_data[:kern_pair_table]
+        @attributes      = font_data[:attributes]
 
-        @ascender  = @attributes["Ascender"].to_i
-        @descender = @attributes["Descender"].to_i
+        @ascender  = @attributes["ascender"].to_i
+        @descender = @attributes["descender"].to_i
         @line_gap  = Float(bbox[3] - bbox[1]) - (@ascender - @descender)
       end
 
       # The font bbox, as an array of integers
       #
       def bbox
-        @bbox ||= @attributes['FontBBox'].split(/\s+/).map { |e| Integer(e) }
+        @bbox ||= @attributes['fontbbox'].split(/\s+/).map { |e| Integer(e) }
       end
 
       # NOTE: String *must* be encoded as WinAnsi
@@ -141,7 +142,7 @@ module Prawn
       end
 
       def symbolic?
-        attributes["CharacterSet"] == "Special"
+        attributes["characterset"] == "Special"
       end
 
       def find_font(file)
@@ -152,6 +153,61 @@ module Prawn
            self.class.metrics_path.join("\n")
       end
 
+      def parse_afm(file_name)
+        data    = {:glyph_widths => {}, :bounding_boxes => {}, :kern_pairs => {}, :attributes => {}}         
+        section = []
+
+        File.foreach(file_name) do |line|
+          case line
+          when /^Start(\w+)/
+            section.push $1
+            next
+          when /^End(\w+)/
+            section.pop
+            next
+          end
+
+          case section
+          when ["FontMetrics", "CharMetrics"]
+            next unless line =~ /^CH?\s/
+
+            name                        = line[/\bN\s+(\.?\w+)\s*;/, 1]
+            data[:glyph_widths][name]   = line[/\bWX\s+(\d+)\s*;/, 1].to_i
+            data[:bounding_boxes][name] = line[/\bB\s+([^;]+);/, 1].to_s.rstrip
+          when ["FontMetrics", "KernData", "KernPairs"]
+            next unless line =~ /^KPX\s+(\.?\w+)\s+(\.?\w+)\s+(-?\d+)/
+            data[:kern_pairs][[$1, $2]] = $3.to_i
+          when ["FontMetrics", "KernData", "TrackKern"],
+            ["FontMetrics", "Composites"]
+            next
+          else
+            parse_generic_afm_attribute(line, data)
+          end
+        end
+        
+        # process data parsed from AFM file to build tables which
+        #   will be used when measuring and kerning text
+        data[:glyph_table] = (0..255).map do |i|
+          data[:glyph_widths][Encoding::WinAnsi::CHARACTERS[i]].to_i
+        end
+
+        character_hash = Hash[Encoding::WinAnsi::CHARACTERS.zip((0..Encoding::WinAnsi::CHARACTERS.size).to_a)]
+        data[:kern_pair_table] = data[:kern_pairs].inject({}) do |h,p|
+          h[p[0].map { |n| character_hash[n] }] = p[1]
+          h
+        end
+
+        data.each_value { |hash| hash.freeze }
+        data.freeze
+      end
+
+      def parse_generic_afm_attribute(line, hash)
+        line =~ /(^\w+)\s+(.*)/
+        key, value = $1.to_s.downcase, $2
+
+        hash[:attributes][key] = hash[:attributes][key] ? Array(hash[:attributes][key]) << value : value
+      end
+
       # converts a string into an array with spacing offsets
       # bewteen characters that need to be kerned
       #
@@ -172,27 +228,12 @@ module Prawn
 
         kerned.map { |e|
           e = (Array === e ? e.pack("C*") : e)
-          e.respond_to?(:force_encoding) ? e.force_encoding("Windows-1252") : e
+          e.respond_to?(:force_encoding) ? e.force_encoding(::Encoding::Windows_1252) : e
         }
       end
-
-      def build_kern_pair_table(kern_pairs)
-        character_hash = Hash[Encoding::WinAnsi::CHARACTERS.zip((0..Encoding::WinAnsi::CHARACTERS.size).to_a)]
-        kern_pairs.inject({}) do |h,p|
-          h[
-            [character_hash[p[0]], character_hash[p[1]]]
-          ] = p[2]
-          h
-        end
-      end
-
-      def build_glyph_table(font_data)
-        (0..255).map do |char|
-          metrics = font_data.metrics_for(char)
-          metrics ? metrics[:wx] : 0
-        end
-      end
-
+      
+      private
+      
       def unscaled_width_of(string)
         string.bytes.inject(0) do |s,r|
           s + @glyph_table[r]

data/lib/prawn/font/dfont.rb

@@ -6,7 +6,7 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 #
-require 'prawn/font/ttf'
+require_relative 'ttf'
 
 module Prawn
   class Font

data/lib/prawn/font/ttf.rb

@@ -160,7 +160,15 @@ module Prawn
       end
 
       def normalize_encoding(text)
-        text.normalize_to_utf8
+        begin
+          text.encode(::Encoding::UTF_8)
+        rescue => e
+          puts e
+          raise Prawn::Errors::IncompatibleStringEncoding, "Encoding " +
+            "#{text.encoding} can not be transparently converted to UTF-8. " +
+            "Please ensure the encoding of the string you are attempting " +
+            "to use is set correctly"
+        end
       end
 
       def glyph_present?(char)
@@ -171,7 +179,7 @@ module Prawn
       # Returns the number of characters in +str+ (a UTF-8-encoded string).
       #
       def character_count(str)
-        str.unicode_length
+        str.length
       end
 
       private