ruport 0.6.1 → 0.7.0

data/AUTHORS

@@ -35,3 +35,9 @@ Daniel Berger:
 Marshall T. Vandegrift:
  - Fixed a bug in Record's struct-like accessors (method_missing)
  - Provided performance enhancements and tests for query.rb
+
+Stefan Mahlitz:
+ - Table#sort_rows_by
+
+llasram@gmail.com
+ - Improved alignment for Text Tables.

data/Rakefile

@@ -23,10 +23,10 @@ end
 
 spec = Gem::Specification.new do |spec|
 	spec.name = LEAN ? "lean-ruport" : "ruport"
-	spec.version = "0.6.1"
+	spec.version = "0.7.0"
 	spec.platform = Gem::Platform::RUBY
 	spec.summary = "A generalized Ruby report generation and templating engine."
-	spec.files =  Dir.glob("{examples,lib,test,bin}/**/**/**/*") +
+	spec.files =  Dir.glob("{examples,lib,test,bin}/**/**/*") +
                       ["Rakefile", "setup.rb"]
   
   spec.require_path = "lib"
@@ -35,7 +35,7 @@ spec = Gem::Specification.new do |spec|
   spec.bindir = "bin"
   spec.executables = FileList["rope"]
 	spec.has_rdoc = true
-	spec.extra_rdoc_files = %w{README LICENSE TODO AUTHORS CHANGELOG}
+	spec.extra_rdoc_files = %w{README LICENSE TODO AUTHORS}
 	spec.rdoc_options << '--title' << 'Ruport Documentation' <<
 	                     '--main'  << 'README' << '-q'
   unless LEAN
@@ -43,7 +43,7 @@ spec = Gem::Specification.new do |spec|
     spec.add_dependency('RedCloth',  '>= 3.0.0')
     spec.add_dependency('pdf-writer', '>= 1.1.3')
     spec.add_dependency("mailfactory", ">= 1.2.2")
-    spec.add_dependency("scruffy", ">= 0.2.2")
+    spec.add_dependency('scruffy', '>= 0.2.2')
   end
   spec.author = "Gregory Brown"
 	spec.email = "	gregory.t.brown@gmail.com"

data/TODO

@@ -1,4 +1,5 @@
 = TODO
 
-Any future plans are available on Ruports Trac website
-=   http://stonecode.svnrepository.com/ruport/trac.cgi
+- Any future plans are available on Ruport's Trac website
+  
+  http://stonecode.svnrepository.com/ruport/trac.cgi

data/bin/rope

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
-
 require "fileutils"
+require "ruport/generator"
 include FileUtils
 
 if ARGV.empty?
@@ -9,105 +9,4 @@ if ARGV.empty?
 end
 project = ARGV[0]
 
-RAKEFILE = <<END_RAKEFILE
-begin; require "rubygems"; rescue LoadError; end
-require "rake/testtask"
-
-task :default => [:test]
-
-Rake::TestTask.new do |test|
-  test.libs    << "test"
-  test.pattern =  'test/**/test_*.rb'
-  test.verbose =  true
-end
-END_RAKEFILE
-
-CONFIG = <<END_CONFIG
-require "ruport"
-
-# For details, see Ruport::Config documentation
-Ruport.configure { |c|
-  c.source :default, :user     => "root", 
-                     :dsn      =>  "dbi:mysql:mydb"
-  c.log_file "log/ruport.log"
-}
-END_CONFIG
-
-BUILD = <<'END_BUILD'
-def format_class_name(string)
-  string.downcase.split("_").map { |s| s.capitalize }.join
-end
-
-unless ARGV.length > 1
-  puts "usage build.rb [command] [options]"
-  exit
-end
-
-class_name = format_class_name(ARGV[1])
-
-exit if File.exist? "app/reports/#{ARGV[1]}.rb"
-if ARGV[0].eql? "report"
-  File.open("app/reports.rb", "a") { |f| 
-    f.puts("require \"app/reports/#{ARGV[1]}\"")
-  }
-REP = <<EOR
-begin; require "rubygems"; rescue LoadError; end
-require "ruport"
-require "config/ruport_config"
-
-class #{class_name} < Ruport::Report
-  
-  #optional
-  prepare { }
-  
-  #mandatory
-  generate { }
-
-  #optional
-  cleanup  { }
-
-end
-
-# 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
-begin; require "rubygems"; rescue LoadError; end
-require "ruport"
-require "test/unit"
-require "app/reports/#{ARGV[1]}"
-require "config/ruport_config"
-
-class Test#{class_name} < Test::Unit::TestCase
-  def test_flunk
-    flunk "Write your real tests here or in any test/test_* file"
-  end
-end
-EOR
-  File.open("app/reports/#{ARGV[1]}.rb", "w") { |f| f << REP }
-  File.open("test/test_#{ARGV[1]}.rb","w") { |f| f << TEST } 
-end
-END_BUILD
-
-SQL_EXEC = <<'END_SQL'
-begin; require "rubygems"; rescue LoadError; end
-require "ruport"
-require "config/ruport_config"
-
-puts Ruport::Query.new(ARGF.read).result
-END_SQL
-
-mkdir project
-%w[test config output data app app/reports templates sql log util].each do |d|
-  mkdir "#{project}/#{d}"
-end
-
-touch("#{project}/app/reports.rb")
-File.open("#{project}/config/ruport_config.rb","w") { |f| f << CONFIG }
-File.open("#{project}/Rakefile","w") { |f| f << RAKEFILE }
-File.open("#{project}/util/build.rb","w") { |f| f << BUILD }
-File.open("#{project}/util/sql_exec.rb","w") { |f| f << SQL_EXEC }
+Ruport::Generator.build(ARGV[0])

