prawn 0.12.0 → 0.13.0

data/lib/pdf/core/stream.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+# prawn/core/stream.rb : Implements Stream objects
+#
+# Copyright February 2013, Alexander Mankuta.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module PDF
+  module Core
+    class Stream
+      attr_reader :filters
+
+      def initialize(io = nil)
+        @filtered_stream = ''
+        @stream = io
+        @filters = FilterList.new
+      end
+
+      def <<(io)
+        (@stream ||= '') << io
+        @filtered_stream = nil
+        self
+      end
+
+      def compress!
+        unless @filters.names.include? :FlateDecode
+          @filtered_stream = nil
+          @filters << :FlateDecode
+        end
+      end
+
+      def compressed?
+        @filters.names.include? :FlateDecode
+      end
+
+      def empty?
+        @stream.nil?
+      end
+
+      def filtered_stream
+        if @stream
+          if @filtered_stream.nil?
+            @filtered_stream = @stream.dup
+
+            @filters.each do |(filter_name, params)|
+              if filter = PDF::Core::Filters.const_get(filter_name)
+                @filtered_stream = filter.encode @filtered_stream, params
+              end
+            end
+          end
+
+          @filtered_stream
+          # XXX Fillter stream
+        else
+          nil
+        end
+      end
+
+      def length
+        @stream.length
+      end
+
+      def object
+        if filtered_stream
+          "stream\n#{filtered_stream}\nendstream\n"
+        else
+          ''
+        end
+      end
+
+      def data
+        if @stream
+          filter_names = @filters.names
+          filter_params = @filters.decode_params
+
+          d = {
+            :Length => filtered_stream.length
+          }
+          if filter_names.any?
+            d[:Filter] = filter_names
+          end
+          if filter_params.any? {|f| !f.nil? }
+            d[:DecodeParms] = filter_params
+          end
+
+          d
+        else
+          {}
+        end
+      end
+
+      def inspect
+        "#<#{self.class.name}:0x#{'%014x' % object_id} @stream=#{@stream.inspect}, @filters=#{@filters.inspect}>"
+      end
+    end
+  end
+end

data/lib/{prawn → pdf}/core/text.rb

@@ -6,7 +6,7 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-module Prawn
+module PDF
   module Core
     module Text #:nodoc:
 
@@ -49,7 +49,7 @@ module Prawn
       # Defaults to true
       #
       def default_kerning?
-        return true if @default_kerning.nil?
+        return true if !defined?(@default_kerning)
         @default_kerning
       end
 
@@ -81,8 +81,7 @@ module Prawn
       #
       def default_leading(number=nil)
         if number.nil?
-          return 0 if @default_leading.nil?
-          @default_leading
+          defined?(@default_leading) && @default_leading || 0
         else
           @default_leading = number
         end
@@ -112,8 +111,7 @@ module Prawn
       #
       def text_direction(direction=nil)
         if direction.nil?
-          return :ltr if @text_direction.nil?
-          @text_direction
+          defined?(@text_direction) && @text_direction || :ltr
         else
           @text_direction = direction
         end
@@ -131,11 +129,11 @@ module Prawn
       #
       # Call with an empty array to turn off fallback fonts
       #
-      # file = "#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf"
+      # file = "#{Prawn::DATADIR}/fonts/gkai00mp.ttf"
       # font_families["Kai"] = {
       #   :normal => { :file => file, :font => "Kai" }
       # }
-      # file = "#{Prawn::BASEDIR}/data/fonts/Action Man.dfont"
+      # file = "#{Prawn::DATADIR}/fonts/Action Man.dfont"
       # font_families["Action Man"] = {
       #   :normal      => { :file => file, :font => "ActionMan" },
       # }
@@ -155,8 +153,7 @@ module Prawn
       #
       def fallback_fonts(fallback_fonts=nil)
         if fallback_fonts.nil?
-          return [] if @fallback_fonts.nil?
-          @fallback_fonts
+          defined?(@fallback_fonts) && @fallback_fonts || []
         else
           @fallback_fonts = fallback_fonts
         end
@@ -184,12 +181,19 @@ module Prawn
       # * :fill_stroke_clip - fill then stroke text, then add to path for clipping
       # * :clip             - add text to path for clipping
       #
