reportbuilder 1.0.0 → 1.1.0

data/History.txt

@@ -1,3 +1,5 @@
+=== 1.1.0 / 2009-03-23
+* Added rtf support
 === 1.0.0 / 2009-03-22
 Change of API:
  * Deleted "add_" before methods

data/Manifest.txt

@@ -6,18 +6,24 @@ bin/reportbuilder
 data/reportbuilder.css
 data/reportbuilder.js
 data/sheep.jpg
+examples/generic_interface.rb
+examples/images.rb
+examples/rtf.rb
+examples/test.rtf
+examples/using_a_block.rb
 lib/reportbuilder.rb
 lib/reportbuilder/generator.rb
 lib/reportbuilder/generator/html.rb
+lib/reportbuilder/generator/rtf.rb
 lib/reportbuilder/generator/text.rb
 lib/reportbuilder/image.rb
 lib/reportbuilder/section.rb
 lib/reportbuilder/table.rb
 lib/reportbuilder/table/htmlgenerator.rb
+lib/reportbuilder/table/rtfgenerator.rb
 lib/reportbuilder/table/textgenerator.rb
 test/test_html.rb
 test/test_image.rb
 test/test_reportbuilder.rb
 test/test_section.rb
 test/test_table.rb
-

data/README.txt

@@ -4,7 +4,7 @@
 
 == DESCRIPTION:
 
-Report Abstract Interface. Creates text and html output, based on a common framework.
+Report Abstract Interface. Creates text, html and rtf output, based on a common framework.
 
 == FEATURES
 
@@ -27,6 +27,7 @@ Report Abstract Interface. Creates text and html output, based on a common frame
     rb.add("Another text") # used directly
     rb.name="Text output"
     puts rb.to_text
+    rb.save_rtf("test.rtf") # You could save files, too
 
 * Using a block, you can control directly the generator
 

data/Rakefile

@@ -11,7 +11,8 @@ Hoe.spec 'reportbuilder' do
   self.rubyforge_name = 'ruby-statsample'
   self.developer('Claudio Bustos', 'clbustos_at_gmail.com')
   self.url = "http://rubyforge.org/projects/ruby-statsample/"
-  self.extra_dev_deps << ["hpricot", "~>0.8"]
+  self.extra_deps << ["rtf","~>0.1"]
+  self.extra_dev_deps << ["hpricot", "~>0.8"] 
 end
 
 # vim: syntax=ruby

data/examples/generic_interface.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.dirname(__FILE__)+"/../lib")
+require "reportbuilder"    
+rb=ReportBuilder.new
+rb.add(2) # Int#to_s used
+section=ReportBuilder::Section.new(:name=>"Section 1")
+table=ReportBuilder::Table.new(:name=>"Table", :header=>%w{id name})
+table.row([1,"John"])
+table.hr
+table.row([2,"Peter"])
+
+section.add(table) # Section is a container for other methods
+rb.add(section) # table have a #report_building method
+rb.add("Another text") # used directly
+rb.name="Text output"
+puts rb.to_text
+rb.name="Html output"
+puts rb.to_html

data/examples/images.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)+"/../lib")
+require "reportbuilder"    
+rb=ReportBuilder.new do
+  image("../data/sheep.jpg")
+end
+rb.name="Text output"
+puts rb.to_text
+

data/examples/rtf.rb

@@ -0,0 +1,32 @@
+$:.unshift(File.dirname(__FILE__)+"/../lib")
+require "reportbuilder"    
+rb=ReportBuilder.new do
+  text("First Paragraph")
+  section(:name=>"Section 1") do
+    section(:name=>"Section 1.1") do
+      text("Paragraph inside section 1.1")
+    end
+    table(:name=>"Table", :header=>%w{id name}) do
+      row([1,"John"])
+      row([2,"Peter"])
+      hr
+      row([3,"John"])
+      row([4,"Peter"])
+      
+    end
+  end
+  preformatted <<-EOL
+def test_generate
+  html=ReportBuilder.generate(:format=>:html, :name=>@title, :directory=>@tmpdir) do 
+    text("hola")
+  end
+  doc=Hpricot(html)
+  assert_equal(@title, doc.search("head/title").inner_html)
+  assert_equal(@title, doc.search("body/h1").inner_html)
+  assert_equal("hola", doc.search("body/p").inner_html)
+end  
+EOL
+    text("Last paragraph")
+end
+rb.name="RTF output"
+puts rb.to_rtf

data/examples/test.rtf