data/examples/pdf_complex_report.rb

@@ -0,0 +1,53 @@
+require "ruport"
+
+module MyStuff
+
+  class DocumentRenderer < Ruport::Renderer
+    include Ruport::Renderer::Helpers
+
+    def run
+      build [:header,:body,:footer],:document
+      finalize :document
+    end
+
+    def table=(t)
+      options.table = t
+    end
+
+    def header_text=(t)
+      options.header_text=(t)
+    end
+
+    def footer_text=(t)
+      options.footer_text=(t)
+    end
+
+  end
+
+  class PDF < Ruport::Format::PDF
+    DocumentRenderer.add_format self, :pdf
+
+    def build_document_header
+      add_text options.header_text, :justification => :center
+    end
+
+    def build_document_body
+      pad(10) { draw_table }
+    end
+
+    def build_document_footer
+      add_text options.footer_text, :justification => :center
+    end
+
+    def finalize_document
+      output << pdf_writer.render
+    end
+
+  end
+end
+
+puts MyStuff::DocumentRenderer.render_pdf { |e| 
+  e.data = [[1,2],[3,4]].to_table(%w[apple banana]) 
+  e.header_text = "foo"
+  e.footer_text = "bar"
+}

data/lib/ruport/config.rb

@@ -161,16 +161,12 @@ module Ruport
     def logger; @logger; end
 
     # Forces all messages marked <tt>:log_only</tt> to print anyway.
-    def enable_paranoia; @paranoid = true; end
+    #    def enable_paranoia; @paranoid = true; end
 
     # Disables the printing of <tt>:log_only</tt> messages.
-    def disable_paranoia; @paranoid = false; end
+    #def disable_paranoia; @paranoid = false; end
 
-    # Sets paranoid status.
-    def paranoid=(val); @paranoid = val; end
-
-    # Checks to see if paranoia is enabled.
-    def paranoid?; !!@paranoid; end
+    def debug_mode?; !!@debug_mode; end
     
     # Verifies that you have provided a DSN for your source.
     def check_source(settings,label) # :nodoc:
@@ -193,6 +189,10 @@ module Ruport
         )
       end
     end
+
+    def debug_mode=(something)
+      @debug_mode = !!something
+    end
     
   end
 end

data/lib/ruport/data/collection.rb

@@ -18,8 +18,8 @@ module Ruport::Data
     extend Forwardable
     include Enumerable
     include Taggable
-
-    def initialize(data=nil,options={})
+    
+    def initialize(data=nil,options={}) #:nodoc:
       @data = data.dup if data
     end
 
@@ -29,9 +29,10 @@ module Ruport::Data
     # Example:
     #   my_collection.as(:csv)  #=> "1,2,3\n4,5,6"
     def as(type)
-      eng = Ruport::Format.table_object :data => self, :plugin => type
-      yield(eng) if block_given?
-      eng.render
+      Ruport::Renderer::Table.render(type) do |rend|
+        rend.data = self
+        yield(rend) if block_given?
+      end
     end
 
     # Converts a <tt>Collection</tt> object to a <tt>Data::Set</tt>.
@@ -47,8 +48,8 @@ module Ruport::Data
     # Provides a shortcut for the <tt>as()</tt> method by converting a call to
     # <tt>as(:format_name)</tt> into a call to <tt>to_format_name</tt>
     def method_missing(id,*args)
-      return as($1.to_sym) if id.to_s =~ /^to_(.*)/ 
-      super
+     return as($1.to_sym) if id.to_s =~ /^to_(.*)/ 
+     super
     end
     
     attr_reader :data

data/lib/ruport/data/groupable.rb

