prawn 0.11.1 → 0.15.0

data/HACKING

@@ -1,50 +0,0 @@
-= Hacking on Prawn
-
-While we hope to have more extensive documentation for contributors in time, for
-now, here is the bare minimum to get you up and running
-
-== NOTES 
-
-Install test-spec, pdf-reader, and mocha from RubyGems
-
-Be sure to load in the necessary git submodules as well:
-
-  git submodule init
-  git submodule update
-
-If you are running on Ruby 1.9, you will need Test::Unit 1.2.3:
-
-  gem install test-unit -v 1.2.3
-  
-== Patch process 
-
-  1. File a ticket in the bug tracker describing a defect or feature
-
-   http://github.com/sandal/prawn/issues
-
-  2. Fork us on Github, make your changes.  Bug fixes or tiny enhancements can
-  be done on your master branch, everything else should be done on its own topic
-  branch.
-
-  3. Post a comment to the ticket telling us where your fork is, and what
-  patches we should be looking at.
-  
-  If you are working on a ticket that has already been created, skip step 1.
-  
-  All feature enhancements should come with an example in the examples/ dir,
-  and preferably, some specs.
-  
-  All bug reports should have a reproducible example in bugs/ and preferably,
-  some specs.
-  
-== Support
-
-  Find us in #prawn on irc.freenode.net
-  <sandal>     - Gregory Brown
-  <yob>        - James Healy
-  <bluejade>   - Daniel Nelson
-  <bradediger> - Brad Ediger
-  <jonsgreen>  - Jonathan Greenberg
-  
-  Otherwise, use the mailing list:
-  http://groups.google.com/group/prawn-ruby

data/README

@@ -1,141 +0,0 @@
-= Prawn: Fast, Nimble PDF Generation For Ruby
-
-Prawn is a PDF writing library for Ruby designed to be tiny, fast, and nimble,
-just like the majestic sea creature.
-
-Development on this library was initially made possible thanks to 
-the many people who donated to the Ruby Mendicant project: 
-http://rubymendicant.wikidot.com 
-
-The project is currently maintained by Gregory Brown, with lots of help from
-Prawn's core developers and the community.
-
-== Quick Start
-
-Getting started with Prawn can be as simple as:
-
- require 'prawn'
- pdf = Prawn::Document.new
- pdf.text("Prawn Rocks")
- pdf.render_file('prawn.pdf')
-
-But prawn can do a lot more:
-
-===Any page size you can think of
-
- Prawn::Document.new('A0')
-
-...gives you an _really_ big page.
-
- Prawn::Document.new(:page_size   => [11.32, 8.49],
-                     :page_layout => :portrait)
-
-...giving you a postage stamp.
-
-{Learn more}[link:classes/Prawn/Document.html]
-
-===Multiple Font Handling with UTF-8 Support
-
- pdf.text("Prawn Rocks")
- pdf.font("/myfont.ttf")
- pdf.text("Prawn still rocks in a different font")
-
-...allowing you to use any font you want.
-
-{Learn more}[link:classes/Prawn/Font.html]
-
-===Drawing graphics directly into the page
-
-Simple shapes:
-
- pdf.stroke do
-   pdf.circle_at [100,100], :radius => 25
-   pdf.rectangle [300,300], 100, 200
- end
-
-(note, you need to stroke the path to put "ink" there)
-
-{Learn more}[link:classes/Prawn/Graphics.html]
-
-===Embedding JPEG and PNG Images Natively
-
-Reading an image directly from a file:
-
- prawn_logo = "#{Prawn::BASEDIR}/data/images/prawn_logo.png"
- pdf.image prawn_logo, :at => [50,450], :width => 450
-
-Or reading it from an IO stream:
-
- require "open-uri"
- pdf.image open("http://prawn.majesticseacreature.com/media/prawn_logo.png")
-
-{Learn more}[link:classes/Prawn/Images.html]
-
-===Measurement Conversion Tools for Your Sanity
-
-Prawn deals exclusively in PDF points... which work out to about 2.83464567mm... 
-don't try and do it in your head, instead, let Prawn help you:
-
- require "prawn/measurement_extensions"
-
- Prawn::Document.generate(:page_layout => :portrait, 
-                     :left_margin => 10.mm,    # different
-                     :right_margin => 1.cm,    # units
-                     :top_margin => 0.1.dm,    # work
-                     :bottom_margin => 0.01.m, # well 
-                     :page_size => 'A4') do
-   text "Prawn Rocks"
- end
-
-{Learn more}[link:classes/Prawn/Measurements.html]
-
-===Document Security, Permissions, and Encryption
-
-See examples/security/ for example code, such as this:
-
-  require 'prawn/security'
-
-  Prawn::Document.generate("hello_foo.pdf") do
-    text "Hello, world!"
-    encrypt_document :user_password => 'foo', :owner_password => 'bar',
-      :permissions => { :print_document => false }
-  end
-
-This creates a document that requires the password 'foo' to be opened,
-and cannot be printed without entering the owner password 'bar'.
-
-If you want to prohibit most anyone from performing a certain activity, you can
-pass :owner_password => :random to generate a probably-unguessable owner 
-password.
-
-== Resources
-
-=== Examples:
-
-http://github.com/sandal/prawn/tree/stable/examples
-
-=== Bug Tracker:
-
-http://github.com/sandal/prawn/issues
-
-=== Source Code:
-
-http://github.com/sandal/prawn
-
-=== Mailing List:
-
-http://groups.google.com/group/prawn-ruby
-
-=== IRC:
-
-Find us in #prawn on irc.freenode.net
-  Gregory Brown: <sandal>
-  James Healy: <yob>               
-  Brad Ediger: <bradediger>
-  Daniel Nelson: <bluejade>
-  Jonathan Greenberg: <jonsgreen>
-  
-== Notes to Developers: 
-
-See HACKING file for details on getting set up with a local build.
-

