ruport 0.5.4 → 0.6.0

data/AUTHORS

@@ -8,17 +8,26 @@
 = Contributors / People we've (legally) stolen from:
 
 Iain Broadfoot:
-- RuportDay 2006 Participant
+ - RuportDay 2006 Participant
 
 Eric Pugh:
-- RuportDay 2006 Participant
+ - RuportDay 2006 Participant
 
 James Edward Gray II:
   - Original inspiration via query.rb
   - system_extensions.rb
 
+Mathijs Mohlmann:
+ - Performance Enhancement
+     TextPlugin r264-r265
+     HTMLPlugin r266
+
 Francis Hwang:
-- SQLSplit
+ - SQLSplit
 
 Simon Claret:
-- Initial PDF table support (now deprecated)
+ - Initial PDF table support (now deprecated)
+
+Daniel Berger:
+ - we vendored and modified attempt.rb to support it directly in Report.
+   Original website: http://raa.ruby-lang.org/project/attempt/

data/CHANGELOG

@@ -1,4 +1,18 @@
-Tnghe current version of Ruby Reports is 0.5.4
+The current version of Ruby Reports is 0.6.0
+
+changes since 0.5.4
+
+From Ruport News (http://www.stonecode.org/blog/?cat=14)
+
+    * added ERb support inside SQL queries
+    * a new LaTeX plugin for the table formatting engine
+    * support for summation in data tables
+    * new grouping functionality based on the tagging system
+    * very large performance enhancements in HTML and text rendering
+    * better integration with FasterCSV
+    * some simple interfaces for graphs and data tables
+    * syntactic sugar (shortcuts) for common tasks
+    * support for rerunning reports on timeouts and errors
 
 changes since 0.5.3
 

data/Rakefile

@@ -23,7 +23,7 @@ end
 
 spec = Gem::Specification.new do |spec|
 	spec.name = LEAN ? "lean-ruport" : "ruport"
-	spec.version = "0.5.4"
+	spec.version = "0.6.0"
 	spec.platform = Gem::Platform::RUBY
 	spec.summary = "A generalized Ruby report generation and templating engine."
 	spec.files =  Dir.glob("{examples,lib,test,bin}/**/**/**/*") +

data/bin/rope

@@ -68,7 +68,11 @@ class #{class_name} < Ruport::Report
 
 end
 
-##{class_name}.run { |res| puts res.results }
+# uncomment the line below to let the report be run directly
+#
+# if __FILE__ == $0
+#   #{class_name}.run { |res| puts res.results }
+# end
 EOR
 
 TEST = <<EOR

data/examples/basic_grouping.rb

@@ -1,9 +1,19 @@
 require "ruport"
 a = [ ['a',7],['b',5],['c',11],
-      ['d',9],['a',3],['b',2] ].to_table(%w[letter num])
+      ['d',9],['a',3],['b',2], ['e',4] ].to_table(%w[letter num])
 puts "Initial Data:\n#{a}"
+
+
+# group by column values
 b = a.split(:group => "letter")
 totals = [].to_table(%w[group sum])
-b.attributes.each { |x| totals << [x,b[x].inject(0) { |s,r| s + r['num'] }] }
-puts "After grouping:\n#{totals}"
+b.each_group { |x| totals << [x,b[x].sum("num")] }
+puts "After column grouping:\n#{totals}"
 
+# group by tag name
+a.create_tag_group(:num_even) { |r| (r.num % 2).zero? }
+a.create_tag_group(:num_odd)  { |r| (r.num % 2).nonzero? }
+c = a.group_by_tag
+totals.data.clear
+c.each_group { |x| totals << [x,c[x].sum("num")] }
+puts "After tag grouping:\n#{totals}"

data/examples/latex_table.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/../lib/")
+require "ruport"
+
+# build up a Table - this could be built in a range of ways
+# Check the API documentation and recipe book for more information
+data = [[1,4,7,9], [6,2,3,0]].to_table(%w[a b c d])
+
+# Build the report object
+report = Ruport::Format.table_object(:plugin => :latex, :data => data)
+
+# By default, the latex plugin will return plain text latex source
+# changing the format option asks Ruport to attempt to render
+# the source into a PDF using pdflatex
+report.options = { :format => :pdf }
+
+# save the resulting report to a file on the filesystem
+File.open( "table.tex","w") { |f| f.puts report.render }

