RubyGems - reportbuilder - Versions diffs - 0.1.0 → 0.2.0 - Mend

reportbuilder 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

data/Manifest.txt +4 -1
data/Rakefile +4 -3
data/data/reportbuilder.css +10 -0
data/data/sheep.jpg +0 -0
data/lib/reportbuilder/generator/html.rb +58 -28
data/lib/reportbuilder/generator/text.rb +5 -2
data/lib/reportbuilder/generator.rb +44 -9
data/lib/reportbuilder/image.rb +78 -0
data/lib/reportbuilder/section.rb +11 -17
data/lib/reportbuilder/table/htmlgenerator.rb +2 -2
data/lib/reportbuilder/table/textgenerator.rb +1 -1
data/lib/reportbuilder/table.rb +6 -4
data/lib/reportbuilder.rb +16 -17
data/test/test_html.rb +2 -2
data/test/test_image.rb +42 -0
data/test/test_section.rb +13 -5
metadata +8 -4

data/Manifest.txt CHANGED Viewed

@@ -5,15 +5,18 @@ Rakefile
 bin/reportbuilder
 data/reportbuilder.css
 data/reportbuilder.js
+data/sheep.jpg
+lib/reportbuilder.rb
 lib/reportbuilder/generator.rb
 lib/reportbuilder/generator/html.rb
 lib/reportbuilder/generator/text.rb
-lib/reportbuilder.rb
+lib/reportbuilder/image.rb
 lib/reportbuilder/section.rb
 lib/reportbuilder/table.rb
 lib/reportbuilder/table/htmlgenerator.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/Rakefile CHANGED Viewed

@@ -5,11 +5,12 @@ require 'rubygems'
 require 'hoe'
 require 'reportbuilder'
 Hoe.spec 'reportbuilder' do
   self.version=ReportBuilder::VERSION
-    self.rubyforge_name = 'ruby-statsample'
-      self.developer('Claudio Bustos', 'clbustos_at_gmail.com')
-      self.url = "http://rubyforge.org/projects/ruby-statsample/"
+  self.rubyforge_name = 'ruby-statsample'
+  self.developer('Claudio Bustos', 'clbustos_at_gmail.com')
+  self.url = "http://rubyforge.org/projects/ruby-statsample/"
 end

data/data/reportbuilder.css CHANGED Viewed

@@ -0,0 +1,10 @@
+body {
+  background-color: white;
+  color: black;
+  padding: 0;
+  font-family: "Arial",sans-serif;
+}
+h1,h2,h3 {
+	color:#600;
+}

data/data/sheep.jpg ADDED Viewed

Binary file

data/lib/reportbuilder/generator/html.rb CHANGED Viewed

@@ -5,31 +5,49 @@ class ReportBuilder
     class Html < Generator
       PREFIX="html"
       attr_reader :toc
-      def initialize(builder)
+      def initialize(builder, options)
         super
         @body=""
-        @toc=[]
-        @table_n=1
-        @entry_n=1
-        @list_tables=[]
         @headers=[]
         @footers=[]
       end
       def parse
+        # add_css(File.dirname(__FILE__)+"/../../../data/reportbuilder.css")
+        # add_js(File.dirname(__FILE__)+"/../../../data/reportbuilder.js")
         parse_cycle(@builder)
       end
+      def basic_css
+<<-HERE
+<style>
+body {
+margin:0;
+padding:1em;
+}
+table {
+border-collapse: collapse;
+}
+table td {
+border: 1px solid black;
+}
+.section {
+margin:0.5em;
+}
+</style>
+HERE
+      end
       def out
-        out="<html><head><title>#{@builder.name}</title>"
+        out= <<-HERE
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
+<title>#{@builder.name}</title>
+#{basic_css}
+HERE
         out << @headers.join("\n")
         out << "</head><body>\n"
         out << "<h1>#{@builder.name}</h1>"
