ruport 0.8.0 → 0.8.1

data/AUTHORS

@@ -4,6 +4,7 @@
 - {Dudley Flanders}[mailto:dudley@misnomer.us]
 - {James Healy}[mailto:jimmy@deefa.com]
 - Dinko Mehinovic
+- {Michael Milner}[mailto:mikem836@gmail.com]
 
 = Contributors / People we've (legally) stolen from:
 
@@ -40,10 +41,5 @@ Marshall T. Vandegrift:
 Stefan Mahlitz:
  - Table#sort_rows_by
 
-Michael Milner
- - Refactoring for Table#column_names= (r436)
- - Mock object for Mailer
- - Mock object for Report (#130)
-
 Chris Carter
  - Table#remove_columns (r440)

data/README

@@ -99,7 +99,7 @@
 #
 # = Bug Reports / Feature Requests
 #
-#  Our Trac is at: http://stonecode.svnrepository.com
+#  Our Trac is at: http://code.stonecode.org
 #  You may use the username ruport and password blinky to file tickets
 #
 # = Resources
@@ -123,7 +123,7 @@
 #     http://rubyforge.org/projects/ruport
 #
 #   - The latest stable API documentation is available at:
-#     http://reporting.stonecode.org/docs
+#     http://api.rubyreports.org
 #
 # There are also some tutorial available:
 # http://stonecode.svnrepository.com/ruport/trac.cgi/wiki/TutorialsAndArticles
@@ -136,11 +136,11 @@
 #
 # - Grabbing the code from the svn trunk is simple:
 #
-#   svn co svn://rubyforge.org//var/svn/ruport/trunk/
+#   svn co svn://rubyforge.org//var/svn/ruport/trunk/ ruport
 #
 # - Or if you are interested in the latest updates to the stable branch
 #
-#   svn co svn://rubyforge.org//var/svn/ruport/branches/stable
+#   svn co svn://rubyforge.org//var/svn/ruport/branches/stable ruport
 #
 # Thanks for checking out Ruport!
 #

data/Rakefile

@@ -23,7 +23,7 @@ end
 
 spec = Gem::Specification.new do |spec|
 	spec.name = LEAN ? "lean-ruport" : "ruport"
-	spec.version = "0.8.0"
+	spec.version = "0.8.1"
 	spec.platform = Gem::Platform::RUBY
 	spec.summary = "A generalized Ruby report generation and templating engine."
 	spec.files =  Dir.glob("{examples,lib,test,bin}/**/**/*") +
@@ -40,7 +40,7 @@ spec = Gem::Specification.new do |spec|
 	                     '--main'  << 'README' << '-q'
   unless LEAN
     spec.add_dependency('fastercsv', '>= 1.1.0')
-    spec.add_dependency('RedCloth',  '>= 3.0.4')
+    spec.add_dependency('RedCloth',  '>= 3.0.3')
     spec.add_dependency('pdf-writer', '>= 1.1.3')
     spec.add_dependency("mailfactory", ">= 1.2.3")
     spec.add_dependency('scruffy', '>= 0.2.2')

data/examples/rope_examples/itunes/README

@@ -0,0 +1,12 @@
+- this is an up to date version of the code in Chris Carter's tutorial at:
+http://concentrationstudios.com/2007/1/21/ruports
+
+To run the report do:
+
+ruby app/reports/playlist.rb
+
+or 
+
+rake run report=playlist
+
+It will generate a pdf in output/

data/examples/rope_examples/itunes/Rakefile

@@ -0,0 +1,18 @@
+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
+
+task :build do
+  sh "ruby util/build report #{ENV['report']}"
+end
+
+task :run do
+  sh "ruby lib/reports/#{ENV['report']}.rb"
+end

data/examples/rope_examples/itunes/config/ruport_config.rb

@@ -0,0 +1,8 @@
+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"
+}

data/examples/rope_examples/itunes/data/mix.txt

@@ -0,0 +1 @@
+Name	Artist	Composer	Album	Grouping	Genre	Size	Time	Disc Number	Disc Count	Track Number	Track Count	Year	Date Modified	Date Added	Bit Rate	Sample Rate	Volume Adjustment	Kind	Equalizer	Comments	Play Count	Last Played	Skip Count	Last Skipped	My Rating	Location

data/examples/rope_examples/itunes/lib/init.rb

@@ -0,0 +1,9 @@
+begin
+  require "rubygems"
+  gem "ruport","=0.8.0"
+rescue LoadError 
+  nil
+end
+require "ruport"
+require "lib/helpers"
+require "config/ruport_config"

data/examples/rope_examples/itunes/lib/reports.rb

