ruport 0.4.9 → 0.4.11

data/lib/ruport/query.rb

@@ -111,7 +111,7 @@ module Ruport
     # DBI:Row objects
     def result; fetch; end
     
-    # Runs the query without returning it's results.
+    # Runs the query without returning its results.
     def execute; fetch; nil; end
     
     # clears the contents of the cache

data/lib/ruport/rails/reportable.rb

@@ -1,15 +1,15 @@
 module Ruport
   module Reportable
     def formatted_table(type,options={},&block)
-      to_ds({:find => options[:find]}).as(type) do |e|
+      to_ds(:find => options[:find],:columns => options[:columns]).as(type){ |e|
         block[e] if block_given?
-        e.data.select_columns! *options[:columns] if options[:columns]
-      end
+      }
     end
     def to_ds(options={})
-     find(:all,options[:find]).to_ds(options[:columns] || column_names)
+     options[:columns] ||= column_names
+     find(:all,options[:find]).
+       to_ds(column_names).select_columns(*options[:columns])
     end
-    
   end
   class DataSet
     alias_method :old_append, :<<

data/lib/ruport/report.rb

@@ -1,4 +1,4 @@
-# FIXME: Copyright notice here.
+# fixME: Copyright notice here.
 
 #load the needed standard libraries.
 %w[erb yaml date logger fileutils].each { |lib| require lib }
@@ -9,7 +9,6 @@ module Ruport
   class Report   
     def initialize( source_name=:default, mailer_name=:default )
       @source = source_name
-      
       @report_name = @report = ""
       @file        = nil
     end
@@ -40,11 +39,7 @@ module Ruport
     # Evaluates _code_ from _filename_ as pure ruby code for files ending in
     # .rb, and as ERb templates for anything else.
     def eval_template( filename, code )
-      if filename =~ /\.rb/
-        eval(code)
-      else
-        ERB.new(code, 0, "%").run(binding)
-      end
+      filename =~ /\.rb/ ? eval(code) : ERB.new(code, 0, "%").run(binding)
     end
     
 
@@ -55,19 +50,11 @@ module Ruport
     # file with the specified name.  Otherwise, it will print to STDOUT by
     # default. 
     #
-    # Lastly, if you have your mailer configuration set up and
-    # you've specified recipients, the contents of @mailer.body will
-    # be automatically emailed by this fuction.
-    #
     # The source for this function is probably easier to read than this
     # explanation, so you may want to start there.     
     def generate_report
       @pre.call if @pre
-      if (@file.nil?) 
-        puts(@report)
-      else 
-        File.open(@file,"w") { |f| f.puts @report }
-      end
+      @file ? File.open(@file,"w") { |f| f.puts @report } : puts(@report)
       @post.call if @post
     end
 

data/lib/ruport/system_extensions.rb

@@ -0,0 +1,125 @@
+#!/usr/local/bin/ruby -w
+
+# system_extensions.rb
+#
+# lovingly ganked from HighLine 1.2.1
+#
+# The following modifications have been made by Gregory Brown on 2006.06.25
+#
+# - Outer Module is changed from HighLine to Ruport
+# - terminal_width / terminal_height added
+#
+# All modifications are under the distributions terms of Ruport.
+# Copyright 2006, Gregory Brown.  All Rights Reserved
+#
+# Original copyright notice preserved below. 
+# --------------------------------------------------------------------------
+#
+#  Created by James Edward Gray II on 2006-06-14.
+#  Copyright 2006 Gray Productions. All rights reserved.
+#
+#  This is Free Software.  See LICENSE and COPYING for details.
+
+module Ruport
+  module SystemExtensions
+    module_function
+    
+    #
+    # This section builds character reading and terminal size functions
+    # to suit the proper platform we're running on.  Be warned:  Here be
+    # dragons!
+    #
+    begin
+      require "Win32API"       # See if we're on Windows.
+
+      CHARACTER_MODE = "Win32API"    # For Debugging purposes only.
+
+      #
+      # Windows savvy getc().
+      # 
+      # *WARNING*:  This method ignores <tt>input</tt> and reads one
+      # character from +STDIN+!
+      # 
+      def get_character( input = STDIN )
+        Win32API.new("crtdll", "_getch", [ ], "L").Call
+      end
+
+      # A Windows savvy method to fetch the console columns, and rows.
+      def terminal_size
+        m_GetStdHandle               = Win32API.new( 'kernel32',
+                                                     'GetStdHandle',
+                                                     ['L'],
+                                                     'L' )
+        m_GetConsoleScreenBufferInfo = Win32API.new(
+          'kernel32', 'GetConsoleScreenBufferInfo', ['L', 'P'], 'L'
+        )
+
+        format        = 'SSSSSssssSS'
+        buf           = ([0] * format.size).pack(format)
+        stdout_handle = m_GetStdHandle.call(0xFFFFFFF5)
+        
+        m_GetConsoleScreenBufferInfo.call(stdout_handle, buf)
+        bufx, bufy, curx, cury, wattr,
+        left, top, right, bottom, maxx, maxy = buf.unpack(format)
+        return right - left + 1, bottom - top + 1
+      end
+    rescue LoadError             # If we're not on Windows try...
+      begin
+        require "termios"    # Unix, first choice.
+
+        CHARACTER_MODE = "termios"    # For Debugging purposes only.
+
+        #
+        # Unix savvy getc().  (First choice.)
+        # 
+        # *WARNING*:  This method requires the "termios" library!
+        # 
+        def get_character( input = STDIN )
+          old_settings = Termios.getattr(input)
+
+          new_settings         =  old_settings.dup
+          new_settings.c_lflag &= ~(Termios::ECHO | Termios::ICANON)
+
+          begin
+            Termios.setattr(input, Termios::TCSANOW, new_settings)
+            input.getc
+          ensure
+            Termios.setattr(input, Termios::TCSANOW, old_settings)
+          end
+        end
+      rescue LoadError         # If our first choice fails, default.
+        CHARACTER_MODE = "stty"    # For Debugging purposes only.
+
+        #
+        # Unix savvy getc().  (Second choice.)
+        # 
+        # *WARNING*:  This method requires the external "stty" program!
+        # 
+        def get_character( input = STDIN )
+          state = `stty -g`
+
+          begin
+            system "stty raw -echo cbreak"
+            input.getc
+          ensure
+            system "stty #{state}"
+          end
+        end
+      end
+      
+      # A Unix savvy method to fetch the console columns, and rows.
+      def terminal_size
+       `stty size`.split.map { |x| x.to_i }.reverse
+      end
+
+      def terminal_width
+        terminal_size.first
+      end
+
+      def terminal_height
+        terminal_size.last
+      end
+      
+    end
+  end
+end

data/test/tc_data_set.rb

@@ -163,9 +163,16 @@ class TestDataSet < Test::Unit::TestCase
   end
 
   def test_load
-    loaded_data = DataSet.load("test/samples/data.csv")
+    loaded_data = DataSet.load("test/samples/data.csv", :default => "")
     assert_equal(@data,loaded_data)
 
+    loaded_data = DataSet.load("test/samples/data.csv", :has_names => false)
+    
+    assert_equal(nil,loaded_data.fields)
+    assert_equal([%w[col1 col2 col3],%w[a b c],["d",nil,"e"]],loaded_data.to_a)
+    assert_equal(%w[a b c],loaded_data[1].to_a)
+    
+
     loaded_data = DataSet.load("test/samples/data.csv") do |set,row| 
       set << row if row.include? 'b' 
     end
@@ -175,7 +182,7 @@ class TestDataSet < Test::Unit::TestCase
   def test_to_csv
     loaded_data = DataSet.load("test/samples/data.csv" )
     csv = loaded_data.to_csv
-    assert_equal("col1,col2,col3\na,b,c\nd,\"\",e\n",csv)
+    assert_equal("col1,col2,col3\na,b,c\nd,,e\n",csv)
   end
 
   def test_to_html
@@ -183,20 +190,27 @@ class TestDataSet < Test::Unit::TestCase
                  "<th>col2 </th>\n\t\t\t<th>col3</th>\n\t\t</tr>\n"+
                  "\t\t<tr>\n\t\t\t<td>a</td>\n\t\t\t<td>b</td>\n\t\t\t"+
                  "<td>c</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>d</td>\n\t"+
-                 "\t\t<td>e</td>\n\t\t</tr>\n\t</table>", @data.to_html )
+                 "\t\t<td>&nbsp;</td>\n\t\t\t<td>e</td>\n\t\t</tr>"+
+                 "\n\t</table>", @data.to_html )
   end
 
   def test_select_columns