-        if (@list_tables.size>0)
-          out << "<div class='tot'><div class='title'>List of tables</div><ul>"
-          @list_tables.each {|anchor,name|
-            out << "<li><a href='#"+anchor+"'>#{name}</a></li>"
-          }
-          out << "</ul></div>\n"
-        end
         if(@toc.size>0)
         out << "<div class='toc'><div class='title'>List of contents</div></div>"
           actual_level=0
@@ -47,10 +65,30 @@ class ReportBuilder
           actual_level.times { out << "</ul>\n"}
           out << "</div>\n"
         end
+        if (@list_tables.size>0)
+          out << "<div class='tot'><div class='title'>List of tables</div><ul>"
+          @list_tables.each {|anchor,name|
+            out << "<li><a href='#"+anchor+"'>#{name}</a></li>"
+          }
+          out << "</ul></div>\n"
+        end
         out << @body
         out << @footers.join("\n")
         out << "</body></html>"
       end
+      def add_image(filename)
+        if(File.exists? filename)
+          if(!File.exists? @builder.dir+"/images/"+File.basename(filename))
+            FileUtils.mkdir @builder.dir+"/images"
+            FileUtils.cp filename, @builder.dir+"/images/"+File.basename(filename)
+          end
+        end
+        "images/"+File.basename(filename)
+      end
       def add_js(js)
         if(File.exists? js)
           if(!File.exists? @builder.dir+"/js/"+File.basename(js))
@@ -74,26 +112,18 @@ class ReportBuilder
       def add_text(t)
         ws=(" "*parse_level*2)
-        @body << ws << "<pre>#{t}</pre>\n"
+        @body << ws << "<p>#{t}</p>\n"
       end
-      def add_raw(t)
+      def add_html(t)
         ws=(" "*parse_level*2)
         @body << ws << t << "\n"
       end
-      def add_toc_entry(name)
-        anchor="toc_#{@entry_n}"
-        @entry_n+=1
-        @toc.push([anchor, name, parse_level])
-        anchor
-      end
-      # Add an entry for a table
-      # Returns the name of the anchor
-      def add_table_entry(name)
-        anchor="table_#{@table_n}"
-        @table_n+=1
-        @list_tables.push([anchor,name])
-        anchor
+      def add_preformatted(t)
+        ws=(" "*parse_level*2)
+        @body << ws << "<pre>#{t}</pre>\n"
       end
     end
   end
 end

data/lib/reportbuilder/generator/text.rb CHANGED Viewed

@@ -4,7 +4,7 @@ class ReportBuilder
       PREFIX="text"
       attr_reader :toc
       attr_reader :out
-      def initialize(builder)
+      def initialize(builder, options)
         super
         @out=""
       end
@@ -17,9 +17,12 @@ class ReportBuilder
         ws=" "*parse_level*2
         @out << ws << t << "\n"
       end
-      def add_text_raw(t)
+      def add_preformatted(t)
         @out << t
       end
+      def add_html(t)
+        # Nothing printed
+      end
     end
   end
 end

data/lib/reportbuilder/generator.rb CHANGED Viewed

@@ -1,32 +1,67 @@
 class ReportBuilder
   # Abstract class for generators.
-  # A generator is a class which control the output for a builder.
+  #   A generator is a class which control the output for a builder.
   # On parse_cycle()....
   #
   class Generator
-    #PREFIX="none"
     attr_reader :parse_level
     # builder is a ReportBuilder object
-    def initialize(builder)
+    def initialize(builder, options)
       @builder=builder
       @parse_level=0
+      @options=default_options.merge(options)
+      @toc=[]
+      @table_n=1
+      @entry_n=1
+      @list_tables=[]
+    end
+    def default_options
+      {}
     end
     # parse each element of the parameters
     def parse_cycle(container)
       @parse_level+=1
       container.elements.each do |element|
-        method=("to_rb_"+self.class::PREFIX).intern
-        if element.respond_to? method
-          element.send(method, self)
-        else
-          add_text(element.to_s)
-        end
+        parse_element(element)
       end
       @parse_level-=1
     end
