prawn 0.13.0 → 2.4.0

data/manual/table/content_and_subtables.rb

@@ -1,39 +0,0 @@
-# encoding: utf-8
-#
-# There are five kinds of objects which can be put in table cells:
-#   1. String: produces a text cell (the most common usage)
-#   2. <code>Prawn::Table::Cell</code>
-#   3. <code>Prawn::Table</code>
-#   4. Array
-#   5. Images
-#
-# Whenever a table or an array is provided as a cell, a subtable will be created
-# (a table within a cell).
-#
-# If you'd like to provide a cell or table directly, the best way is to
-# use the <code>make_cell</code> and <code>make_table</code> methods as they
-# don't call <code>draw</code> on the created object.
-#
-# To insert an image just provide a hash with an with an <code>:image</code> key
-# pointing to the image path.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  cell_1 = make_cell(:content => "this row content comes directly ")
-  cell_2 = make_cell(:content => "from cell objects")
-  
-  two_dimensional_array = [ ["..."], ["subtable from an array"], ["..."] ]
-  
-  my_table = make_table([ ["..."], ["subtable from another table"], ["..."] ])
-  
-  image_path = "#{Prawn::DATADIR}/images/stef.jpg"
-  
-  table([ ["just a regular row", "", "", "blah blah blah"],
-          [cell_1, cell_2, "", ""],
-          ["", "", two_dimensional_array, ""],
-          ["just another regular row", "", "", ""],
-          [{:image => image_path}, "", my_table, ""]])
-end

data/manual/table/creation.rb

@@ -1,27 +0,0 @@
-# encoding: utf-8
-#
-# Creating tables with Prawn is fairly easy. There are two methods that will
-# create tables for us <code>table</code> and <code>make_table</code>.
-#
-# Both are wrappers that create a new <code>Prawn::Table</code> object. The
-# difference is that <code>table</code> calls the <code>draw</code> method
-# after creating the table and <code>make_table</code> only returns the created
-# table, so you have to call the <code>draw</code> method yourself.
-#
-# The most simple table can be created by providing only an array of arrays
-# containing your data where each inner array represents one row.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  t = make_table([ ["this is the first row"],
-                   ["this is the second row"] ])
-  t.draw
-  move_down 20
-  
-  table([ ["short", "short", "loooooooooooooooooooong"],
-          ["short", "loooooooooooooooooooong", "short"],
-          ["loooooooooooooooooooong", "short", "short"] ])
-end

data/manual/table/filtering.rb

@@ -1,36 +0,0 @@
-# encoding: utf-8
-#
-# Another way to reduce the number of cells is to <code>filter</code> the table.
-#
-# <code>filter</code> is just like <code>Enumerable#select</code>. Pass it a
-# block and it will iterate through the cells returning a new 
-# <code>Prawn::Table::Cells</code> instance containing only those cells for
-# which the block was not false.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  data = [ ["Item", "Jan Sales", "Feb Sales"],
-           ["Oven", 17, 89],
-           ["Fridge", 62, 30],
-           ["Microwave", 71, 47]
-         ]
-  
-  table(data) do
-    values = cells.columns(1..-1).rows(1..-1)
-    
-    bad_sales = values.filter do |cell|
-      cell.content.to_i < 40
-    end
-    
-    bad_sales.background_color = "FFAAAA"
-
-    good_sales = values.filter do |cell|
-      cell.content.to_i > 70
-    end
-    
-    good_sales.background_color = "AAFFAA"
-  end
-end

data/manual/table/flow_and_header.rb

@@ -1,17 +0,0 @@
-# encoding: utf-8
-#
-# If the table cannot fit on the current page it will flow to the next page just
-# like free flowing text. If you would like to have the first row treated as a
-# header which will be repeated on subsequent pages set the <code>:header</code>
-# option to true.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  data = [["This row should be repeated on every new page"]]
-  data += [["..."]] * 30
-  
-  table(data, :header => true)
-end

data/manual/table/image_cells.rb

