prawn 0.14.0 → 0.15.0

data/lib/prawn/text.rb

@@ -8,7 +8,8 @@
 
 require "zlib"
 
-require_relative "../pdf/core/text"
+require "pdf/core/text"
+
 require_relative "text/formatted"
 require_relative "text/box"
 
@@ -25,6 +26,8 @@ module Prawn
     # Soft Hyphen (invisible, except when causing a line break)
     Prawn::Text::SHY = "­"
 
+    # @group Stable API
+    
     # If you want text to flow onto a new page or between columns, this is the
     # method to use. If, instead, if you want to place bounded text outside of
     # the flow of a document (for captions, labels, charts, etc.), use Text::Box
@@ -170,7 +173,6 @@ module Prawn
       formatted_text(array, options)
     end
 
-
     # Draws formatted text to the page.
     # Formatted text is comprised of an array of hashes, where each hash defines
     # text and format information. See Text::Formatted#formatted_text_box for

data/lib/prawn/text/box.rb

@@ -11,6 +11,7 @@ require_relative "formatted/box"
 
 module Prawn
   module Text
+    # @group Stable API
 
     # Draws the requested text into a box. When the text overflows
     # the rectangle, you shrink to fit, or truncate the text. Text
@@ -121,6 +122,8 @@ module Prawn
       box.render
     end
 
+    # @group Experimental API
+
     # Generally, one would use the Prawn::Text#text_box convenience
     # method. However, using Text::Box.new in conjunction with
     # #render(:dry_run=> true) enables one to do look-ahead calculations prior

data/lib/prawn/text/formatted/arranger.rb

@@ -11,6 +11,8 @@ module Prawn
   module Text
     module Formatted #:nodoc:
 
+      # @private
+      
       class Arranger #:nodoc:
         attr_reader :max_line_height
         attr_reader :max_descender

data/lib/prawn/text/formatted/box.rb

@@ -10,7 +10,8 @@
 module Prawn
   module Text
     module Formatted
-
+      # @group Stable API
+      
       # Draws the requested formatted text into a box. When the text overflows
       # the rectangle shrink to fit or truncate the text. Text boxes are
       # independent of the document y position.
@@ -100,19 +101,7 @@ module Prawn
       class Box
         include Prawn::Text::Formatted::Wrap
 
-        def valid_options
-          PDF::Core::Text::VALID_OPTIONS + [:at, :height, :width,
-                                              :align, :valign,
-                                              :rotate, :rotate_around,
-                                              :overflow, :min_font_size,
-                                              :leading, :character_spacing,
-                                              :mode, :single_line,
-                                              :skip_encoding,
-                                              :document,
-                                              :direction,
-                                              :fallback_fonts,
-                                              :draw_text_callback]
-        end
+        # @group Experimental API
 
         # The text that was successfully printed (or, if <tt>dry_run</tt> was
         # used, the text that would have been successfully printed)
@@ -145,42 +134,6 @@ module Prawn
           line_height - (ascender + descender)
         end
 
-        #
-        # Example (see Prawn::Text::Core::Formatted::Wrap for what is required
-        # of the wrap method if you want to override the default wrapping
-        # algorithm):
-        #
-        #
-        #   module MyWrap
-        #
-        #     def wrap(array)
-        #       initialize_wrap([{ :text => 'all your base are belong to us' }])
-        #       @line_wrap.wrap_line(:document => @document,
-        #                            :kerning => @kerning,
-        #                            :width => 10000,
-        #                            :arranger => @arranger)
-        #       fragment = @arranger.retrieve_fragment
-        #       format_and_draw_fragment(fragment, 0, @line_wrap.width, 0)
-        #       []
-        #     end
-        #
-        #   end
-        #
-        #   Prawn::Text::Formatted::Box.extensions << MyWrap
-        #
-        #   box = Prawn::Text::Formatted::Box.new('hello world')
-        #   box.render('why can't I print anything other than' +
-        #              '"all your base are belong to us"?')
-        #
-        #
-        def self.extensions
-          @extensions ||= []
-        end
-
-        def self.inherited(base) #:nodoc:
-          extensions.each { |e| base.extensions << e }
-        end
-
         # See Prawn::Text#text_box for valid options
         #
         def initialize(formatted_text, options={})
