reportbuilder 1.4.0 → 1.4.1

data/History.txt

@@ -1,3 +1,10 @@
+=== 1.4.1 / 2011-02-03
+* Add generic ReportBuilder#save method, to save according to extension
+* Better titles layout on PDF.
+* Pages could be numbered on PDF
+* Small fixed on docs
+* Test works on Ruby 1.9.3
+
 === 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

data/README.txt

@@ -4,7 +4,7 @@
 
 == DESCRIPTION:
 
-Report Abstract Interface. Creates text, html and rtf output, based on a common framework.
+Report Abstract Interface. Creates text, html, pdf and rtf output, based on a common framework.
 
 == FEATURES
 
@@ -62,8 +62,13 @@ http://github.com/clbustos/reportbuilder
 * RMagick, only to generate text output of images (see examples/image.rb)
 
 == INSTALL:
+With RVM
 
-  sudo gem install reportbuilder
+  $ gem install reportbuilder
+
+without RVM
+
+  $ sudo gem install reportbuilder
 
 == LICENSE:
 

data/Rakefile

@@ -16,6 +16,4 @@ Hoe.spec 'reportbuilder' do
   self.extra_dev_deps << ["nokogiri", "~>1.4"] 
 end
 
-
-
 # vim: syntax=ruby

data/lib/reportbuilder.rb

@@ -5,7 +5,7 @@ require 'reportbuilder/image'
 require 'reportbuilder/graph'
 
 # = Report Abstract Interface.
-# Creates text, html and rtf output, based on a common framework.
+# Creates text, html,pdf and rtf output, based on a common framework.
 #
 # == Use
 # 
@@ -52,7 +52,7 @@ class ReportBuilder
   # Doesn't print a title if set to true
   attr_accessor :no_title
   # ReportBuilder version
-  VERSION = '1.4.0'
+  VERSION = '1.4.1'
   DATA_DIR=File.dirname(__FILE__)+"/../data"
   FormatNotFound=Class.new(Exception)
   # Available formats
@@ -76,11 +76,9 @@ class ReportBuilder
   # * &block: block executed inside builder 
   def self.generate(options=Hash.new, &block)
     options[:filename]||=nil
+    options[:format]||=self.get_format_from_filename(options[:filename]) if options[:filename]    
     options[:format]||="text"
     
-    if options[:filename] and options[:filename]=~/\.(\w+?)$/
-      options[:format]=$1
-    end
     file=options.delete(:filename)
     format=options.delete(:format)
     rb=ReportBuilder.new(options)
@@ -88,7 +86,7 @@ class ReportBuilder
     begin
       builder=builder_for(format).new(rb, options)
     rescue NameError  => e
-      raise FormatNotFound.new(e)
+      raise ReportBuilder::FormatNotFound.new(e)
     end
     builder.parse
     out=builder.out
@@ -100,11 +98,17 @@ class ReportBuilder
       out
     end
   end
+  def self.get_format_from_filename(filename)
+    filename=~/\.(\w+?)$/
+    $1
+  end
   # Create a new Report
   def initialize(options=Hash.new, &block)
     options[:name]||="Report "+Time.new.to_s
+    
     @no_title=options.delete :no_title
     @name=options.delete :name 
+    @name=@name.to_s
     @options=options
     @elements=Array.new
     add(block) if block
@@ -134,6 +138,10 @@ class ReportBuilder
     gen.parse
     gen.out
   end
+  def save(filename)
+    format=(self.class).get_format_from_filename(filename)
+    send("save_#{format}", filename)
+  end
   # Save a rtf file
   def save_rtf(filename)
     gen = Builder::Rtf.new(self,@options)

data/lib/reportbuilder/builder.rb

@@ -59,15 +59,16 @@ class ReportBuilder
     end    
     
     # Parse one object, using this workflow
-    # * If is a block, evaluate it
-    # * Use #report_building_CODE, where CODE is one of the codes defined by #code
+    # * If is a block, evaluate it in the context of the builder
+    # * Use method #report_building_CODE, where CODE is one of the codes defined by
+    #   ReportBuilder::Builder.code
     # * Use #report_building
     # * Use #to_s
     def parse_element(element)
       methods=self.class.code.map {|m| ("report_building_"+m).intern}
       
       if element.is_a? Proc
