ruport 1.0.0 → 1.0.1

data/Rakefile

@@ -3,7 +3,7 @@ require "rake/testtask"
 require "rake/gempackagetask"
 
 
-RUPORT_VERSION = "1.0.0"
+RUPORT_VERSION = "1.0.1"
 
 begin
   require "rubygems"

data/examples/btree/commaleon/commaleon.rb

@@ -34,7 +34,6 @@
 require "rubygems"
 require "camping"               
 require "camping/session"   
-gem "ruport", "=0.12.1"
 require "ruport" 
 require "ruport/extensions"     
    
@@ -261,4 +260,4 @@ module Commaleon::Views
     end
   end        
            
-end
+end

data/lib/ruport/acts_as_reportable.rb

@@ -10,7 +10,7 @@
 # See LICENSE and COPYING for details.   
 #
 require "ruport"
-quiet { require "active_record" }
+Ruport.quiet { require "active_record" }
 
 module Ruport
   

data/lib/ruport/data/grouping.rb

@@ -118,6 +118,7 @@ module Ruport::Data
       columns = column_names.dup
       columns.delete(group_column)
       group_names.each do |name|
+        # FIXME - this doesn't seem to reduce the data set
         group_data = sub_table(columns) {|r|
           r.send(group_column) == name
         }

data/lib/ruport/formatter/pdf.rb

@@ -90,7 +90,7 @@ module Ruport
                 :paper_orientation
 
     def initialize
-      quiet do   
+      Ruport.quiet do   
         require "pdf/writer"
         require "pdf/simpletable"
       end
@@ -418,7 +418,10 @@ module Ruport
       data.each do |name,group|
         group_column = { data.grouped_by => "<b>#{name}</b>\n" }
         group.each_with_index do |rec,i|
-          i == 0 ? table << group_column.merge(rec.to_hash) : table << rec
+          # FIXME - Find the source of the bug requiring to_a
+          i == 0 ?
+            table << group_column.merge(rec.to_hash) :
+            table << rec.to_a.unshift(nil)
         end
         table << Array.new(grouping_columns.length,' ') if style == :separated
       end
@@ -429,7 +432,8 @@ module Ruport
       table = table_with_grouped_by_column
       data.each do |name,group|
         table << ["<b>#{name}</b>\n",nil,nil]
-        group.each {|r| table << r }
+        # FIXME - Find the source of the bug requiring to_a
+        group.each {|r| table << r.to_a.unshift(nil) }
       end
       render_table table, options.to_hash.merge(:formatter => pdf_writer)
     end

data/lib/ruport/query/sql_split.rb

@@ -13,21 +13,21 @@ module Ruport
     # This class properly splits up multi-statement SQL input for use with
     # Ruby/DBI
     class SqlSplit < Array  #:nodoc:
-			def initialize( sql )
-				super()
-				next_sql = ''
-				sql.each do |line|
-					unless line =~ /^--/ or line =~ %r{^/\*.*\*/;} or line =~ /^\s*$/
-						next_sql << line
-						if line =~ /;$/
-							next_sql.gsub!( /;\s$/, '' )
-							self << next_sql
-							next_sql = ''
-						end
-					end
-				end
-				self << next_sql if next_sql != ''
-			end
-		end
+      def initialize( sql )
+        super()
+        next_sql = ''
+        sql.each do |line|
+          unless line =~ /^--/ or line =~ %r{^/\*.*\*/;} or line =~ /^\s*$/
+            next_sql << line
+            if line =~ /;$/
+              next_sql.gsub!( /;\s$/, '' )
+              self << next_sql
+              next_sql = ''
+            end
+          end
+        end
+        self << next_sql if next_sql != ''
+      end
+    end
   end
 end

data/lib/ruport/renderer.rb

@@ -168,8 +168,8 @@ class Ruport::Renderer
       end
       self.class.renderer.render(format,
        self.class.rendering_options.merge(options)) do |rend|
