reportbuilder 1.3.0 → 1.4.0

data/History.txt

@@ -1,5 +1,8 @@
-=== 1.3.0 / 2010-11-24
+=== 1.4.0 / 2010-11-26
+* Basic support for pdf creation, using Prawn. SVG insertion could be realized using Prawn-svg (as vectors) or Rmagick (as bitmap)
+* Added SimpleCov support
 
+=== 1.3.0 / 2010-11-24
 * Implemented loading of images via blobs and filenames.
 * SVG are converted to raster before inserted of RTFs
 * First (almost) complete support for Graph API on jqPlot and Flot. Test for Graph and jqPlot wrapper for html

data/Manifest.txt

@@ -385,6 +385,7 @@ examples/using_a_block.rb
 lib/reportbuilder.rb
 lib/reportbuilder/builder.rb
 lib/reportbuilder/builder/html.rb
+lib/reportbuilder/builder/pdf.rb
 lib/reportbuilder/builder/rtf.rb
 lib/reportbuilder/builder/text.rb
 lib/reportbuilder/graph.rb
@@ -394,6 +395,7 @@ lib/reportbuilder/image.rb
 lib/reportbuilder/section.rb
 lib/reportbuilder/table.rb
 lib/reportbuilder/table/htmlbuilder.rb
+lib/reportbuilder/table/pdfbuilder.rb
 lib/reportbuilder/table/rtfbuilder.rb
 lib/reportbuilder/table/textbuilder.rb
 test/helper_test.rb

data/Rakefile

@@ -12,8 +12,10 @@ Hoe.spec 'reportbuilder' do
   self.rubyforge_name = 'ruby-statsample'
   self.developer('Claudio Bustos', 'clbustos_at_gmail.com')
   self.url = "http://ruby-statsample.rubyforge.org/reportbuilder/"
-  self.extra_deps << ["clbustos-rtf","~>0.3.0"] << ['text-table', "~>1.2"]
+  self.extra_deps << ["clbustos-rtf","~>0.4.0"] << ['text-table', "~>1.2"] << ["prawn", "~>0.8.4"] <<  ["prawn-svg","~>0.9.1"]
   self.extra_dev_deps << ["nokogiri", "~>1.4"] 
 end
 
+
+
 # vim: syntax=ruby

data/lib/reportbuilder.rb

@@ -52,7 +52,7 @@ class ReportBuilder
   # Doesn't print a title if set to true
   attr_accessor :no_title
   # ReportBuilder version
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
   DATA_DIR=File.dirname(__FILE__)+"/../data"
   FormatNotFound=Class.new(Exception)
   # Available formats
@@ -118,17 +118,22 @@ class ReportBuilder
     self
   end
   # Returns an Html output
-  def to_html()
+  def to_html
     gen = Builder::Html.new(self,@options)
     gen.parse
     gen.out
   end
   # Returns a RTF output
-  def to_rtf()
+  def to_rtf
     gen = Builder::Rtf.new(self, @options)
     gen.parse
     gen.out
-  end  
+  end
+  def to_pdf
+    gen = Builder::Pdf.new(self, @options)
+    gen.parse
+    gen.out
+  end
   # Save a rtf file
   def save_rtf(filename)
     gen = Builder::Rtf.new(self,@options)
@@ -143,6 +148,14 @@ class ReportBuilder
     gen.parse
     gen.save(file)
   end
+  # Save a pdf file
+  def save_pdf(file)
+    options=@options.dup
+    gen=Builder::Pdf.new(self, options)
+    gen.parse
+    gen.save(file)
+  end  
+
   # Returns a Text output
   def to_text()
     gen=Builder::Text.new(self, @options)
@@ -154,5 +167,6 @@ class ReportBuilder
     gen.parse
      gen.save(file)    
   end
+  
   alias_method :to_s, :to_text
 end

data/lib/reportbuilder/builder.rb

@@ -157,4 +157,4 @@ end
 require 'reportbuilder/builder/text'
 require 'reportbuilder/builder/html'
 require 'reportbuilder/builder/rtf'
-
+require 'reportbuilder/builder/pdf'

data/lib/reportbuilder/builder/pdf.rb