+    def parse_element(element)
+      method=("to_reportbuilder_"+self.class::PREFIX).intern
+      if element.respond_to? method
+        element.send(method, self)
+      elsif element.respond_to? :to_reportbuilder
+        element.send(:to_reportbuilder, self)
+      else
+        add_text(element.to_s)
+      end
+    end
     def add_text(t)
       raise "Implement this"
     end
+    def add_html(t)
+      raise "Implement this"
+    end
+    def add_preformatted(t)
+      raise "Implement this"
+    end
+    def add_toc_entry(name)
+      anchor="toc_#{@entry_n}"
+      @entry_n+=1
+      @toc.push([anchor, name, parse_level])
+      anchor
+    end
+    # Add an entry for a table
+    # Returns the name of the anchor
+    def add_table_entry(name)
+      anchor="table_#{@table_n}"
+      @table_n+=1
+      @list_tables.push([anchor,name])
+      anchor
+    end
   end
   class ElementGenerator
     def initialize(generator,element)

data/lib/reportbuilder/image.rb ADDED Viewed

@@ -0,0 +1,78 @@
+# Creates a Section
+class ReportBuilder::Image
+  @@n=1
+  attr_reader :name
+  def initialize(filename, options={})
+    if !options.has_key? :name
+      @name="Image #{@@n}"
+      @@n+=1
+    else
+      @name=options[:name]
+    end
+    default_options={
+      :alt=>@name,
+      :chars => [ 'W', 'M', '$', '@', '#', '%', '^', 'x', '*', 'o', '=', '+',
+      ':', '~', '.', ' ' ],
+      :font_rows => 8,
+      :font_cols => 4
+    }
+    @options=default_options.merge(options)
+    @filename=filename
+  end
+  # Based on http://rubyquiz.com/quiz50.html
+  def to_reportbuilder_text(generator)
+    require 'RMagick'
+    img = Magick::Image.read(@filename).first
+    # Resize too-large images. The resulting image is going to be
+    # about twice the size of the input, so if the original image is too
+    # large we need to make it smaller so the ASCII version won't be too
+    # big. The `change_geometry' method computes new dimensions for an
+    # image based on the geometry argument. The '320x320>' argument says
+    # "If the image is too big to fit in a 320x320 square, compute the
+    # dimensions of an image that will fit, but retain the original aspect
+    # ratio. If the image is already smaller than 320x320, keep the same
+    # dimensions."
+    img.change_geometry('320x320>') do |cols, rows|
+      img.resize!(cols, rows) if cols != img.columns || rows != img.rows
+    end
+    # Compute the image size in ASCII "pixels" and resize the image to have
+    # those dimensions. The resulting image does not have the same aspect
+    # ratio as the original, but since our "pixels" are twice as tall as
+    # they are wide we'll get our proportions back (roughly) when we render.
+    pr = img.rows / @options[:font_rows]
+    pc = img.columns / @options[:font_cols]
+    img.resize!(pc, pr)
+    img = img.quantize(@options[:chars].size, Magick::GRAYColorspace)
+    img = img.normalize
+    out=""
+    # Draw the image surrounded by a border. The `view' method is slow but
+    # it makes it easy to address individual pixels. In grayscale images,
+    # all three RGB channels have the same value so the red channel is as
+    # good as any for choosing which character to represent the intensity of
+    # this particular pixel.
+    border = '+' + ('-' * pc) + '+'
+    out += border+"\n"
+    img.view(0, 0, pc, pr) do |view|
+      pr.times do |i|
+        out+= '|'
+        pc.times do |j|
+          out+= @options[:chars][view[i][j].red / (2**16/@options[:chars].size)]
+        end
+        out+= '|'+"\n"
+      end
+    end
+    out+= border
+    generator.add_raw(out)
+  end
+  def to_reportbuilder_html(generator)
+    src=generator.add_image(@filename)
+    generator.add_raw("<img src='#{src}' alt='#{@options[:alt]}' />")
+  end
+end