-        rend.data = send(:renderable_data) rescue self
-        yield(rend) if block_given?  
+         rend.data = respond_to?(:renderable_data) ? renderable_data : self
+         yield(rend) if block_given?  
       end
     end  
   end

data/lib/ruport.rb

@@ -12,7 +12,7 @@
 
 module Ruport #:nodoc:#
   
-  VERSION = "1.0.0"   
+  VERSION = "1.0.1"   
   
   class FormatterError < RuntimeError #:nodoc:
   end
@@ -82,11 +82,6 @@ module Ruport #:nodoc:#
 
   end
 
-
-end
-
-module Kernel
-  
   # quiets warnings for block
   def quiet #:nodoc:
     warnings = $VERBOSE
@@ -96,6 +91,8 @@ module Kernel
     return result
   end
 
+  module_function :quiet
+
 end
 
 require "enumerator"

data/test/acts_as_reportable_test.rb

@@ -1,9 +1,5 @@
-require "test/unit"      
-require "ruport"         
-
+require "test/helpers"
 begin
-  require "rubygems"  
-  gem "mocha", ">=0.4.0"
   require "mocha"
   require "stubba"
   require "active_record"

data/test/csv_formatter_test.rb

@@ -1,11 +1,4 @@
-require "test/unit"
-require "ruport"
-
-begin
-  require "rubygems"
-rescue LoadError
-  nil
-end    
+require "test/helpers"
 
 class TestRenderCSVRow < Test::Unit::TestCase
   def test_render_csv_row

data/test/grouping_test.rb

@@ -1,6 +1,4 @@
-require "test/unit"
-require "ruport"
-begin; require "rubygems"; rescue LoadError; nil; end
+require "test/helpers"
 
 class TestGroup < Test::Unit::TestCase
 

data/test/helpers.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "ruport"
+begin; require "rubygems"; rescue LoadError; nil; end
+require "spec-unit"
+
+class Test::Unit::TestCase
+  include SpecUnit
+end

data/test/html_formatter_test.rb

@@ -1,5 +1,4 @@
-require "test/unit"
-require "ruport"
+require "test/helpers"
 
 class TestRenderHTMLTable < Test::Unit::TestCase
   

data/test/pdf_formatter_test.rb

@@ -1,13 +1,4 @@
-require "test/unit"
-require "ruport"
-
-begin
-  require "rubygems"
-rescue LoadError
-  nil
-end                        
-
-#require "pdf/writer"    
+require "test/helpers"
 
 class TestRenderPDFTable < Test::Unit::TestCase
 

data/test/query_test.rb

@@ -1,5 +1,4 @@
- require "test/unit"
- require "ruport"
+ require "test/helpers"
  
  begin
    require 'mocha'

data/test/record_test.rb

@@ -1,63 +1,72 @@
-require "test/unit"
-require "ruport"
-                      
-module RecordTestSetup
-  def setup
-    @attributes = %w[a b c d]
-    @record = Ruport::Data::Record.new [1,2,3,4], :attributes => @attributes 
-  end
-end
+require "test/helpers"
 
 class TestRecord < Test::Unit::TestCase
 
   include Ruport::Data
-  include RecordTestSetup 
-
-  def test_init
-    record = Ruport::Data::Record.new [1,2,3,4]
-    assert_equal 1, record[0]
-    assert_equal 2, record[1]
-    assert_equal 3, record[2]
-    assert_equal 4, record[3]
-
-    assert_equal 1, @record["a"]
-    assert_equal 4, @record["d"]
-    assert_equal 2, @record.b
-    assert_equal 3, @record.c
-    assert_raise(NoMethodError) { @record.f }
-  end
   
-  def test_hash_constructor
-    record = Ruport::Data::Record.new({:a => 1, :b => 2, :c => 3},{})
-    assert_equal 1, record[:a]
-    assert_equal 2, record[:b]
-    assert_equal 3, record[:c]
-    assert_equal 3, record.c
-  end
+  def setup
+    @attributes = %w[a b c d]
+    @record = Ruport::Data::Record.new [1,2,3,4], :attributes => @attributes 
+  end   
   