+      # There's the special mode :unknown which only occurs when we're working
+      # with templates.  If left in :unknown, the first text command will force
+      # an assertion to :fill.
       def text_rendering_mode(mode=nil)
-        return @text_rendering_mode || :fill if mode.nil?
-        unless MODES.keys.include?(mode)
+        return (defined?(@text_rendering_mode) && @text_rendering_mode || :fill) if mode.nil?
+        unless MODES.key?(mode)
           raise ArgumentError, "mode must be between one of #{MODES.keys.join(', ')} (#{mode})"
         end
-        original_mode = text_rendering_mode
+        original_mode = self.text_rendering_mode
+        if original_mode == :unknown
+          original_mode = :fill
+          add_content "\n#{MODES[:fill]} Tr"
+        end
         if original_mode == mode
           yield
         else
@@ -201,12 +205,16 @@ module Prawn
         end
       end
 
+      def forget_text_rendering_mode!
+        @text_rendering_mode = :unknown
+      end
+
       # Increases or decreases the space between characters.
       # For horizontal text, a positive value will increase the space.
       # For veritical text, a positive value will decrease the space.
       #
       def character_spacing(amount=nil)
-        return @character_spacing || 0 if amount.nil?
+        return defined?(@character_spacing) && @character_spacing || 0 if amount.nil?
         original_character_spacing = character_spacing
         if original_character_spacing == amount
           yield
@@ -224,7 +232,7 @@ module Prawn
       # For veritical text, a positive value will decrease the space.
       #
       def word_spacing(amount=nil)
-        return @word_spacing || 0 if amount.nil?
+        return defined?(@word_spacing) && @word_spacing || 0 if amount.nil?
         original_word_spacing = word_spacing
         if original_word_spacing == amount
           yield
@@ -257,12 +265,11 @@ module Prawn
           add_content "/#{font.identifier_for(subset)} #{font_size} Tf"
 
           operation = options[:kerning] && string.is_a?(Array) ? "TJ" : "Tj"
-          add_content Prawn::Core::PdfObject(string, true) << " " << operation
+          add_content PDF::Core::PdfObject(string, true) << " " << operation
         end
 
         add_content "ET\n"
       end
     end
-
   end
 end

data/lib/prawn.rb

@@ -4,23 +4,101 @@
 # Those looking to contribute code or write extensions should look
 # into the lib/prawn/core/* source tree.
 #
-module Prawn #:nodoc:
-  VERSION = "0.12.0"
+%w[ttfunk/lib].each do |dep|
+  $LOAD_PATH.unshift(File.dirname(__FILE__) + "/../../vendor/#{dep}")
 end
 
-require "prawn/core"
-require "prawn/text"
-require "prawn/graphics"
-require "prawn/images"
-require "prawn/images/jpg"
-require "prawn/images/png"
-require "prawn/stamp"
-require "prawn/security"
-require "prawn/document"
-require "prawn/font"
-require "prawn/encoding"
-require "prawn/measurements"
-require "prawn/repeater"
-require "prawn/outline"
-require "prawn/layout"
+begin
+  require 'ttfunk'
+rescue LoadError
+  puts "Failed to load ttfunk. If you are running Prawn from git:"
+  puts "  git submodule init"
+  puts "  git submodule update"
+  exit
+end
+
+require "set"
+
+module Prawn
+  VERSION = "0.13.0"
+
+  extend self
+
+  file = __FILE__
+  file = File.readlink(file) if File.symlink?(file)
+  dir  = File.dirname(file)
+
+  # The base source directory for Prawn as installed on the system
+  #
+  #
+  BASEDIR = File.expand_path(File.join(dir, '..'))
+  DATADIR = File.expand_path(File.join(dir, '..', 'data'))
+
+  # Whe set to true, Prawn will verify hash options to ensure only valid keys
+  # are used.  Off by default.
+  #
+  # Example:
+  #   >> Prawn::Document.new(:tomato => "Juicy")
+  #   Prawn::Errors::UnknownOption:
+  #   Detected unknown option(s): [:tomato]
+  #   Accepted options are: [:page_size, :page_layout, :left_margin, ...]
+  #
+  attr_accessor :debug
+
+  def verify_options(accepted, actual) #:nodoc:
+    return unless debug || $DEBUG
+    unless (act=Set[*actual.keys]).subset?(acc=Set[*accepted])
+      raise Prawn::Errors::UnknownOption,
+        "\nDetected unknown option(s): #{(act - acc).to_a.inspect}\n" <<
+        "Accepted options are: #{accepted.inspect}"
+    end
+    yield if block_given?
+  end
+
+  module Configurable #:nodoc:
+    def configuration(*args)
+      @config ||= Marshal.load(Marshal.dump(default_configuration))
+      if Hash === args[0]
+        @config.update(args[0])
+      elsif args.length > 1
+        @config.values_at(*args)
+      elsif args.length == 1
+        @config[args[0]]
+      else
+        @config
+      end
+    end
+
+    alias_method :C, :configuration
+  end
+end
+
+require_relative "prawn/compatibility"
+require_relative "prawn/errors"
+
+require_relative "pdf/core"
+
+require_relative "prawn/utilities"
+require_relative "prawn/text"
+require_relative "prawn/graphics"
+require_relative "prawn/images"
+require_relative "prawn/images/image"
+require_relative "prawn/images/jpg"
+require_relative "prawn/images/png"
+require_relative "prawn/stamp"
+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"
+require_relative "prawn/layout"
+
+require_relative "prawn/image_handler"
+
+
 
+Prawn.image_handler.register(Prawn::Images::PNG)
+Prawn.image_handler.register(Prawn::Images::JPG)

data/lib/prawn/compatibility.rb

@@ -1,51 +1,91 @@
 # coding: utf-8
 #
-# Why would we ever use Ruby 1.8.7 when we can backport with something
-# as simple as this?
-#
+# Compatibility layer to smooth over differences between Ruby implementations
+# The oldest version of Ruby which is supported is MRI 1.8.7
+# Ideally, all version-specific or implementation-specific code should be
+#   kept in this file (but that ideal has not been attained yet)
+
 class String  #:nodoc:
   def first_line
     self.each_line { |line| return line }
   end
-  unless "".respond_to?(:lines)
-    alias_method :lines, :to_a
+
+  unless "".respond_to?(:codepoints)
+    def codepoints(&block)
+      if block_given?
+        unpack("U*").each(&block)
+      else
+        unpack("U*")
+      end
+    end
+
+    def each_codepoint(&block)
+      unpack("U*").each(&block)
+    end
   end
-  unless "".respond_to?(:each_char)
-    def each_char #:nodoc:
-      # copied from jcode
+
+  if "".respond_to?(:encode)
+    def normalize_to_utf8
+      begin
+        encode(Encoding::UTF_8)
+      rescue
+        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
+    alias :unicode_characters :each_char
+    alias :unicode_length     :length
+
+  else
+    def normalize_to_utf8
+      begin
+        # use unpack as a hackish way to verify the string is valid utf-8
+        unpack("U*")
+        return dup
+      rescue
+        raise Prawn::Errors::IncompatibleStringEncoding, "The string you " +
+        "are attempting to render is not encoded in valid UTF-8."
+      end
+    end
+    def unicode_characters
       if block_given?
-        scan(/./m) { |x| yield x }
+        unpack("U*").each { |c| yield [c].pack("U") }
       else
-        scan(/./m)
+        unpack("U*").map { |c| [c].pack("U") }
       end
     end
+    def unicode_length
+      unpack("U*").length
+    end
   end
 end
 
-unless File.respond_to?(:binread) 
+unless File.respond_to?(:binread)
   def File.binread(file) #:nodoc:
-    File.open(file,"rb") { |f| f.read } 
+    File.open(file,"rb") { |f| f.read }
   end
 end
 
 if RUBY_VERSION < "1.9"
-  
-  def ruby_18  #:nodoc:  
+
+  def ruby_18  #:nodoc:
     yield
   end
-  
-  def ruby_19  #:nodoc:  
+
+  def ruby_19  #:nodoc:
     false
   end
-     
-else  
- 
-  def ruby_18  #:nodoc:  
-    false  
+
+else
+
+  def ruby_18  #:nodoc:
+    false
   end
-  
-  def ruby_19  #:nodoc:  
+
+  def ruby_19  #:nodoc:
     yield
-  end 
-  
-end 
+  end
+
+end