reportbuilder 1.2.0 → 1.2.1

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.2.1 / 2010-03-29
+* ReportBuilder#add returns self, to create chain of adds
+* Changes on documentation, replacing Generator for Builder
+
 === 1.2.0 / 2010-03-28
 *ReporBuilder::Table 
   * Colspans works as expected on Html and Text. On Rtf the cells doesn't merge, because ruby-rtf doesn't support it.

data/README.txt

@@ -21,16 +21,16 @@ Report Abstract Interface. Creates text, html and rtf output, based on a common
   * report_building or
   * to_s
 
-    require "reportbuilder"    
-    rb=ReportBuilder.new
-    rb.add(2) # Int#to_s used
-    table=ReportBuilder::Table.new(:name=>"Table", :header=>%w{id name})
-    table.row([1,"John"])
-    rb.add(table) # table have a #report_building method
-    rb.add("Another text") # used directly
-    rb.name="Text output"
-    puts rb.to_text
-    rb.save_rtf("test.rtf") # You could save files, too
+        require "reportbuilder"    
+        rb=ReportBuilder.new
+        rb.add(2) # Int#to_s used
+        table=ReportBuilder::Table.new(:name=>"Table", :header=>%w{id name})
+        table.row([1,"John"])
+        rb.add(table) # table have a #report_building method
+        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
 
@@ -49,9 +49,9 @@ Report Abstract Interface. Creates text, html and rtf output, based on a common
 
 == DEVELOPERS
 
-If you want to give support to your class, create a method called #report_building(g), which accept a ReportBuilder::Generator as argument. If you need fine control of output according to format, append the name of format, like #report_building_html, #report_building_text.
+If you want to give support to your class, create a method called #report_building(b), which accept a ReportBuilder::Builder as argument. If you need fine control of output according to format, append the name of format, like #report_building_html, #report_building_text.
 
-See ReportBuilder::Generator for API and ReportBuilder::Table, ReportBuilder::Image and ReportBuilder::Section for examples of implementation. Also, Statsample package object uses report_building on almost every class.
+See ReportBuilder::Builder for API and ReportBuilder::Table, ReportBuilder::Image and ReportBuilder::Section for examples of implementation. Also, Statsample package object uses report_building on almost every class.
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -20,6 +20,7 @@ task :release => [:tag] do
 end
 
 task :tag do	
+  sh %(svn commit -m "Version bump: #{ReportBuilder::VERSION}")
 	sh %(svn cp https://ruby-statsample.googlecode.com/svn/reportbuilder/trunk https://ruby-statsample.googlecode.com/svn/reportbuilder/tags/v#{ReportBuilder::VERSION} -m "ReportBuilder #{ReportBuilder::VERSION} tagged")
 end
 

data/lib/reportbuilder.rb

@@ -53,7 +53,7 @@ class ReportBuilder
   # Doesn't print a title if set to true
   attr_accessor :no_title
   # ReportBuilder version
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
   
   FormatNotFound=Class.new(Exception)
   # Available formats
@@ -103,6 +103,7 @@ class ReportBuilder
   # Otherwise, the element itself will be added
   def add(element)
     @elements.push(element)
+    self
   end
   # Returns an Html output
   def to_html()

data/lib/reportbuilder/builder/rtf.rb

@@ -3,13 +3,21 @@ require 'pp'
 class ReportBuilder
   class Builder
     # Rtf Builder.
-    # Based on ruby-rtf (http://ruby-rtf.rubyforge.org/)
+    # Based on ruby-rtf (http://ruby-rtf.rubyforge.org/).
     # 
     class Rtf < Builder
       # RTF::Document object.
       # See http://ruby-rtf.rubyforge.org/ for documentation
       attr_accessor :rtf
       include RTF
+      # Creates a new Rtf object
+      # Params:
+      # * <tt>builder</tt>: A ReportBuilder::Builder object or other with same interface
+      # * <tt>options</tt>: Hash of options.
+      #   * <tt>:font</tt>: Font family. Default to "Times New Roman"
+      #   * <tt>:font_size</tt>: Font size. Default to 20
+      #   * <tt>:table_border_width</tt>
+      #   * <tt>:table_hr_width</tt>
       def initialize(builder, options)
         super
         @font=Font.new(Font::ROMAN, @options[:font])
@@ -47,6 +55,7 @@ class ReportBuilder
           :table_hr_width=>25
         }
       end
+      # Add a paragraph of text.
       def text(*args,&block)
         if args.size==1 and args[0].is_a? String and !block
           @rtf.paragraph << args[0]
@@ -54,6 +63,7 @@ class ReportBuilder
           @rtf.paragraph(*args,&block)
         end
       end
+      # Add a header of level <tt>level</tt> with text <tt>t</tt>
       def header(level,t)
         @rtf.paragraph(@header_styles[level][:ps]) do |n1|
           n1.apply(@header_styles[level][:cs]) do |n2|
@@ -63,6 +73,7 @@ class ReportBuilder
           end
         end
       end
+      # Add preformatted text. By default, uses Courier
       def preformatted(t)
         @rtf.paragraph(@pre_par) do |n1|
           n1.apply(@pre_char) do |n2|
@@ -74,14 +85,16 @@ class ReportBuilder
         end
         
       end
-     
+      # Returns rtf code for report
       def out
         @rtf.to_rtf
       end
+      # Save rtf file
       def save(filename)
         File.open(filename,'wb')  {|file| file.write(@rtf.to_rtf)
         }
       end
+      # Do nothing on this builder 
       def html(t)
         # Nothing
       end

data/lib/reportbuilder/table/textbuilder.rb

@@ -1,6 +1,10 @@
 require 'text-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 TextBuilder < ElementBuilder
       def generate()
         

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 2
-  - 0
-  version: 1.2.0
+  - 1
+  version: 1.2.1
 platform: ruby
 authors: 
 - Claudio Bustos
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-28 00:00:00 -03:00
+date: 2010-03-29 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency