alphasights-prawn 0.10.0

data/examples/text/family_based_styling.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+#
+# This example demonstrates using the :style option for Document#text.
+# If you are working with TTF fonts, you'll want to check out the 
+# documentation for Document#font_families and register your fonts with it.
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("family_style.pdf") do
+  ["Courier","Helvetica","Times-Roman"].each do |f|
+    [:bold,:bold_italic,:italic,:normal].each do |s|
+      font f, :style => s
+      text "I'm writing in #{f} (#{s})"
+    end
+  end
+  
+  font "Helvetica"
+  
+  text "Normal"
+  text "Bold",        :style => :bold
+  text "Bold Italic", :style => :bold_italic
+  text "Italic",      :style => :italic
+  text "Normal"
+end

data/examples/text/font_calculations.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+# 
+# This example is a demonstration of how Prawn does its text positioning,
+# meant to assist those that need to do advanced positioning calculations.
+# Run the example for a clearer picture of how things work
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate('font_calculations.pdf') do
+  
+  def demonstration
+    font_size 12
+    move_down 10
+
+    stroke_horizontal_rule
+
+    text "When using flowing text, Prawn will position text\n" +
+         "starting font.ascender below the baseline, and leave\n" +
+         "the y-cursor at the baseline of the next line of text"
+
+    stroke_horizontal_rule
+
+    move_down 20
+
+    bl = y - bounds.absolute_bottom
+
+    stroke_horizontal_rule
+    draw_text "When using text positioned with :at, the baseline is used", :at => [0, bl]
+
+    draw_text "(and the Y-cursor is not moved)", :at => [350, bl]
+
+    colors = { :ascender    => "ff0000", 
+               :descender   => "00ff00",
+               :line_gap    => "0000ff",
+               :font_height => "005500" }
+
+
+    pad(20) do                    
+      text "Calculations Demo", :size => 16
+    end
+
+    fill_color colors[:ascender]
+    text "ASCENDER"
+
+    fill_color colors[:descender]
+    text "DESCENDER"
+
+    fill_color colors[:line_gap]
+    text "LINEGAP" 
+
+    fill_color colors[:font_height]
+    text "FONT_HEIGHT"
+
+    fill_color "000000"
+    font_size 16
+
+    move_down 40
+
+    bl = y - bounds.absolute_bottom
+    draw_text "The quick brown fox jumps over the lazy dog.", :at => [0, bl]
+
+    stroke_color colors[:ascender]
+    stroke_line [0, bl], [0, bl + font.ascender]
+    stroke_line [0, bl + font.ascender], [bounds.width, bl + font.ascender]
+
+    stroke_color colors[:descender]
+    stroke_line [0,bl], [0, bl - font.descender]
+    stroke_line [0, bl - font.descender], [bounds.width, bl - font.descender]
+
+    stroke_color colors[:line_gap]
+    stroke_line [0, bl - font.descender], [0,bl - font.descender - font.line_gap]
+    stroke_line [0, bl - font.descender - font.line_gap], 
+                [bounds.width,bl - font.descender - font.line_gap]
+
+    stroke_color colors[:font_height]
+    stroke_line [bounds.width, bl + font.ascender],
+                [bounds.width, bl - font.descender - font.line_gap]
+                
+    stroke_color "000000"
+    fill_color "000000"
+  end
+  
+  text "Using AFM", :size => 20
+  demonstration
+  
+  move_down 75
+  font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+  text "Using TTF", :size => 20
+  demonstration
+  
+end

data/examples/text/font_size.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+#
+# This example shows the many ways of setting font sizes in Prawn
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "font_size.pdf", :page_size => "A4" do
+
+  # Explicit global changes
+  font 'Helvetica'
+  self.font_size = 16
+
+  text 'Font at 16 point'
+
+  # Transactional changes rolled back after block exit
+  font_size 9 do
+    text 'Font at 9 point'
+    # single line changes, not persisted.
+    text 'Font at manual override 20 point', :size => 20
+    text 'Font at 9 point'
+  end
+
+  # Transactional changes rolled back after block exit on full fonts.
+  font("Times-Roman", :style => :italic, :size => 12) do
+    text "Font in times at 12"
+    font_size(16) { text "Font in Times at 16" }
+  end
+
+  text 'Font at 16 point'
+
+  font "Courier", :size => 40
+  text "40 pt!"
+end