@@ -339,6 +292,58 @@ module Prawn
           end
         end
 
+        # @group Extension API
+        
+        # Example (see Prawn::Text::Core::Formatted::Wrap for what is required
+        # of the wrap method if you want to override the default wrapping
+        # algorithm):
+        #
+        #
+        #   module MyWrap
+        #
+        #     def wrap(array)
+        #       initialize_wrap([{ :text => 'all your base are belong to us' }])
+        #       @line_wrap.wrap_line(:document => @document,
+        #                            :kerning => @kerning,
+        #                            :width => 10000,
+        #                            :arranger => @arranger)
+        #       fragment = @arranger.retrieve_fragment
+        #       format_and_draw_fragment(fragment, 0, @line_wrap.width, 0)
+        #       []
+        #     end
+        #
+        #   end
+        #
+        #   Prawn::Text::Formatted::Box.extensions << MyWrap
+        #
+        #   box = Prawn::Text::Formatted::Box.new('hello world')
+        #   box.render('why can't I print anything other than' +
+        #              '"all your base are belong to us"?')
+        #
+        #
+        def self.extensions
+          @extensions ||= []
+        end
+
+        # @private
+        def self.inherited(base)
+          extensions.each { |e| base.extensions << e }
+        end
+
+        def valid_options
+          PDF::Core::Text::VALID_OPTIONS + [:at, :height, :width,
+                                              :align, :valign,
+                                              :rotate, :rotate_around,
+                                              :overflow, :min_font_size,
+                                              :leading, :character_spacing,
+                                              :mode, :single_line,
+                                              :skip_encoding,
+                                              :document,
+                                              :direction,
+                                              :fallback_fonts,
+                                              :draw_text_callback]
+        end
+
         private
 
         def original_text

data/lib/prawn/text/formatted/fragment.rb

@@ -10,9 +10,11 @@ module Prawn
   module Text
     module Formatted
 
+
       # Prawn::Text::Formatted::Fragment is a state store for a formatted text
       # fragment. It does not render anything.
       #
+      # @private
       class Fragment
 
         attr_reader :format_state, :text

data/lib/prawn/text/formatted/line_wrap.rb

@@ -12,6 +12,7 @@ module Prawn
   module Text
     module Formatted #:nodoc:
 
+      # @private
       class LineWrap #:nodoc:
 
         # The width of the last wrapped line

data/lib/prawn/text/formatted/parser.rb

@@ -13,6 +13,8 @@ module Prawn
     module Formatted
 
       class Parser
+        # @group Extension API
+
         PARSER_REGEX = begin
           regex_string = "\n|" +
                          "<b>|</b>|" +

data/lib/prawn/text/formatted/wrap.rb

@@ -4,6 +4,8 @@ require_relative "arranger"
 module Prawn
   module Text
     module Formatted #:nodoc:
+      # @private
+
       module Wrap #:nodoc:
 
         def initialize(array, options)

data/lib/prawn/utilities.rb

@@ -16,7 +16,8 @@ module Prawn
   # But at the same time, we don't want to throw away thread safety
   # We have two interchangeable thread-safe cache implementations:
 
-  class SynchronizedCache
+  # @private
+  class SynchronizedCache 
     # As an optimization, this could access the hash directly on VMs with a global interpreter lock (like MRI)
     def initialize
       @cache = {}
@@ -29,8 +30,9 @@ module Prawn
       @mutex.synchronize { @cache[key] = value }
     end
   end
-
-  class ThreadLocalCache
+  
+  # @private
+  class ThreadLocalCache     
     def initialize
       @cache_id = "cache_#{self.object_id}".to_sym
     end

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/text/group.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 #
+# <strong>NOTE: This feature is currently not working correctly</strong>
+#
 # 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.

data/manual/text/text.rb

@@ -14,7 +14,7 @@ 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 "group", :eval_source => false
       s.example "column_box"
     end
     

data/prawn.gemspec

@@ -20,9 +20,8 @@ Gem::Specification.new do |spec|
   spec.rubyforge_project = "prawn"
   spec.licenses = ['RUBY', 'GPL-2', 'GPL-3']
 