data/examples/line_graph_report.rb

@@ -0,0 +1,23 @@
+require "ruport"
+class GraphSample < Ruport::Report
+  
+  include Graph
+
+  prepare do
+    @data = [[5,7,9,12,14,16,18]].to_table(%w[jan feb mar apr may jun jul])
+  end
+
+  generate do
+    render_graph do |g|
+      g.data   = @data
+      g.width  = 700
+      g.height = 500
+      g.title  = "A Simple Line Graph"
+      g.style  = :line
+    end
+  end
+end
+
+GraphSample.run { |r| puts r.results }
+
+

data/examples/line_graph_report.rb.rej

@@ -0,0 +1,15 @@
+***************
+*** 19,24 ****
+    end
+  end
+  
+- GraphSample.run { |r| puts r.write }
+  
+  
+--- 19,24 ----
+    end
+  end
+  
++ GraphSample.run(:tries => 3, :timeout => 1) { |r| sleep 2; puts r.results }
+  
+  

data/examples/line_graph_report.rb~

@@ -0,0 +1,23 @@
+require "ruport"
+class GraphSample < Ruport::Report
+  
+  include Graph
+
+  prepare do
+    @data = [[5,7,9,12,14,16,18]].to_table(%w[jan feb mar apr may jun jul])
+  end
+
+  generate do
+    render_graph do |g|
+      g.data   = @data
+      g.width  = 700
+      g.height = 500
+      g.title  = "A Simple Line Graph"
+      g.style  = :line
+    end
+  end
+end
+
+GraphSample.run { |r| puts r.results }
+
+

data/examples/line_plotter.rb

@@ -32,6 +32,7 @@ class SVG < Format::Plugin
     } << "</g></svg>"
   end
  
+  plugin_name :svg
   register_on :line_plotting_engine
 end
 

data/examples/sql_erb.rb

@@ -0,0 +1,20 @@
+require "ruport"
+require "rubygems"
+
+class Foo < Ruport::Report
+
+  SQL = "select * from <%= helper %>"
+
+  prepare do
+    source :default, :dsn => "dbi:mysql:foo", :user => "root"
+  end
+
+  generate do
+    query(SQL)
+  end
+
+  def helper; "bar" end
+
+end
+
+Foo.run { |r| puts r.results }

data/examples/template.rb

@@ -12,4 +12,4 @@ class MyReport < Ruport::Report
   generate { eval_template TEMPLATE }
 end
 
-MyReport.run
+MyReport.run { |r| puts r.results }

data/examples/text_processors.rb

@@ -3,17 +3,11 @@ require "ruport"
 class MyReport < Ruport::Report
   prepare {
     self.results = "Foo Bar Baz"
-    text_processor(:replace_foo) { results.gsub!(/Foo/,"Ruport") }
-    text_processor(:replace_bar) { results.gsub!(/Bar/,"Is") }
-    text_processor(:replace_baz) { results.gsub!(/Baz/, "Cool!") }
+    text_processor(:replace_foo) { |r| r.gsub(/Foo/,"Ruport") }
+    text_processor(:replace_bar) { |r| r.gsub(/Bar/,"Is") }
+    text_processor(:replace_baz) { |r| r.gsub(/Baz/, "Cool!") }
   }
   generate {
     process_text results, :filters => [:replace_foo,:replace_bar,:replace_baz]
   }
 end
-
-MyReport.run { |e| puts e.results }
-    
-
-
-  

data/lib/ruport.rb

@@ -9,10 +9,9 @@
 #
 # See LICENSE and COPYING for details
 #
-
 module Ruport
   
-  VERSION = "0.5.4"
+  VERSION = "0.6.0"
   
   # Ruports logging and error interface.
   # Can generate warnings or raise fatal errors
@@ -65,6 +64,6 @@ module Ruport
 end
 
 