@@ -0,0 +1,103 @@
+{\rtf1\ansi\deff0\deflang2057\plain\fs24\fet1
+{\fonttbl
+{\f0\froman Times New Roman;}
+{\f1\fmodern Courier;}
+}
+{\info
+{\createim\yr2010\mo3\dy23\hr13\min11}
+}
+\paperw11907\paperh16840\margl1800\margr1800\margt1440\margb1440
+{\pard
+First Paragraph
+\par}
+{\pard\qc
+{\b\f0\fs34
+Section 1
+}
+\par}
+{\pard\qc
+{\b\f0\fs32
+Section 1.1
+}
+\par}
+{\pard
+Paragraph inside section 1.1
+\par}
+\trowd\tgraph100
+\clbrdrt\brdrw3\brdrs\clbrdrl\brdrw3\brdrs\clbrdrb\brdrw3\brdrs\clbrdrr\brdrw3\brdrs\cellx400
+\clbrdrt\brdrw3\brdrs\clbrdrl\brdrw3\brdrs\clbrdrb\brdrw3\brdrs\clbrdrr\brdrw3\brdrs\cellx1400
+\pard\intbl
+id
+\cell
+\pard\intbl
+name
+\cell
+\row
+\trowd\tgraph100
+\clbrdrt\brdrw3\brdrs\clbrdrl\brdrw3\brdrs\clbrdrb\brdrw3\brdrs\clbrdrr\brdrw3\brdrs\cellx400
+\clbrdrt\brdrw3\brdrs\clbrdrl\brdrw3\brdrs\clbrdrb\brdrw3\brdrs\clbrdrr\brdrw3\brdrs\cellx1400
+\pard\intbl
+1
+\cell
+\pard\intbl
+John
+\cell
+\row
+\trowd\tgraph100
+\clbrdrt\brdrw3\brdrs\clbrdrl\brdrw3\brdrs\clbrdrb\brdrw3\brdrs\clbrdrr\brdrw3\brdrs\cellx400
+\clbrdrt\brdrw3\brdrs\clbrdrl\brdrw3\brdrs\clbrdrb\brdrw3\brdrs\clbrdrr\brdrw3\brdrs\cellx1400
+\pard\intbl
+2
+\cell
+\pard\intbl
+Peter
+\cell
+\row
+\trowd\tgraph100
+\clbrdrt\brdrw25\brdrs\clbrdrl\brdrw3\brdrs\clbrdrb\brdrw3\brdrs\clbrdrr\brdrw3\brdrs\cellx400
+\clbrdrt\brdrw25\brdrs\clbrdrl\brdrw3\brdrs\clbrdrb\brdrw3\brdrs\clbrdrr\brdrw3\brdrs\cellx1400
+\pard\intbl
+3
+\cell
+\pard\intbl
+John
+\cell
+\row
+\trowd\tgraph100
+\clbrdrt\brdrw3\brdrs\clbrdrl\brdrw3\brdrs\clbrdrb\brdrw3\brdrs\clbrdrr\brdrw3\brdrs\cellx400
+\clbrdrt\brdrw3\brdrs\clbrdrl\brdrw3\brdrs\clbrdrb\brdrw3\brdrs\clbrdrr\brdrw3\brdrs\cellx1400
+\pard\intbl
+4
+\cell
+\pard\intbl
+Peter
+\cell
+\row
+{\pard\ql
+{\f1\fs20
+def test_generate
+{\line}
+  html=ReportBuilder.generate(:format=>:html, :name=>@title, :directory=>@tmpdir) do 
+{\line}
+    text("hola")
+{\line}
+  end
+{\line}
+  doc=Hpricot(html)
+{\line}
+  assert_equal(@title, doc.search("head/title").inner_html)
+{\line}
+  assert_equal(@title, doc.search("body/h1").inner_html)
+{\line}
+  assert_equal("hola", doc.search("body/p").inner_html)
+{\line}
+  
+{\line}
+end  
+{\line}
+}
+\par}
+{\pard
+Last paragraph
+\par}
+}

data/examples/using_a_block.rb

@@ -0,0 +1,18 @@
+$:.unshift(File.dirname(__FILE__)+"/../lib")
+require "reportbuilder"    
+rb=ReportBuilder.new do
+  text("2")
+  section(:name=>"Section 1") do
+    table(:name=>"Table", :header=>%w{id name}) do
+      row([1,"John"])
+      hr
+      row([2,"Peter"])
+    end
+  end
+  preformatted("Another Text")
+end
+rb.name="Text output"
+puts rb.to_text
+rb.name="Html output"
+puts rb.to_html
+

data/lib/reportbuilder.rb

@@ -51,7 +51,7 @@ class ReportBuilder
   # Doesn't print a title if set to true
   attr_accessor :no_title
   
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
   # Generates and optionally save the report on one function
   def self.generate(options=Hash.new, &block)
     options[:filename]||=nil