-  def test_hash_constructor_with_attributes
-    record = Record.new({:a => 1, :b => 2, :c => 3 }, :attributes => [:c,:b,:a])
-    assert_equal 1, record[:a]
-    assert_equal 2, record[:b]
-    assert_equal 3, record[:c]
-    assert_equal 3, record.c
+  context "when initializing with an array with attributes" do 
+    def specify_key_access_should_work
+      assert_equal 1, @record["a"]
+      assert_equal 4, @record["d"]
+      assert_equal 2, @record.b
+      assert_equal 3, @record.c
+      assert_raise(NoMethodError) { @record.f }        
+    end  
     
-    assert_equal 3, record[0]
-    assert_equal 2, record[1]
-    assert_equal 1, record[2]
+    def specify_ordinal_access_should_work
+      assert_equal 1, @record[0]
+      assert_equal 2, @record[1]
+      assert_equal 3, @record[2]
+      assert_equal 4, @record[3]
+    end
+  end  
+      
+  context "when initializing with an array without attributes" do
+    def specify_ordinal_access_should_work
+      record = Ruport::Data::Record.new [1,2,3,4]
+      assert_equal 1, record[0]
+      assert_equal 2, record[1]
+      assert_equal 3, record[2]
+      assert_equal 4, record[3]   
+    end 
+  end         
+  
+  context "when initializing with a hash without attributes" do    
+    def setup  
+      @record = Ruport::Data::Record.new({:a => 1, :b => 2, :c => 3},{})
+    end     
+     
+    def specify_key_access_should_work
+      assert_equal 1, @record[:a]
+      assert_equal 2, @record[:b]
+      assert_equal 3, @record[:c]
+      assert_equal 3, @record.c  
+    end  
   end
   
-  def test_brackets
-    assert_equal 1, @record[0]
-    assert_equal 2, @record[1]
-    assert_equal 3, @record[2]
-    assert_equal 4, @record[3]
-
-    assert_equal 1, @record["a"]
-    assert_equal 2, @record["b"]
-    assert_equal 3, @record["c"]
-    assert_equal 4, @record["d"]
-    assert_equal 4, @record.d
+  context "when initializing with a hash with attributes" do
+    def setup
+      @record = Record.new({:a => 1, :b => 2, :c => 3 }, 
+                           :attributes => [:c,:b,:a])
+    end   
+    
+    def specify_key_access_should_work
+      assert_equal 1, @record[:a]
+      assert_equal 2, @record[:b]
+      assert_equal 3, @record[:c]
+      assert_equal 3, @record.c   
+    end
+    
+    def specify_ordinal_access_should_work    
+      assert_equal 3, @record[0]
+      assert_equal 2, @record[1]           
+      assert_equal 1, @record[2]           
+    end
   end
   
   def test_bracket_equals
@@ -275,40 +284,43 @@ class TestRecord < Test::Unit::TestCase
     assert_equal "1,2,3\n", a.to_csv
   end
     
-end 
+  context "when rendering records" do   
     
+    def specify_record_as_should_work
+      rendered_row = @record.as(:text)
+      assert_equal("| 1 | 2 | 3 | 4 |\n", rendered_row)
+    end
 
-class TestRecordRenderering < Test::Unit::TestCase
-  
-  include RecordTestSetup
-  include Ruport::Data
-
-  def test_record_as
-    rendered_row = @record.as(:text)
-    assert_equal("| 1 | 2 | 3 | 4 |\n", rendered_row)
-  end
-
-  def test_to_hack
-    rendered_row = @record.to_text
-    assert_equal("| 1 | 2 | 3 | 4 |\n", rendered_row)  
+    def specify_record_to_format_should_work_without_options
+      rendered_row = @record.to_text
+      assert_equal("| 1 | 2 | 3 | 4 |\n", rendered_row)    
+    end             
+         
+    def specify_record_to_format_should_work_with_options
+      rendered_row = @record.to_csv(:format_options => { :col_sep => "\t"})
+      assert_equal("1\t2\t3\t4\n",rendered_row)     
+    end                                      
     