-        element.arity<1 ? instance_eval(&element) : element.call(self)
+        element.arity < 1 ? instance_eval(&element) : element.call(self)
       elsif method=methods.find {|m| element.respond_to? m}
         element.send(method, self)
       elsif element.respond_to? :report_building
@@ -127,7 +128,6 @@ class ReportBuilder
       @toc.push([anchor, name, parse_level])
       anchor
     end
-
     # Add an entry for  table index.
     # Returns the name of the anchor
     def table_entry(name)

data/lib/reportbuilder/builder/pdf.rb

@@ -17,6 +17,7 @@ class ReportBuilder
         super
         @pdf=Prawn::Document.new(options)
         @pdf.font_size=@options[:font_size]
+
       end
       
       def self.code
@@ -36,13 +37,14 @@ class ReportBuilder
       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
+        @pdf.pad 5 do 
+          @pdf.text t, {:size=>15-level*1.5,:align=>:center}
+        end
       end
       # Add preformatted text. 
       def preformatted(t)
@@ -50,12 +52,18 @@ class ReportBuilder
           @pdf.text t 
         end
       end
+      def at_end
+        @pdf.number_pages(@options[:number_pages], [@pdf.bounds.right - 50, 0]  ) if @options[:numerate_pages]        
+        
+      end
       # Returns pdf code for report
       def out
+        at_end
         @pdf.render
       end
       # Save pdf file
       def save(filename)
+        at_end
         @pdf.render_file(filename)
       end
       # Do nothing on this builder 

data/lib/reportbuilder/section.rb

@@ -27,7 +27,7 @@ class ReportBuilder::Section
   end
 
   def report_building_text(builder)
-    builder.text(("="*builder.parse_level)+" "+name)
+    builder.text(("="*builder.parse_level)+" #{name}")
     builder.parse_cycle(self)
   end
 

data/lib/reportbuilder/table/pdfbuilder.rb

@@ -11,16 +11,22 @@ class ReportBuilder
         t=@element
         @pdf=@builder.pdf
         @rowspans=[]
-        @pdf.text t.name, :size=>14
+        if !t.nil? and t.name!=""
+          @pdf.pad_top 10 do
+            @pdf.text t.name, {:size=>12, :align=>:center} 
+          end
+        end
         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')
+        @pdf.pad(10) do 
+          if has_header
+            t_options=t.options.merge({:headers=>t.header, :align_headers=>:center})
+            @pdf.table(t.rows.map{|row| parse_row(row)}, t_options) do
+              row(0).style(:font_style => :bold, :background_color => 'cccccc')
+            end
+          else
+            @pdf.table(t.rows.map{|row| parse_row(row)}, t.options) 
           end
-        else
-          @pdf.table(t.rows.map{|row| parse_row(row)}, t.options) 
         end
       end
       # Parse a row

data/test/helper_test.rb

@@ -19,4 +19,4 @@ require 'tempfile'
 
 
 
-MiniTest::Unit.autorun
+MiniTest::Unit.autorun

data/test/test_graph.rb

@@ -1,4 +1,4 @@
-require(File.dirname(__FILE__)+"/helper_test.rb")
+require(File.expand_path(File.dirname(__FILE__)+"/helper_test.rb"))
 
 class TestReportbuilderGraph < MiniTest::Unit::TestCase
   def test_init_without_block

data/test/test_graph_html_flot.rb

@@ -1,4 +1,4 @@
-require(File.dirname(__FILE__)+"/helper_test.rb")
+require(File.expand_path(File.dirname(__FILE__)+"/helper_test.rb"))
 require 'json'
 class TestReportbuilderGraphHtmlFlot < MiniTest::Unit::TestCase
   def setup

data/test/test_graph_html_jqplot.rb

@@ -1,4 +1,4 @@
-require(File.dirname(__FILE__)+"/helper_test.rb")
+require(File.expand_path(File.dirname(__FILE__)+"/helper_test.rb"))
 require 'json'
 class TestReportbuilderGraphHtmlJqplot < MiniTest::Unit::TestCase
   def setup

data/test/test_html.rb

