prawn 1.2.1 → 1.3.0

data/lib/prawn/graphics/cap_style.rb

@@ -40,7 +40,7 @@ module Prawn
       end
 
       def write_stroke_cap_style
-        add_content "#{CAP_STYLES[current_cap_style]} J"
+        renderer.add_content "#{CAP_STYLES[current_cap_style]} J"
       end
     end
   end

data/lib/prawn/graphics/color.rb

@@ -151,7 +151,7 @@ module Prawn
           raise ArgumentError, "unknown type '#{type}'"
         end
 
-        add_content "/#{color_space} #{operator}"
+        renderer.add_content "/#{color_space} #{operator}"
       end
 
       def set_color(type, color, options = {})
@@ -166,7 +166,7 @@ module Prawn
 
         if options[:pattern]
           set_color_space type, :Pattern
-          add_content "/#{color} #{operator}"
+          renderer.add_content "/#{color} #{operator}"
         else
           set_color_space type, color_space(color)
           color = color_to_s(color)
@@ -223,7 +223,7 @@ module Prawn
       end
 
       def write_color(color, operator)
-        add_content "#{color} #{operator}"
+        renderer.add_content "#{color} #{operator}"
       end
 
     end

data/lib/prawn/graphics/dash.rb

@@ -80,7 +80,7 @@ module Prawn
       private
 
       def write_stroke_dash
-        add_content dash_setting
+        renderer.add_content dash_setting
       end
 
       def undashed_setting

data/lib/prawn/graphics/join_style.rb

@@ -42,7 +42,7 @@ module Prawn
 
 
       def write_stroke_join_style
-        add_content "#{JOIN_STYLES[current_join_style]} j"
+        renderer.add_content "#{JOIN_STYLES[current_join_style]} j"
       end
     end
   end

data/lib/prawn/graphics/patterns.rb

@@ -56,7 +56,7 @@ module Prawn
         end
 
         set_color_space type, :Pattern
-        add_content "/SP#{registry_key} #{operator}"
+        renderer.add_content "/SP#{registry_key} #{operator}"
       end
 
       def gradient_registry_key(gradient)

data/lib/prawn/graphics/transformation.rb

@@ -145,7 +145,7 @@ module Prawn
       def transformation_matrix(a, b, c, d, e, f)
         values = [a, b, c, d, e, f].map { |x| "%.5f" % x }.join(" ")
         save_graphics_state if block_given?
-        add_content "#{values} cm"
+        renderer.add_content "#{values} cm"
         if block_given?
           yield
           restore_graphics_state

data/lib/prawn/graphics/transparency.rb

@@ -54,13 +54,13 @@ module Prawn
       #   end
       #
       def transparent(opacity, stroke_opacity=opacity, &block)
-        min_version(1.4)
+        renderer.min_version(1.4)
 
         opacity        = [[opacity, 0.0].max, 1.0].min
         stroke_opacity = [[stroke_opacity, 0.0].max, 1.0].min
 
         save_graphics_state
-        add_content "/#{opacity_dictionary_name(opacity, stroke_opacity)} gs"
+        renderer.add_content "/#{opacity_dictionary_name(opacity, stroke_opacity)} gs"
         yield
         restore_graphics_state
       end

data/lib/prawn/grid.rb

@@ -28,7 +28,7 @@ module Prawn
     # or work with the grid system directly.
     #
     #   @pdf.grid                 # Get the Grid directly
-    #   @pdf.grid([0,1])          # Get the box at [0,1]
+    #   @pdf.grid([0,1])          # Get the GridBox at [0,1]
     #   @pdf.grid([0,1], [1,2])   # Get a multi-box spanning from [0,1] to [1,2]
     #
     def grid(*args)
@@ -49,7 +49,7 @@ module Prawn
     # A Grid represents the entire grid system of a Page and calculates
     # the column width and row height of the base box.
     #
-    # @private
+    # @group Experimental API
     class Grid
       attr_reader :pdf, :columns, :rows, :gutter, :row_gutter, :column_gutter
       def initialize(pdf, options = {}) # :nodoc:
@@ -103,7 +103,7 @@ module Prawn
     # A Grid object has methods that allow easy access to the coordinates of
     # its corners, which can be plugged into most existing prawnmethods.
     #
-    # @private
+    # @group Experimental API
     class GridBox
       attr_reader :pdf
 
@@ -206,8 +206,8 @@ module Prawn
 
     # A MultiBox is specified by 2 Boxes and spans the areas between.
     #
-    # @private
-    class MultiBox < GridBox #:nodoc:
+    # @group Experimental API
+    class MultiBox < GridBox
       def initialize(pdf, b1, b2)
         @pdf = pdf
         @bs = [b1, b2]

data/lib/prawn/images.rb

@@ -89,7 +89,7 @@ module Prawn
         info = Prawn.image_handler.find(image_content).new(image_content)
 
         # Bump PDF version if the image requires it
-        min_version(info.min_pdf_version) if info.respond_to?(:min_pdf_version)
+        renderer.min_version(info.min_pdf_version) if info.respond_to?(:min_pdf_version)
 
         # Add the image to the PDF and register it in case we see it again.
         image_obj = info.build_pdf_object(self)
@@ -123,7 +123,7 @@ module Prawn
 
       # add the image to the current page
       instruct = "\nq\n%.3f 0 0 %.3f %.3f %.3f cm\n/%s Do\nQ"
-      add_content instruct % [ w, h, x, y - h, label ]
+      renderer.add_content instruct % [ w, h, x, y - h, label ]
     end
 
     private

data/lib/prawn/security.rb

@@ -10,7 +10,7 @@ require 'digest/md5'
 
 require 'pdf/core/byte_string'
 
-require 'prawn/security/arcfour'
+require_relative 'security/arcfour'
 
 module Prawn
   class Document

data/lib/prawn/soft_mask.rb

@@ -29,7 +29,7 @@ module Prawn
     # @group Stable API
 
     def soft_mask(&block)
