prawn-format 0.1.0

data/examples/document.rb

@@ -0,0 +1,61 @@
+#coding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require "prawn"
+require "prawn/format"
+
+Prawn::Document.generate("document.pdf") do
+  tags :h1 => { :font_size => "2em", :font_weight => :bold },
+       :h2 => { :font_size => "1.5em", :font_weight => :bold },
+       :stave => { :display => :break, :meta => { :name => :anchor }, :font_weight => :bold, :font_size => "2em" },
+       :title => { :font_weight => :bold, :font_size => "1.5em" },
+       :indent => { :width => "2em" }
+
+  font "Times-Roman", :size => 14
+  File.open("#{File.dirname(__FILE__)}/christmas-carol.txt") do |story|
+    line_number = 0
+    story.each_line do |line|
+      line_number += 1
+      next if line.strip == ""
+
+      type, data = line.match(/^(\w+)\.\s*(.*)/)[1,2]
+
+      case type
+      when "h1"
+        move_text_position 144
+        text "<h1>#{data}</h1>", :align => :center
+        move_text_position 72
+        
+      when "h2"
+        text "<h2>#{data}</h2>", :align => :center
+        move_text_position 72
+        
+      when "toc"
+        bounding_box [bounds.left+bounds.width/4, y-bounds.absolute_bottom], :width => bounds.width do
+          text(data)
+        end
+
+      when "stave"
+        start_new_page
+        text(data, :align => :center)
+        move_text_position 72
+
+      when "p"
+        text("<indent/>" + data, :align => :justify)
+
+      when "song"
+        move_text_position font_size/2
+        text(data, :align => :center)
+        move_text_position font_size/2
+
+      when "block"
+        text(data, :align => :justify)
+
+      when "stop"
+        break
+
+      else raise "unknown block type #{type.inspect} (line \##{line_number})"
+      end
+    end
+  end
+end

data/examples/flowing.rb

@@ -0,0 +1,24 @@
+#coding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'prawn'
+require 'prawn/format'
+
+dice = "#{Prawn::BASEDIR}/data/images/dice.png"
+Prawn::Document.generate "flowing.pdf" do
+  # first, position an image that we'll flow around
+  width = bounds.width / 2 - 18 # give us some padding on the left of the image
+  info = image(dice, :width => width, :position => :right)
+
+  # create the layout helper that we'll use to flow the text
+  layout(DATA.read, :align => :justify) do |helper|
+    # fill the first box
+    y = helper.fill(bounds.left, bounds.top, width, :height => info.scaled_height + font_size - 1)
+
+    # fill the rest
+    self.y = helper.fill(bounds.left, y, bounds.width)
+  end
+end
+
+__END__
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse ut neque. Maecenas scelerisque euismod purus. Nam venenatis. Sed velit mauris, cursus sit amet, semper vitae, sagittis quis, tortor. Nam at nisi. Sed ac nibh. Curabitur auctor ipsum nec tellus. Suspendisse potenti. Morbi dapibus magna a velit. Ut fringilla enim eu enim. Quisque lacinia, arcu dignissim gravida semper, eros quam tempor nisi, non scelerisque massa odio ut mi. Nullam ac ipsum. Proin volutpat tristique sem. Sed ipsum felis, volutpat vel, porttitor id, volutpat eu, mauris. Cras eget nulla sit amet dolor cursus semper. Curabitur nulla nunc, accumsan sit amet, vestibulum sit amet, adipiscing in, lorem. Pellentesque sodales purus sit amet odio. Cras commodo. Nam accumsan. Suspendisse potenti. Fusce posuere neque in nulla. Ut cursus blandit nisl. Phasellus ut nulla quis nunc tempus consequat. In hac habitasse platea dictumst. Praesent molestie nisl nec erat. Vivamus pretium nibh sit amet est. Integer dolor. Sed dictum blandit purus. Quisque et mauris vel diam dictum dignissim. Maecenas ultrices. Cras leo risus, tristique quis, hendrerit eu, condimentum tempor, mi. Nullam consectetur ante non nisl. Nulla dignissim sem in turpis. Cras purus felis, molestie ac, rhoncus sed, suscipit et, nisl. Donec tempus justo eu turpis. Aenean quis diam at dolor interdum tempor. Mauris sed nulla vitae erat lobortis lacinia. Nunc mauris. Aliquam mattis egestas ligula. Morbi magna dolor, convallis id, interdum lacinia, pellentesque eu, velit. In non arcu. Duis a nibh. Vestibulum volutpat erat et magna. Vivamus mi ante, aliquam et, vulputate sit amet, pretium non, ligula. Curabitur elementum, nisl ut gravida placerat, nisl sapien posuere augue, a placerat urna enim in velit. Cras nisi. Suspendisse volutpat. Ut eu lorem sed eros sollicitudin volutpat. Quisque blandit, libero sed mattis scelerisque, elit turpis ultricies purus, quis faucibus orci erat quis sem. Vestibulum imperdiet facilisis ante. Mauris dignissim, arcu vitae tincidunt congue, ante nulla aliquam purus, a porta tellus nisl at lectus. Phasellus commodo lacus et tortor. Etiam tortor leo, scelerisque sit amet, lobortis non, gravida vitae, mi. Donec eget augue. Sed ultrices ipsum eget risus. Aliquam rhoncus arcu vitae orci pellentesque pulvinar. Praesent ornare, lacus eget elementum ultrices, massa justo dignissim massa, a suscipit elit nibh quis arcu. Aliquam non massa. Etiam pharetra nisi at risus. Donec felis turpis, suscipit a, luctus vulputate, lobortis id, neque. Proin vitae nibh. Pellentesque nibh risus, volutpat sollicitudin, lobortis vitae, malesuada eu, elit. Duis felis nulla, sagittis id, faucibus luctus, viverra id, eros. Phasellus vulputate leo eget libero. Ut ut ipsum ac dui accumsan placerat. Integer porttitor. Quisque gravida dolor eu diam. Phasellus sodales sem sit amet urna. Morbi ornare viverra mauris. 

data/examples/style-classes.rb

@@ -0,0 +1,12 @@
+#coding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'prawn'
+require 'prawn/format'
+
+Prawn::Document.generate "style-classes.pdf" do
+  styles :quote => { :font_style => :italic },
+         :product => { :font_weight => :bold, :color => "#007" }
+
+  text "<span class='product'>Prawn</span> is a fantastic utility for formatting PDF's. Jamis Buck may once have said, speaking of <span class='product'>Prawn</span>, <span class='quote'>\"<span class='product'>Prawn</span> is <em>the</em> single most fantastic PDF creation library ever to be written. In Ruby. In 2008. By Greg Brown.\"</span>"
+end

data/examples/syntax-highlighting.rb

@@ -0,0 +1,31 @@
+#coding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'prawn'
+require 'prawn/format'
+
+begin
+  require 'coderay'
+rescue LoadError
+  abort "This example (#{__FILE__}) requires the 'coderay' gem.\n" +
+    "Please make sure it is installed."
+end
+
+# Use CodeRay to parse the source and return HTML
+html = CodeRay.scan(File.read(__FILE__), :ruby).html(:line_numbers => :inline)
+
+# Use prawn and prawn/format to parse and format the HTML
+Prawn::Document.generate "syntax-highlighting.pdf", :page_layout => :landscape do
+  styles :no  => { :color => "gray" },
+         :c   => { :color => "#666" },
+         :s   => { :color => "#d20" },
+         :dl  => { :color => "black" },
+         :co  => { :color => "#036", :font_weight => :bold },
+         :pc  => { :color => "#038", :font_weight => :bold },
+         :sy  => { :color => "#A60" },
+         :r   => { :color => "#080" },
+         :i   => { :color => "#00D", :font_weight => :bold },
+         :idl => { :color => "#888", :font_weight => :bold }
+
+  text "<pre>#{html}</pre>"
+end

data/examples/tags.rb

@@ -0,0 +1,24 @@
+#coding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'prawn'
+require 'prawn/format'
+
+CHINESE_FONT = "#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf"
+
+Prawn::Document.generate "tags.pdf" do
+  # tweak an existing tag
+  tags[:em][:color] = "red"
+  
+  # completely redefine an existing tag
+  tags[:strong] = { :text_decoration => :underline }
+
+  # define altogether new tags
+  tags :chinese => { :font_family => CHINESE_FONT },
+       :exp     => { :vertical_align => :super, :font_size => "70%", :color => "blue", :font_weight => :bold },
+       :header  => { :font_weight => :bold, :font_size => 24, :text_decoration => :underline }
+
+  text "<header>Fun with Tags</header>"
+
+  text "<em>Emphasized text</em>, <strong>strong text</strong>, <chinese>汉语</chinese>, and <code>E = mc<exp>2</exp></code>"
+end

data/lib/prawn/format.rb

