ruport 0.2.2 → 0.2.4

data/AUTHORS

@@ -1 +1,7 @@
-{Gregory Brown}[mailto:gregory.t.brown@gmail.com]
+{Gregory Brown}[mailto:gregory.t.brown@gmail.com]:
+
+Original Author and Ruport::Report hacker.
+
+{Robert Canieso}[mailto:rcanieso@gmail.com]:
+
+Guy in charge of the Ruport::Format module

data/CHANGELOG

@@ -1,4 +1,25 @@
-The current version of Ruby Reports is 0.2.2
+The current version of Ruby Reports is 0.2.4
+
+changes since Ruport 0.2.2:
+
+- Report::DataSet and Report::DataRow are now enumerable
+
+- DataSet#eql? fixed
+
+- Format::Builder has been added to handle formatting
+  (Supports CSV / HTML currently)
+
+- Format::Builder is easily extendable via send("render_#{@type}")
+
+- DataSet#to_html convenience method added
+
+- DataSet#fields can now be arbitrary objects (does not need to be Strings)
+
+- Dropped DataRow#middle? because it was useless. (And poorly named)
+
+- FakeMailer added for testing goodness.
+
+- Dropped select() and execute() in favor of query()
 
 changes since Ruport 0.2.0:
 

data/README

@@ -81,6 +81,9 @@ point, unless you're magic, you'll probably need to either read the
 {API Documentation}[http://ruport.rubyforge.org/docs/] or the source, whichever
 you're most comfortable with.
 
+There is also a set of examples at:
+http://rubyforge.org/frs/?group_id=856&release_id=3481
+
 I hope you enjoy this software and that it is useful to you.
 
 -Greg

data/Rakefile

@@ -14,7 +14,7 @@ end
 
 spec = Gem::Specification.new do |spec|
 	spec.name = "ruport"
-	spec.version = "0.2.2"
+	spec.version = "0.2.4"
 	spec.platform = Gem::Platform::RUBY
 	spec.summary = "A generalized Ruby report generation and templating engine."
 

data/TODO

@@ -1,15 +1,12 @@
 TODO:
 
 Bugfixes:
- - Fix potential failure in Ruport::Report::DataSet#eql?
- - Is there an OS X packaging problem with the gems?
  - Fix the manual that is in the example package so it it reads FakeDB instead
-   of MockDB
+   of MockDB.  Update the manual to cover new features in 0.2.4
  
 Improvement:
 
 - Mail system
-	Hook up unit tests
 	Make attachments doable
 
 - Template Config / Line Editing
@@ -27,6 +24,7 @@ Improvement:
 	Expand so that it covers most common SQL commands.
 	Form better more complete unit tests.
 
+- Queries from file / db need to use ERb or some other replacement ability 
 
 Begin implementing new features:
 
@@ -120,5 +118,6 @@ Other:
 This is only the tip of the iceburg.  Please feel free to continue to fill my
 plate by sending any suggestions to gregory.t.brown@gmail.com
 	
-
-		
+JEG2 Code Review 2005.11.14: (email me if you find any of this interesting)
+- use the many levels of logger
+- RQL (Ruport Query Language)

data/bin/ruport

@@ -65,7 +65,7 @@ if ARGV[0].eql?("generate")
   }
   exit
 elsif ARGV[0].eql?("-v")
-  puts "Ruport Version 0.2.2 \nA ruby report generation system by Gregory " +
+  puts "Ruport Version 0.2.4 \nA ruby report generation system by Gregory " +
   "Brown.\nThis application is Free Software under the GPL/Ruby License. " +
   "\nAll praise and/or criticism can be directed to "+
   "gregory.t.brown@gmail.com"

data/lib/ruport/format/builder.rb

@@ -0,0 +1,34 @@
+module Ruport
+  module Format
+    class Builder
+      
+      def initialize( data_set )
+        @data = data_set
+        @type = nil
+      end
+      
+      attr_accessor :type
+      
+      def render
+        send("render_#{@type}")
+      end
+      
+      def render_csv
+        @data.inject(CSV.generate_line(@data.fields) + "\n") do |out,r|  
+          out << CSV.generate_line(@data.fields.map { |f| r[f] }) + "\n"
+        end
+      end
+
+      def render_html
+        fields_html = "<tr>\n    <td>#{@data.fields.join('</td><td>')}</td>\n  </tr>"
+        @data.inject("<table>\n  #{fields_html}"){|html,row|
+          html << row.inject("  <tr>\n    "){ |row_html, field|
+                    row_html << "<td>#{field}</td>"
+                  } + "\n  </tr>"
+        } + "\n</table>"
+      end
+      
+    end
+  end
+end
+