+
+    b = @data.select_columns(0,2)
+    assert_equal(%w[col1 col3], b.fields)
+    assert_equal([%w[a c],%w[d e]],b.to_a)
+    
     assert_equal( [["a"],["d"]],
-                  @data.select_columns("col1").map { |r| r.to_a } )
+                  @data.select_columns("col1").to_a )
     assert_equal( [["b"],[""]] , 
-                  @data.select_columns("col2").map { |r| r.to_a } )
+                  @data.select_columns("col2").to_a )
     assert_equal( [["c"],["e"]],
-                  @data.select_columns("col3").map { |r| r.to_a } )
+                  @data.select_columns("col3").to_a )
     assert_equal( [["a","b","c"],["d","","e"]],
-                  @data.select_columns("col1","col2","col3").map { |r| r.to_a })
+                  @data.select_columns("col1","col2","col3").to_a )
     assert_equal( [["c","a"],["e","d"]],
-                  @data.select_columns("col3","col1").map { |r| r.to_a } )
+                  @data.select_columns("col3","col1").to_a )
+
   end
  
   def test_select_columns!
@@ -247,17 +261,40 @@ class TestDataSet < Test::Unit::TestCase
 
     #check alias
     sum = data.sum { |r| r["x"] }
-    assert_equal(18,sum)
-    
+    assert_equal(18,sum) 
+  end
+
+  def test_add_columns
+    d = @data.add_columns("a","b")
+    assert_equal %w[col1 col2 col3 a b], d.fields
+    assert_equal %w[col1 col2 col3], @data.fields
+    assert_equal %w[col1 col2 col3 a b], d[0].fields
+    assert_equal %w[col1 col2 col3], @data[0].fields
+    assert_equal nil, d[0]["a"]
+    d[0]["a"] = "foo"
+    assert_equal %w[a b c foo] + [nil], d[0].to_a
+
+    d.add_columns!("c")
+    assert_equal %w[col1 col2 col3 a b c], d.fields
+    assert_equal %w[col1 col2 col3 a b c], d[0].fields
   end
 
   def test_remove_columns
+   
+   d = @data.remove_columns(0)
+   assert_equal(%w[col2 col3],d.fields)
+   assert_equal([%w[b c],["","e"]], d.to_a)
+    
    data = @data.remove_columns("col1","col3")
    assert_equal(["col2"],data.fields)
+   assert_equal([["b"],[""]], data.to_a)
 
    data.remove_columns!("col2")
    assert_equal([],data.fields)
    assert(data.empty?)
+
+   @data.remove_columns!("col1")
+   assert_equal(%w[col2 col3], @data.fields)
   end
 
   def test_bracket_equals

data/test/tc_format_engine.rb

@@ -1,93 +1,83 @@
-require 'rubygems'
+begin require 'rubygems'; rescue LoadError; nil end
 require 'ruport'
 require 'test/unit'
 
+class MockPlugin < Ruport::Format::Plugin
+  
+  renderer(:table) { "#{rendered_field_names}#{data}" }
+ 
+  format_field_names { "#{data.fields}" }
+  
+  renderer(:document) { data }
+
+  register_on :table_engine
+  register_on :document_engine
+
+  rendering_options :red_cloth_enabled => true, 
+                    :erb_enabled => true
+
+end
+
 class TestTabularFormatEngine < Test::Unit::TestCase
   
   include Ruport
-
+  
   def setup
-    @engine = Format::Engine::Table
+    @engine = Format::Engine::Table.dup
   end
   
   def test_basic_render
-     @engine.plugin = :csv
-     @engine.data = [[1,2,3],[4,5,6],[7,8,9]].to_ds(%w[a b c])
-     assert_equal( "a,b,c\n1,2,3\n4,5,6\n7,8,9\n", 
-                   @engine.render )
+     @engine.plugin = :mock
      @engine.data = [[1,2,3],[4,5,6],[7,8,9]]
-     assert_equal( "1,2,3\n4,5,6\n7,8,9\n", @engine.render )
+     assert_equal( "#{@engine.data}", @engine.render )
   end
 
   def test_render_without_field_names
-    @engine.plugin = :csv
+    @engine.plugin = :mock
     @engine.show_field_names = false
     