data/examples/bounding_box/bounding_boxes.rb

@@ -1,44 +0,0 @@
-# encoding: utf-8
-#
-# This example demonstrates the basic functionality of Prawn's bounding boxes.
-# Note that top level bounding boxes are positioned relative to the margin_box.
-# 
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-Prawn::Document.generate("bounding_boxes.pdf") do
-
-  # Generates a box with a top-left of [100,600] and a top-right of [300,600]
-  # The box automatically expands as the cursor moves down the page.  Notice
-  # that the final coordinates are outlined by a top and bottom line drawn
-  # relatively using calculations from +bounds+.
-  #
-  bounding_box [100,600], :width => 200 do
-    move_down 10
-    text "The rain in spain falls mainly on the plains " * 5
-    move_down 20
-    stroke do
-      line bounds.top_left,    bounds.top_right
-      line bounds.bottom_left, bounds.bottom_right
-    end
-  end
-
-  # Generates a bounding box from [100, cursor], [300, cursor - 200],
-  # where cursor is the current y position.
-  #
-  bounding_box [100,cursor], :width => 200, :height => 200 do
-    stroke do
-      circle [100,100], 100
-      line bounds.top_left, bounds.bottom_right
-      line bounds.top_right, bounds.bottom_left
-    end
-    
-    # Generates a nested bonding box and strokes its boundaries.  Note that
-    # this box is anchored relative to its parent bounding box, not the
-    # margin_box 
-    bounding_box [50,150], :width => 100, :height => 100 do
-      stroke_bounds
-    end
-  end
-
-end                 

data/examples/bounding_box/indentation.rb

@@ -1,35 +0,0 @@
-# encoding: utf-8
-#
-# This example demonstrates the basic functionality of Prawn's bounding boxes.
-# Note that top level bounding boxes are positioned relative to the margin_box.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-Prawn::Document.generate("indentation.pdf") do
-
-  text "No indentation"
-  indent(20) do
-    text "Some indentation"
-    # Generates a box with a top-left of [100,600] and a top-right of [300,600]
-    # The box automatically expands as the cursor moves down the page.  Notice
-    # that the final coordinates are outlined by a top and bottom line drawn
-    # relatively using calculations from +bounds+.
-    #
-    bounding_box [100,600], :width => 200 do
-      text "A little more indentation"
-      indent(20) do
-        text "And some more indentation"
-        indent(20) do
-          text "And some deeper indentation"
-        end
-      end
-    end
-    text "Some indentation"
-  end
-  indent(10) do
-    text "A bit of indentation"
-  end
-  
-  text "No indentation"
-end

