ruport 0.2.0 → 0.2.2

data/lib/ruport/report/fake_db.rb

@@ -0,0 +1,54 @@
+#!/usr/local/bin/ruby
+# fake_db.rb
+# Created by Gregory Thomas Brown on 2005-08-02
+# Copyright 2005 (Gregory Brown) All rights reserved.
+#
+# This product is free software, you may distribute it as such
+# under your choice of the Ruby license or the GNU GPL
+# See LICENSE for details
+
+module Ruport
+  module Report
+    class FakeDB
+      
+      # Creates a new FakeDB e.g.
+      #
+      #  FakeDB.new([ "ruport",    "ruport_example",
+      #               "localhost", "test", "123"] )
+      #
+      # Which would create a fake database ruport_example at
+      # localhost with the  username test and the password 123
+      # using the driver 'ruport'
+      def initialize(args)
+        @db_driver, @db_name, @db_host, @username, @password = *args
+        @data = Hash.new
+      end
+
+
+      # Verifies account info and retrieves information
+      def process( dsn, user, password, query )
+        if  ( dsn.eql?("#{@db_driver}:#{@db_name}:#{@db_host}") and
+              user.eql?(@username) and password.eql?(@password) )
+          @data[query]
+        else
+          throw "Processing Error"
+        end
+      end
+      
+
+      # Allows query to be looked up in the data
+      def [](query)
+        @data[query]
+      end
+
+      # Used to setup fake queries E.g:
+      #
+      # DataSet#fake_db["SELECT * FROM address_book"] =
+      #   DataSet.load("data/addressbook.csv")
+      def []=(query, contents)
+        @data[query] = contents
+      end
+
+    end
+  end
+end

data/lib/ruport/report/fake_engine.rb

@@ -0,0 +1,46 @@
+#!/usr/local/bin/ruby
+# fake_engine.rb
+# Created by Gregory Thomas Brown on 2005-08-02
+# Copyright 2005 (Gregory Brown) All rights reserved.
+#
+# This product is free software, you may distribute it as such
+# under your choice of the Ruby license or the GNU GPL
+# See LICENSE for details
+
+module Ruport
+  module Report
+    class FakeEngine < Ruport::Report::Engine
+      
+      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
+      end
+
+    end
+  end
+end

data/lib/ruport/report/mailer.rb

@@ -0,0 +1,46 @@
+# mailer.rb
+#  Created by Gregory Brown on 2005-08-16
+#  Copyright 2005 (Gregory Brown) All Rights Reserved.
+#  This product is free software, you may distribute it as such
+#  under your choice of the Ruby license or the GNU GPL
+#  See LICENSE for details
+require "net/smtp"
+module Ruport  
+  module Report
+    class Mailer
+      
+      # Creates a new Mailer object.  User must specify their mail host, email
+      # address, and account.  Password, port, and authentication method are all
+      # optional.
+      def initialize( host, address, account,
+                      password=nil , port=25, authentication=nil )
+        @host           = host
+        @account        = account
+        @password       = password
+        @address        = address
+        @port           = port
+        @auth           = authentication
+        @recipients     = []
+        @body           = ""
+      end
+      
+      #A list of email addresses to send the message to.
+      attr_accessor :recipients
+      
+      #The body of the message to be sent
+      attr_accessor :body
+
+      # This takes _report_name_ as argument and sends the contents of @body to
+      # @recipients
+      def send_report(report_name="No Subject")
+        return if @body.empty?
+        Net::SMTP.start(@host,@port,@host,@account,@password,@auth) do |smtp|
+          smtp.send_message( "Subject: #{report_name}\n\n#{@body}",
+                             @address, 
+                             @recipients )
+        end
+      end
+      
+    end
+  end
+end

data/lib/ruport/report/sql.rb