@@ -1,5 +1,4 @@
-require(File.dirname(__FILE__)+"/helper_test.rb")
-
+require(File.expand_path(File.dirname(__FILE__)+"/helper_test.rb"))
 class TestReportbuilderHtml < MiniTest::Unit::TestCase
   def setup
     @tmpdir=Dir::mktmpdir

data/test/test_image.rb

@@ -1,4 +1,4 @@
-require(File.dirname(__FILE__)+"/helper_test.rb")
+require(File.expand_path(File.dirname(__FILE__)+"/helper_test.rb"))
 
 class TestReportbuilderImage < MiniTest::Unit::TestCase
   def setup

data/test/test_reportbuilder.rb

@@ -1,4 +1,4 @@
-require(File.dirname(__FILE__)+"/helper_test.rb")
+require(File.expand_path(File.dirname(__FILE__)+"/helper_test.rb"))
 class TestReportbuilder < MiniTest::Unit::TestCase
   def setup
     @datadir=File.dirname(__FILE__)+"/../data"
@@ -89,24 +89,27 @@ class TestReportbuilder < MiniTest::Unit::TestCase
   
   def test_generate
     txt_file=Tempfile.new("test.txt")
+    
     ReportBuilder.generate(:name=>"Test", :filename=>txt_file.path) do
       text("hola")
     end
     
-    text=ReportBuilder.generate(:format=>:text,:name=>"Test") do 
+    text=ReportBuilder.generate(:format=>:text, :name=>"Test") do 
       text("hola")
     end
+    
     assert_match(/^Test\nhola$/,text)
     assert_equal(text, File.read(txt_file.path))
+    
     html_file=Tempfile.new("test.html")
     html=ReportBuilder.generate(:name=>"Test", :format=>:html) do
       text("hola")
     end
+    
     ReportBuilder.generate(:name=>"Test", :filename=>html_file.path,:format=>:html) do
       text("hola")
     end
     
     assert_equal(html,File.read(html_file.path))
-    
   end
 end

data/test/test_section.rb

@@ -1,4 +1,4 @@
-require(File.dirname(__FILE__)+"/helper_test.rb")
+require(File.expand_path(File.dirname(__FILE__)+"/helper_test.rb"))
 
 class TestReportbuilderSection < MiniTest::Unit::TestCase
   def setup

data/test/test_table.rb

@@ -1,5 +1,4 @@
-require(File.dirname(__FILE__)+"/helper_test.rb")
-
+require(File.expand_path(File.dirname(__FILE__)+"/helper_test.rb"))
 class TestReportbuilderTable < MiniTest::Unit::TestCase
   def setup
     super

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: reportbuilder
 version: !ruby/object:Gem::Version 
-  hash: 7
   prerelease: false
   segments: 
   - 1
   - 4
-  - 0
-  version: 1.4.0
+  - 1
+  version: 1.4.1
 platform: ruby
 authors: 
 - Claudio Bustos
@@ -36,7 +35,7 @@ cert_chain:
   rpP0jjs0
   -----END CERTIFICATE-----
 
-date: 2010-11-26 00:00:00 -03:00
+date: 2011-02-03 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +46,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
         segments: 
         - 0
         - 4
@@ -63,7 +61,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
         segments: 
         - 1
         - 2
@@ -78,7 +75,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 55
         segments: 
         - 0
         - 8
@@ -94,7 +90,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 57
         segments: 
         - 0
         - 9
@@ -102,54 +97,36 @@ dependencies:
         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: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 0
-        - 4
-        version: 2.0.4
-  type: :development
-  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: nokogiri
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 1
         - 4
         version: "1.4"
   type: :development
-  version_requirements: *id006
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
         segments: 
         - 2
-        - 7
+        - 8
         - 0
-        version: 2.7.0
+        version: 2.8.0
   type: :development
-  version_requirements: *id007
-description: Report Abstract Interface. Creates text, html and rtf output, based on a common framework.
+  version_requirements: *id006
+description: Report Abstract Interface. Creates text, html, pdf and rtf output, based on a common framework.
 email: 
 - clbustos_at_gmail.com
 executables: 
@@ -585,7 +562,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -594,7 +570,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"