@@ -1,33 +0,0 @@
-# encoding: utf-8
-#
-# Prawn can insert images into a table. Just pass a hash into
-# <code>table()</code> with an <code>:image</code> key pointing to the image.
-#
-# You can pass the <code>:scale</code>, <code>:fit</code>,
-# <code>:position</code>, and <code>:vposition</code> arguments in alongside
-# <code>:image</code>; these will function just as in <code>image()</code>.
-#
-# The <code>:image_width</code> and <code>:image_height</code> arguments set
-# the width/height of the image within the cell, as opposed to the
-# <code>:width</code> and <code>:height</code> arguments, which set the table
-# cell's dimensions.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  image = "#{Prawn::DATADIR}/images/prawn.png"
-
-  table [
-    ["Standard image cell",   {:image => image}],
-    [":scale => 0.5",         {:image => image, :scale => 0.5}],
-    [":fit => [100, 200]",    {:image => image, :fit => [100, 200]}],
-    [":image_height => 50,
-      :image_width => 100",   {:image => image, :image_height => 50,
-                                                :image_width  => 100}],
-    [":position => :center",  {:image => image, :position  => :center}],
-    [":vposition => :center", {:image => image, :vposition => :center,
-                                                :height => 200}]
-  ], :width => bounds.width
-end

data/manual/table/position.rb

@@ -1,29 +0,0 @@
-# encoding: utf-8
-#
-# The <code>table()</code> method accepts a <code>:position</code> argument to
-# determine horizontal position of the table within its bounding box. It can be
-# <code>:left</code> (the default), <code>:center</code>, <code>:right</code>,
-# or a number specifying a distance in PDF points from the left side.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  data = [["The quick brown fox jumped over the lazy dogs."]] * 2
-
-  text "Left:"
-  table data, :position => :left
-  move_down 10
-
-  text "Center:"
-  table data, :position => :center
-  move_down 10
-
-  text "Right:"
-  table data, :position => :right
-  move_down 10
-
-  text "100pt:"
-  table data, :position => 100
-end

data/manual/table/row_colors.rb

@@ -1,20 +0,0 @@
-# encoding: utf-8
-#
-# One of the most common table styling techniques is to stripe the rows with
-# alternating colors.
-#
-# There is one helper just for that. Just provide the <code>:row_colors</code>
-# option an array with color values.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  data = [["This row should have one color"],
-          ["And this row should have another"]]
-  
-  data += [["..."]] * 10
-  
-  table(data, :row_colors => ["F0F0F0", "FFFFCC"])
-end

data/manual/table/span.rb

@@ -1,30 +0,0 @@
-# encoding: utf-8
-#
-# Table cells can span multiple columns, rows, or both. When building a cell,
-# use the hash argument constructor with a <code>:colspan</code> and/or
-# <code>:rowspan</code> argument. Row or column spanning must be specified when
-# building the data array; you can't set the span in the table's initialization
-# block. This is because cells are laid out in the grid before that block is
-# called, so that references to row and column numbers make sense.
-#
-# Cells are laid out in the order given, skipping any positions spanned by
-# previously instantiated cells. Therefore, a cell with <code>rowspan: 2</code>
-# will be missing at least one cell in the row below it. See the code and table
-# below for an example.
-#
-# It is illegal to overlap cells via spanning. A
-# <code>Prawn::Errors::InvalidTableSpan</code> error will be raised if spans
-# would cause cells to overlap.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  table([
-    ["A", {:content => "2x1", :colspan => 2}, "B"],
-    [{:content => "1x2", :rowspan => 2}, "C", "D", "E"],
-    [{:content => "2x2", :colspan => 2, :rowspan => 2}, "F"],
-    ["G", "H"]
-  ])
-end

data/manual/table/style.rb

@@ -1,22 +0,0 @@
-# encoding: utf-8
-#
-# We've seen how to apply styles to a selection of cells by setting the
-# individual properties. Another option is to use the <code>style</code> method
-#
-# <code>style</code> lets us define multiple properties at once with a hash. It
-# also accepts a block that will be called for each cell and can be used for
-# some complex styling.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  table([[""] * 8] * 8) do
-    cells.style(:width => 24, :height => 24)
-    
-    cells.style do |c| 
-      c.background_color = ((c.row + c.column) % 2).zero? ? '000000' : 'ffffff'
-    end
-  end
-end

data/manual/table/table.rb