@@ -0,0 +1,95 @@
+#!/usr/local/bin/ruby -w
+# sql.rb:
+# Generates queries from simple ruby syntax 
+#
+# Created by Gregory Thomas Brown on 2005-08-02
+# Copyright 2005 (Gregory Brown) All rights reserved.
+#
+# This product is free software, you may distribute it as such
+# under your choice of the Ruby license or the GNU GPL
+# See LICENSE for details
+#
+# Special thanks and acknowledgement go to James Edward Gray II
+# for providing the original source code for this application
+module Ruport
+  module Report
+    class SQL
+      
+      # Generates an SQL object which can generate queries.
+      def initialize( statement, &init )
+        @statement = statement
+        
+        @fields     = Array.new
+        @tables     = Array.new
+        @conditions = Array.new
+        @order_by   = Array.new
+        
+        instance_eval(&init) unless init.nil?
+      end
+      
+      #Specifies the fields to select from
+      def columns( *fields )
+        fields.each { |field| @fields << "'#{field}'" }
+      end
+      
+      #generates an FROM clause for the given tables
+      def from( *tables )
+        tables.each { |table| @tables << table }
+      end
+      
+      # generates a conditional expression.
+      # condition :name, :LIKE, :jim -> "name LIKE 'jim'"
+      def condition( field, operator, match )
+        @conditions << "#{field} #{operator.to_s.upcase} '#{match}'"
+      end
+      
+      # generates an ORDER BY clause for list +order+
+      def order( *order )
+        order.each { |table| @order_by << table }
+      end
+      
+      # Converts SQL object into a query string
+      def to_s
+        sql = "#{@statement} "
+        
+        sql << if @fields.empty?
+          "* "
+        else
+          @fields.join(", ") + " "
+        end
+        
+        sql << "FROM #{@tables.join(', ')} "
+        
+        unless @conditions.empty?
+          sql << "WHERE #{@conditions.join(' AND ')} "
+        end
+
+        unless @order_by.empty?
+          sql << "ORDER BY #{@order_by.join(', ')} "
+        end
+        
+        sql.sub!(/ \Z/, "")
+        sql << ";"
+        
+        sql
+      end
+    end    
+  end
+end
+class String
+  def with( other_table, field = nil )
+   if field.nil?
+     "#{self} NATURAL JOIN #{other_table}"
+    else
+     "#{self} LEFT JOIN #{other_table} " +
+     "ON #{self}.#{field} = #{other_table}.#{field}"
+   end
+  end
+end
+
+class Symbol
+  def with( other_table, field = nil )
+   to_s.with(other_table, field)
+  end
+end
+

data/lib/ruportlib.rb

@@ -1,7 +1,8 @@
-require "ruport/db/report"
-require "ruport/db/mailer"
-require "ruport/db/sql"
-require "ruport/db/mock_db"
-require "ruport/db/mock_report"
-require "ruport/db/data_set"
-require "ruport/db/data_row"
+require "ruport/report/engine"
+require "ruport/report/mailer"
+require "ruport/report/sql"
+require "ruport/report/fake_db"
+require "ruport/report/fake_engine"
+require "ruport/report/data_set"
+require "ruport/report/data_row"
+include Ruport

data/test/tc_data_row.rb

@@ -5,7 +5,7 @@ require "ruportlib"
 
 class TestDataRow < Test::Unit::TestCase
   def setup
-    @rows = DataSet.new
+    @rows = Report::DataSet.new
     @rows.fields = %w[ foo bar ]
     @rows << [ 1 , 2 ]
     @rows << [ 3 , 4 ]

data/test/tc_data_set.rb

@@ -5,7 +5,7 @@ require "ruportlib"
 
 class TestDataSet < Test::Unit::TestCase
   def setup
-    @data = DataSet.new
+    @data = Report::DataSet.new
     @data.fields = %w[ col1 col2 col3 ]
     @data.default = ""
     @data << %w[ a b c ]
@@ -35,7 +35,7 @@ class TestDataSet < Test::Unit::TestCase
   end
 
   def test_eql?
-    data2 = DataSet.new
+    data2 = Report::DataSet.new
     data2.fields = %w[ col1 col2 col3 ]
     data2.default = ""
     data2 << %w[ a b c ]
@@ -54,12 +54,12 @@ class TestDataSet < Test::Unit::TestCase
   end
 
   def test_load
-     loaded_data = DataSet.load("test/data.csv")
+     loaded_data = Report::DataSet.load("test/data.csv")
      assert(@data.eql?(loaded_data))
   end
 
   def test_to_csv
-    loaded_data = DataSet.load("test/data.csv" )
+    loaded_data = Report::DataSet.load("test/data.csv" )
     csv = loaded_data.to_csv
     assert_equal("col1,col2,col3\na,b,c\nd,\"\",e\n",csv)
   end

data/test/{tc_report.rb → tc_engine.rb}

@@ -8,10 +8,10 @@ require "lib/ruportlib"
 class TestRuport < Test::Unit::TestCase
   
 def setup
-    @report = MockReport.new( "DBI:mysql:ruport:localhost", "test", "123") 
+    @report = Report::FakeEngine.new( "DBI:mysql:ruport:localhost", "test", "123") 
     @report.query_table = "ruport_queries"
 