@@ -0,0 +1,67 @@
+require 'prawn'
+require 'prawn-svg'
+require 'pp'
+class ReportBuilder
+  class Builder
+    # Rtf Builder.
+    # Based on Prawn[http://prawn.majesticseacreature.com/]
+    # 
+    class Pdf < Builder
+      # Pdf object.
+      attr_accessor :pdf
+      # Creates a new Pdf object
+      # Params:
+      # * <tt>builder</tt>: A ReportBuilder::Builder object or other with same interface
+      # * <tt>options</tt>: Hash of options.
+      def initialize(builder, options)
+        super
+        @pdf=Prawn::Document.new(options)
+        @pdf.font_size=@options[:font_size]
+      end
+      
+      def self.code
+        %w{pdf}
+      end
+      def parse
+         unless @builder.no_title
+           header(0,@builder.name)
+         end
+        parse_cycle(@builder)
+      end
+      
+      def default_options
+        {
+          :font_size=>12
+        }
+      end
+      # Add a paragraph of text.
+      def text(t)
+
+        @pdf.text(t)
+      end
+      # Add a header of level <tt>level</tt> with text <tt>t</tt>
+      # Level works similar to h
+      def header(level, t)
+        @pdf.text t, :size=>15-level
+      end
+      # Add preformatted text. 
+      def preformatted(t)
+        @pdf.font("Courier") do 
+          @pdf.text t 
+        end
+      end
+      # Returns pdf code for report
+      def out
+        @pdf.render
+      end
+      # Save pdf file
+      def save(filename)
+        @pdf.render_file(filename)
+      end
+      # Do nothing on this builder 
+      def html(t)
+        # Nothing
+      end
+    end
+  end
+end

data/lib/reportbuilder/builder/rtf.rb

@@ -33,14 +33,19 @@ class ReportBuilder
         @header_styles=Hash.new {|h,k|
           cs=CharacterStyle.new
           cs.font=@font
-          cs.font_size=@options[:font_size]+(8-k)*2
+          cs.font_size=@options[:font_size]+(8-k)*1.5
           cs.bold=true
           ps=ParagraphStyle.new
           ps.justification = ParagraphStyle::CENTER_JUSTIFY
           h[k]={:cs=>cs, :ps=>ps}
         }        
       end
-      
+      def parse
+         unless @builder.no_title
+           header(0,@builder.name)
+         end
+        parse_cycle(@builder)
+      end
       def self.code
         %w{rtf}
       end

data/lib/reportbuilder/image.rb

@@ -10,6 +10,7 @@ class ReportBuilder
     attr_accessor :font_cols
     attr_accessor :width
     attr_accessor :height
+    attr_accessor :svg_raster
     attr_accessor :type
     attr_reader :filename
     attr_reader :url
@@ -22,7 +23,7 @@ class ReportBuilder
         @name="Image #{@@n}"
         @@n+=1
       else
-        @name=options[:name]
+        @name=options.delete :name
       end
       
       default_options={
@@ -31,17 +32,23 @@ class ReportBuilder
         ':', '~', '.', ' ' ],
         :font_rows => 8,
         :font_cols => 4,
-        :width=>400,
-        :height=>300
+        :width=>nil,
+        :height=>nil,
+        :svg_raster=>false
       }
-      @options=default_options.merge(options)
+      @options=default_options.merge options
       @options.each {|k,v|
         self.send("#{k}=",v) if self.respond_to? k
       }
     end 
     # Get image_magick version of the image
     def image_magick
-      raise "Must be implemented"
+      if ReportBuilder.has_rmagick?
+        _image_magick if respond_to? :_image_magick
+        
+      else
+        raise "Requires RMagick"
+      end
     end
     # Based on http://rubyquiz.com/quiz50.html
     def report_building_text(builder)
@@ -97,16 +104,20 @@ class ReportBuilder
     end
     # Generate the code for images on html
     def generate_tag_html(builder)
