ruport 0.12.0 → 1.0.0

data/examples/trac_ticket_status.rb

@@ -0,0 +1,59 @@
+ %w[ruport hpricot open-uri].each { |lib| require lib }
+
+class TracSummaryReport
+  
+  include Ruport::Renderer::Hooks
+  
+  renders_as_table
+  
+  def initialize(options={})
+    @days = options[:days] || 7
+    @timeline_uri = options[:timeline_uri]
+  end
+
+  class TicketStatus < Ruport::Data::Record
+
+    def closed
+      title =~ /Ticket.+(\w+ closed)/ ? 1 : 0
+    end
+
+    def opened
+      title =~ /Ticket.+(\w+ created)|(\w+ reopened)/ ? 1 : 0
+    end
+
+  end
+
+  def feed_data
+    uri = @timeline_uri + "?wiki=on&milestone=on&ticket=on&changeset=on"+
+     "&max=10000&daysback=#{@days-1}&format=rss" 
+     
+    feed = Hpricot(open(uri))  
+    
+    table = Table([:title, :date], :record_class => TicketStatus) do |table|
+      (feed/"item").each do |r|
+         title = (r/"title").innerHTML
+         next unless title =~ /Ticket.*(created|closed|reopene)/
+         table <<  { :title => title,
+                     :date  => Date.parse((r/"pubdate").innerHTML) }
+       end
+    end     
+    
+    Grouping(table,:by => :date)
+  end
+
+  def renderable_data
+    summary = feed_data.summary :date,
+      :opened => lambda { |g| g.sigma { |r| r.opened  } },
+      :closed => lambda { |g| g.sigma { |r| r.closed  } },
+      :order => [:date,:opened,:closed] 
+      
+    summary.sort_rows_by! { |r| r.date }
+    return summary
+  end
+end
+
+timeline = "http://stonecode.svnrepository.com/ruport/trac.cgi/timeline"
+
+report = TracSummaryReport.new(:timeline_uri => timeline, :days => 14)  
+puts report.as(:text)
+

data/lib/ruport.rb

@@ -2,7 +2,7 @@
 #
 # Author: Gregory T. Brown (gregory.t.brown at gmail dot com)
 #
-# Copyright (c) 2006, All Rights Reserved.
+# Copyright (c) 2005-2007, All Rights Reserved.
 #
 # This is free software.  You may modify and redistribute this freely under
 # your choice of the GNU General Public License or the Ruby License. 
@@ -12,7 +12,7 @@
 
 module Ruport #:nodoc:#
   
-  VERSION = "0.12.0"   
+  VERSION = "1.0.0"   
   
   class FormatterError < RuntimeError #:nodoc:
   end

data/lib/ruport/data/grouping.rb

@@ -156,14 +156,19 @@ module Ruport::Data
     #
     #   grouping = Grouping.new(table, :by => "a")
     #
-    def initialize(data,options={})
-      @grouped_by = options[:by] 
-      cols = Array(options[:by]).dup
-      @data = data.to_group.send(:grouped_data, cols.shift)
-      cols.each do |col|
-        @data.each do |name,group|
-          group.create_subgroups(col)
-        end
+    def initialize(data={},options={})
+      if data.kind_of?(Hash)
+        @grouped_by = data[:by] 
+        @data = {}
+      else
+        @grouped_by = options[:by] 
+        cols = Array(options[:by]).dup
+        @data = data.to_group.send(:grouped_data, cols.shift)
+        cols.each do |col|
+          @data.each do |name,group|
+            group.create_subgroups(col)
+          end
+        end    
       end
     end
     

data/lib/ruport/formatter.rb

@@ -113,7 +113,7 @@ module Ruport
       # followed by a newline.
       #
       def render_inline_grouping(options={},&block)
-        data.each do |_,group|
+        data.each do |_,group|                     
           render_group(group, options, &block)
           output << "\n"
         end

data/lib/ruport/formatter/html.rb

@@ -21,12 +21,14 @@ module Ruport
   #
   # <tt>:show_group_headers</tt>  True by default   
   #
+  # <tt>:style</tt> Used for grouping (:inline, :justified)
+  #
   class Formatter::HTML < Formatter    
     
     renders :html, :for => [ Renderer::Row, Renderer::Table,
                              Renderer::Group, Renderer::Grouping ]
 