@@ -0,0 +1 @@
+require "lib/reports/playlist"

data/examples/rope_examples/itunes/lib/reports/playlist.rb

@@ -0,0 +1,17 @@
+require "lib/init"
+class Playlist < Ruport::Report
+  
+  def prepare
+    t = load_csv "data/mix.txt", :csv_options => { :col_sep => "\t" }
+    @table = t.sub_table(%w[Name Artist Album Time])
+  end
+ 
+  def generate
+    @table.to_pdf
+  end
+
+end
+
+if __FILE__ == $0
+   Playlist.run { |res| res.write 'output/mix.pdf'}
+end

data/examples/rope_examples/itunes/log/ruport.log

@@ -0,0 +1 @@
+# Logfile created on Sat Feb 03 19:38:27 -0500 2007 by logger.rb/1.5.2.9

data/examples/rope_examples/itunes/test/test_playlist.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "lib/reports/playlist"
+
+class TestPlaylist < Test::Unit::TestCase
+  def test_flunk
+    flunk "Write your real tests here or in any test/test_* file"
+  end
+end

data/examples/rope_examples/itunes/util/build

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+include FileUtils
+
+def format_class_name(string)
+  string.downcase.split("_").map { |s| s.capitalize }.join
+end
+
+unless ARGV.length > 1
+  puts "usage: build [command] [options]"
+  exit
+end
+
+class_name = format_class_name(ARGV[1])
+
+exit if File.exist? "lib/reports/#{ARGV[1]}.rb"
+if ARGV[0].eql? "report"
+  File.open("lib/reports.rb", "a") { |f| 
+    f.puts("require \"lib/reports/#{ARGV[1]}\"")
+  }
+REP = <<EOR
+require "lib/init"
+class #{class_name} < Ruport::Report
+  
+  def prepare
+
+  end
+ 
+  def generate
+
+  end
+
+  def cleanup
+
+  end
+
+end
+
+if __FILE__ == $0
+   #{class_name}.run { |res| puts res.results }
+end
+EOR
+
+TEST = <<EOR
+require "test/unit"
+require "lib/reports/#{ARGV[1]}"
+
+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
+  puts "report file: lib/reports/#{ARGV[1]}.rb"
+  File.open("lib/reports/#{ARGV[1]}.rb", "w") { |f| f << REP }
+  puts "test file: test/test_#{ARGV[1]}.rb"
+  puts "class name: #{class_name}" 
+  File.open("test/test_#{ARGV[1]}.rb","w") { |f| f << TEST }  
+else
+  puts "Incorrect usage."
+end

data/examples/rope_examples/itunes/util/sql_exec

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "lib/init"
+
+puts Ruport::Query.new(ARGF.read).result

data/examples/rope_examples/sales_report/README

@@ -0,0 +1,4 @@
+This example is based on the code in James Healy's excellent formatting system 
+tutorial, but includes updated features from 0.8
+
+http://www.yob.id.au/articles/ruport_formatting_system.html

data/examples/rope_examples/sales_report/Rakefile

@@ -0,0 +1,18 @@
+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
+
+task :build do
+  sh "ruby util/build report #{ENV['report']}"
+end
+
+task :run do
+  sh "ruby lib/reports/#{ENV['report']}.rb"
+end

data/examples/rope_examples/sales_report/config/ruport_config.rb

@@ -0,0 +1,8 @@
+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"
+}

data/examples/rope_examples/sales_report/lib/init.rb

@@ -0,0 +1,9 @@
+begin
+  require "rubygems"
+  gem "ruport","=0.8.0"
+rescue LoadError 
+  nil
+end
+require "ruport"
+require "lib/helpers"
+require "config/ruport_config"

data/examples/rope_examples/sales_report/lib/reports.rb

@@ -0,0 +1 @@
+require "lib/reports/sales"

data/examples/rope_examples/sales_report/lib/reports/sales.rb