+      attrs=""
+      attrs+=" height='#{:height}' " if :height
+      attrs+=" width='#{:width}' " if :width
+      
       if @type=='svg'
         builder.html("
           <div class='image'>
           <!--[if IE]>
-          <embed class='svg' height='#{@options[:height]}' src='#{@url}' width='#{@options[:width]}'></embed>
+          <embed class='svg'  src='#{@url}' #{attrs}'></embed>
           <![endif]-->
-            <object class='svg' data='#{@url}' height='#{@options[:height]}' type='image/svg+xml' width='#{@options[:width]}'></object>
+            <object class='svg' data='#{@url}' type='image/svg+xml' #{attrs} ></object>
         </div>")
       else
-        builder.html("<img src='#{@url}' alt='#{@options[:alt]}' />")
+        builder.html "<img src='#{@url}' alt='#{alt}' #{attrs} />"
       end
     end
     def create_file(directory)
@@ -116,13 +127,29 @@ class ReportBuilder
       create_file(builder.directory)
       generate_tag_html(builder)
     end
+    def report_building_pdf(builder)
+      require 'tmpdir'
+      dir=Dir::mktmpdir
+      create_file(dir)
+      if @type=='svg'
+        if svg_raster
+          builder.pdf.image(generate_raster_from_svg(dir))
+        else
+        # Prawn-svg is not ready for production.
+        y=builder.pdf.y
+        builder.pdf.svg File.read(@filename), :at=>[0, y-60]
+        end
+      else
+        builder.pdf.image(filename, @options)
+      end
+    end
     # return filename
     def generate_raster_from_svg(dir)
-      
       out_file="#{dir}/#{@id}.png"
-      `rsvg '#{filename}' #{out_file}`
+      image_magick.write(out_file)
       out_file
     end
+    
     def report_building_rtf(builder)
       require 'tmpdir'
       directory=Dir::mktmpdir
@@ -149,8 +176,14 @@ class ReportBuilder
         end
       end
     end
-    def image_magick
-      Magick::Image.from_blob(@blob)
+    def _image_magick
+        that=self
+        img=Magick::Image.from_blob(@blob) { 
+          if that.type=='svg'
+            self.format='SVG'
+          end
+        }
+        img.first
     end
     def create_file(directory)
       FileUtils.mkdir_p directory+"/images"
@@ -171,7 +204,7 @@ class ReportBuilder
       File.basename(@filename)=~/\.(.+)$/
       @type=File.basename($1)
     end
-    def image_magick
+    def _image_magick
       Magick::Image.read(@filename).first
     end
     def create_file(directory)

data/lib/reportbuilder/section.rb

@@ -40,9 +40,14 @@ class ReportBuilder::Section
   end
   def report_building_rtf(g)
     level=g.parse_level
-    g.header(level,name)
+    g.header(level, name)
     g.parse_cycle(self)
   end
+  def report_building_pdf(g)
+    level=g.parse_level
+    g.header(level, name)
+    g.parse_cycle(self)    
+  end
   def add(element)
     if element.is_a? ReportBuilder::Section
       element.parent=self

data/lib/reportbuilder/table.rb

@@ -28,23 +28,24 @@ class ReportBuilder
     # Array of headers
     attr_accessor :header, :name
     # Size for each column
-    attr_reader :max_cols
+    attr_reader   :max_cols
     # Array of rows
-    attr_reader :rows
+    attr_reader   :rows
+    attr_accessor :options
     # Create a new table.
     # Options: :name, :header
     # Use:
     #   table=ReportBuilder::Table.new(:header =>["var1","var2"])
     def initialize(opts=Hash.new, &block)
       raise ArgumentError,"opts should be a Hash" if !opts.is_a? Hash
-      opts=DEFAULT_OPTIONS.merge opts
-      if opts[:name].nil?
+      @options=DEFAULT_OPTIONS.merge opts
+      if @options[:name].nil?
         @name= "Table #{@@n}"
         @@n+=1
       else
-        @name=opts[:name]
+        @name=@options.delete :name
       end
-      @header=opts[:header]
+      @header=@options.delete :header
       @rows=[]
       @max_cols=[]
       if block
@@ -124,6 +125,12 @@ class ReportBuilder
       table_builder=ReportBuilder::Table::RtfBuilder.new(builder, self)
       table_builder.generate
     end
+    def report_building_pdf(builder)
+      require 'reportbuilder/table/pdfbuilder'
+      table_builder=ReportBuilder::Table::PdfBuilder.new(builder, self)
+      table_builder.generate
+    end
+    
     def total_width # :nodoc:
       if @max_cols.size>0
         @max_cols.inject(0){|a,v| a+(v+3)}+1

data/lib/reportbuilder/table/pdfbuilder.rb

@@ -0,0 +1,36 @@
+require 'text-table'
+require 'prawn/table'
+class ReportBuilder
+  class Table
+    # Text Builder for ReportBuilder::Table objects.
+    # 
+    # Uses Aaron Tinio's text-table gem[http://github.com/aptinio/text-table]
+    
+    class PdfBuilder < ElementBuilder
+      def generate()
+        t=@element
+        @pdf=@builder.pdf
+        @rowspans=[]
+        @pdf.text t.name, :size=>14
+        return if t.header.size+t.rows.size==0
+        has_header=t.header.size>0
+        if has_header
+          t_options=t.options.merge({:headers=>t.header})
+          @pdf.table(t.rows.map{|row| parse_row(row)}, t_options) do
+            row(0).style(:style => :bold, :background_color => 'cccccc')
+          end
+        else
+          @pdf.table(t.rows.map{|row| parse_row(row)}, t.options) 
+        end
+      end
+      # Parse a row
+      def parse_row(row)
+        if row==:hr
+          []
+        else
+          row
+        end
+      end
+    end
+  end
+end

data/test/helper_test.rb

@@ -1,4 +1,15 @@
 $:.unshift(File.dirname(__FILE__)+"/../lib")
+begin
+  require 'simplecov'
+  
+  SimpleCov.start do
+  add_filter '/test/'
+  add_filter '/examples/'
+  add_group 'Libraries', 'lib'
+  end
+rescue LoadError
+end
+
 require "reportbuilder"
 require 'nokogiri'
 require 'minitest/unit'

data/test/test_image.rb

@@ -11,7 +11,6 @@ class TestReportbuilderImage < MiniTest::Unit::TestCase
   end
   def test_image_text
     @rp.add(ReportBuilder::ImageFilename.new(@datadir+"/sheep.jpg"))
-
     expected= <<-HERE
 Test
 +--------------------------------+
@@ -49,7 +48,6 @@ Test
     assert_equal(out, File.read(image_blob.filename))
     assert_match(/img src='#{image_blob.url}'/, @rp.to_html)
     assert_match(/\\pict\\picw128\\pich112\\bliptag\d+\\jpegblip/, @rp.to_rtf)
-    
   end
   def test_image_blob_svg
     svg='<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" width="200px" height="50px">

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: reportbuilder
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 7
   prerelease: false
   segments: 
   - 1
-  - 3
+  - 4
   - 0
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Claudio Bustos
@@ -36,7 +36,7 @@ cert_chain:
   rpP0jjs0
   -----END CERTIFICATE-----
 
-date: 2010-11-24 00:00:00 -03:00
+date: 2010-11-26 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,12 +47,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 15
         segments: 
         - 0
-        - 3
+        - 4
         - 0
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -71,9 +71,41 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rubyforge
+  name: prawn
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 8
+        - 4
+        version: 0.8.4
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: prawn-svg
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -85,11 +117,11 @@ dependencies:
         - 4
         version: 2.0.4
   type: :development
-  version_requirements: *id003
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: nokogiri
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -100,11 +132,11 @@ dependencies:
         - 4
         version: "1.4"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -116,7 +148,7 @@ dependencies:
         - 0
         version: 2.7.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id007
 description: Report Abstract Interface. Creates text, html and rtf output, based on a common framework.
 email: 
 - clbustos_at_gmail.com
@@ -516,6 +548,7 @@ files:
 - lib/reportbuilder.rb
 - lib/reportbuilder/builder.rb
 - lib/reportbuilder/builder/html.rb
+- lib/reportbuilder/builder/pdf.rb
 - lib/reportbuilder/builder/rtf.rb
 - lib/reportbuilder/builder/text.rb
 - lib/reportbuilder/graph.rb
@@ -525,6 +558,7 @@ files:
 - lib/reportbuilder/section.rb
 - lib/reportbuilder/table.rb
 - lib/reportbuilder/table/htmlbuilder.rb
+- lib/reportbuilder/table/pdfbuilder.rb
 - lib/reportbuilder/table/rtfbuilder.rb
 - lib/reportbuilder/table/textbuilder.rb
 - test/helper_test.rb