-    opt_reader :show_table_headers, :show_group_headers
+    opt_reader :show_table_headers, :show_group_headers, :style
     
     # Generates table headers based on the column names of your Data::Table.  
     #
@@ -80,7 +82,12 @@ module Ruport
     # renders them using the group renderer.
     #
     def build_grouping_body
-      render_inline_grouping(options)
+      case style
+      when :inline
+        render_inline_grouping(options)
+      when :justified
+        render_justified_grouping
+      end
     end
 
     # Generates <table> tags enclosing the yielded content.
@@ -106,6 +113,32 @@ module Ruport
     rescue LoadError
       raise RuntimeError, "You need RedCloth!\n gem install RedCloth -v 3.0.3"
     end
+    
+    private
+    
+    def render_justified_grouping
+      output << "\t<table>\n\t\t<tr>\n\t\t\t<th>" +
+        "#{data.grouped_by}</th>\n\t\t\t<th>" +
+        grouping_columns.join("</th>\n\t\t\t<th>") + 
+        "</th>\n\t\t</tr>\n"
+      data.each do |name, group|                     
+        group.each_with_index do |row, i|
+          output << "\t\t<tr>\n\t\t\t"
+          if i == 0
+            output << "<td class=\"groupName\">#{name}</td>\n\t\t\t<td>"
+          else
+            output << "<td>&nbsp;</td>\n\t\t\t<td>"
+          end
+          output << row.to_a.join("</td>\n\t\t\t<td>") +
+            "</td>\n\t\t</tr>\n"
+        end
+      end
+      output << "\t</table>"
+    end
+    
+    def grouping_columns
+      data.data.to_a[0][1].column_names
+    end
 
   end
 end

data/lib/ruport/formatter/pdf.rb

@@ -41,8 +41,6 @@ module Ruport
   #
   class Formatter::PDF < Formatter          
     
-    ## THESE ARE WHY YOU SHOULD NEVER USE PDF::Writer 
-    
     module PDFWriterMemoryPatch #:nodoc:
       unless self.class.instance_methods.include?("_post_transaction_rewind")
         def _post_transaction_rewind
@@ -133,7 +131,7 @@ module Ruport
                      
     # Determines which style to use and renders the main body for
     # Renderer::Grouping