-    @engine.data = [[1,2,3],[4,5,6],[7,8,9]].to_ds(%w[a b c])
-    assert_equal "1,2,3\n4,5,6\n7,8,9\n", @engine.render
-    
     @engine.data = [[1,2,3],[4,5,6],[7,8,9]]
-    assert_equal "1,2,3\n4,5,6\n7,8,9\n", @engine.render 
-  end
-
-  def test_render_with_column_spacer
-    a = @engine.dup
-    
-    a.plugin = :csv
-    a.data = [[1,2],[3,4],[5,6],[7,8]]
-    a.insert_column :left_of => 1
-    assert_equal "1,\"\",2\n3,\"\",4\n5,\"\",6\n7,\"\",8\n", a.render
-    
-    b = @engine.dup
-    
-    b.plugin = :csv
-    b.data = [%w[a b c],%w[d e f],%w[g h i]]
-    b.insert_column :right_of => 1
-    assert_equal "a,b,\"\",c\nd,e,\"\",f\ng,h,\"\",i\n", b.render
-  end
-
-  def test_render_with_row_spacer
-    a = @engine.dup
-
-    a.plugin = :csv
-    a.data = [[1,2],[3,4]]
-    a.insert_row :above => 1
-    assert_equal "1,2\n\n3,4\n", a.render
-
-    b = @engine.dup
-    b.plugin = :csv
-    b.data = [[1,2],[3,4],[5,6],[7,8]]
-    b.insert_row :below => 2
-    assert_equal "1,2\n3,4\n5,6\n\n7,8\n", b.render
-    
+    assert_equal "#{@engine.data}", @engine.render 
   end
 
   def test_simple_interface
-    expected = "1,2\n3,4\n"
-    actual = Format.table(:plugin => :csv, :data => [[1,2],[3,4]]) 
+    expected = "#{[[1,2],[3,4]]}"
+    actual = Format.table(:plugin => :mock, :data => [[1,2],[3,4]]) 
     assert_equal(expected,actual)
   end
 
   def test_rewrite_column
     a = @engine.dup
-    a.plugin = :csv
+    a.plugin = :mock
+    
     a.data = [[1,2],[3,4]].to_ds(%w[a b])
     a.rewrite_column("a") { |r| r["a"] + 1 }
-    assert_equal "2,2\n4,4\n", a.render
+    assert_equal([[2,2],[4,4]].to_ds(%w[a b]),a.data)
+    assert_nothing_raised { a.render }
+    
     a.data = [[5,6],[7,8]]
     a.rewrite_column(1) { "apple" }
-    assert_equal "5,apple\n7,apple\n", a.render
+    assert_equal [[5,"apple"],[7,"apple"]], a.data
+    assert_nothing_raised { a.render }
+  end
+
+  def test_num_columns
+    @engine.data = [[1,2,3,4],[5,6,7,8]]
+    assert_equal(4,@engine.num_cols)
+
+    @engine.data = [[1,2,3],[4,5,6]].to_ds(%w[a b c])
+    assert_equal(3,@engine.num_cols)
   end
     
 end
 
 class TestDocumentFormatEngine < Test::Unit::TestCase
   def setup
-    @engine = Format::Engine::Document
+    @engine = Format::Engine::Document.dup
   end
 
   def test_basic_render
-    @engine.plugin = :html
+    @engine.plugin = :mock
     @engine.red_cloth_enabled = true
     @engine.erb_enabled = true
     @engine.data = "* <%= 3 + 2 %>\n* <%= 'apple'.reverse %>\n* <%= [1,2][0] %>"
@@ -98,7 +88,7 @@ class TestDocumentFormatEngine < Test::Unit::TestCase
   def test_simple_interface
    
    d = "*<%= 'apple'.reverse %>*"
-   opts = { :data => d, :plugin => :html }
+   opts = { :data => d, :plugin => :mock }
    
    a = Format.document opts
    assert_equal "<p><strong>elppa</strong></p>", a
@@ -108,6 +98,9 @@ class TestDocumentFormatEngine < Test::Unit::TestCase
 
    a = Format.document opts.merge!({:erb_enabled => false})
    assert_equal d, a
+
+   a = Format.document :data => d, :plugin => :mock
+   assert_equal "<p><strong>elppa</strong></p>", a
    
   end
 end