data/lib/reportbuilder/section.rb CHANGED Viewed

@@ -2,12 +2,12 @@
 class ReportBuilder::Section
   @@n=1
   attr_reader :parent, :elements, :name
-  def initialize(name=nil)
-    if name.nil?
+  def initialize(options={})
+    if !options.has_key? :name
       @name="Section #{@nn}"
       @nn+=1
     else
-      @name=name
+      @name=options[:name]
     end
     @parent = nil
     @elements = []
@@ -20,29 +20,23 @@ class ReportBuilder::Section
     end
   end
-  def to_rb_text(generator)
+  def to_reportbuilder_text(generator)
     generator.add_text(("="*generator.parse_level)+" "+name)
     generator.parse_cycle(self)
   end
-  def to_rb_html(generator)
+  def to_reportbuilder_html(generator)
     htag="h#{generator.parse_level+1}"
     anchor=generator.add_toc_entry(name)
-    generator.add_raw "<div class='section'><#{htag}>#{name}</#{htag}><a name='#{anchor}'></a>"
+    generator.add_html "<div class='section'><#{htag}>#{name}</#{htag}><a name='#{anchor}'></a>"
     generator.parse_cycle(self)
-    generator.add_raw "</div>"
+    generator.add_html "</div>"
   end
-  def add(*elements)
-    elements.each do |element|
-      if element.is_a? ReportBuilder::Section
-        element.parent=self
-      end
-      if element.respond_to?(:to_reportbuilder)
-        @elements.push(element.to_reportbuilder)
-      else
-        @elements.push(element)
-      end
+  def add(element)
+    if element.is_a? ReportBuilder::Section
+      element.parent=self
     end
+    @elements.push(element)
   end
 end

data/lib/reportbuilder/table/htmlgenerator.rb CHANGED Viewed

@@ -4,7 +4,7 @@ class ReportBuilder
         def generate()
           t=@element
           anchor=@generator.add_table_entry(t.name)
-          out="<a name='#{anchor}'></a><table>"
+          out="<a name='#{anchor}'></a><table><caption>#{t.name}</caption>"
           @rowspans=[]
           if t.header.size>0
             out+="<thead>"+parse_row(t,t.header,"th")+"</thead>\n"
@@ -21,7 +21,7 @@ class ReportBuilder
           end
           }
           out+="</tbody>\n</table>\n"
-          @generator.add_raw(out)
+          @generator.add_html(out)
         end
         def parse_row(t,row,tag="td")
           row_ary=[]

data/lib/reportbuilder/table/textgenerator.rb CHANGED Viewed

@@ -6,7 +6,7 @@ class ReportBuilder
         t=@element
         t.calculate_widths
         total_width=t.total_width
-        out=""
+        out="Table: #{t.name}\n"
         if t.header.size>0
           out+=parse_hr(total_width)+"\n"
           out+=parse_row(t,t.header)+"\n"

data/lib/reportbuilder/table.rb CHANGED Viewed

@@ -19,8 +19,8 @@ class ReportBuilder
   #   | 4  | London   |George | ab-4          |
   #   -----------------------------------------
   class Table
-    @@n=1
-    # :nodoc:
+    @@n=1 # :nodoc:
     DEFAULT_OPTIONS={
       :header =>  [],
       :name   =>   nil
@@ -36,6 +36,7 @@ class ReportBuilder
     # Use:
     #   table=ReportBuilder::Table.new(:header =>["var1","var2"])
     def initialize(opts=Hash.new)
+      raise ArgumentError,"opts should be a Hash" if !opts.is_a? Hash
       opts=DEFAULT_OPTIONS.merge opts
       if opts[:name].nil?
         @name= "Table #{@@n}"
@@ -57,6 +58,7 @@ class ReportBuilder
     def add_hr
       @rows.push(:hr)
     end
+    alias_method  :add_horizontal_line, :add_hr
     # Adds a rowspan on a cell
     #   table.add_row(["a",table.rowspan("b",2)])
     def rowspan(data,n)
@@ -93,12 +95,12 @@ class ReportBuilder
       }
     }
     end