-%w[config meta_tools report format query data mailer].each { |lib|
+%w[attempt config data meta_tools report format query mailer].each { |lib|
   require "ruport/#{lib}" 
 }

data/lib/ruport.rb~

@@ -0,0 +1,69 @@
+# ruport.rb : Ruby Reports toplevel module
+#
+# Author: Gregory T. Brown (gregory.t.brown at gmail dot com)
+#
+# Copyright (c) 2006, 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. 
+#
+# See LICENSE and COPYING for details
+#
+module Ruport
+  
+  VERSION = "0.6.0"
+  
+  # Ruports logging and error interface.
+  # Can generate warnings or raise fatal errors
+  # 
+  # Takes a message to display and a set of options.
+  # Will log to the file defined by Config::log_file
+  #
+  # Options:
+  # <tt>:status</tt>::    sets the severity level. defaults to <tt>:warn</tt>
+  # <tt>:output</tt>::    optional 2nd output, defaults to <tt>$stderr</tt>
+  # <tt>:level</tt>::     set to <tt>:log_only</tt> to disable secondary output
+  # <tt>:exception</tt>:: exception to throw on fail.  Defaults to RunTimeError
+  # 
+  # The status <tt>:warn</tt> will invoke Logger#warn.  A status of
+  # <tt>:fatal</tt> will invoke Logger#fatal and raise an exception
+  # 
+  # By default, <tt>log()</tt> will also print warnings to $stderr
+  # You can redirect this to any I/O object via <tt>:output</tt>
+  #
+  # You can prevent messages from appearing on the secondary output by setting
+  # <tt>:level</tt> to <tt>:log_only</tt>
+  # 
+  # If you want to recover these messages to secondary output for debugging, you
+  # can use Config::enable_paranoia 
+  def self.log(message,options={})
+    options = {:status => :warn, :output => $stderr}.merge(options)
+    options[:output].puts "[!!] #{message}" unless 
+      options[:level].eql?(:log_only) and not Ruport::Config.paranoid?
+    Ruport::Config::logger.send(options[:status],message) if Config.logger
+    if options[:status].eql? :fatal
+      raise(options[:exception] || RuntimeError, message) 
+    end
+  end
+ 
+  #Alias for Ruport.log
+  def self.complain(*args); Ruport.log(*args) end
+ 
+  # yields a Ruport::Config object, allowing you to specify configuration
+  # options.
+  #
+  # Example: 
+  #
+  #   Ruport.configure do |c|
+  #     c.source :default, :dsn => "dbi:mysql:foo",
+  #                        :user => "clyde", :password => "pman"
+  #   end
+  def self.configure(&block)
+    block.call(Ruport::Config)
+  end
+end
+
+
+%w[attempt config meta_tools report format query data mailer].each { |lib|
+  require "ruport/#{lib}" 
+}

data/lib/ruport/attempt.rb

@@ -0,0 +1,63 @@
+require 'timeout'
+
+class Attempt
+   VERSION = '0.1.0'
+   
+   # Number of attempts to make before failing.  The default is 3.
+   attr_accessor :tries
+   
+   # Number of seconds to wait between attempts.  The default is 60.
+   attr_accessor :interval
+   
+   # a level which ruport understands.  
+   attr_accessor :log_level
+   
+   # If set, this increments the interval with each failed attempt by that
+   # number of seconds.
+   attr_accessor :increment
+   
+   # If set, the code block is further wrapped in a timeout block.
+   attr_accessor :timeout
+   
+   # Determines which exception level to check when looking for errors to
+   # retry.  The default is 'Exception' (i.e. all errors).
+   attr_accessor :level
+   
+   # :call-seq:
+   #    Attempt.new{ |a| ... }
+   # 
+   # Creates and returns a new +Attempt+ object.  Use a block to set the
+   # accessors.
+   # 
+   def initialize           
+      @tries     = 3         # Reasonable default
+      @interval  = 60        # Reasonable default
+      @increment = nil       # Should be an int, if provided
+      @timeout   = nil       # Wrap the code in a timeout block if provided
+      @level     = Exception # Level of exception to be caught
+      
+      yield self if block_given?
+   end
+   
+   def attempt
+      count = 1
+      begin
+         if @timeout
+            Timeout.timeout(@timeout){ yield }
+         else
+            yield
+         end
+      rescue @level => error
+         @tries -= 1
+         if @tries > 0
+            msg = "Error on attempt # #{count}: #{error}; retrying"
+            count += 1
+            Ruport.log(msg, :level => log_level)
+            @interval += @increment if @increment
+            sleep @interval
+            retry
+         end
+         raise
+      end
+   end
+end

data/lib/ruport/data.rb

@@ -1 +1 @@
-%w[taggable record collection table set].each { |l| require "ruport/data/#{l}" }
+%w[groupable taggable record collection table set ].each { |l| require "ruport/data/#{l}" }

data/lib/ruport/data.rb.rej

@@ -0,0 +1,5 @@
+***************
+*** 1 ****
+- %w[taggable record collection table set groupable ].each { |l| require "ruport/data/#{l}" }
+--- 1 ----
++ %w[groupable taggable record collection table set].each { |l| require "ruport/data/#{l}" }

data/lib/ruport/data.rb~

@@ -0,0 +1 @@
+%w[taggable record collection table set groupable].each { |l| require "ruport/data/#{l}" }

data/lib/ruport/data/groupable.rb

@@ -0,0 +1,20 @@
+module Ruport::Data
+  module Groupable
+
+    def group_by_tag
+      r_tags = data.map {|row| row.tags}.flatten.uniq
+      d = r_tags.map do |t| 
+	      select {|row| row.tags.include? t }.to_table(column_names)      
+      end
+      r = Record.new d, :attributes => r_tags
+      class << r
+        def each_group; attributes.each { |a| yield(a) }; end
+      end; r
+    end
+
+    def create_tag_group(label,&block)
+      select(&block).each { |r| r.tag label }
+    end
+
+  end
+end

data/lib/ruport/data/record.rb

@@ -47,7 +47,11 @@ module Ruport::Data
         end
       else
         @data = data.dup
-        @attributes = options[:attributes]
+        @attributes = if options[:attributes] 
+          options[:attributes]
+        else 
+          []
+        end
       end
     end
     
@@ -68,8 +72,8 @@ module Ruport::Data
         raise "Invalid index" unless index < @data.length
         @data[index]
       else
-        raise "Invalid index" unless @attributes.index(index)
-        @data[@attributes.index(index)]
+        raise "Invalid index" unless attributes.index(index.to_s)
+        @data[attributes.index(index.to_s)]
       end
     end
 
@@ -86,8 +90,8 @@ module Ruport::Data
         raise "Invalid index" unless index < @data.length
         @data[index] = value
       else
-        raise "Invalid index" unless @attributes.index(index)
-        @data[attributes.index(index)] = value
+        raise "Invalid index" unless attributes.index(index.to_s)
+        @data[attributes.index(index.to_s)] = value
       end
     end
 
@@ -95,9 +99,9 @@ module Ruport::Data
     # If attributes and data are equivalent, then == evaluates to true.
     # Otherwise, == returns false
     def ==(other)
-      return false if @attributes && !other.attributes
-      return false if other.attributes && !@attributes
-      @attributes == other.attributes && @data == other.data
+      return false if attributes && !other.attributes
+      return false if other.attributes && !attributes
+      attributes == other.attributes && @data == other.data
     end
 
     alias_method :eql?, :==
@@ -113,19 +117,20 @@ module Ruport::Data
     #
     #   a = Data::Record.new([1,2],:attributes => %w[a b])
     #   a.to_h #=> {"a" => 1, "b" => 2}
-    def to_h; Hash[*@attributes.zip(data).flatten] end
+    def to_h; Hash[*attributes.zip(data).flatten] end
   
     # Returns a copy of the list of attribute names associated with this Record.
     #
     #   a = Data::Record.new([1,2],:attributes => %w[a b])
     #   a.attributes #=> ["a","b"]
-    def attributes; @attributes && @attributes.dup; end
+    def attributes; @attributes.map { |a| a.to_s }; end
 
     # Sets the attribute list for this Record
     #
     #   my_record.attributes = %w[foo bar baz]
     attr_writer :attributes
 
+
     # Allows you to change the order of or reduce the number of columns in a
     # Record.  Example:
     #
@@ -140,9 +145,9 @@ module Ruport::Data
     # Same as Record#reorder but is destructive
     def reorder!(*indices)
       indices = reorder_data!(*indices)
-      if @attributes
+      if attributes
         if indices.all? { |e| e.kind_of? Integer }
-          @attributes = indices.map { |i| @attributes[i] }
+          @attributes = indices.map { |i| attributes[i] }
         else
           @attributes = indices
         end
@@ -181,7 +186,7 @@ module Ruport::Data
     #   my_record.foo #=> 2
     def method_missing(id,*args)
       id = id.to_s.gsub(/=$/,"")
-      if @attributes.include?(id)
+      if attributes.include?(id)
         args.empty? ? self[id] : self[id] = args.first
       else
         super