prawn 1.0.0.rc2 → 1.0.0

data/manual/graphics/common_lines.rb

@@ -15,6 +15,8 @@ require File.expand_path(File.join(File.dirname(__FILE__),
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::Example.generate(filename) do
   stroke_axis
+
+  stroke_color "ff0000"
   
   stroke do
     # just lower the current y position

data/manual/graphics/helper.rb

@@ -1,12 +1,15 @@
 # encoding: utf-8
 #
 # To produce this manual we use the <code>stroke_axis</code> helper method
-# within examples but it is not from the Prawn API. It is defined on this file:
-#
-# https://github.com/prawnpdf/prawn/blob/master/manual/example_helper.rb
+# within the examples.
 #
 # <code>stroke_axis</code> prints the x and y axis for the current bounding box
-# with markers in 100 increments
+# with markers in 100 increments. The defaults can be changed with various
+# options.
+#
+# Note that the examples define a custom <code>:height</code> option so that
+# only the example canvas is used (as seen with the output of the first line of
+# the example code).
 #
 require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
@@ -14,4 +17,8 @@ require File.expand_path(File.join(File.dirname(__FILE__),
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::Example.generate(filename) do
   stroke_axis
+  stroke_axis(:at => [70, 70], :height => 200, :step_length => 50,
+              :negative_axes_length => 5, :color => '0000FF')
+  stroke_axis(:at => [140, 140], :width => 200, :height => cursor.to_i - 140,
+              :step_length => 20, :negative_axes_length => 40, :color => 'FF00')
 end

data/manual/graphics/stroke_dash.rb

@@ -1,14 +1,17 @@
 # encoding: utf-8
 #
-# This sets the dashed pattern for lines and curves.
-#
-# The (dash) length defines how long each dash will be.
+# This sets the dashed pattern for lines and curves. The (dash) length defines
+# how long each dash will be.
 #
 # The <code>:space</code> option defines the length of the space between the
 # dashes.
 #
 # The <code>:phase</code> option defines the start point of the sequence of
-# dashes and spaces. 
+# dashes and spaces.
+#
+# Complex dash patterns can be specified by using an array with alternating
+# dash/gap lengths for the first parameter (note that the <code>:space</code>
+# option is ignored in this case).
 #
 require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
@@ -16,27 +19,29 @@ require File.expand_path(File.join(File.dirname(__FILE__),
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::Example.generate(filename) do
   stroke_axis
-  
+
+  dash([1, 2, 3, 2, 1, 5], :phase => 6)
+  stroke_horizontal_line 50, 500, :at => 230
+  dash([1, 2, 3, 4, 5, 6, 7, 8])
+  stroke_horizontal_line 50, 500, :at => 220
+
   base_y = 210
-  
+
   24.times do |i|
     length = (i / 4) + 1
     space = length            # space between dashes same length as dash
     phase = 0                 # start with dash
-    
+
     case i % 4
-    when 0
-      base_y -= 5
-    when 1
-      phase = length          # start with space between dashes
-    when 2
-      space = length * 0.5    # space between dashes half as long as dash
+    when 0 then base_y -= 5
+    when 1 then phase = length        # start with space between dashes
+    when 2 then space = length * 0.5  # space between dashes half as long as dash
     when 3
       space = length * 0.5    # space between dashes half as long as dash
       phase = length          # start with space between dashes
     end
     base_y -= 5
-    
+
     dash(length, :space => space, :phase => phase)
     stroke_horizontal_line 50, 500, :at => base_y - (2 * i)
   end

data/manual/manual/cover.rb

@@ -22,5 +22,21 @@ Prawn::Example.generate(filename) do
                         :font => 'Courier',
                         :size => 60}
                      ], :at => [170, cursor - 160])
+
+  if Dir.exist?("#{Prawn::BASEDIR}/.git")
+    #long git commit hash
+    #commit = `git show --pretty=%H`
+    #short git commit hash
+    commit = `git show --pretty=%h`
+    git_commit = "git commit: #{commit}"
+  else
+    git_commit = ""
+  end
+
+  formatted_text_box([  {:text => "Last Update: #{Time.now.strftime("%Y-%m-%d")}\n"+
+                                  "Prawn Version: #{Prawn::VERSION}\n"+
+                                  git_commit,
+                         :size => 12}
+                    ],   :at => [390, cursor - 620])
   
 end

data/manual/manual/manual.rb

@@ -3,19 +3,16 @@
 # Generates the Prawn by example manual.
 #
 
-Encoding.default_external = "UTF-8" if defined? Encoding
+Encoding.default_external = Encoding::UTF_8
 
 require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
 Prawn::Example.generate("manual.pdf",
-                        :optimize_objects => true,
-                        :compress => false,
                         :skip_page_creation => true,
                         :page_size => "FOLIO") do
 
   load_page "cover"
-  load_page "foreword"
   load_page "how_to_read_this_manual"
 
   # Core chapters
@@ -31,6 +28,5 @@ Prawn::Example.generate("manual.pdf",
   load_package "document_and_page_options"
   load_package "outline"
   load_package "repeatable_content"
-  load_package "templates"
   load_package "security"
 end

data/manual/text/fallback_fonts.rb

@@ -14,12 +14,12 @@ Prawn::Example.generate(filename) do
     :normal => { :file => file, :font => "Kai" }
   }
   
-  file = "#{Prawn::DATADIR}/fonts/Action Man.dfont"
-  font_families["Action Man"] = {
-    :normal => { :file => file, :font => "ActionMan" },
+  file = "#{Prawn::DATADIR}/fonts/Panic+Sans.dfont"
+  font_families["Panic Sans"] = {
+    :normal => { :file => file, :font => "PanicSans" },
   }
   
-  font("Action Man") do
+  font("Panic Sans") do
     text("When fallback fonts are included, each glyph will be rendered " +
          "using the first font that includes the glyph, starting with the " +
          "current font and then moving through the fallback fonts from left " +

data/manual/text/formatted_text.rb

@@ -17,9 +17,9 @@
 # <code>:character_spacing</code> (additional space between the characters),
 # <code>:font</code> (the name of a registered font), <code>:color</code> (the
 # same input accepted by <code>fill_color</code> and <code>stroke_color</code>),
-# <code>:link</code> (an URL to create a link), and <code>:anchor</code> (a
-# destination inside the document).
-#
+# <code>:link</code> (an URL to create a link), and <code>:local</code> 
+# (a link to a local file).
+
 require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
@@ -35,9 +35,9 @@ Prawn::Example.generate(filename) do
                    { :text => "Link to the wiki. ",
                      :color => "0000FF",
                      :link => "https://github.com/prawnpdf/prawn/wiki" },
-                   { :text => "Link to the Text Reference. "  ,
+                   { :text => "Link to a local file. ",
                      :color => "0000FF",
-                     :anchor => "Text Reference" }
+                     :local => "./local_file.txt" }
                  ]
   
   formatted_text_box [ { :text => "Just your regular" },

data/manual/text/inline.rb

@@ -9,8 +9,7 @@
 # The following tags accept specific attributes: <code>font</code> accepts
 # <code>size</code>, <code>name</code>, and <code>character_spacing</code>;
 # <code>color</code> accepts <code>rgb</code> and <code>cmyk</code>;
-# <code>link</code> accepts <code>href</code> for external links and
-# <code>anchor</code> for internal links.
+# <code>link</code> accepts <code>href</code> for external links.
 #
 require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
@@ -37,7 +36,6 @@ Prawn::Example.generate(filename) do
   
   text "This an external link to the " +
        "<u><link href='https://github.com/prawnpdf/prawn/wiki'>Prawn wiki" +
-       "</link></u> and this is a link to the " +
-       "<u><link anchor='Text Reference'>Text Reference</link></u> anchor",
+       "</link></u>",
        :inline_format => true
 end

data/manual/text/registering_families.rb

@@ -14,26 +14,26 @@ require File.expand_path(File.join(File.dirname(__FILE__),
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::Example.generate(filename) do
   # Registering a single TTF font
-  font_families.update("Chalkboard" => {
-    :normal => "#{Prawn::DATADIR}/fonts/Chalkboard.ttf"
+  font_families.update("DejaVu Sans" => {
+    :normal => "#{Prawn::DATADIR}/fonts/DejaVuSans.ttf"
   })
   
-  font("Chalkboard") do
-    text "Using the Chalkboard font providing only its name to the font method"
+  font("DejaVu Sans") do
+    text "Using the DejaVu Sans font providing only its name to the font method"
   end
   move_down 20
   
   # Registering a DFONT package
-  font_path = "#{Prawn::DATADIR}/fonts/Action Man.dfont"
-  font_families.update("Action Man" => {
-    :normal      => { :file => font_path, :font => "ActionMan" },
-    :italic      => { :file => font_path, :font => "ActionMan-Italic" },
-    :bold        => { :file => font_path, :font => "ActionMan-Bold" },
-    :bold_italic => { :file => font_path, :font => "ActionMan-BoldItalic" }
+  font_path = "#{Prawn::DATADIR}/fonts/Panic+Sans.dfont"
+  font_families.update("Panic Sans" => {
+    :normal      => { :file => font_path, :font => "PanicSans" },
+    :italic      => { :file => font_path, :font => "PanicSans-Italic" },
+    :bold        => { :file => font_path, :font => "PanicSans-Bold" },
+    :bold_italic => { :file => font_path, :font => "PanicSans-BoldItalic" }
   })
   
-  font "Action Man"
-  text "Also using the Action Man by providing only its name"
+  font "Panic Sans"
+  text "Also using Panic Sans by providing only its name"
   move_down 20
   
   text "Taking <b>advantage</b> of the <i>inline formatting</i>",

data/manual/text/single_usage.rb

@@ -19,8 +19,8 @@ require File.expand_path(File.join(File.dirname(__FILE__),
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::Example.generate(filename) do
   # Using a TTF font file
-  font("#{Prawn::DATADIR}/fonts/Chalkboard.ttf") do
-    text "Written with the Chalkboard TTF font."
+  font("#{Prawn::DATADIR}/fonts/DejaVuSans.ttf") do
+    text "Written with the DejaVu Sans TTF font."
   end
   move_down 20
   
@@ -28,8 +28,8 @@ Prawn::Example.generate(filename) do
   move_down 20
   
   # Using an DFONT font file
-  font("#{Prawn::DATADIR}/fonts/Action Man.dfont") do
-    text "Written with the Action Man DFONT font"
+  font("#{Prawn::DATADIR}/fonts/Panic+Sans.dfont") do
+    text "Written with the Panic Sans DFONT font"
   end
   move_down 20
 

data/manual/text/text.rb

@@ -14,7 +14,6 @@ Prawn::Example.generate("text.pdf", :page_size => "FOLIO") do
       s.example "positioned_text"
       s.example "text_box_overflow"
       s.example "text_box_excess"
-      s.example "group"
       s.example "column_box"
     end
     
@@ -59,7 +58,6 @@ Prawn::Example.generate("text.pdf", :page_size => "FOLIO") do
       list( "Text that flows from page to page automatically starting new pages when necessary",
             "How to use text boxes and place them on specific positions",
             "What to do when a text box is too small to fit its content",
-            "How to proceed when you want to prevent paragraphs from splitting between pages",
             "Flowing text in columns",
             "How to change the text style configuring font, size, alignment and many other settings",
             "How to style specific portions of a text with inline styling and formatted text",

data/prawn.gemspec

@@ -3,27 +3,35 @@ Gem::Specification.new do |spec|
   spec.version = File.read(File.expand_path('VERSION', File.dirname(__FILE__))).strip
   spec.platform = Gem::Platform::RUBY
   spec.summary = "A fast and nimble PDF generator for Ruby"
-  spec.files =  Dir.glob("{examples,lib,spec,data,manual}/**/**/*") +
-    ["Rakefile", "prawn.gemspec", "COPYING", "LICENSE", "GPLv2", "GPLv3",
-     "Gemfile"]
+  spec.files =  Dir.glob("{examples,lib,spec,manual}/**/**/*") +
+                Dir.glob("data/{encodings,images,pdfs}/*") +
+                Dir.glob("data/fonts/{MustRead.html,*.afm}") +
+                ["data/shift_jis_text.txt"] +
+                ["Rakefile", "prawn.gemspec", "Gemfile",
+                 "COPYING", "LICENSE", "GPLv2", "GPLv3",
+                 ".yardopts"]
   spec.require_path = "lib"
-  spec.required_ruby_version = '>= 1.8.7'
+  spec.required_ruby_version = '>= 1.9.3'
   spec.required_rubygems_version = ">= 1.3.6"
 
   spec.test_files = Dir[ "spec/*_spec.rb" ]
-  spec.extra_rdoc_files = %w{README.md LICENSE COPYING GPLv2 GPLv3}
-  spec.rdoc_options << '--title' << 'Prawn Documentation' <<
-                       '--main'  << 'README.md' << '-q'
   spec.authors = ["Gregory Brown","Brad Ediger","Daniel Nelson","Jonathan Greenberg","James Healy"]
   spec.email = ["gregory.t.brown@gmail.com","brad@bradediger.com","dnelson@bluejade.com","greenberg@entryway.net","jimmy@deefa.com"]
   spec.rubyforge_project = "prawn"
-  spec.add_dependency('pdf-reader', '>=0.9.0', '<2.0')
-  spec.add_dependency('ttfunk', '~>1.0.3')
-  spec.add_dependency('ruby-rc4')
-  spec.add_dependency('afm')
-  spec.add_development_dependency('pdf-inspector', '~> 1.0.1')
+  spec.licenses = ['RUBY', 'GPL-2', 'GPL-3']
+
+  spec.add_dependency('ttfunk', '~> 1.1.1')
+  spec.add_dependency('pdf-core', "~> 0.2.2")
+
+  spec.add_development_dependency('pdf-inspector', '~> 1.1.0')
   spec.add_development_dependency('coderay', '~> 1.0.7')
-  spec.add_development_dependency('rdoc')
+  spec.add_development_dependency('yard')
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('mocha')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('simplecov')
+  spec.add_development_dependency('pdf-reader', '~>1.2')
+
   spec.homepage = "http://prawn.majesticseacreature.com"
   spec.description = <<END_DESC
   Prawn is a fast, tiny, and nimble PDF generator for Ruby

data/spec/acceptance/png.rb

@@ -0,0 +1,23 @@
+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,35 +1,19 @@
 # encoding: utf-8
 
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")  
-                               
-class PageAnnotations
-  attr_reader :pages
-
-  def self.parse(document)
-    receiver = new
-    PDF::Reader.string(document.render, receiver)
-    return receiver
-  end
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 
-  def initialize
-    @pages = []
-  end
 
-  def begin_page(params)
-    @pages << params
-  end
-end
+describe "When creating annotations" do
 
-describe "When creating annotations" do 
- 
   before(:each) { create_pdf }
-  
-  it "should append annotation to current page" do 
+
+  it "should append annotation to current page" do
     @pdf.start_new_page
     @pdf.annotate(:Rect => [0,0,10,10], :Subtype => :Text, :Contents => "Hello world!")
-    obj = PageAnnotations.parse(@pdf)
-    obj.pages[0][:Annots].nil?.should == true
-    obj.pages[1][:Annots].length.should == 1
+    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
@@ -42,14 +26,14 @@ describe "When creating annotations" do
 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 
+
+  it "should build appropriate annotation" do
     opts = @pdf.text_annotation(@rect, @content)
     opts[:Type].should == :Annot
     opts[:Subtype].should == :Text
@@ -57,7 +41,7 @@ describe "When creating text annotations" do
     opts[:Contents].should == @content
   end
 
-  it "should merge extra options" do 
+  it "should merge extra options" do
     opts = @pdf.text_annotation(@rect, @content, :Open => true, :Subtype => :Bogus)
     opts[:Subtype].should == :Text
     opts[:Open].should == true
@@ -66,14 +50,14 @@ describe "When creating text annotations" do
 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 
+
+  it "should build appropriate annotation" do
     opts = @pdf.link_annotation(@rect, :Dest => @dest)
     opts[:Type].should == :Annot
     opts[:Subtype].should == :Link
@@ -81,7 +65,7 @@ describe "When creating link annotations" do
     opts[:Dest].should == @dest
   end
 
-  it "should merge extra options" do 
+  it "should merge extra options" do
     opts = @pdf.link_annotation(@rect, :Dest => @dest, :Subtype => :Bogus)
     opts[:Subtype].should == :Link
     opts[:Dest].should == @dest