data/lib/ruport/report/data_row.rb

@@ -11,6 +11,8 @@ module Ruport
   module Report
     class DataRow 
     
+      include Enumerable
+      
       attr_accessor :fields
     
       # DataRows are essentially arrays with named ordinal fields and
@@ -27,7 +29,7 @@ module Ruport
       #
       # i.e. row["phone"]
       def [](key)
-        key.kind_of?(String) ? @data[@fields.index(key)] : @data[key]
+        key.kind_of?(Fixnum) ? @data[key] : @data[@fields.index(key)] 
       end
       
       # Lets you set field values
@@ -53,13 +55,17 @@ module Ruport
       # DataRow#first? DataRow#last? DataRow#middle?
       # DataRow#odd? DataRow#even? which are all conditional methods.
       def method_missing(method)
-        if %[last? first? middle?].include? method.to_s
+        if %[last? first? center?].include? method.to_s
         return @position.eql?(method.to_s[0..-2].to_sym)
         elsif %[odd? even?].include? method.to_s
           return @oddness.eql?(method.to_s[0..-2].to_sym)
         end
         super
       end
+
+      def each(&action)
+        @data.each(&action)
+      end
           
       attr_accessor :position
     end

data/lib/ruport/report/data_set.rb

@@ -9,6 +9,9 @@
 module Ruport
   module Report
     class DataSet
+      
+      include Enumerable
+      
       def initialize
         @data = []
       end
@@ -48,19 +51,21 @@ module Ruport
         
         oddness  = (@data.length % 2 == 0 ? :even  : :odd)
         position = (@data.length == 0 ? :first : :last)
-        @data[@data.length - 1].position = :middle if @data.length > 1
+        @data[@data.length - 1].position = nil if @data.length > 1
         @data << DataRow.new(new_row,@fields,oddness,position)
       end
 
       # This works in best case scenario.  It should return true if
       # both DataSets have the same values.  Still working out the kinks here.
       def eql?(data2)
-        return false unless (@data.length == data2.data.length)
-        0.upto(@data.length - 1) do |index|
-          (@fields + data2.fields).uniq.each do |key|
-            return false unless @data[index][key] == data2[index][key]
+        return false unless ( @data.length == data2.data.length and
+                              @fields.eql?(data2.fields) )
+        @data.each_with_index do |row, r_index|
+          row.each_with_index do |field, f_index|
+            return false unless field.eql?(data2[r_index][f_index])
           end
         end
+
         return true
       end
       
@@ -82,21 +87,19 @@ module Ruport
      
       # Converts a DataSet to CSV
       def to_csv
-        output = CSV.generate_line(@fields) + "\n"
-        @data.each do |row|
-          output << CSV.generate_line(@fields.map { |f| row[f] }) + "\n"
-        end
-        return output
+        builder = Format::Builder.new(self)
+        builder.type = :csv
+        builder.render
+      end
+      # Converts a Dataset to Html
+      def to_html 
+        builder = Format::Builder.new(self)
+        builder.type = :html
+        builder.render
       end
-
       # Works like a standard each iterator
       def each(&action)
-        @data[0..-1].each(&action)
-      end
-
-      # Works like a standard each_with_index iterator
-      def each_with_index(&action)
-        @data[0..-1].each_with_index(&action)
+        @data.each(&action)
       end
 
     end

data/lib/ruport/report/engine.rb

@@ -21,69 +21,25 @@ module Ruport
   module Report
     class Engine 
       def initialize( dsn, user, password, mailer=nil )
+        
+        File.exists?("log") or FileUtils.mkdir("log")
+        @logger      = Logger.new("log/ruport.log")
+        
         @dsn         = dsn
         @user        = user
         @password    = password
-        @report_name = ""
         @mailer      = mailer
-        File.exists?("log") or FileUtils.mkdir("log")
-        @logger      = Logger.new("log/ruport.log")
         @generate    = true
+        @report_name = ""
         @report      = ""
+        @query_table = nil
+        @file        = nil
+        @config      = nil
       end
       
       attr_accessor :query_table, :file
       attr_reader   :mailer, :generate, :config, :logger  
       
-      # * DEPRECATED:  Use query() *
-      #
-      # Takes a query, an optional sourcetype, and a block which is passed the
-      # results row by row.  When passed a query in string form, it adds the
-      # SELECT clause to the string and executes the query.  When passed a
-      # filename and a source :file, it looks in queries/ for the file specified.
-      # When given a database query label, it looks in config[query_table] for a
-      # query with the label specified.  If no source is specified, it uses
-      # string by default for the source.
-      #
-      # Example:
-      # 
-      # select ( "* FROM test" ) 
-      # Passes "SELECT * FROM test" to the database
-      #
-      # select ( "test.sql", :file )
-      # Passes the contents of queries/test.sql to the database
-      #  
-      # select ( "TEST", :db )
-      # Calls the query TEST stored in the database and query_table specified in
-      # config/ruport.yaml
-      
-      def select( query, source = :string, &action )
-        source != :string || query = "SELECT " + query
-        execute( query, source ) do |sth|
-          @column_names = sth.column_names
-          @first_row = true 
-          sth.fetch do |row|
-            action.call(row) if block_given?
-            @first_row = false 
-          end
-        end
-      end
-
-      # * DEPRECATED, Use query() * 
-      #
-      # Takes a query and an optional sourcetype and then runs the query
-      # against the database.  The output is not returned.  This is useful for
-      # doing construction and destruction actions.
-      def execute( query, source = :string )
-        query = get_query(source, query)
-        DBI.connect(@dsn, @user, @password) do |dbh|
-          dbh.prepare(query) do |sth|
-            sth.execute()
-            yield(sth)
-          end
-        end
-      end
-      
       # Takes a query and an optional sourcetype and then runs the query 
       # against the database.  The return from the query is then converted
       # into a DataSet which can then be manipulated.
@@ -159,8 +115,10 @@ module Ruport
         when :file
           load_file( query )
         when :db
-          select ( "query FROM #{@query_table} WHERE " +
-          "label LIKE '#{query}';" ) do |row| return row["query"] end
+          query ( "SELECT query FROM #{@query_table} WHERE " +
+                  "label LIKE '#{query}';" ) do |data|
+                    return data[0]["query"] 
+          end
         end
       end
           

data/lib/ruport/report/fake_engine.rb

@@ -13,32 +13,10 @@ module Ruport
       
       attr_accessor :fake_db
       
-      def execute (query, source = :string)
-        query = get_query(source, query)
-        yield(@fake_db.process(@dsn,@user,@password, query))
-      end
-      
-      def select( query, source = :string, &action )
-        source != :string || query = "SELECT " + query
-        execute( query, source ) do |table|
-          if table.kind_of?(DataSet)
-            @column_names = table.fields
-          else
-            @column_names = table[0].keys
-          end
-          @first_row = true
-          table.each do |row|
-            row = row.to_hash if table.kind_of?(DataSet)
-            action.call(row) if block_given?
-            @first_row = false
-          end
-        end
-      end
 
       def query ( query, source = :string, &action)
-        execute( query, source ) do |table|
-          action.call(table)
-        end
+        query = get_query(source, query)
+        yield(@fake_db.process(@dsn,@user,@password, query))
       end
 
     end

data/lib/ruport/report/fake_mailer.rb

@@ -0,0 +1,23 @@
+module Ruport
+  module Report
+    class FakeMailer < Mailer
+      
+      @@fake_server = Hash.new
+      @@fake_server[:port] = 25
+      
+      def self.[]=(key,value)
+        @@fake_server[key] = value
+      end
+        
+      def send_report(report_name="No Subject")
+        raise "Invalid Host" unless @@fake_server[:host].eql?(@host)
+        raise "Invalid Account" unless @@fake_server[:account].eql?(@account)
+        raise "Bad Email Address" unless @@fake_server[:address].eql?(@address)
+        raise "Bad Password" unless @@fake_server[:password].eql?(@password)
+        raise "Invalid Port" unless @@fake_server[:port].eql?(@port)
+        raise "Bad Authorization Type" unless @@fake_server[:auth].eql?(@auth)
+      end
+
+    end
+  end
+end

data/lib/ruportlib.rb

@@ -5,4 +5,6 @@ require "ruport/report/fake_db"
 require "ruport/report/fake_engine"
 require "ruport/report/data_set"
 require "ruport/report/data_row"
+require "ruport/report/fake_mailer"
+require "ruport/format/builder"
 include Ruport

data/test/tc_builder.rb