@@ -101,6 +101,18 @@ class ReportBuilder
     gen.parse
     gen.out
   end
+  # Returns a RTF output
+  def to_rtf()
+    gen = Generator::Rtf.new(self,@options)
+    gen.parse
+    gen.out
+  end  
+  # Save a rtf file
+  def save_rtf(filename)
+    gen = Generator::Rtf.new(self,@options)
+    gen.parse
+    gen.save(filename)
+  end
   # Save an html file
   def save_html(file)
     options=@options.dup

data/lib/reportbuilder/generator.rb

@@ -7,6 +7,8 @@ class ReportBuilder
     attr_reader :parse_level
     # Options for Generator. Passed by ReportBuilder class on creation
     attr_reader :options
+    # Entries for Table of Contents
+    attr_reader :toc
     def initialize(builder, options)
       @builder=builder
       @parse_level=0
@@ -112,3 +114,5 @@ end
 
 require 'reportbuilder/generator/text'
 require 'reportbuilder/generator/html'
+require 'reportbuilder/generator/rtf'
+

data/lib/reportbuilder/generator/html.rb

@@ -3,7 +3,6 @@ class ReportBuilder
   class Generator
     class Html < Generator
       PREFIX="html"
-      attr_reader :toc
       attr_reader :directory
       def initialize(builder, options)
         super

data/lib/reportbuilder/generator/rtf.rb

@@ -0,0 +1,75 @@
+require 'rtf'
+class ReportBuilder
+  class Generator
+    class Rtf < Generator
+      PREFIX="rtf"
+      attr_accessor :rtf
+      attr_reader :options
+      include RTF
+      def initialize(builder, options)
+        super
+        @font=Font.new(Font::ROMAN, @options[:font])
+        
+        @rtf = Document.new(@font)
+        @pre_char = CharacterStyle.new
+        
+        @pre_char.font = Font.new(Font::MODERN, 'Courier')
+        @pre_char.font_size=@options[:font_size]
+        
+        @pre_par  = ParagraphStyle.new
+        
+        @header_styles=Hash.new {|h,k|
+          cs=CharacterStyle.new
+          cs.font=@font
+          cs.font_size=@options[:font_size]+(8-k)*2
+          cs.bold=true
+          ps=ParagraphStyle.new
+          ps.justification = ParagraphStyle::CENTER_JUSTIFY
+          h[k]={:cs=>cs, :ps=>ps}
+        }
+        
+      end
+      def default_options
+        
+        {
+          :font=>'Times New Roman',
+          :font_size=>20,
+          :table_border_width=>3,
+          :table_hr_width=>25
+        }
+      end
+      def text(*args,&block)
+        if args.size==1 and args[0].is_a? String and !block
+          @rtf.paragraph << args[0]
+        else
+          @rtf.paragraph(*args,&block)
+        end
+      end
+      def header(level,t)
+        @rtf.paragraph(@header_styles[level][:ps]) do |n1|
+          n1.apply(@header_styles[level][:cs]) do |n2|
+            n2 << t
+          end
+        end
+      end
+      def preformatted(t)
+        @rtf.paragraph(@pre_par) do |n1|
+          n1.apply(@pre_char) do |n2|
+            t.split("\n").each do |line|
+              n2 << line
+              n2.line_break
+            end
+          end
+        end
+        
+      end
+      def out
+        @rtf.to_rtf
+      end
+      def save(filename)
+        File.open(filename,'wb')  {|file| file.write(@rtf.to_rtf)
+        }
+      end
+    end
+  end
+end

data/lib/reportbuilder/section.rb

@@ -31,14 +31,18 @@ class ReportBuilder::Section
     generator.parse_cycle(self)
   end
 
-  def report_building_html(generator)
-    htag="h#{generator.parse_level+1}"
-    anchor=generator.toc_entry(name)
+  def report_building_html(g)
+    htag="h#{g.parse_level+1}"
+    anchor=g.toc_entry(name)
     generator.html "<div class='section'><#{htag}>#{name}</#{htag}><a name='#{anchor}'></a>"
-    generator.parse_cycle(self)
-    generator.html "</div>"
+    g.parse_cycle(self)
+    g.html "</div>"
+  end
+  def report_building_rtf(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

@@ -56,6 +56,9 @@ class ReportBuilder
     def row(row)
       @rows.push(row)
     end
+    def n_columns
+      @n_columns||=calculate_widths.size
+    end
     # Adds a horizontal rule
     #   table.add_hr
     def hr
@@ -67,9 +70,12 @@ class ReportBuilder
     def rowspan(data,n)
       Rowspan.new(data,n)
     end
+    # Count the numbers of rows without :hr
+    def n_rows_no_hr
+      @rows.inject(0) {|ac,v| ac+(v==:hr ? 0 : 1)}
+    end
     # Adds a colspan on a cell
     #   table.add_row(["a",table.colspan("b",2)])
-
     def colspan(data,n)
       Colspan.new(data,n)
     end
@@ -97,6 +103,7 @@ class ReportBuilder
           end
         }
       }