data/examples/bounding_box/russian_boxes.rb

@@ -1,37 +0,0 @@
-# encoding: utf-8
-#
-# This example is mostly just for fun, and shows how nested bounding boxes
-# can simplify calculations.  See the other files in examples/bounding_box
-# for more basic uses.
-
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-class Array
-  def combine(arr)
-    output = []
-    self.each do |i1|
-      arr.each do |i2|
-        output += [[i1,i2]]
-      end
-    end
-    output
-  end
-end
-
-def recurse_bounding_box(pdf, max_depth=5, depth=1)
-  box = pdf.bounds
-  width = (box.width-15)/2
-  height = (box.height-15)/2
-  left_top_corners = [5, box.right-width-5].combine [box.top-5, height+5]
-  left_top_corners.each do |lt|
-    pdf.bounding_box(lt, :width=>width, :height=>height) do
-      pdf.stroke_bounds
-      recurse_bounding_box(pdf, max_depth, depth+1) if depth<max_depth
-    end
-  end
-end
-
-Prawn::Document.generate("russian_boxes.pdf") do |pdf|
-  recurse_bounding_box(pdf)
-end

data/examples/bounding_box/stretched_nesting.rb

@@ -1,68 +0,0 @@
-# encoding: utf-8
-#
-# This example demonstrates how nested bounding boxes work when the outer box is
-# stretchy and includes several inner boxes of different sizes.
-
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-Prawn::Document.generate("stretched_nesting.pdf", :page_layout => :landscape) do
-
-  def stroke_dashed_bounds
-    dash(1)
-    stroke_bounds
-    undash
-  end
-
-  bounding_box [100,400], :width => 500 do
-
-    bounding_box [0, bounds.top], :width => 200, :height => 100 do
-      stroke_bounds
-    end
-
-    bounding_box [200, bounds.top], :width => 150 do
-      indent(5) do
-        text "This box is longest, so it stretches the parent box. \n"*5
-      end
-    end
-
-    bounding_box [350, bounds.top], :width => 150 do
-      text "I AM SANTA CLAUS!!!"
-    end
-
-    stroke_dashed_bounds
-
-  end
-
-  bounding_box [100, 250], :width => 500 do
-
-    bounding_box [0, bounds.top], :width => 100, :height => 100 do
-      text "1"
-      stroke_bounds
-    end
-
-    bounding_box [125, bounds.top], :width => 50, :height => 25 do
-      text "2"
-      stroke_bounds
-    end
-
-    bounding_box [200, bounds.top - 50], :width => 50, :height => 125 do
-      text "3"
-      stroke_bounds
-    end
-
-    bounding_box [350, bounds.top - 100], :width => 20, :height => 20 do
-      text "4"
-      stroke_bounds
-    end
-
-    bounding_box [400, bounds.height - 150], :width => 100, :height => 100 do
-      text "5"
-      stroke_bounds
-    end
-
-    stroke_dashed_bounds
-
-  end
-
-end

data/examples/example_helper.rb

@@ -1,8 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'rubygems'
-require 'prawn'
-require 'prawn/security'
-require "prawn/layout"
-
-
-Prawn.debug = true

data/examples/general/background.rb

@@ -1,24 +0,0 @@
-# encoding: utf-8
-#
-# This example demonstrates the use of the new :background option when
-# generating a new Document.  Image is assumed to be pre-fit for your page
-# size, and will not be rescaled.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-img = "#{Prawn::BASEDIR}/data/images/letterhead.jpg"
-
-Prawn::Document.generate("background.pdf", :background => img, :margin => 100) do
-  text "My report caption", :size => 18, :align => :right
-
-  move_down font.height * 2
-
-  text "Here is my text explaning this report. " * 20, 
-    :size => 12, :align => :left, :leading => 2
-
-  move_down font.height
-
-  text "I'm using a soft background. " * 40,
-    :size => 12, :align => :left, :leading => 2
-end