-    rendered_row = @record.to_csv(:format_options => { :col_sep => "\t"})
-    assert_equal("1\t2\t3\t4\n",rendered_row)
-  end             
-
-  def test_as_throws_proper_errors
-    a = Record.new({ "a" => 1, "b" => 2 })
-    assert_nothing_raised { a.as(:csv) }
-    assert_nothing_raised { a.to_csv }
-    assert_raises(Ruport::Renderer::UnknownFormatError) { a.as(:nothing) }
-    assert_raises(Ruport::Renderer::UnknownFormatError) { a.to_nothing }
-  end  
+    context "when given bad format names" do
+      def setup 
+        @a = Record.new({ "a" => 1, "b" => 2 }) 
+      end
+
+      def specify_as_should_throw_proper_errors
+        assert_raises(Ruport::Renderer::UnknownFormatError) { @a.as(:nothing) } 
+      end 
+    
+      def specify_to_format_should_throw_proper_errors
+        assert_raises(Ruport::Renderer::UnknownFormatError) { @a.to_nothing }
+      end  
+    end   
   
-  ## -- BUG TRAPS --------------------
+    ## -- BUG TRAPS --------------------
   
-  def test_ensure_attributes_not_broken_by_to_hack
-    record = Ruport::Data::Record.new [1,2], :attributes => %w[a to_something]
-    assert_equal 2, record.to_something
+    def specify_attributes_should_not_be_broken_by_to_hack
+      record = Ruport::Data::Record.new [1,2], :attributes => %w[a to_something]
+      assert_equal 2, record.to_something
+    end                              
   end
 
 end

data/test/renderer_test.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require 'ruport'
+require 'test/helpers'
 
 ###########################################################################
 #
@@ -453,3 +452,61 @@ class TestSetupOrdering < Test::Unit::TestCase
   end
   
 end
+
+class TestRendererHooks < Test::Unit::TestCase
+
+  context "when renderable_data omitted" do
+
+    require "mocha"
+
+    class DummyObject 
+      include Ruport::Renderer::Hooks
+      renders_as_table
+    end
+
+    def specify_should_return_self
+      a = DummyObject.new
+      rend = mock("renderer")
+      rend.expects(:data=).with(a)
+      Ruport::Renderer::Table.expects(:render).with(:csv,{}).yields(rend)
+      a.as(:csv)
+    end
+
+  end
+
+  context "when using renderable_data" do
+
+    class DummyObject2
+      include Ruport::Renderer::Hooks
+      renders_as_table
+
+      def renderable_data
+        1
+      end
+    end
+
+    def specify_should_return_results_of_renderable_data
+      a = DummyObject2.new
+      rend = mock("renderer")
+      rend.expects(:data=).with(1)
+      Ruport::Renderer::Table.expects(:render).with(:csv,{}).yields(rend)
+      a.as(:csv)
+    end
+
+    class DummyObject3
+      include Ruport::Renderer::Hooks
+      renders_as_table
+      
+      def renderable_data
+        raise ArgumentError
+      end
+    end
+
+    def specify_should_not_mask_errors
+      assert_raises(ArgumentError) { DummyObject3.new.as(:csv) }
+    end
+
+
+  end
+
+end

data/test/sql_split_test.rb

@@ -1,5 +1,4 @@
-require "test/unit"
-require "ruport"
+require "test/helpers"
 class TestSqlSplit < Test::Unit::TestCase
 	include Ruport
  	

data/test/table_test.rb

@@ -1,7 +1,4 @@
-require "test/unit"
-require "ruport"
-begin; require "rubygems"; rescue LoadError; nil; end
-
+require "test/helpers"
 
 class Person < Ruport::Data::Record
   