@@ -1,52 +0,0 @@
-# encoding: utf-8
-#
-# Examples for tables.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-Prawn::Example.generate("table.pdf", :page_size => "FOLIO") do
-  
-  package "table" do |p|
-    
-    p.section "Basics" do |s|
-      s.example "creation"
-      s.example "content_and_subtables"
-      s.example "flow_and_header"
-      s.example "position"
-    end
-    
-    p.section "Styling" do |s|
-      s.example "column_widths"
-      s.example "width"
-      s.example "row_colors"
-      s.example "cell_dimensions"
-      s.example "cell_borders_and_bg"
-      s.example "cell_border_lines"
-      s.example "cell_text"
-      s.example "image_cells"
-      s.example "span"
-      s.example "before_rendering_page"
-    end
-    
-    p.section "Initializer Block" do |s|
-      s.example "basic_block"
-      s.example "filtering"
-      s.example "style"
-    end
-    
-    p.intro do
-      prose("Prawn comes with table support out of the box. Tables can be styled in whatever way you see fit. The whole table, rows, columns and cells can be styled independently from each other.
-
-      The examples show:")
-
-      list( "How to create tables",
-            "What content can be placed on tables",
-            "Subtables (or tables within tables)",
-            "How to style the whole table",
-            "How to use initializer blocks to style only specific portions of the table"
-          )
-    end
-    
-  end
-end

data/manual/table/width.rb

@@ -1,27 +0,0 @@
-# encoding: utf-8
-#
-# The default table width depends on the content provided. It will expand up
-# to the current bounding box width to fit the content. If you want the table to
-# have a fixed width no matter the content you may use the <code>:width</code>
-# option to manually set the width.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  text "Normal width:"
-  table [%w[A B C]]
-  move_down 20
-  
-  text "Fixed width:"
-  table([%w[A B C]], :width => 300)
-  move_down 20
-
-  text "Normal width:"
-  table([["A", "Blah " * 20, "C"]])
-  move_down 20
-  
-  text "Fixed width:"
-  table([["A", "Blah " * 20, "C"]], :width => 300)
-end

data/manual/templates/full_template.rb

@@ -1,25 +0,0 @@
-# encoding: utf-8
-#
-#<b>NOTE: Templates are currently unmaintained and may be removed by Prawn 1.0!</b>
-#
-# You may load another PDF while creating a new one. Just pass the loaded PDF
-# filename to the <code>:template</code> option when creating/generating the new
-# PDF.
-#
-# The provided PDF will be loaded and its first page will be set as the
-# current page. If you'd like to resume the document you may take advantage of
-# two helpers: <code>page_count</code> and <code>go_to_page</code>.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = "#{Prawn::DATADIR}/pdfs/multipage_template.pdf"
-
-Prawn::Example.generate("full_template.pdf", :template => filename) do
-  go_to_page(page_count)
-
-  start_new_page
-
-  text "Previous pages and content imported.", :align => :center
-  text "This page and content is brand new.",  :align => :center
-end

data/manual/templates/page_template.rb

@@ -1,48 +0,0 @@
-# encoding: utf-8
-# <b>NOTE: Templates are currently unmaintained and may be removed by Prawn 1.0!</b>
-#
-# If you only need to load some pages from another PDF, you can accomplish it
-# with the <code>start_new_page</code> method. You may pass it a
-# <code>:template</code> option with the path for an existing pdf and a
-# <code>:template_page</code> option to specify which page to load.
-# You can also load a <code>:template</code> using a URI:
-#
-# <code>require 'open-uri'</code>
-#
-# <code>start_new_page(:template => open('url_for_your.pdf'))</code>
-#
-# The following example loads some pages from an existing PDF. If we don't
-# specify the <code>:template_page</code> option, the first page of the template
-# PDF will be loaded. That's what happens on the first load below. Then we load
-# a page by specifying the <code>:template_page</code> option and then we do it
-# again this time adding some content to the loaded page.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  text "Please scan the next 3 pages to see the page templates in action."
-  move_down 10
-  text "You also might want to look at the pdf used as a template: "
-  url = "https://github.com/prawnpdf/prawn/raw/master/data/pdfs/form.pdf"
-  move_down 10
-  
-  formatted_text [{:text => url, :link => url}]
-  
-  filename = "#{Prawn::DATADIR}/pdfs/form.pdf"
-  start_new_page(:template => filename)
-  
-  start_new_page(:template => filename, :template_page => 2)
-  
-  start_new_page(:template => filename, :template_page => 2)
-  
-  fill_color "FF8888"
-  
-  text_box "John Doe", :at => [75, cursor-75]
-  text_box "john@doe.com", :at => [75, cursor-105]
-  text_box "John Doe inc", :at => [75, cursor-135]
-  text_box "You didn't think I'd tell, did you?", :at => [75, cursor-165]
-  
-  fill_color "000000"
-end

data/manual/templates/templates.rb

@@ -1,27 +0,0 @@
-# encoding: utf-8
-#
-# Examples for loading existing pdfs.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-Prawn::Example.generate("templates.pdf", :page_size => "FOLIO") do
-  
-  package "templates" do |p|
-    
-    p.example "full_template", :eval_source => false, :full_source => true
-    p.example "page_template"
-    
-    p.intro do
-      prose("<b>NOTE: Templates are currently unmaintained and may be removed by Prawn 1.0!</b>")
-      prose("Templates let you embed other PDF documents inside the current one.
-
-      The examples show:")
-
-      list( "How to load the whole content from another PDF",
-            "How to load single pages from another PDF"
-          )
-    end
-    
-  end
-end

data/manual/text/group.rb

@@ -1,29 +0,0 @@
-# encoding: utf-8
-#
-# Sometimes free flowing text might look ugly, specially when a paragraph is
-# split between two pages. Using a positioned text box just to overcome this
-# nuisance is not the right choice.
-#
-# You probably want to use the <code>group</code> method instead. It will try
-# to render the block within the current page. If the content would fall to a
-# new page it just renders everything on the following page. If the block cannot
-# be executed on a single blank page a <code>CannotGroup</code> exception will
-# be raised.
-#
-# So if you can split your text blocks in paragraphs you can have every
-# paragraph contained on a single page.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  move_cursor_to 80
-  text "Let's move to the end of the page so that you can see group in action."
-  
-  group do
-    text "This block of text was too big to be rendered on the bottom of the " +
-         " previous page. So it was rendered entirely on this new page. " +
-         " _ " * 200
-  end
-end

data/spec/acceptance/png.rb

@@ -1,23 +0,0 @@
-require_relative "../../lib/prawn"
-
-images = [
-      ["Type 0", "#{Prawn::BASEDIR}/data/images/web-links.png"],
-      ["Type 2", "#{Prawn::BASEDIR}/data/images/ruport.png"],
-      ["Type 3", "#{Prawn::BASEDIR}/data/images/indexed_color.png"],
-      ["Type 4", "#{Prawn::BASEDIR}/data/images/page_white_text.png"],
-      ["Type 6", "#{Prawn::BASEDIR}/data/images/dice.png"],
-]
-
-Prawn::Document.generate("png_types.pdf", :page_size => "A5") do
-  images.each do |header, file|
-    start_new_page unless header.include?("0")
-
-    fill_color "FF0000"
-
-    fill_rectangle bounds.top_left, bounds.width, bounds.height
-    text header 
-    
-    image file, :at => [50,450]
-  end 
-end
-

data/spec/annotations_spec.rb

@@ -1,74 +0,0 @@
-# encoding: utf-8
-
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
-
-
-describe "When creating annotations" do
-
-  before(:each) { create_pdf }
-
-  it "should append annotation to current page" do
-    @pdf.start_new_page
-    @pdf.annotate(:Rect => [0,0,10,10], :Subtype => :Text, :Contents => "Hello world!")
-    PDF::Reader.open(StringIO.new(@pdf.render)) do |pdf|
-      pdf.page(1).attributes[:Annots].should be_nil
-      pdf.page(2).attributes[:Annots].size.should == 1
-    end
-  end
-
-  it "should force :Type to be :Annot" do
-    opts = @pdf.annotate(:Rect => [0,0,10,10], :Subtype => :Text, :Contents => "Hello world!")
-    opts[:Type].should == :Annot
-    opts = @pdf.annotate(:Type => :Bogus, :Rect => [0,0,10,10], :Subtype => :Text, :Contents => "Hello world!")
-    opts[:Type].should == :Annot
-  end
-
-end
-
-describe "When creating text annotations" do
-
-  before(:each) do
-    @rect = [0,0,10,10]
-    @content = "Hello, world!"
-    create_pdf
-  end
-
-  it "should build appropriate annotation" do
-    opts = @pdf.text_annotation(@rect, @content)
-    opts[:Type].should == :Annot
-    opts[:Subtype].should == :Text
-    opts[:Rect].should == @rect
-    opts[:Contents].should == @content
-  end
-
-  it "should merge extra options" do
-    opts = @pdf.text_annotation(@rect, @content, :Open => true, :Subtype => :Bogus)
-    opts[:Subtype].should == :Text
-    opts[:Open].should == true
-  end
-
-end
-
-describe "When creating link annotations" do
-
-  before(:each) do
-    @rect = [0,0,10,10]
-    @dest = "home"
-    create_pdf
-  end
-
-  it "should build appropriate annotation" do
-    opts = @pdf.link_annotation(@rect, :Dest => @dest)
-    opts[:Type].should == :Annot
-    opts[:Subtype].should == :Link
-    opts[:Rect].should == @rect
-    opts[:Dest].should == @dest
-  end
-
-  it "should merge extra options" do
-    opts = @pdf.link_annotation(@rect, :Dest => @dest, :Subtype => :Bogus)
-    opts[:Subtype].should == :Link
-    opts[:Dest].should == @dest
-  end
-
-end