@@ -44,7 +44,9 @@ module Ruport::Data
       r_tags = map { |r| r.tags }.flatten.uniq
       tables_hash = Hash.new { |h,k| h[k] = [].to_table(column_names) }
       each { |row|
-        row.tags.each { |t| tables_hash[t] << row }
+        row.tags.each { |t| 
+          tables_hash[t].instance_variable_get(:@data) << row
+        }
       }
       r = Record.new tables_hash, :attributes => r_tags
       class << r
@@ -74,7 +76,6 @@ module Ruport::Data
     #
     def create_tag_group(label,&block)
       each { |r| block[r] && r.tag(label) }
-      #select(&block).each { |r| r.tag label }
     end
     alias_method :tag_group, :create_tag_group
 

data/lib/ruport/data/record.rb

@@ -55,11 +55,7 @@ module Ruport::Data
         end
       else
         @data = data.dup
-        @attributes = if options[:attributes] 
-          options[:attributes]
-        else 
-          []
-        end
+        @attributes = options[:attributes] || []
       end
     end
     
@@ -81,8 +77,9 @@ module Ruport::Data
         raise "Invalid index" unless index < @data.length
         @data[index]
       else
-        raise "Invalid index" unless attributes.index(index.to_s)
-        @data[attributes.index(index.to_s)]
+        index = index.to_s
+        raise "Invalid index" unless attributes.index(index)
+        @data[attributes.index(index)]
       end
     end
 
@@ -100,8 +97,9 @@ module Ruport::Data
         raise "Invalid index" unless index < @data.length
         @data[index] = value
       else
-        raise "Invalid index" unless attributes.index(index.to_s)
-        @data[attributes.index(index.to_s)] = value
+        index = index.to_s
+        raise "Invalid index" unless @attributes.index(index)
+        @data[attributes.index(index)] = value
       end
     end
 
@@ -110,9 +108,9 @@ module Ruport::Data
     # <tt>==</tt> evaluates to true. Otherwise, <tt>==</tt> 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?, :==
@@ -135,8 +133,7 @@ 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 <tt>attributes</tt> from this Record.
@@ -175,9 +172,9 @@ module Ruport::Data
     # Same as Record#reorder but modifies its reciever in place.
     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

data/lib/ruport/data/table.rb

@@ -4,20 +4,6 @@
 # This is Free Software.  For details, see LICENSE and COPYING
 # Copyright 2006 by respective content owners, all rights reserved.
 
-class Array
-
-  #
-  # Converts an array to a Ruport::Data::Table object, ready to
-  # use in your reports.
-  #
-  # Example:
-  #   [[1,2],[3,4]].to_table(%w[a b])
-  #
-  def to_table(options={})
-    options = { :column_names => options } if options.kind_of? Array 
-    Ruport::Data::Table.new({:data => self}.merge(options))
-  end
-end
 
 module Ruport::Data
 
@@ -415,13 +401,98 @@ module Ruport::Data
 
     alias_method :sum, :sigma
     
+    #
+    # Returns a sorted table. If col_names is specified, 
+    # the block is ignored and the table is sorted by the named columns. All
+    # options are used in constructing the new Table (see Array#to_table
+    # for details).
+    #
+    # Example:
+    #
+    #   table = [[4, 3], [2, 5], [7, 1]].to_table(%w[col1 col2 ])
+    #
+    #   # returns a new table sorted by col1
+    #   table.sort_rows_by {|r| r["col1"]}
+    #
+    #   # returns a new table sorted by col2
+    #   table.sort_rows_by ["col2"]
+    #
+    #   # returns a new table sorted by col1, then col2
+    #   table.sort_rows_by ["col1", "col2"]
+    #
+    def sort_rows_by(col_names=nil, &block)
+      # stabilizer is needed because of 
+      # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/170565
+      stabilizer = 0
+
+      data_array =
+        if col_names
+          sort_by do |r| 
+            stabilizer += 1
+            [col_names.map {|col| r[col]}, stabilizer] 
+          end
+        else
+          sort_by(&block)
+        end
+
+      table = 
+        data_array.to_table(@column_names)
+
+      table.tags = self.tags
+      return table
+    end
+        
   end
 
 end
 