data/test/text_formatter_test.rb

@@ -1,5 +1,4 @@
-require "test/unit"
-require "ruport"        
+require "test/helpers"
 
 class TestRenderTextTable < Test::Unit::TestCase 
   

data/util/bench/data/table/bench_manip.rb

@@ -41,7 +41,7 @@ bench_suite do
     small_table << [1,2,3] 
   }                              
   
-  small_hash = small_table[0].to_h
+  small_hash = small_table[0].to_hash
   bench_case("Table#<< - small hash",SMALL_N) {
     small_table << small_hash 
   }       
@@ -56,7 +56,7 @@ bench_suite do
     wide_table << wide_data[0] 
   }      
   
-  large_hash = wide_table[0].to_h
+  large_hash = wide_table[0].to_hash
   bench_case("Table#<< - large hash",WIDE_N) {
     wide_table << large_hash 
   }       

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: ruport
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2007-05-14 00:00:00 -04:00
+  version: 1.0.1
+date: 2007-06-12 00:00:00 -04:00
 summary: A generalized Ruby report generation and templating engine.
 require_paths: 
 - lib
@@ -30,105 +30,106 @@ authors:
 - Gregory Brown
 files: 
 - examples/btree
-- examples/centered_pdf_text_box.rb
-- examples/data
-- examples/example.csv
-- examples/line_plotter.rb
-- examples/pdf_report_with_common_base.rb
-- examples/png_embed.rb
-- examples/roadmap.png
-- examples/row_renderer.rb
-- examples/RWEmerson.jpg
-- examples/simple_pdf_lines.rb
-- examples/tattle_ruby_version.rb
-- examples/tattle_rubygems_version.rb
-- examples/trac_ticket_status.rb
 - examples/btree/commaleon
-- examples/btree/commaleon/commaleon.rb
 - examples/btree/commaleon/sample_data
 - examples/btree/commaleon/sample_data/ticket_count.csv
 - examples/btree/commaleon/sample_data/ticket_count2.csv
+- examples/btree/commaleon/commaleon.rb
+- examples/data
 - examples/data/tattle.dump
+- examples/row_renderer.rb
+- examples/RWEmerson.jpg
+- examples/centered_pdf_text_box.rb
+- examples/tattle_rubygems_version.rb
+- examples/trac_ticket_status.rb
+- examples/line_plotter.rb
+- examples/png_embed.rb
+- examples/pdf_report_with_common_base.rb
+- examples/example.csv
+- examples/tattle_ruby_version.rb
+- examples/roadmap.png
+- examples/simple_pdf_lines.rb
 - lib/ruport
-- lib/ruport.rb
-- lib/uport.rb
-- lib/ruport/acts_as_reportable.rb
-- lib/ruport/data
-- lib/ruport/data.rb
-- lib/ruport/extensions.rb
 - lib/ruport/formatter
-- lib/ruport/formatter.rb
-- lib/ruport/query
-- lib/ruport/query.rb
-- lib/ruport/renderer
-- lib/ruport/renderer.rb
-- lib/ruport/data/grouping.rb
-- lib/ruport/data/record.rb
-- lib/ruport/data/table.rb
-- lib/ruport/formatter/csv.rb
 - lib/ruport/formatter/html.rb
-- lib/ruport/formatter/pdf.rb
 - lib/ruport/formatter/text.rb
+- lib/ruport/formatter/pdf.rb
+- lib/ruport/formatter/csv.rb
+- lib/ruport/query
 - lib/ruport/query/sql_split.rb
-- lib/ruport/renderer/grouping.rb
+- lib/ruport/renderer
 - lib/ruport/renderer/table.rb