+      @max_cols
     end
     def report_building_text(generator)
       require 'reportbuilder/table/textgenerator'
@@ -108,7 +115,11 @@ class ReportBuilder
       table_generator=ReportBuilder::Table::HtmlGenerator.new(generator, self)
       table_generator.generate
     end
-
+    def report_building_rtf(generator)
+      require 'reportbuilder/table/rtfgenerator'
+      table_generator=ReportBuilder::Table::RtfGenerator.new(generator, self)
+      table_generator.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/rtfgenerator.rb

@@ -0,0 +1,66 @@
+class ReportBuilder
+  class Table
+    class RtfGenerator < ElementGenerator
+      include RTF
+      def generate()
+        @t=@element
+        @rtf=@generator.rtf
+        max_cols=@t.calculate_widths
+        n_rows=@t.n_rows_no_hr+(@t.header.size>0 ? 1: 0)
+        args=[n_rows, @t.n_columns]+max_cols.map{|m| m*@generator.options[:font_size]*10}
+        @table=@rtf.table(*args)
+        @table.border_width=@generator.options[:table_border_width]
+        @rowspans=[]
+        if @t.header.size>0
+          @t.header.each_with_index do |th,i|
+            @table[0][i] << th
+          end
+        end
+        row_i=1
+        next_with_hr=false
+        @t.rows.each_with_index{|row|
+          if row==:hr
+            next_with_hr=true
+            # Nothing
+          else
+            parse_row(row,row_i)
+            if next_with_hr
+              create_hr(row_i)
+              next_with_hr=false
+            end
+            row_i+=1
+          end
+        }
+        
+      end
+      def create_hr(row_i)
+        (0...@t.n_columns).each {|i|
+          @table[row_i][i].top_border_width=@generator.options[:table_hr_width]
+        }
+      end
+      
+      def parse_row(row,row_i)
+        t=@element
+        row_ary=[]
+        colspan_i=0
+        row.each_index do |i|
+          if !@rowspans[i].nil? and @rowspans[i]>0
+            @rowspans[i]-=1
+          elsif colspan_i>0
+            colspan_i-=1
+          elsif row[i].is_a? Table::Colspan
+            @table[row_i][i] << row[i].data            
+            colspan_i=row[i].cols-1
+          elsif row[i].nil?
+            @table[row_i][i] << ""
+          elsif row[i].is_a? Table::Rowspan
+            @table[row_i][i] << row[i].data
+            @rowspans[i]=row[i].rows-1
+          else
+            @table[row_i][i] << row[i].to_s
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Claudio Bustos
@@ -18,9 +18,22 @@ date: 2010-03-23 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rubyforge
+  name: rtf
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -30,11 +43,11 @@ dependencies:
         - 4
         version: 2.0.4
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: gemcutter
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -44,11 +57,11 @@ dependencies:
         - 0
         version: 0.5.0
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: hpricot
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -57,11 +70,11 @@ dependencies:
         - 8
         version: "0.8"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -71,8 +84,8 @@ dependencies:
         - 1
         version: 2.5.1
   type: :development
-  version_requirements: *id004
-description: Report Abstract Interface. Creates text and html output, based on a common framework.
+  version_requirements: *id005
+description: Report Abstract Interface. Creates text, html and rtf output, based on a common framework.
 email: 
 - clbustos_at_gmail.com
 executables: 
@@ -92,14 +105,21 @@ files:
 - data/reportbuilder.css
 - data/reportbuilder.js
 - data/sheep.jpg
+- examples/generic_interface.rb
+- examples/images.rb
+- examples/rtf.rb
+- examples/test.rtf
+- examples/using_a_block.rb
 - lib/reportbuilder.rb
 - lib/reportbuilder/generator.rb
 - lib/reportbuilder/generator/html.rb
+- lib/reportbuilder/generator/rtf.rb
 - lib/reportbuilder/generator/text.rb
 - lib/reportbuilder/image.rb
 - lib/reportbuilder/section.rb
 - lib/reportbuilder/table.rb
 - lib/reportbuilder/table/htmlgenerator.rb
+- lib/reportbuilder/table/rtfgenerator.rb
 - lib/reportbuilder/table/textgenerator.rb
 - test/test_html.rb
 - test/test_image.rb