-    def to_rb_text(generator)
+    def to_reportbuilder_text(generator)
       require 'reportbuilder/table/textgenerator'
       table_generator=ReportBuilder::Table::TextGenerator.new( generator, self)
       table_generator.generate
     end
-    def to_rb_html(generator)
+    def to_reportbuilder_html(generator)
       require 'reportbuilder/table/htmlgenerator'
       table_generator=ReportBuilder::Table::HtmlGenerator.new(generator, self)
       table_generator.generate

data/lib/reportbuilder.rb CHANGED Viewed

@@ -1,12 +1,13 @@
 require 'reportbuilder/table'
 require 'reportbuilder/section'
 require 'reportbuilder/generator'
+require 'reportbuilder/image'
 class ReportBuilder
   attr_reader :elements
   attr_reader :name
   attr_reader :dir
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
   # Create a new Report
   def initialize(name=nil,dir=nil)
     name||="Report "+Time.new.to_s
@@ -19,40 +20,38 @@ class ReportBuilder
   # If parameters is an object which respond to :to_reportbuilder,
   # this method will called.
   # Otherwise, the element itself will be added
-  def add(*elements)
-    elements.each do |element|
-      if element.respond_to?(:to_reportbuilder)
-        @elements.push(element.to_reportbuilder)
-      else
-        @elements.push(element)
-      end
-    end
+  def add(element)
+      @elements.push(element)
   end
   # Returns a Section
-  def section(name)
-     Section.new(name)
+  def section(options={})
+    Section.new(options)
+  end
+  def image(filename)
+    Image.new(filename)
   end
   # Returns a Table
   def table(h=[])
       Table.new(h)
   end
   # Returns an Html output
-  def to_html
-    gen=Generator::Html.new(self)
+  def to_html(options={})
+    gen = Generator::Html.new(self,options)
     gen.parse
     gen.out
   end
-  def save_html(file)
-    gen=Generator::Html.new(self)
+  def save_html(file, options={})
+    gen=Generator::Html.new(self,options)
     gen.parse
     File.open(@dir+"/"+file,"wb") {|fp|
       fp.write(gen.out)
     }
   end
   # Returns a Text output
-  def to_s
-    gen=Generator::Text.new(self)
+  def to_text(options={})
+    gen=Generator::Text.new(self, options)
     gen.parse
     gen.out
   end
+  alias_method :to_s, :to_text
 end

data/test/test_html.rb CHANGED Viewed