-- test/acts_as_reportable_test.rb
-- test/csv_formatter_test.rb
-- test/grouping_test.rb
-- test/html_formatter_test.rb
-- test/pdf_formatter_test.rb
-- test/query_test.rb
-- test/record_test.rb
-- test/renderer_test.rb
+- lib/ruport/renderer/grouping.rb
+- lib/ruport/data
+- lib/ruport/data/record.rb
+- lib/ruport/data/table.rb
+- lib/ruport/data/grouping.rb
+- lib/ruport/extensions.rb
+- lib/ruport/formatter.rb
+- lib/ruport/query.rb
+- lib/ruport/renderer.rb
+- lib/ruport/data.rb
+- lib/ruport/acts_as_reportable.rb
+- lib/uport.rb
+- lib/ruport.rb
 - test/samples
-- test/sql_split_test.rb
-- test/table_test.rb
-- test/text_formatter_test.rb
-- test/samples/addressbook.csv
+- test/samples/test.yaml
+- test/samples/query_test.sql
 - test/samples/data.csv
 - test/samples/data.tsv
-- test/samples/dates.csv
 - test/samples/erb_test.sql
-- test/samples/query_test.sql
+- test/samples/ticket_count.csv
 - test/samples/ruport_test.sql
+- test/samples/addressbook.csv
+- test/samples/dates.csv
 - test/samples/test.sql
-- test/samples/test.yaml
-- test/samples/ticket_count.csv
-- util/bench/data
+- test/csv_formatter_test.rb
+- test/record_test.rb
+- test/helpers.rb
+- test/query_test.rb
+- test/renderer_test.rb
+- test/html_formatter_test.rb
+- test/table_test.rb
+- test/text_formatter_test.rb
+- test/grouping_test.rb
+- test/sql_split_test.rb
+- test/acts_as_reportable_test.rb
+- test/pdf_formatter_test.rb
 - util/bench/formatter
+- util/bench/formatter/bench_html.rb
+- util/bench/formatter/bench_text.rb
+- util/bench/formatter/bench_pdf.rb
+- util/bench/formatter/bench_csv.rb
 - util/bench/samples
-- util/bench/data/record
+- util/bench/samples/tattle.csv
+- util/bench/data
 - util/bench/data/table
-- util/bench/data/record/bench_as_vs_to.rb
-- util/bench/data/record/bench_constructor.rb
-- util/bench/data/record/bench_indexing.rb
-- util/bench/data/record/bench_reorder.rb
-- util/bench/data/record/bench_to_a.rb
 - util/bench/data/table/bench_column_manip.rb
-- util/bench/data/table/bench_dup.rb
 - util/bench/data/table/bench_init.rb
 - util/bench/data/table/bench_manip.rb
-- util/bench/formatter/bench_csv.rb
-- util/bench/formatter/bench_html.rb
-- util/bench/formatter/bench_pdf.rb
-- util/bench/formatter/bench_text.rb
-- util/bench/samples/tattle.csv
+- util/bench/data/table/bench_dup.rb
+- util/bench/data/record
+- util/bench/data/record/bench_reorder.rb
+- util/bench/data/record/bench_to_a.rb
+- util/bench/data/record/bench_constructor.rb
+- util/bench/data/record/bench_indexing.rb
+- util/bench/data/record/bench_as_vs_to.rb
 - Rakefile
 - README
 - LICENSE
 - AUTHORS
 test_files: 
-- test/acts_as_reportable_test.rb
 - test/csv_formatter_test.rb
-- test/grouping_test.rb
-- test/html_formatter_test.rb
-- test/pdf_formatter_test.rb
-- test/query_test.rb
 - test/record_test.rb
+- test/query_test.rb
 - test/renderer_test.rb
-- test/sql_split_test.rb
+- test/html_formatter_test.rb
 - test/table_test.rb
 - test/text_formatter_test.rb
+- test/grouping_test.rb
+- test/sql_split_test.rb
+- test/acts_as_reportable_test.rb
+- test/pdf_formatter_test.rb
 rdoc_options: 
 - --title
 - Ruport Documentation