data/examples/text/hyphenation.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+#
+
+require 'examples/example_helper'
+
+Prawn::Document.generate("hyphenation.pdf") do
+  def get_string(i)
+    case i
+    when 0
+      text = "this­is­soft­hyphenated­text­" * 30
+    when 1
+      text = "this-is-hard-hyphenated-text-" * 30
+    when 2
+      text = "this­-is­-soft­-hard­-hyphenated­-text­-" * 30
+    end
+  end
+
+  options = {
+    :width    => bounds.width * 0.3,
+    :height   => bounds.width * 0.3,
+    :overflow => :ellipses,
+    :at       => [0, 0],
+    :align    => :left,
+    :document => self
+  }
+
+  stroke_color("555555")
+  3.times do |i|
+    options[:at][0] = (bounds.width  - options[:width]) * 0.5 * i
+    options[:at][1] = bounds.height * 0.5 + options[:height] + 50
+    box = Prawn::Text::Box.new(get_string(i), options)
+    box.render
+  end
+
+  
+  font("#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf")
+
+  stroke_color("555555")
+  3.times do |i|
+    options[:at][0] = (bounds.width  - options[:width]) * 0.5 * i
+    options[:at][1] = bounds.height * 0.5 - 50
+    box = Prawn::Text::Box.new(get_string(i), options)
+    box.render
+  end
+end

data/examples/text/indent_paragraphs.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+#
+# Example of two ways of indenting paragraphs
+#
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "indent_paragraphs.pdf" do |pdf|
+  hello = "hello " * 50
+  world = "world " * 50
+  pdf.text(hello + "\n" + world, :indent_paragraphs => 60)
+
+  pdf.move_cursor_to(pdf.font.height)
+  pdf.text(hello + "\n" + world, :indent_paragraphs => 60)
+
+  pdf.move_cursor_to(pdf.font.height * 3)
+  pdf.text(hello + "\n" + world, :indent_paragraphs => 60)
+
+  # can also indent using a non-breaking space
+  nbsp = Prawn::Text::NBSP
+  pdf.text("\n" * 10 + hello + "\n#{nbsp * 10}" + world)
+end

data/examples/text/inline_format.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+#
+# This example shows how to use inline formatting
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate("inline_format.pdf") do |pdf|
+  
+  pdf.text("hello <strikethrough><b>world\nhow <i>are</i></b> you?</strikethrough> world, <u>how are you</u> now?",
+       :inline_format => true)
+  pdf.text("<font size='14'>left: </font>" + "hello <b>world <font name='Times-Roman' size='28'>how</font> <i>are</i></b> you? <font size='14'><b>Goodbye.</b></font> " * 8,
+       :inline_format => true)
+  pdf.text("right: " + "hello <b>world how <i>are</i></b> you? " * 2,
+       :inline_format => true,
+       :align => :right)
+  pdf.text("center: " + "hello <b>world how <i>are</i></b> you? " * 2,
+       :inline_format => true,
+       :align => :center)
+  pdf.text("\njustify: " + "hello <b>world <i>goodbye</i></b> " * 12 + "the end ",
+       :inline_format => true,
+       :align => :justify)
+  pdf.text("\njustify: " + "hello world goodbye " * 12 + "the end ",
+       :inline_format => true,
+       :align => :justify)
+  pdf.text("\njustify: " + "hello world goodbye " * 12 + "the end ",
+       :align => :justify)
+
+  
+  pdf.text("<color rgb='00ff00'>link: <font size='24' character_spacing='7.5'>please make</font> <color rgb='#0000ff'><u><link href='http://wiki.github.com/sandal/prawn/'>this</link></u></color> clickable.</color> Here we have A<color rgb='#0000ff'><sup><link href='http://wiki.github.com/sandal/prawn/'>superscript</link></sup></color> link and A<color rgb='#0000ff'><sub><link href='http://wiki.github.com/sandal/prawn/'> subscript</link></sub></color> link.",
+       :inline_format => true)
+
+  pdf.text("<color c='100' m='0' y='0' k='0'><font size='24'>CMYK</font></color>",
+       :inline_format => true)
+
+  file = "#{Prawn::BASEDIR}/data/fonts/Action Man.dfont"
+  pdf.font_families["Action Man"] = {
+    :normal      => { :file => file, :font => "ActionMan" },
+    :italic      => { :file => file, :font => "ActionMan-Italic" },
+    :bold        => { :file => file, :font => "ActionMan-Bold" },
+    :bold_italic => { :file => file, :font => "ActionMan-BoldItalic" }
+  }
+
+  pdf.font("Action Man")
+  pdf.text("\nhello <b>world\nhow <i>are</i></b> you?",
+           :inline_format => true)
+
+
+  pdf.font("Helvetica")
+
+
+
+  class Highlight
+    def initialize(options)
+      @color = options[:color]
+      @document = options[:document]
+    end
+
+    def render_behind(fragment)
+      original_color = @document.fill_color
+      @document.fill_color = @color
+      @document.fill_rectangle(fragment.top_left,
+                               fragment.width,
+                               fragment.height)
+      @document.fill_color = original_color
+    end
+  end
+
+  class FragmentBorder
+    def initialize(options)
+      @radius = options[:radius]
+      @connect_corners = options[:connect_corners]
+      @document = options[:document]
+    end
+
+    def render_in_front(fragment)
+      box = fragment.bounding_box
+      if @connect_corners
+        @document.stroke_polygon(fragment.top_left, fragment.top_right,
+                                 fragment.bottom_right, fragment.bottom_left)
+      end
+      @document.stroke_circle_at(fragment.top_left, :radius => @radius)
+      @document.stroke_circle_at(fragment.top_right, :radius => @radius)
+      @document.stroke_circle_at(fragment.bottom_right, :radius => @radius)
+      @document.stroke_circle_at(fragment.bottom_left, :radius => @radius)
+    end
+  end
+
+  highlight_callback = Highlight.new(:color => 'ffff00', :document => pdf)
+  border_callback = FragmentBorder.new(:radius => 2.5,
+                                       :connect_corners => true,
+                                       :document => pdf)
+  pdf.formatted_text([
+                      { :text => "\n" },
+                      { :text => "hello   ",
+                        :callback => highlight_callback },
+                      { :text => "world",
+                        :size => 24,
+                        :character_spacing => 0,
+                        :callback => [highlight_callback, border_callback] },
+                      { :text => "   hello" }
+                     ], :indent_paragraphs => 40, :character_spacing => -2)
+end
+