@@ -0,0 +1,138 @@
+require "lib/init"
+
+module MyModule
+  class SalesRenderer < Ruport::Renderer
+
+     include Ruport::Renderer::Helpers
+
+     required_option :report_title
+     required_option :titles
+
+     stage :document_header
+     stage :document_body
+
+     finalize :document
+  end
+
+  class Text < Ruport::Format::Plugin
+
+    SalesRenderer.add_format self, :txt
+
+    def pad(str, len)
+      return "".ljust(len) if str.nil?
+      str = str.slice(0, len) # truncate long strings
+      str.ljust(len) # pad with whitespace
+    end
+
+    def build_document_header
+      unless options.report_title.nil?
+        output << "".ljust(75,"*") << "\n"
+        output << "  #{options.report_title}\n" 
+        output << "".ljust(75,"*") << "\n"
+        output << "\n"
+      end
+    end
+
+    def build_document_body
+      # table heading
+      output << pad("isbn", 15) << "|" << pad("title",30) << "|"
+      output << pad("author", 15) << "|" << pad("sales", 10) << "\n"
+      output << "".ljust(75,"#") << "\n"
+
+      # table data
+      options.titles.each do |title|
+        output << pad(title["isbn"],15) << "|"
+        output << pad(title["title"],30) << "|"
+        output << pad(title["author"],15) << "|"
+        output << pad(title["sales"].to_s,10) << "\n"
+      end
+
+      output << "".ljust(75,"#") << "\n"
+    end
+
+    def finalize_document; output end
+
+  end
+
+  class PDF < Ruport::Format::PDF
+    SalesRenderer.add_format self, :pdf
+
+    def add_title( title )  
+      rounded_text_box("<b>#{title}</b>") do |o|
+        o.fill_color = Color::RGB::Gray80
+        o.radius    = 5  
+        o.width     = layout.header_width || 200
+        o.height    = layout.header_height || 20
+        o.font_size = layout.header_font_size || 12
+        o.x         = pdf_writer.absolute_right_margin - o.width 
+        o.y         = pdf_writer.absolute_top_margin
+      end
+    end      
+
+    def build_document_header
+      add_title( options.report_title ) unless options.report_title.nil?
+    end
+
+    def build_document_body
+      pad(50) {
+        ::PDF::SimpleTable.new do |table|
+          table.maximum_width = 500
+          table.orientation   = :center
+          table.data          = options.titles
+          table.column_order  = %w[isbn title author sales]
+          table.render_on(pdf_writer)
+        end
+      }
+    end
+
+    def finalize_document
+      output << pdf_writer.render
+    end 
+
+  end
+
+end
+
+class Sales < Ruport::Report
+ 
+  attr_accessor :books, :format 
+ 
+  def generate
+    MyModule::SalesRenderer.render(format) do |r|
+      r.report_title = "December 2006 Sales Figures"
+      r.titles = books
+    end
+  end
+
+end
+
+if __FILE__ == $0
+
+  book1 = {"isbn"    => "978111111111", 
+           "title"   => "Book Number One", 
+           "author"  => "me", "sales" => 10}
+
+  book2 = { "isbn"   => "978222222222", 
+            "title"  => "Two is better than one", 
+            "author" => "you", "sales" => 267}
+
+  book3 = { "isbn"   => "978333333333", 
+            "title"  => "Three Blind Mice", 
+            "author" => "John Howard", "sales" => 1}
+
+  book4 = { "isbn"   => "978444444444", 
+            "title"  => "The number 4", 
+            "author" => "George Bush", "sales" => 1829}
+
+  books = [book1, book2, book3, book4]
+
+  report = Sales.new 
+
+  report.books = books
+
+  [:pdf, :txt].each { |f|
+    report.format = f
+    report.run { |r| r.write "output/books.#{f}" }
+  }
+
+end

data/examples/rope_examples/sales_report/log/ruport.log

@@ -0,0 +1 @@
+# Logfile created on Sat Feb 03 20:02:43 -0500 2007 by logger.rb/1.5.2.9

data/examples/rope_examples/sales_report/output/books.pdf