-module Ruport::Data::TableHelper #:nodoc:
-  def table(names=[])
-    t = [].to_table(names)
-    yield(t) if block_given?; t
+
+module Kernel
+  
+  # Shortcut interface for creating Data::Tables
+  #
+  # Examples:
+  #
+  #   t = Table(%w[a b c])   #=> creates a new empty table w. cols a,b,c
+  #   t = Table("a","b","c") #=> creates a new empty table w. cols a,b,c
+  #
+  #   # allows building table inside of block, returns table object
+  #   t = Table(%w[a b c]) { |t| t << [1,2,3] } 
+  #
+  #   # allows loading table from CSV
+  #   # accepts all Data::Table.load options, but block form yields table,
+  #   # not row!
+  #
+  #   t = Table("foo.csv")
+  #   t = Table("bar.csv", :has_names => false)
+  def Table(*args,&block)
+    table=
+    case(args[0])
+    when Array
+      [].to_table(args[0])
+    when /\.csv/
+      Ruport::Data::Table.load(*args)
+    else
+       [].to_table(args)
+    end
+
+    block[table] if block
+
+    return table
+  end
+end
+
+class Array
+
+  #
+  # Converts an array to a Ruport::Data::Table object, ready to
+  # use in your reports.
+  #
+  # Example:
+  #   [[1,2],[3,4]].to_table(%w[a b])
+  #
+  def to_table(column_names=nil)
+    Ruport::Data::Table.new({:data => self, :column_names => column_names})
   end
 end
+

data/lib/ruport/format/csv.rb

@@ -0,0 +1,29 @@
+module Ruport::Format
+
+  # This plugin implements the CSV format for tabular data output. 
+  # See also:  Renderer::Table
+  class CSV < Plugin
+    
+    # Generates table header by turning column_names into a CSV row.
+    # Uses build_csv_row to generate the actual formatted output
+    #
+    # This method does not do anything if layout.show_table_headers is false or
+    # the Data::Table has no column names.
+    def build_table_header
+      unless data.column_names.empty? || !layout.show_table_headers
+        build_csv_row(data.column_names)
+      end
+    end
+
+    # Calls build_csv_row for each row in the Data::Table
+    def build_table_body
+      data.map { |r| build_csv_row(r) }.join("\n")
+    end
+
+    # Produces CSV output for a data row.
+    def build_csv_row(row)
+      require "fastercsv"
+      output << FasterCSV.generate { |csv| csv << row } 
+    end
+  end
+end

data/lib/ruport/format/html.rb

@@ -0,0 +1,40 @@
+module Ruport::Format
+  # Produces HTML output for tabular data.
+  #
+  # See also Renderer::Table
+  class HTML < Plugin
+    
+    # Generates table headers based on the column names of your Data::Table.  
+    #
+    # This method does not do anything if layout.show_table_headers is false or
+    # the Data::Table has no column names.
+    def build_table_header
+      output << "\t<table>\n"
+      unless data.column_names.empty? || !layout.show_table_headers
+        output << "\t\t<tr>\n\t\t\t<th>" + 
+          data.column_names.join("</th>\n\t\t\t<th>") + 
+          "</th>\n\t\t</tr>\n"
+      end
+    end
+    
+    # Generates the <tr> and <td> tags for each row, calling to_s on each
+    # element of the Record.  If the Record has been tagged, the tags will be
+    # converted into class attributes in the HTML output.
+    #
+    def build_table_body
+      output << data.inject("") do |s,r| 
+        row = r.map { |e| e.to_s.empty? ? "&nbsp;" : e }
+        classstr = r.tags.inject("") {|cs,c| cs + " class='#{c}'" } 
+        s + "\t\t<tr#{classstr}>\n\t\t\t<td#{classstr}>" +
+          row.to_a.join("</td>\n\t\t\t<td#{classstr}>") + 
+          "</td>\n\t\t</tr>\n"
+      end 
+    end
+
+    # Simply closes the table tag. 
+    def build_table_footer
+      output << "\t</table>"
+    end
+
+  end
+end

data/lib/ruport/format/latex.rb

@@ -0,0 +1,50 @@
+module Ruport::Format
+  class Latex < Plugin
+
+    attr_accessor :caption
+    
+    def build_table_header
+      output << "\\documentclass[11pt]{article}\n"     <<
+                "\\RequirePackage{lscape,longtable}\n" <<
+                "\\begin{document}\n" <<
+                "\\begin{longtable}[c]{ "
+        
+        data.column_names.each do
+          output << " p{2cm} "
+        end
+        output << " }\n"
+        output << "\\hline\n"
+
+        #FIXME: this ain't ruby, jh ;)
+        counter = 0
+
+        data.column_names.each do |t|
+          output << " & " unless counter == 0
+          output << "\\textsc{#{t}}"
+          counter += 1
+        end
+
+        output << "\\\\\n"
+        output << "\\hline\n"
+        output << "\\endhead\n"
+        output << "\\endfoot\n"
+        output << "\\hline\n"
+    end
+
+    def build_table_body
+      data.each do |r|
+        output << r.data.join(" & ") + "\\\\\n"
+        output << "\\hline\n"
+      end
+      if caption
+        output << "\\caption[#{caption}]{#{caption}}\n"
+      end
+      output << "\\end{longtable}\n"
+    end
+
+    def build_table_footer
+      output << "\\end{document}\n"
+    end
+
+  end
+end