@@ -0,0 +1,211 @@
+# encoding: utf-8
+
+require 'prawn/format/layout_builder'
+require 'prawn/format/text_object'
+
+module Prawn
+  module Format
+    def self.included(mod)
+      mod.send :alias_method, :text_without_formatting, :text
+      mod.send :alias_method, :text, :text_with_formatting
+
+      mod.send :alias_method, :height_of_without_formatting, :height_of
+      mod.send :alias_method, :height_of, :height_of_with_formatting
+    end
+
+    # Overloaded version of #text. Call via #text, rather than #text_with_formatting
+    # (see above, where it aliased to #text).
+    def text_with_formatting(text, options={}) #:nodoc:
+      if unformatted?(text, options)
+        text_without_formatting(text, options)
+      else
+        format(text, options)
+      end
+    end
+
+    # Overloaded version of #height_of. Call via #height_of, rather than
+    # #height_of_with_formatting (see above, where it aliased to #height_of).
+    def height_of_with_formatting(string, line_width, size=font_size, options={}) #:nodoc:
+      if unformatted?(string, options)
+        height_of_without_formatting(string, line_width, size)
+      else
+        formatted_height(string, line_width, size, options)
+      end
+    end
+
+    DEFAULT_TAGS = {
+      :a      => { :meta => { :name => :anchor, :href => :target }, :color => "0000ff", :text_decoration => :underline },
+      :b      => { :font_weight => :bold },
+      :br     => { :display => :break },
+      :code   => { :font_family => "Courier", :font_size => "90%" },
+      :em     => { :font_style => :italic },
+      :font   => { :meta => { :face => :font_family, :color => :color, :size => :font_size } },
+      :i      => { :font_style => :italic },
+      :pre    => { :white_space => :pre, :font_family => "Courier", :font_size => "90%" },
+      :span   => {},
+      :strong => { :font_weight => :bold },
+      :sub    => { :vertical_align => :sub, :font_size => "70%" },
+      :sup    => { :vertical_align => :super, :font_size => "70%" },
+      :tt     => { :font_family => "Courier" },
+      :u      => { :text_decoration => :underline },
+    }.freeze
+
+    def tags(update={})
+      @tags ||= DEFAULT_TAGS.dup
+      @tags.update(update)
+    end
+
+    def styles(update={})
+      @styles ||= {}
+      @styles.update(update)
+    end
+
+    def default_style
+      { :font_family => font.family || font.name,
+        :font_size   => font_size,
+        :color       => fill_color }
+    end
+
+    def evaluate_measure(measure, options={})
+      case measure
+      when nil then nil
+      when Numeric then return measure
+      when Symbol then
+        mappings = options[:mappings] || {}
+        raise ArgumentError, "unrecognized value #{measure.inspect}" unless mappings.key?(measure)
+        return evaluate_measure(mappings[measure], options)
+      when String then
+        operator, value, unit = measure.match(/^([-+]?)(\d+(?:\.\d+)?)(.*)$/)[1,3]
+
+        value = case unit
+          when "%" then
+            relative = options[:relative] || 0
+            relative * value.to_f / 100
+          when "em" then
+            # not a true em, but good enough for approximating. patches welcome.
+            value.to_f * (options[:em] || font_size)
+          when "", "pt" then return value.to_f
+          when "pc" then return value.to_f * 12
+          when "in" then return value.to_f * 72
+          else raise ArgumentError, "unsupport units in style value: #{measure.inspect}"
+          end
+
+        current = options[:current] || 0
+        case operator
+        when "+" then return current + value
+        when "-" then return current - value
+        else return value
+        end
+      else return measure.to_f
+      end
+    end
+
+    def draw_lines(x, y, width, lines, options={})
+      real_x, real_y = translate(x, y)
+
+      state = options[:state] || {}
+      options[:align] ||= :left
+
+      state = state.merge(:width => width,
+        :x => x, :y => y,
+        :real_x => real_x, :real_y => real_y,
+        :dx => 0, :dy => 0)
+
+      state[:cookies] ||= {}
+      state[:pending_effects] ||= []
+
+      return state if lines.empty?
+
+      text_object do |text|
+        text.rotate(real_x, real_y, options[:rotate] || 0)
+        state[:text] = text
+        lines.each { |line| line.draw_on(self, state, options) }
+      end
+
+      state.delete(:text)
+
+      #rectangle [x, y+state[:dy]], width, state[:dy]
+      #stroke
+
+      return state
+    end
+
+    def layout(text, options={})
+      helper = Format::LayoutBuilder.new(self, text, options)
+      yield helper if block_given?
+      return helper
+    end
+
+    def format(text, options={})
+      if options[:at]
+        x, y = options[:at]
+        format_positioned_text(text, x, y, options)
+      else
+        format_wrapped_text(text, options)
+      end
+    end
+
+    def text_object
+      object = TextObject.new
+
+      if block_given?
+        yield object.open
+        add_content(object.close)
+      end
+
+      return object
+    end
+
+    private
+
+      def unformatted?(text, options={})
+        # If they have a preference, use it
+        if options.key?(:plain)
+          return options[:plain]
+
+        # Otherwise, if they're asking for full-justification, we must assume
+        # the text is formatted (since Prawn's text() method has no full justification)
+        elsif options[:align] == :justify
+          return false
+
+        # Otherwise, look for tags or XML entities in the text
+        else
+          return text !~ /<|&(?:#x?)?\w+;/
+        end
+      end
+
+      def format_positioned_text(text, x, y, options={})
+        helper = layout(text, options)
+        line = helper.next
+        draw_lines(x, y+line.ascent, line.width, [line], options)
+      end
+
+      def format_wrapped_text(text, options={})
+        helper = layout(text, options)
+
+        start_new_page if self.y < bounds.absolute_bottom
+
+        until helper.done?
+          y = self.y - bounds.absolute_bottom
+          height = bounds.stretchy? ? bounds.absolute_top : y
+
+          y = helper.fill(bounds.left, y, bounds.width, options.merge(:height => height))
+
+          if helper.done?
+            self.y = y + bounds.absolute_bottom
+          else
+            start_new_page
+          end
+        end
+      end
+
+      def formatted_height(string, line_width, size=font_size, options={})
+        helper = layout(string, options.merge(:size => font_size))
+        lines = helper.word_wrap(line_width)
+        return lines.inject(0) { |s, line| s + line.height }
+      end
+  end
+end
+
+require 'prawn/document'
+Prawn::Document.send(:include, Prawn::Format)

data/lib/prawn/format/effects/link.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Prawn
+  module Format
+    module Effects
+
+      class Link
+        def initialize(target, x)
+          @target = target.sub(/^#/, "")
+          @x = x
+        end
+
+        def finish(document, draw_state)
+          x1 = draw_state[:real_x] + @x
+          x2 = draw_state[:real_x] + draw_state[:dx]
+          y  = draw_state[:real_y] + draw_state[:dy]
+
+          rect = [x1, y + draw_state[:line].descent, x2, y + draw_state[:line].ascent]
+          document.link_annotation(rect, :Dest => @target, :Border => [0,0,0])
+        end
+
+        def wrap(document, draw_state)
+          finish(document, draw_state)
+          @x = 0
+        end
+      end
+
+    end
+  end
+end

data/lib/prawn/format/effects/underline.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module Prawn
+  module Format
+    module Effects
+
+      class Underline
+        def initialize(from, state)
+          @from = from
+          @state = state
+        end
+
+        def finish(document, draw_state)
+          x1 = draw_state[:x] + @from
+          x2 = draw_state[:x] + draw_state[:dx]
+          y  = draw_state[:y] + draw_state[:dy] - 2
+
+          document.stroke_color(@state.color)
+          document.move_to(x1, y)
+          document.line_to(x2, y)
+          document.stroke
+        end
+
+        def wrap(document, draw_state)
+          finish(document, draw_state)
+          @from = 0
+        end
+      end
+
+    end
+  end
+end

data/lib/prawn/format/instructions/base.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+module Prawn
+  module Format
+    module Instructions
+
+      class Base
+        attr_reader :state, :ascent, :descent
+
+        def initialize(state)
+          @state = state
+          state.document.font_size(state.font_size) do
+            @height = state.font.height
+            @ascent = state.font.ascender
+            @descent = state.font.descender
+          end
+        end
+
+        def spaces
+          0
+        end
+
+        def width(*args)
+          0
+        end
+
+        def height(*args)
+          @height
+        end
+
+        def break?
+          false
+        end
+
+        def force_break?
+          false
+        end
+
+        def discardable?
+          false
+        end
+
+        def start_verbatim?
+          false
+        end
+
+        def end_verbatim?
+          false
+        end
+
+        def style
+          {}
+        end
+
+        def accumulate(list)
+          list.push(self)
+        end
+      end
+
+    end
+  end
+end