data/examples/general/canvas.rb

@@ -1,16 +0,0 @@
-# encoding: utf-8
-#
-# Demonstrates how to enable absolute positioning in Prawn by temporarily
-# removing the margin_box via Document#canvas()
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-Prawn::Document.generate("canvas.pdf") do
-  canvas do
-    text "This text should appear at the absolute top left"
-
-    # stroke a line to show that the relative coordinates are the same as absolute
-    stroke_line [bounds.left,bounds.bottom], [bounds.right,bounds.top]
-  end
-end

data/examples/general/context_sensitive_headers.rb

@@ -1,38 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-# Ex. Generate a roster of meeting attendees given a set of meetings.
-# Attendees for a meeting may overflow to accross page boundaries but 
-# each meeting starts on a separate page. Each page for any given
-# meeting will have the heading for that meeting. 
-
-#dummying up some meetings
-meetings = []
-5.times do |i|
-  meetings << "Meeting number #{i}"
-end
-
-Prawn::Document.generate('context_sensitive_headers.pdf', :margin => [100, 100], :skip_page_creation => true) do
-  meetings.each_with_index do |meeting,i|
-    
-    create_stamp(meeting.to_s) do
-      canvas do
-        text_box("header for #{meeting}",
-          :at => [bounds.left + 50, bounds.top - 20],
-          :height => 50,
-          :width => margin_box.width)
-      end
-    end
-    on_page_create { stamp(meeting.to_s) }
-
-    start_new_page
-
-    #simulate some meetings with content over multiple pages
-    (15 + 20*i).times do |i|
-      text "#{meeting} attendee #{i}"
-    end
-    
-  end
-
-end
-

data/examples/general/float.rb

@@ -1,12 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-Prawn::Document.generate('float.pdf') do
-  float do
-    bounding_box [bounds.width / 2.0, bounds.top], :width => 100 do
-      text "Hello world. " * 50
-    end
-  end
-
-  text "Hello world again"
-end

data/examples/general/margin.rb

@@ -1,37 +0,0 @@
-# encoding: utf-8
-#
-# This demonstrates the Prawn options for document and page margin, similar to CSS shorthand.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-LOREM = ("Lorem ipsum dolor sit amet, consectetur adipisicing elit, "+
-"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. "+
-"Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris "+
-"nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in "+
-"reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla "+
-"pariatur. Excepteur sint occaecat cupidatat non proident, sunt in " +
-"culpa qui officia deserunt mollit anim id est laborum. ") * 20
-
-Prawn::Document.generate("margin.pdf", :margin => 100) do |pdf|
-
-  pdf.text "100 on all sides", :style => :bold
-  pdf.text LOREM
-  
-  pdf.start_new_page(:margin => 100, :left_margin => 0)
-  pdf.text "100 on all sides but 0 on the left", :style => :bold
-  pdf.text LOREM
-
-  pdf.start_new_page(:margin => [100, 0])
-  pdf.text "100 top and bottom, 0 left and right.", :style => :bold
-  pdf.text LOREM
-  
-  pdf.start_new_page(:margin => [100, 0, 50])
-  pdf.text "100 top, 0 left and right, 50 bottom.", :style => :bold
-  pdf.text LOREM
-  
-  pdf.start_new_page(:margin => [0, 50, 100, 150])
-  pdf.text "0 top, 50 right, 100 bottom, 150 left.", :style => :bold
-  pdf.text LOREM
-
-end

data/examples/general/measurement_units.rb