-      min_version(1.4)
+      renderer.min_version(1.4)
 
       group_attrs = ref!({
         :Type => :Group,
@@ -73,7 +73,7 @@ module Prawn
       }.hash
 
       if soft_mask_registry[registry_key]
-        add_content "/#{soft_mask_registry[registry_key]} gs"
+        renderer.add_content "/#{soft_mask_registry[registry_key]} gs"
       else
         masks = page.resources[:ExtGState] ||= {}
         id = masks.empty? ? 'GS1' : masks.keys.sort.last.succ
@@ -81,7 +81,7 @@ module Prawn
 
         soft_mask_registry[registry_key] = id
 
-        add_content "/#{id} gs"
+        renderer.add_content "/#{id} gs"
       end
     end
 

data/lib/prawn/stamp.rb

@@ -44,7 +44,7 @@ module Prawn
     #
     def stamp(name)
       dictionary_name, dictionary = stamp_dictionary(name)
-      add_content "/#{dictionary_name} Do"
+      renderer.add_content "/#{dictionary_name} Do"
       state.page.xobjects.merge!(dictionary_name => dictionary)
     end
 

data/lib/prawn/text.rb

@@ -288,6 +288,14 @@ module Prawn
       end
     end
 
+    # Low level text placement method. All font and size alterations
+    # should already be set
+    #
+    def draw_text!(text, options)
+      x,y = map_to_absolute(options[:at])
+      add_text_content(text,x,y,options)
+    end
+
     # Gets height of text in PDF points.
     # Same options as #text, except as noted.
     # Not compatible with :indent_paragraphs option

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

@@ -209,9 +209,19 @@ module Prawn
 
         def process_text(text)
           string = strip_zero_width_spaces(text)
+
           if exclude_trailing_white_space?
-            string = process_soft_hyphens(string.rstrip)
+            string = string.rstrip
+
+            if soft_hyphens_need_processing?(string)
+              string = process_soft_hyphens(string[0..-2]) + string[-1..-1]
+            end
+          else
+            if soft_hyphens_need_processing?(string)
+              string = process_soft_hyphens(string)
+            end
           end
+
           case direction
           when :rtl
             string.reverse
@@ -224,19 +234,20 @@ module Prawn
           @format_state[:exclude_trailing_white_space]
         end
 
+        def soft_hyphens_need_processing?(string)
+          string.length > 0 && normalized_soft_hyphen
+        end
+
         def normalized_soft_hyphen
           @format_state[:normalized_soft_hyphen]
         end
 
         def process_soft_hyphens(string)
-          if string.length > 0 && normalized_soft_hyphen
-            if string.encoding != normalized_soft_hyphen.encoding
-              string.force_encoding(normalized_soft_hyphen.encoding)
-            end
-            string[0..-2].gsub(normalized_soft_hyphen, "") + string[-1..-1]
-          else
-            string
+          if string.encoding != normalized_soft_hyphen.encoding
+            string.force_encoding(normalized_soft_hyphen.encoding)
           end
+
+          string.gsub(normalized_soft_hyphen, "")
         end
 
         def strip_zero_width_spaces(string)

data/lib/prawn/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Prawn
+  VERSION = "1.3.0"
+end

data/lib/prawn/view.rb

@@ -0,0 +1,91 @@
+# encoding: UTF-8
+#
+# prawn/view.rb : Implements a mixin for Prawn's DSL
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  # This mixin allows you to create modular Prawn code without the
+  # need to create subclasses of Prawn::Document.
+  #
+  #     class Greeter
+  #       include Prawn::View
+  #
+  #       def initialize(name)
+  #         @name = name
+  #       end
+  #
+  #       def say_hello
+  #         text "Hello, #{@name}!"
+  #       end
+  #
+  #       def say_goodbye
+  #         font("Courier") do
+  #           text "Goodbye, #{@name}!"
+  #         end
+  #       end
+  #    end
+  #
+  #    greeter = Greeter.new("Gregory")
+  #
+  #    greeter.say_hello
+  #    greeter.say_goodbye
+  #
+  #    greeter.save_as("greetings.pdf")
+  #
+  # The short story about why you should use this mixin rather than
+  # creating subclasses of +Prawn::Document+ is that it helps
+  # prevent accidental conflicts between your code and Prawn's
+  # code.
+  #
+  # Here's the slightly longer story...
+  #
+  # By using composition rather than inheritance under the hood, this
+  # mixin allows you to keep your state separate from +Prawn::Document+'s
+  # state, and also will prevent unexpected method name collisions due
+  # to late binding effects.
+  #
+  # This mixin is mostly meant for extending Prawn's functionality
+  # with your own additions, but you can also use it to replace or
+  # wrap existing Prawn methods. Calling +super+ will still work
+  # as expected, and alternatively you can explictly call
+  # +document.some_method+ to delegate to Prawn where needed.
+  module View
+    # @group Experimental API
+
+    # Lazily instantiates a +Prawn::Document+ object.
+    #
+    # You can also redefine this method in your own classes to use
+    # a custom document class.
+    def document
+      @document ||= Prawn::Document.new
+    end
+
+    # Delegates all unhandled calls to object returned by +document+ method.
+    # (which is an instance of Prawn::Document by default)
+    def method_missing(m, *a, &b)
+      return super unless document.respond_to?(m)
+
+      document.send(m, *a, &b)
+    end
+
+    # Syntactic sugar that uses +instance_eval+ under the hood to provide
+    # a block-based DSL.
+    #
+    #    greeter.update do
+    #      say_hello
+    #      say_goodbye
+    #    end
+    #
+    def update(&b)
+      instance_eval(&b)
+    end
+
+    # Syntatic sugar that calls +document.render_file+ under the hood.
+    #
+    #    greeter.save_as("greetings.pdf")
+    def save_as(filename)
+      document.render_file(filename)
+    end
+  end
+end

data/manual/basic_concepts/basic_concepts.rb

@@ -15,6 +15,7 @@ Prawn::ManualBuilder::Example.generate("basic_concepts.pdf", :page_size => "FOLI
     p.example "other_cursor_helpers"
     p.example "adding_pages"
     p.example "measurement"
+    p.example "view", :eval_source => false, :full_source => true
 
     p.intro do
       prose("This chapter covers the minimum amount of functionality you'll need to start using Prawn.
@@ -27,7 +28,8 @@ Prawn::ManualBuilder::Example.generate("basic_concepts.pdf", :page_size => "FOLI
             "Where the origin for the document coordinates is. What are Bounding Boxes and how they interact with the origin",
             "How the cursor behaves",
             "How to start new pages",
-            "What the base unit for measurement and coordinates is and how to use other convenient measures"
+            "What the base unit for measurement and coordinates is and how to use other convenient measures",
+            "How to build custom view objects that use Prawn's DSL"
           )
     end
   end

data/manual/basic_concepts/view.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+#
+# To create a custom class that extends Prawn's functionality,
+# use the <code>Prawn::View</code> mixin. This approach is safer than creating
+# subclasses of <code>Prawn::Document</code> while being just as convenient.
+#
+# By using this mixin, your state will be kept completely separate
+# from <code>Prawn::Document</code>'s state, and you will avoid accidental method
+# collisions within <code>Prawn::Document</code>.
+#
+# To build custom classes that make use of other custom classes,
+# you can define a method named <code>document()</code> that returns
+# any object that acts similar to a <code>Prawn::Document</code>
+# object. <code>Prawn::View</code> will then direct all delegated
+# calls to that object instead.
+
+require_relative "../example_helper"
+
+class Greeter
+  include Prawn::View
+
+  def initialize(name)
+    @name = name
+  end
+
+  def say_hello
+    text "Hello, #{@name}!"
+  end
+
+  def say_goodbye
+    font("Courier") do
+      text "Goodbye, #{@name}!"
+    end
+  end
+ end
+
+greeter = Greeter.new("Gregory")
+
+greeter.say_hello
+greeter.say_goodbye
+
+greeter.save_as("greetings.pdf")

data/prawn.gemspec

@@ -1,6 +1,10 @@
+basedir = File.expand_path(File.dirname(__FILE__))
+
+require "#{basedir}/lib/prawn/version"
+
 Gem::Specification.new do |spec|
   spec.name = "prawn"
-  spec.version = File.read(File.expand_path('VERSION', File.dirname(__FILE__))).strip
+  spec.version = Prawn::VERSION
   spec.platform = Gem::Platform::RUBY
   spec.summary = "A fast and nimble PDF generator for Ruby"
   spec.files =  Dir.glob("{examples,lib,spec,manual}/**/**/*") +
@@ -9,7 +13,7 @@ Gem::Specification.new do |spec|
                 ["data/shift_jis_text.txt"] +
                 ["Rakefile", "prawn.gemspec", "Gemfile",
                  "COPYING", "LICENSE", "GPLv2", "GPLv3",
-                 "VERSION", ".yardopts"]
+                 ".yardopts"]
   spec.require_path = "lib"
   spec.required_ruby_version = '>= 1.9.3'
   spec.required_rubygems_version = ">= 1.3.6"
@@ -20,8 +24,8 @@ Gem::Specification.new do |spec|
   spec.rubyforge_project = "prawn"
   spec.licenses = ['RUBY', 'GPL-2', 'GPL-3']
 
-  spec.add_dependency('ttfunk', '~> 1.2.0')
-  spec.add_dependency('pdf-core', "~> 0.2.5")
+  spec.add_dependency('ttfunk', '~> 1.4.0')
+  spec.add_dependency('pdf-core', "~> 0.4.0")
 
   spec.add_development_dependency('pdf-inspector', '~> 1.1.0')
   spec.add_development_dependency('yard')
@@ -32,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('prawn-manual_builder', ">= 0.2.0")
   spec.add_development_dependency('pdf-reader', '~>1.2')
   spec.add_development_dependency('rubocop', '0.20.1')
+  spec.add_development_dependency('code_statistics', '0.2.13')
 
   spec.homepage = "http://prawn.majesticseacreature.com"
   spec.description = <<END_DESC