data/examples/text/kerning.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+#
+# Demonstration of enabling and disabling kerning support
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "kerning.pdf" do
+  draw_text "To kern?", :at => [200,720], :size => 24, :kerning => true
+  draw_text "To not kern?", :at => [200,690], :size => 24, :kerning => false 
+  
+  move_down 100
+                                                                     
+  pad(30) do
+    text "To kern and wrap. " * 5, :size => 24, :kerning => true   
+  end
+  
+  text "To not kern and wrap. " * 5, :size => 24, :kerning => false
+
+  font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+  
+  draw_text "To kern?", :at => [200,660], :size => 24, :kerning => true
+  draw_text "To not kern?", :at => [200,630], :size => 24, :kerning => false     
+  
+  pad(30) do
+    text "To kern and wrap. " * 5, :size => 24, :kerning => true   
+  end
+  
+  text "To not kern and wrap. " * 5, :size => 24, :kerning => false
+  
+end

data/examples/text/rotated.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+#
+# Demonstrates transformations
+#
+require "#{File.dirname(__FILE__)}/../example_helper.rb"
+
+Prawn::Document.generate "rotated_text.pdf" do |pdf|
+  pdf.line_width = 1
+  width = 150
+  height = 200
+  half_width = width / 2
+  half_height = height / 2
+  angle = 30
+
+
+  # AROUND THE CENTER
+  
+  x = pdf.bounds.width / 2 - half_width
+  y = pdf.bounds.height / 2 + half_height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x + half_width, y - half_height]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around the center " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle,
+               :rotate_around => :center)
+
+  
+  # AROUND THE UPPER_LEFT_CORNER
+  
+  x = pdf.bounds.width - width
+  y = height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x, y]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around upper left corner " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle)
+
+  
+  # AROUND THE UPPER_RIGHT_CORNER
+  
+  x = 0
+  y = height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x + width, y]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around upper right corner " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle,
+               :rotate_around => :upper_right)
+
+  
+  # AROUND THE LOWER_RIGHT_CORNER
+  
+  x = 0
+  y = pdf.bounds.height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x + width, y - height]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around lower right corner " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle,
+               :rotate_around => :lower_right)
+
+  
+  # AROUND THE LOWER_LEFT_CORNER
+  
+  x = pdf.bounds.width - width
+  y = pdf.bounds.height
+
+  pdf.stroke_rectangle([x, y], width, height)
+  pdf.rotate(angle, :origin => [x, y - height]) do
+    pdf.stroke_rectangle([x, y], width, height)
+  end
+  pdf.text_box("rotated around lower left corner " * 10,
+               :at => [x, y],
+               :width => width,
+               :height => height,
+               :rotate => angle,
+               :rotate_around => :lower_left)
+end