@@ -1,52 +0,0 @@
-# encoding: utf-8
-#
-# Generates a ruler and also demonstrates prawn/measurement_extensions.
-# It's better to run this example and examine its output than to worry about
-# its particular implementation, though some might find that interesting as
-# well.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-require "prawn/measurement_extensions"
-
-# this makes the following units available (Millimeters, Centimeters, Decimeters, Meters, Inches, Foot, Yards, Points)
-# Methodname is the common abbravation for the unit (mm, cm, dm, m, in, ft, yd, pt)
-# Usage: '10.mm'. 
-# This converts 10mm to PDF points, which Prawn uses internally.
-
-pdf = Prawn::Document.new(
-:page_size => "A4", 
-:left_margin => 10.mm,    # different
-:right_margin => 1.cm,    # units
-:top_margin => 0.1.dm,    # work
-:bottom_margin => 0.01.m) # well
-
-pdf.font_size = 6
-pdf.line_width = 0.05
-
-units_long = %w[Millimeters Centimeters Decimeters Inches Foot Points]
-units = %w[mm cm dm in ft pt]
-offset_multiplier = 2.cm
-temp = "Units\n"
-
-units.each_with_index do |unit, unit_index| #iterate through all units that make sense to display on a sheet of paper
-  one_unit_in_pt = eval "1.#{unit}" # calc the width of one unit
-  temp << "1#{unit} => #{one_unit_in_pt}pt\n" #puts converted unit in points
-  
-  offset = offset_multiplier * unit_index
-  pdf.draw_text units[unit_index], :at => [offset + 0.5.mm, pdf.bounds.top - 2.mm]
-  
-  pdf.stroke_line(offset, pdf.bounds.top, offset, pdf.bounds.bottom)
-  
-  0.upto(((pdf.bounds.height - 5.mm) / one_unit_in_pt).to_i) do |i| # checks, how many strokes can be drawn
-    pdf.stroke_line(offset, i * one_unit_in_pt, (i % 5 == 0 ? 6.mm : 3.mm) + offset, i * one_unit_in_pt) # every fifth stroke is twice as large like on a real ruler
-    pdf.draw_text "#{i}#{unit}", :at => [7.mm + offset, i * one_unit_in_pt] unless unit == "mm" && i % 5 != 0 || unit == "pt" && i % 10 != 0 # avoid text too close to each other
-  end    
-end
-
-pdf.text_box temp,
-  :width    => 5.cm, :height => pdf.font.height * units_long.length,
-  :at       => [offset_multiplier * units_long.length, pdf.bounds.top]
-
-pdf.render_file "measurement_units.pdf"

data/examples/general/metadata-info.rb

@@ -1,17 +0,0 @@
-# encoding: utf-8
-#
-# Demonstrates how to set metadata properties via the info option
-# It allows one to specify no standard properties
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-Prawn::Document.generate "metadata-info.pdf",
-  :info => {
-    :Title => "My title", :Author => "John Doe", :Subject => "My Subject",
-    :Keywords => "test metadata ruby pdf dry", :Creator => "ACME Soft App", 
-    :Producer => "Prawn", :CreationDate => Time.now, :Grok => "Test Property"
-  } do       
-  text "This is a test of setting metadata properties via the info option"
-  text "It allows one to specify no standard properties like 'Grok'"
-end

data/examples/general/multi_page_layout.rb

@@ -1,19 +0,0 @@
-# encoding: utf-8
-#
-# This demonstrates that Prawn can modify page size, margins and layout for 
-# each individual page, via Document#start_new_page()
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-Prawn::Document.generate("multi-layout.pdf", :page_layout => :landscape) do |pdf|
-   pdf.text "This is on a landscaped page" 
-   pdf.start_new_page(:layout => :portrait)
-   pdf.text "This is on a portrait page"   
-   pdf.start_new_page(:size => "LEGAL")
-   pdf.text "This is on legal paper size"      
-   pdf.start_new_page(:left_margin => 150, :right_margin => 150)
-   pdf.text "This page has very wide left and right margins, causing a squeeze"
-   pdf.start_new_page(:margin => 300, :right_margin => 0)
-   pdf.text "This page has even wider margins on all sides except for the right side, where it's 0"
-end