-    @report.fake_db = MockDB.new([ "DBI:mysql","ruport",
+    @report.fake_db = Report::FakeDB.new([ "DBI:mysql","ruport",
                                    "localhost",  "test", "123"])
 
     @report.fake_db["SELECT * FROM ruport_test"] = @data =
@@ -97,7 +97,7 @@ def test_sql
 
   def test_query
     @report.query("SELECT * FROM ruport_test") do |result|
-      assert(@data,result)
+      assert_equal(@data,result)
     end
   end
   

data/test/ts_all.rb

@@ -1,4 +1,4 @@
 require "test/unit"
-require "test/tc_report"
+require "test/tc_engine"
 require "test/tc_data_set"
 require "test/tc_data_row"

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: ruport
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2005-11-08
+  version: 0.2.2
+date: 2005-11-11
 summary: A generalized Ruby report generation and templating engine.
 require_paths: 
   - lib
@@ -28,17 +28,17 @@ authors:
   - Gregory Brown
 files: 
   - lib/ruportlib.rb
-  - lib/ruport/db/data_row.rb
-  - lib/ruport/db/data_set.rb
-  - lib/ruport/db/mailer.rb
-  - lib/ruport/db/mock_db.rb
-  - lib/ruport/db/mock_report.rb
-  - lib/ruport/db/report.rb
-  - lib/ruport/db/sql.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/mailer.rb
+  - lib/ruport/report/sql.rb
   - test/tc_data_row.rb
   - test/tc_data_set.rb
-  - test/tc_report.rb
+  - test/tc_engine.rb
   - test/ts_all.rb
   - Rakefile
   - README

data/lib/ruport/db/data_row.rb

@@ -1,64 +0,0 @@
-#!/usr/local/bin/ruby
-# data_row.rb
-# Created by Gregory Thomas Brown on 2005-08-02
-# Copyright 2005 (Gregory Brown) All rights reserved.
-#
-# This product is free software, you may distribute it as such
-# under your choice of the Ruby license or the GNU GPL
-# See LICENSE for details
-
-
-class DataRow 
-  
-  attr_accessor :fields
-  
-
-  # DataRows are essentially arrays with named ordinal fields and awareness of
-  # their oddness and position.
-  def initialize( data, fields, oddness=nil, position=nil )
-    @data     = data
-    @fields   = fields
-    @oddness  = oddness
-    @position = position
-  end
-  
-
-  # Lets you access individual fields
-  #
-  # i.e. row["phone"]
-  def [](key)
-    key.kind_of?(String) ? @data[@fields.index(key)] : @data[key]
-  end
-  
-  # Lets you set field values
-  #
-  # i.e. row["phone"] = '2038291203'
-  def []=(key,value)
-    key.kind_of?(String) ?  @data[@fields.index(key)] = value :
-                           @data[key] = value    
-  end
-
-  # Converts the DataRow to a plain old Array
-  def to_a
-    @data
-  end
-
-  # Converts the DataRow to a string representation for outputting to screen.
-  def to_s
-    "[" + @data.join(",") + "]"
-  end
-
-  # implements 
-  # 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
-	  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
-      
-  attr_accessor :position
-end

data/lib/ruport/db/data_set.rb

@@ -1,101 +0,0 @@
-#!/usr/local/bin/ruby
-# data_set.rb
-# Created by Gregory Thomas Brown on 2005-08-02
-# Copyright 2005 (Gregory Brown) All rights reserved.
-#
-# This product is free software, you may distribute it as such
-# under your choice of the Ruby license or the GNU GPL
-# See LICENSE for details
-
-class DataSet
-  def initialize
-    @data = []
-  end
-  
-  #fields are the column names, default is the default cell value
-  attr_accessor :fields, :default
-  
-  #data is the core Array that holds all the rows
-  attr_reader   :data
-  
-  
-  #Allows ordinal access to rows
-  def [](index)
-    @data[index]
-  end
-  
-  #allows setting of rows (providing a DataRow is passed in)
-  def []=(index,value)
-    throw "Invalid object type" unless value.kind_of?(DataRow)
-    @data[index] = value
-  end
-
-  # appends a row to the DataSet
-  # can be added as an array or a keyed hash.
-  # i.e if our DataSet have @fields = [:a, :b, :c]
-  # data << [ 1, 2, 3] and data << { :a => 1, :b => 2, :c => 3 } 
-  # are equivalent.
-  def << ( stuff )
-    new_row = Array.new
-    fields.each_with_index do |key, index|
-      if stuff.kind_of?(Array)
-        new_row[index] = stuff.shift || @default
-      else
-        new_row[index] = stuff[key] || @default
-      end
-    end
-    
-    oddness  = (@data.length % 2 == 0 ? :even  : :odd)
-    position = (@data.length == 0 ? :first : :last)
-    @data[@data.length - 1].position = :middle 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]
-      end
-    end
-    return true
-  end
-  
-
-  # Allows loading of CSV files or YAML dumps.  Returns a DataSet
-  def self.load ( source, default="")
-    
-    return YAML.load(File.open(source)) if source =~ /\.(yaml|yml)/ 
-    
-    input = CSV.read(source) if source =~ /\.csv/
-    loaded_data = self.new
-    loaded_data.fields = input[0]
-    loaded_data.default = default
-    input[1..-1].each do |row|
-      loaded_data << row
-    end
-    return loaded_data	
-  end
- 
-  # 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
-  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)
-  end
-
-end