@@ -0,0 +1,25 @@
+
+require "test/unit"
+require "lib/ruportlib"
+class TestBuilder < Test::Unit::TestCase
+  def setup
+    @data = Report::DataSet.new
+    @data.fields = %w[ col1 col2 col3 ]
+    @data.default = ""; @data << %w[ a b c ]; @data << %w[ d e f ]
+    @builder = Format::Builder.new( @data )
+  end
+
+  def test_render_html
+    @builder.type = :html
+    assert_equal("<table>\n  <tr>\n    <td>col1</td><td>col2</td>" +
+                 "<td>col3</td>\n  </tr>" +
+                 "  <tr>\n    <td>a</td><td>b</td><td>c</td>\n  </tr>" +
+                 "  <tr>\n    <td>d</td><td>e</td><td>f</td>\n  </tr>" +
+                 "\n</table>", @builder.render )
+  end
+
+  def test_render_csv
+    @builder.type = :csv
+    assert_equal("col1,col2,col3\na,b,c\nd,e,f\n", @builder.render)
+  end
+end

data/test/tc_data_row.rb

@@ -11,6 +11,7 @@ class TestDataRow < Test::Unit::TestCase
     @rows << [ 3 , 4 ]
     @rows << [ 5 , 6 ]
     @rows << { "foo" => 7, "bar" => 8 }
+    @rows << [ 9, 10 ]
   end
 
   def test_first?
@@ -20,14 +21,6 @@ class TestDataRow < Test::Unit::TestCase
     end
   end
 
-  def test_middle?
-    assert(!@rows[0].middle?)
-    assert(!@rows[-1].middle?)
-    @rows[1..-2].each do |row|
-      assert(row.middle?)
-    end
-  end
-
   def test_last?
     @rows[0..-2].each do |row|
       assert(!row.last?)

data/test/tc_data_set.rb

@@ -54,8 +54,12 @@ class TestDataSet < Test::Unit::TestCase
   end
 
   def test_load
-     loaded_data = Report::DataSet.load("test/data.csv")
-     assert(@data.eql?(loaded_data))
+    loaded_data = Report::DataSet.load("test/data.csv")
+    @data.each_with_index do |row,r_index|
+      row.each_with_index do |field,f_index|
+        assert_equal(field,loaded_data[r_index][f_index])
+      end
+    end
   end
 
   def test_to_csv
@@ -64,4 +68,12 @@ class TestDataSet < Test::Unit::TestCase
     assert_equal("col1,col2,col3\na,b,c\nd,\"\",e\n",csv)
   end
 
+  def test_to_html
+    assert_equal("<table>\n  <tr>\n    <td>col1</td><td>col2</td>" +
+                 "<td>col3</td>\n  </tr>" +
+                 "  <tr>\n    <td>a</td><td>b</td><td>c</td>\n  </tr>" +
+                 "  <tr>\n    <td>d</td><td></td><td>e</td>\n  </tr>" +
+                 "\n</table>", @data.to_html )
+  end
+
 end

data/test/tc_engine.rb

@@ -5,27 +5,28 @@
 
 require "test/unit"
 require "lib/ruportlib"
-class TestRuport < Test::Unit::TestCase
+class TestEngine < Test::Unit::TestCase
   
-def setup
-    @report = Report::FakeEngine.new( "DBI:mysql:ruport:localhost", "test", "123") 
-    @report.query_table = "ruport_queries"
+  def setup
+      @report = Report::FakeEngine.new( "DBI:mysql:ruport:localhost",
+                                        "test", "123") 
+      @report.query_table = "ruport_queries"
 
-    @report.fake_db = Report::FakeDB.new([ "DBI:mysql","ruport",
-                                   "localhost",  "test", "123"])
+      @report.fake_db = Report::FakeDB.new([ "DBI:mysql","ruport",
+                                     "localhost",  "test", "123"])
 
-    @report.fake_db["SELECT * FROM ruport_test"] = @data =
-      [ { "a" => "a column, row 1", "b" => "b column, row 1", 
-          "c" => "c column, row 1", "d" => "d column, row 1" },
-        { "a" => "a column, row 2", "b" => "b column, row 2",
-          "c" => "c column, row 2", "d" => "d column, row 2" },
-        { "a" => "a column, row 3", "b" => "b column, row 3",
-          "c" => "c column, row 3", "d" => "d column, row 3" } ]
-          
-     @report.fake_db[ "SELECT query FROM #{@report.query_table} " +
-                      "WHERE label LIKE 'sql_stored_test';"] =
-                      [ "query" => "SELECT * FROM ruport_test" ]
-end
+      @report.fake_db["SELECT * FROM ruport_test"] = @data =
+        [ { "a" => "a column, row 1", "b" => "b column, row 1", 
+            "c" => "c column, row 1", "d" => "d column, row 1" },
+          { "a" => "a column, row 2", "b" => "b column, row 2",
+            "c" => "c column, row 2", "d" => "d column, row 2" },
+          { "a" => "a column, row 3", "b" => "b column, row 3",
+            "c" => "c column, row 3", "d" => "d column, row 3" } ]
+            
+       @report.fake_db[ "SELECT query FROM #{@report.query_table} " +
+                        "WHERE label LIKE 'sql_stored_test';"] =
+                        [ "query" => "SELECT * FROM ruport_test" ]
+  end
   
   def test_load_file
     contents = "SELECT * FROM ruport_test"