-  spec.add_dependency('pdf-reader', '~>1.2')
-  spec.add_dependency('ttfunk', '~>1.0.3')
-  spec.add_dependency('ruby-rc4')
+  spec.add_dependency('ttfunk', '~> 1.1.0')
+  spec.add_dependency('pdf-core', "~> 0.1.3")
 
   spec.add_development_dependency('pdf-inspector', '~> 1.1.0')
   spec.add_development_dependency('coderay', '~> 1.0.7')
@@ -30,6 +29,8 @@ Gem::Specification.new do |spec|
   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

data/spec/grid_spec.rb

@@ -13,6 +13,17 @@ describe "A document's grid" do
     @pdf.grid.gutter.should == 0.1
   end
 
+  it "should allow re-definition of a grid" do
+    @pdf.define_grid(:columns => 5, :rows => 8, :gutter => 0.1)
+    @pdf.grid.columns.should == 5
+    @pdf.grid.rows.should == 8
+    @pdf.grid.gutter.should == 0.1
+    @pdf.define_grid(:columns => 3, :rows => 6, :gutter => 0.1)
+    @pdf.grid.columns.should == 3
+    @pdf.grid.rows.should == 6
+    @pdf.grid.gutter.should == 0.1
+  end
+
   describe "when a grid is defined" do
     before do
       @num_columns = 5

data/spec/object_store_spec.rb

@@ -15,49 +15,7 @@ describe "Prawn::ObjectStore" do
     store.root.data[:Pages].should == store.pages
   end
 
-  it "should import objects from an existing PDF" do
-    filename = "#{Prawn::BASEDIR}/spec/data/curves.pdf"
-    store = PDF::Core::ObjectStore.new(:template => filename)
-    store.size.should == 5
-  end
-
-  it "should point to existing roots when importing objects from an existing PDF" do
-    filename = "#{Prawn::BASEDIR}/spec/data/curves.pdf"
-    store = PDF::Core::ObjectStore.new(:template => filename)
-    store.info.class.should == PDF::Core::Reference
-    store.root.class.should == PDF::Core::Reference
-  end
-
-  it "should initialize with pages when importing objects from an existing PDF" do
-    filename = "#{Prawn::BASEDIR}/spec/data/curves.pdf"
-    store = PDF::Core::ObjectStore.new(:template => filename)
-    store.pages.data[:Count].should == 1
-  end
-
-  it "should import all objects from a PDF that has an indirect reference in a stream dict" do
-    filename = "#{Prawn::DATADIR}/pdfs/indirect_reference.pdf"
-    store = PDF::Core::ObjectStore.new(:template => filename)
-    store.size.should == 8
-  end
-
-  it "should raise_error ArgumentError when given a file that doesn exist as a template" do
-    filename = "not_really_there.pdf"
-
-    lambda { PDF::Core::ObjectStore.new(:template => filename) }.should raise_error(ArgumentError)
-  end
-
-  it "should raise_error PDF::Core::Errors::TemplateError when given a non PDF as a template" do
-    filename = "#{Prawn::DATADIR}/images/dice.png"
-
-    lambda { PDF::Core::ObjectStore.new(:template => filename) }.should raise_error(PDF::Core::Errors::TemplateError)
-  end
-
-  it "should raise_error PDF::Core::Errors::TemplateError when given an encrypted PDF as a template" do
-    filename = "#{Prawn::DATADIR}/pdfs/encrypted.pdf"
-
-    lambda { PDF::Core::ObjectStore.new(:template => filename) }.should raise_error(PDF::Core::Errors::TemplateError)
-  end
-
+ 
   it "should add to its objects when ref() is called" do
     count = @store.size
     @store.ref("blah")
@@ -121,56 +79,3 @@ describe "Prawn::ObjectStore#compact" do
     store.map{ |o| o.identifier }.should == (1..store.size).to_a
   end
 end