@@ -0,0 +1,170 @@
+%PDF-1.3
+%����
+
+1 0 obj
+<< /Type /Catalog
+/Outlines 2 0 R
+/Pages 3 0 R>>
+endobj
+2 0 obj
+<< /Type /Outlines >>
+endobj
+3 0 obj
+<< /Type /Pages
+/Kids [6 0 R
+]
+/Count 1
+/Resources <<
+/ProcSet 4 0 R
+/Font << 
+/F1 8 0 R
+/F2 10 0 R >>
+>>
+/MediaBox [0 0 612.0 792.0]
+ >>
+endobj
+4 0 obj
+[/PDF /Text ]
+endobj
+5 0 obj
+<<
+/CreationDate (D:200702040113)
+/Creator (sales.rb)
+/Producer (PDF::Writer for Ruby)
+>>
+endobj
+6 0 obj
+<< /Type /Page
+/Parent 3 0 R
+/Contents [
+7 0 R
+11 0 R
+]
+>>
+endobj
+7 0 obj
+<<
+/Length 811 >>
+stream
+
+0.000 0.000 0.000 rg
+0.000 0.000 0.000 RG
+q
+0.800 0.800 0.800 rg
+381.000 756.000 m
+571.000 756.000 l
+573.500 756.000 576.000 753.500 576.000 751.000 c
+576.000 741.000 l
+576.000 738.500 573.500 736.000 571.000 736.000 c
+381.000 736.000 l
+378.500 736.000 376.000 738.500 376.000 741.000 c
+376.000 751.000 l
+376.000 753.500 378.500 756.000 381.000 756.000 c
+576.000 736.000 m B
+1 w
+Q
+BT 391.292 742.128 Td /F2 12.0 Tf 0 Tr (December 2006 Sales Figures) Tj ET
+0.800 0.800 0.800 RG
+BT 158.443 670.128 Td /F1 12.0 Tf 0 Tr (isbn) Tj ET
+BT 235.830 670.128 Td /F1 12.0 Tf 0 Tr (title) Tj ET
+BT 345.760 670.128 Td /F1 12.0 Tf 0 Tr (author) Tj ET
+BT 415.269 670.128 Td /F1 12.0 Tf 0 Tr (sales) Tj ET
+q
+0.800 0.800 0.800 rg
+153.443 648.068 295.114 15.560 re f
+0.800 0.800 0.800 rg
+153.443 616.948 295.114 15.560 re f
+1 w
+Q
+endstream
+endobj
+
+8 0 obj
+<< /Type /Font
+/Subtype /Type1
+/Name /F1
+/BaseFont /Helvetica
+/Encoding /WinAnsiEncoding
+>>
+endobj
+9 0 obj
+<< /Type /Encoding
+/BaseEncoding /WinAnsiEncoding
+
+>>
+endobj
+10 0 obj
+<< /Type /Font
+/Subtype /Type1
+/Name /F2
+/BaseFont /Helvetica-Bold
+/Encoding 9 0 R
+>>
+endobj
+11 0 obj
+<<
+/Length 1255 >>
+stream
+
+BT 158.443 652.318 Td /F1 10.0 Tf 0 Tr (978111111111) Tj ET
+BT 235.830 652.318 Td /F1 10.0 Tf 0 Tr (Book Number One) Tj ET
+BT 345.760 652.318 Td /F1 10.0 Tf 0 Tr (me) Tj ET
+BT 415.269 652.318 Td /F1 10.0 Tf 0 Tr (10) Tj ET
+BT 158.443 636.758 Td /F1 10.0 Tf 0 Tr (978222222222) Tj ET
+BT 235.830 636.758 Td /F1 10.0 Tf 0 Tr (Two is better than one) Tj ET
+BT 345.760 636.758 Td /F1 10.0 Tf 0 Tr (you) Tj ET
+BT 415.269 636.758 Td /F1 10.0 Tf 0 Tr (267) Tj ET
+BT 158.443 621.198 Td /F1 10.0 Tf 0 Tr (978333333333) Tj ET
+BT 235.830 621.198 Td /F1 10.0 Tf 0 Tr (Three Blind Mice) Tj ET
+BT 345.760 621.198 Td /F1 10.0 Tf 0 Tr (John Howard) Tj ET
+BT 415.269 621.198 Td /F1 10.0 Tf 0 Tr (1) Tj ET
+BT 158.443 605.638 Td /F1 10.0 Tf 0 Tr (978444444444) Tj ET
+BT 235.830 605.638 Td /F1 10.0 Tf 0 Tr (The number 4) Tj ET
+BT 345.760 605.638 Td /F1 10.0 Tf 0 Tr (George Bush) Tj ET
+BT 415.269 605.638 Td /F1 10.0 Tf 0 Tr (1829) Tj ET
+0.000 0.000 0.000 RG
+1 w
+153.443 686.000 m
+153.443 601.388 l S
+1 w
+230.830 686.000 m
+230.830 601.388 l S
+340.760 686.000 m
+340.760 601.388 l S
+410.269 686.000 m
+410.269 601.388 l S
+1 w
+448.557 686.000 m
+448.557 601.388 l S
+152.943 686.000 m
+449.057 686.000 l S
+153.443 665.878 m
+448.557 665.878 l S
+152.943 601.388 m
+449.057 601.388 l S
+endstream
+endobj
+
+xref
+0 12
+0000000000 65535 f 
+0000000015 00000 n 
+0000000079 00000 n 
+0000000116 00000 n 
+0000000269 00000 n 
+0000000298 00000 n 
+0000000403 00000 n 
+0000000477 00000 n 
+0000001340 00000 n 
+0000001447 00000 n 
+0000001516 00000 n 
+0000001618 00000 n 
+
+trailer
+  << /Size 12
+     /Root 1 0 R
+ /Info 5 0 R
+  >>
+startxref
+2927
+%%EOF