@@ -62,36 +63,15 @@ end
     end
   end
 
-def test_sql 
-  row_i = 0
-    @report.select("* FROM ruport_test") do |row|
-      assert_equal(@data[row_i]["a"],  row["a"].to_s)
-      assert_equal(@data[row_i]["b"],  row["b"].to_s)
-      assert_equal(@data[row_i]["c"],  row["c"].to_s)
-      assert_equal(@data[row_i]["d"],  row["d"].to_s)
-      row_i += 1
-    end
-  end
-
   def test_sql_file
-    row_i = 0
-    @report.select("test/test.sql",:file) do |row|
-      assert_equal(@data[row_i]["a"],  row["a"].to_s)
-      assert_equal(@data[row_i]["b"],  row["b"].to_s)
-      assert_equal(@data[row_i]["c"],  row["c"].to_s)
-      assert_equal(@data[row_i]["d"],  row["d"].to_s)
-      row_i += 1
+    @report.query("test/test.sql",:file) do |result|
+      assert_equal(@data,result)
     end
   end
 
   def test_sql_stored
-    row_i = 0
-    @report.select("sql_stored_test",:db) do |row|
-      assert_equal(@data[row_i]["a"],  row["a"].to_s)
-      assert_equal(@data[row_i]["b"],  row["b"].to_s)
-      assert_equal(@data[row_i]["c"],  row["c"].to_s)
-      assert_equal(@data[row_i]["d"],  row["d"].to_s)
-      row_i += 1
+    @report.query("sql_stored_test",:db) do |result|
+      assert_equal(@data,result)
     end
   end
 

data/test/tc_mailer.rb

@@ -0,0 +1,21 @@
+require "test/unit"
+require "ruportlib"
+
+class TestMailer < Test::Unit::TestCase
+
+  def setup
+    Report::FakeMailer[:host]      = "mail.fakeruport.org"
+    Report::FakeMailer[:address]   = "greg@fakeruport.org"
+    Report::FakeMailer[:account]   = "greg"
+    Report::FakeMailer[:password]  = "bubbles"
+    Report::FakeMailer[:auth]      = :login
+    
+    @mailer = Report::FakeMailer.new( "mail.fakeruport.org",
+                                      "greg@fakeruport.org",
+                                      "greg","bubbles", 25, :login )
+  end                                  
+  def test_send
+    assert_nothing_raised { @mailer.send_report }
+  end
+
+end

data/test/ts_all.rb

@@ -2,3 +2,5 @@ require "test/unit"
 require "test/tc_engine"
 require "test/tc_data_set"
 require "test/tc_data_row"
+require "test/tc_builder"
+require "test/tc_mailer"

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.10
+rubygems_version: 0.8.11
 specification_version: 1
 name: ruport
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
-date: 2005-11-11
+  version: 0.2.4
+date: 2005-11-16 00:00:00 -06:00
 summary: A generalized Ruby report generation and templating engine.
 require_paths: 
   - lib
@@ -24,21 +24,27 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
         version: 0.0.0
   version: 
 platform: ruby
+signing_key: 
+cert_chain: 
 authors: 
   - Gregory Brown
 files: 
   - lib/ruportlib.rb
+  - lib/ruport/format/builder.rb
   - lib/ruport/format/chart.rb
   - lib/ruport/report/data_row.rb
   - lib/ruport/report/data_set.rb
   - lib/ruport/report/engine.rb
   - lib/ruport/report/fake_db.rb
   - lib/ruport/report/fake_engine.rb
+  - lib/ruport/report/fake_mailer.rb
   - lib/ruport/report/mailer.rb
   - lib/ruport/report/sql.rb
+  - test/tc_builder.rb
   - test/tc_data_row.rb
   - test/tc_data_set.rb
   - test/tc_engine.rb
+  - test/tc_mailer.rb
   - test/ts_all.rb
   - Rakefile
   - README