-    def build_grouping_body
+    def build_grouping_body 
       case style
       when :inline
         render_inline_grouping(options.to_hash.merge(:formatter => pdf_writer,
@@ -311,6 +309,8 @@ module Ruport
       table_data.rename_columns { |c| c.to_s } 
       
       format_opts = table_format.merge(format_opts) if table_format  
+        
+      old = pdf_writer.font_size
       
       ::PDF::SimpleTable.new do |table| 
         table.extend(PDFSimpleTableOrderingPatch)             
@@ -322,7 +322,9 @@ module Ruport
 
         format_opts.each {|k,v| table.send("#{k}=", v) }  
         table.render_on(pdf_writer)
-      end
+      end                                              
+      
+      pdf_writer.font_size = old
     end
     
     # This module provides tools to simplify some common drawing operations

data/lib/ruport/formatter/text.rb

@@ -18,13 +18,13 @@ module Ruport
   # edge of the screen in the console, proper column alignment, and pretty
   # output that looks something like this:
   #
-  #   +-----------------------------+
-  #   | apple | banana | strawberry |
-  #   +-----------------------------+
-  #   | yes   | no     | yes        |
-  #   | yes   | yes    | god yes    |
-  #   | what  | the    | f?         |
-  #   +-----------------------------+ 
+  #   +------------------------------+
+  #   | apple | banana | strawberry  |
+  #   +------------------------------+
+  #   | yes   | no     | yes         |
+  #   | yes   | yes    | red snapper |
+  #   | what  | the    | red snapper |
+  #   +------------------------------+
   #
   # === Supported Options 
   #

data/lib/ruport/renderer.rb

@@ -10,8 +10,6 @@
 # for different kinds of tasks.  See Renderer::Table for a tabular data
 # renderer.  
 #
-# This class can easily be extended to build custom formatting systems, but if
-# you do not need that, it may not be relevant to study for your use of Ruport.
 class Ruport::Renderer
   
   class RequiredOptionNotSet < RuntimeError #:nodoc:
@@ -318,10 +316,16 @@ class Ruport::Renderer
     #      option :font_size, :font_style
     #      # other details omitted
     #   end
-    def option(*opts)
-      opts.each do |opt|
+    def option(*opts)       
+      opts.each do |opt|                                  
+        o = opt 
+        unless instance_methods(false).include?(o.to_s)   
+          define_method(o) {
+             options.send(o.to_s) 
+          }     
+        end
         opt = "#{opt}="
-        define_method(opt) {|t| options.send(opt, t) } 
+        define_method(opt) {|t| options.send(opt, t) }
       end
     end
     
@@ -362,8 +366,8 @@ class Ruport::Renderer
     # sets the data and options, and then does the following process:
     #
     #   * If the renderer contains a module Helpers, mix it in to the instance.
+    #   * If a block is given, yield the Renderer instance  
     #   * If a setup() method is defined on the Renderer, call it
-    #   * If a block is given, yield the Renderer instance
     #   * If the renderer has defined a run() method, call it, otherwise,
     #     include Renderer::AutoRunner. (you usually won't need a run() method )
     #   * call _run_ if it exists (This is provided by default, by AutoRunner)
@@ -375,9 +379,9 @@ class Ruport::Renderer
     # Please see the examples/ directory for custom renderer examples, because
     # this is not nearly as complicated as it sounds in most cases.
     def render(*args)
-      rend = build(*args) { |r|
+      rend = build(*args) { |r|        
+          yield(r) if block_given?   
         r.setup if r.respond_to? :setup
-        yield(r) if block_given?
       }
       if rend.respond_to? :run
         rend.run

data/lib/ruport/renderer/grouping.rb

@@ -1,3 +1,13 @@
+# Ruport : Extensible Reporting System                                
+#
+# renderer/grouping.rb : Group data renderer for Ruby Reports
+#
+# Written by Michael Milner, 2007.
+# Copyright (C) 2007, All Rights Reserved
+#
+# This is free software distributed under the same terms as Ruby 1.8
+# See LICENSE and COPYING for details.
+#
 module Ruport
   
   # This class implements the basic renderer for a single group of data.

data/test/acts_as_reportable_test.rb

@@ -11,10 +11,10 @@ rescue LoadError
   nil
 end
 
-require "ruport/acts_as_reportable"
-
 if Object.const_defined?(:ActiveRecord) && Object.const_defined?(:Mocha)
 
+  require "ruport/acts_as_reportable"
+
   class Team < ActiveRecord::Base
     acts_as_reportable :except => 'id', :include => :players
     has_many :players

data/test/grouping_test.rb

@@ -86,7 +86,7 @@ class TestGroupRendering < Test::Unit::TestCase
     @group = Ruport::Data::Group.new(:name => 'test',
                                      :data => [[1,2,3]],
                                      :column_names => %w[a b c])
-  end
+  end       
 
   def test_group_as
     assert_equal(7, @group.to_text.to_a.length)
@@ -129,7 +129,23 @@ class TestGrouping < Test::Unit::TestCase
                                         :column_names => %w[b c],
                                         :name => 4 ) }
     assert_equal c, b.data
-  end      
+  end        
+  
+  def test_empty_grouping
+    a = Ruport::Data::Grouping.new()
+    a << Group("foo",:data => [[1,2,3],[4,5,6]],
+                     :column_names => %w[a b c] )
+    assert_equal "foo", a["foo"].name    
+    assert_nil a.grouped_by         
+  end                               
+  
+  def test_empty_grouping_with_grouped_by
+    a = Ruport::Data::Grouping.new(:by => "nada")  
+    a << Group("foo",:data => [[1,2,3],[4,5,6]],
+                     :column_names => %w[a b c] )
+    assert_equal "foo", a["foo"].name    
+    assert_equal "nada", a.grouped_by
+  end
   
   def test_grouping_indexing
     a = [Ruport::Data::Group.new( :data => [[2,3]],

data/test/html_formatter_test.rb

@@ -101,6 +101,22 @@ class TestRenderHTMLGrouping < Test::Unit::TestCase
                  "\t<th>c</th>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>7</td>\n"+
                  "\t\t\t<td>9</td>\n\t\t</tr>\n\t</table>\n", actual
   end
+
+  def test_render_justified_html_grouping
+    table = Table(%w[a b c]) << [1,2,3] << [1,1,3] << [2,7,9]
+    g = Grouping(table,:by => "a")
+    actual = Ruport::Renderer::Grouping.render(:html, :data => g,
+                                               :style => :justified)
+
+    assert_equal "\t<table>\n\t\t<tr>\n\t\t\t<th>a</th>\n\t\t\t<th>b</th>\n"+
+                 "\t\t\t<th>c</th>\n\t\t</tr>\n\t\t<tr>\n\t\t\t"+
+                 "<td class=\"groupName\">1</td>\n\t\t\t<td>"+
+                 "2</td>\n\t\t\t<td>3</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t"+
+                 "<td>&nbsp;</td>\n\t\t\t<td>1</td>\n\t\t\t<td>3</td>"+
+                 "\n\t\t</tr>\n\t\t<tr>\n\t\t\t"+
+                 "<td class=\"groupName\">2</td>\n\t\t\t<td>7</td>\n"+
+                 "\t\t\t<td>9</td>\n\t\t</tr>\n\t</table>", actual
+  end
 end  
      
 

data/test/pdf_formatter_test.rb

@@ -69,6 +69,22 @@ class TestRenderPDFGrouping < Test::Unit::TestCase
      assert_raises(NotImplementedError) do 
        grouping.to_pdf(:style => :red_snapper) 
      end       
+  end    
+  
+  def test_grouping_should_have_consistent_font_size
+    a = Table(%w[a b c]) <<  %w[eye like chicken] << %w[eye like liver] << 
+                               %w[meow mix meow ] << %w[mix please deliver ] 
+    b = Grouping(a, :by => "a")
+    splat = b.to_pdf.split("\n") 
+    splat.grep(/meow/).each do |m|
+      assert_equal '10.0', m.split[5] 
+    end                  
+    splat.grep(/mix/).each do |m|
+      assert_equal '10.0', m.split[5] 
+    end                          
+    splat.grep(/eye/).each do |m|
+      assert_equal '10.0', m.split[5]
+    end
   end
   
 end

data/test/renderer_test.rb

@@ -229,14 +229,6 @@ class TestRendererWithManyHooks < Test::Unit::TestCase
    assert_equal "pheader\nbody\nfooter\nf", actual
   end
 
-  def test_setup
-   actual = false
-   RendererWithManyHooks.render_text { |r|
-     actual = r.options.apple
-   }
-   assert actual
-  end
-
   def test_option_helper
    RendererWithManyHooks.render_text do |r|
      r.subtitle = "Test Report"
@@ -395,6 +387,69 @@ class TestFormatterErbHelper < Test::Unit::TestCase
      assert_equal "Binding Override: 321", 
                    VanillaRenderer.render_terb(:binding => arr_binding)
    end
-end
+end    
 
 
+class TestOptionReaders < Test::Unit::TestCase
+  
+  class RendererForCheckingOptionReaders < Ruport::Renderer
+    option :foo  
+  end 
+  
+  class RendererForCheckingPassivity < Ruport::Renderer
+    def foo
+      "apples"
+    end
+    option :foo    
+  end
+
+   def setup 
+     @renderer = RendererForCheckingOptionReaders.new 
+     @renderer.formatter = Ruport::Formatter.new 
+     
+     @passive = RendererForCheckingPassivity.new
+     @passive.formatter = Ruport::Formatter.new
+   end
+   
+   def test_options_are_readable
+      @renderer.foo = 5
+      assert_equal 5, @renderer.foo
+   end                                   
+   
+   def test_methods_are_not_overridden
+     @passive.foo = 5
+     assert_equal "apples", @passive.foo
+     assert_equal 5, @passive.options.foo
+     assert_equal 5, @passive.formatter.options.foo
+   end
+     
+end
+     
+class TestSetupOrdering < Test::Unit::TestCase
+   
+  class RendererWithSetup < Ruport::Renderer
+     option :foo
+     stage :bar
+     def setup
+        foo.capitalize!
+     end        
+  end           
+  
+  class BasicFormatter < Ruport::Formatter 
+    renders :text, :for => RendererWithSetup
+    
+    def build_bar
+      output << options.foo
+    end
+  end
+  
+  def test_render_hash_options_should_be_called_before_setup
+     assert_equal "Hello", RendererWithSetup.render_text(:foo => "hello")
+  end       
+  
+  def test_render_block_should_be_called_before_setup
+     assert_equal "Hello", 
+                   RendererWithSetup.render_text { |r| r.foo = "hello" }
+  end
+  
+end