-
-describe "Prawn::ObjectStorie#object_id_for_page" do
-  it "should return the object ID of an imported template page" do
-    filename = "#{Prawn::DATADIR}/pdfs/hexagon.pdf"
-    store = PDF::Core::ObjectStore.new(:template => filename)
-    store.object_id_for_page(0).should == 4
-  end
-
-  it "should return the object ID of the first imported template page" do
-    filename = "#{Prawn::DATADIR}/pdfs/two_hexagons.pdf"
-    store = PDF::Core::ObjectStore.new(:template => filename)
-    store.object_id_for_page(1).should == 4
-  end
-
-  it "should return the object ID of the last imported template page" do
-    filename = "#{Prawn::DATADIR}/pdfs/two_hexagons.pdf"
-    store = PDF::Core::ObjectStore.new(:template => filename)
-    store.object_id_for_page(-1).should == 6
-  end
-
-  it "should return the object ID of the first page of a template that uses nested Pages" do
-    filename = "#{Prawn::DATADIR}/pdfs/nested_pages.pdf"
-    store = PDF::Core::ObjectStore.new(:template => filename)
-    store.object_id_for_page(1).should == 5
-  end
-
-  it "should return the object ID of the last page of a template that uses nested Pages" do
-    filename = "#{Prawn::DATADIR}/pdfs/nested_pages.pdf"
-    store = PDF::Core::ObjectStore.new(:template => filename)
-    store.object_id_for_page(-1).should == 8
-  end
-
-  it "should return nil if given an invalid page number" do
-    filename = "#{Prawn::DATADIR}/pdfs/hexagon.pdf"
-    store = PDF::Core::ObjectStore.new(:template => filename)
-    store.object_id_for_page(10).should == nil
-  end
-
-  it "should return nil if given an invalid page number" do
-    store = PDF::Core::ObjectStore.new
-    store.object_id_for_page(10).should == nil
-  end
-
-  it "should accept a stream instead of a filename" do
-    example = Prawn::Document.new()
-    example.text "An example doc, created in memory"
-    example.start_new_page
-    StringIO.open(example.render) do |stream|
-      @pdf = PDF::Core::ObjectStore.new(:template => stream)
-    end
-    @pdf.page_count.should == 2
-  end
-end

data/spec/reference_spec.rb

@@ -3,63 +3,6 @@
 require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 
 describe "A Reference object" do
-  it "should produce a PDF reference on #to_s call" do
-    ref = PDF::Core::Reference(1,true)
-    ref.to_s.should == "1 0 R"
-  end
-
-  it "should allow changing generation number" do
-    ref = PDF::Core::Reference(1,true)
-    ref.gen = 1
-    ref.to_s.should == "1 1 R"
-  end
-
-  it "should generate a valid PDF object for the referenced data" do
-    ref = PDF::Core::Reference(2,[1,"foo"])
-    ref.object.should == "2 0 obj\n#{PDF::Core::PdfObject([1,"foo"])}\nendobj\n"
-  end
-
-  it "should include stream fileds in dictionary when serializing" do
-     ref = PDF::Core::Reference(1, {})
-     ref.stream << 'Hello'
-     ref.object.should == "1 0 obj\n<< /Length 5\n>>\nstream\nHello\nendstream\nendobj\n"
-  end
-
-  it "should append data to stream when #<< is used" do
-     ref = PDF::Core::Reference(1, {})
-     ref << "BT\n/F1 12 Tf\n72 712 Td\n( A stream ) Tj\nET"
-     ref.object.should == "1 0 obj\n<< /Length 41\n>>\nstream"+
-                           "\nBT\n/F1 12 Tf\n72 712 Td\n( A stream ) Tj\nET" +
-                           "\nendstream\nendobj\n"
-  end
-
-  it "should copy the data and stream from another ref on #replace" do
-    from = PDF::Core::Reference(3, {:foo => 'bar'})
-    from << "has a stream too"
-
-    to = PDF::Core::Reference(4, {:foo => 'baz'})
-    to.replace from
-
-    # should preserve identifier but copy data and stream
-    to.identifier.should == 4
-    to.data.should == from.data
-    to.stream.should == from.stream
-  end
-
-  it "should copy a compressed stream from a compressed ref on #replace" do
-    from = PDF::Core::Reference(5, {:foo => 'bar'})
-    from << "has a stream too " * 20
-    from.stream.compress!
-
-    to = PDF::Core::Reference(6, {:foo => 'baz'})
-    to.replace from
-
-    to.identifier.should == 6
-    to.data.should == from.data
-    to.stream.should == from.stream
-    to.stream.compressed?.should == true
-  end
-
   describe "generated via Prawn::Document" do
     it "should return a proper reference on ref!" do
       pdf = Prawn::Document.new