@@ -15,7 +15,7 @@ class TestReportbuilderHtml < Test::Unit::TestCase
   def test_include_js
     mock_element = ""
     eval(" class << mock_element
-      def to_rb_html(generator)
+      def to_reportbuilder_html(generator)
         generator.add_js('"+@datadir+"/reportbuilder.js')
       end
     end ")
@@ -35,7 +35,7 @@ class TestReportbuilderHtml < Test::Unit::TestCase
   def test_include_css
     mock_element = ""
     eval(" class << mock_element
-      def to_rb_html(generator)
+      def to_reportbuilder_html(generator)
         generator.add_css('"+@datadir+"/reportbuilder.css')
       end
     end ")

data/test/test_image.rb ADDED Viewed

@@ -0,0 +1,42 @@
+require "test/unit"
+$:.unshift(File.dirname(__FILE__)+"/../lib")
+require "reportbuilder"
+class TestReportbuilderImage < Test::Unit::TestCase
+  def setup
+    @tmpdir=Dir::mktmpdir
+    @rp=ReportBuilder.new("Test", @tmpdir)
+    @datadir=File.dirname(__FILE__)+"/../data"
+    @rp.add(@rp.image(@datadir+"/sheep.jpg"))
+  end
+  def teardown
+   FileUtils.remove_entry_secure @tmpdir
+  end
+  def test_image_text
+    expected= <<-HERE
+Report: Test
++--------------------------------+
+|          *********#**          |
+|         ****#********#    *    |
+|  * *  *********#*******     *  |
+|           * ***  ***   *      *|
+|     * *    WWW WW*     ***     |
+|    ****   *WW* WWW *   **#*    |
+|    ****   *        *   ****    |
+|    *****  #       **  *#***    |
+|    ****** **      *  *#****    |
+|     ******        ********     |
+|     *******   **   ******      |
+|       **#***   * *******       |
+|        ****#**  *#*****        |
+|             **#*****           |
++--------------------------------+
+HERE
+puts @rp.to_s
+  assert_equal(expected, @rp.to_s)
+  end
+  def test_image_html
+    assert_match(/img src='images\/sheep.jpg'/, @rp.to_html)
+  end
+end

data/test/test_section.rb CHANGED Viewed

@@ -5,14 +5,16 @@ require "reportbuilder"
 class TestReportbuilderSection < Test::Unit::TestCase
   def setup
     @rp=ReportBuilder.new("Test Report")
-    s1=@rp.section("Section 1")
+    s1=@rp.section(:name=>"Section 1")
     @rp.add s1
     s1.add("Texto 1")
     s1.add(2)
-    s11=@rp.section("Section 1.1")
+    s11=@rp.section(:name=>"Section 1.1")
     s1.add s11
+    s111=@rp.section(:name=>"Section 1.1.1")
+    s11.add s111
     s1.add("Texto 1.1")
-    s2=@rp.section("Section 2")
+    s2=@rp.section(:name=>"Section 2")
     @rp.add s2
   end
   def test_section_text
@@ -22,6 +24,7 @@ Report: Test Report
     Texto 1
     2
     == Section 1.1
+      === Section 1.1.1
     Texto 1.1
   = Section 2
@@ -35,18 +38,23 @@ HERE
 <li><a href='#toc_1'>Section 1</a></li>
 <ul>
 <li><a href='#toc_2'>Section 1.1</a></li>
+<ul>
+<li><a href='#toc_3'>Section 1.1.1</a></li>
+</ul>
 </ul>
-<li><a href='#toc_3'>Section 2</a></li>
+<li><a href='#toc_4'>Section 2</a></li>
 </ul>
 </div>
     <div class='section'><h2>Section 1</h2><a name='toc_1'></a>
 <pre>Texto 1</pre>
 <pre>2</pre>
         <div class='section'><h3>Section 1.1</h3><a name='toc_2'></a>
+            <div class='section'><h4>Section 1.1.1</h4><a name='toc_3'></a>
+            </div>
         </div>
 <pre>Texto 1.1</pre>
     </div>
-    <div class='section'><h2>Section 2</h2><a name='toc_3'></a>
+    <div class='section'><h2>Section 2</h2><a name='toc_4'></a>
     </div>
 </body></html>
 HERE

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reportbuilder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Claudio Bustos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-11-08 00:00:00 -03:00
+date: 2010-02-06 00:00:00 -03:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -20,7 +20,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.3
+        version: 2.4.0
     version:
 description: Report Abstract Interface. Creates text, html and pdf output, based on a common framework
 email:
@@ -41,15 +41,18 @@ files:
 - bin/reportbuilder
 - data/reportbuilder.css
 - data/reportbuilder.js
+- data/sheep.jpg
+- lib/reportbuilder.rb
 - lib/reportbuilder/generator.rb
 - lib/reportbuilder/generator/html.rb
 - lib/reportbuilder/generator/text.rb
-- lib/reportbuilder.rb
+- lib/reportbuilder/image.rb
 - lib/reportbuilder/section.rb
 - lib/reportbuilder/table.rb
 - lib/reportbuilder/table/htmlgenerator.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
@@ -85,5 +88,6 @@ summary: Report Abstract Interface
 test_files:
 - test/test_section.rb
 - test/test_table.rb
+- test/test_image.rb
 - test/test_html.rb
 - test/test_reportbuilder.rb