ruport-util 0.6.0 → 0.7.0

data/INSTALL

@@ -3,14 +3,18 @@
 ruport-util provides a home for marooned former parts of Ruby Reports,
 and newer fringe ideas.
 
-Support as of 2007.05.01:
+Support as of 2007.06.07:
 
   * Basic Graphing (util/graph)
   * Report runner  (util/report)
   * Report Mailing (util/mailer)
   * Report Manager (util/report_manager)
   * Invoices       (util/invoice)
+  * PDF form helpers (util/pdf/form)
+  * ODS formatter for tables (util/ods) 
+  * Benchmarking Tool (util/bench)
   * Ruport centric code generation via the rope command.
+  * csv to OpenDocument conversion via csv2ods
 
 See example/ for more information
 
@@ -27,14 +31,11 @@ It's on RubyForge:
   gem install ruport-util -y
 
 == Using
-
-To load all of the tools at once:
-
+  
+  require "ruport"
   require "ruport/util"
 
-To load just one tool:
-
-  require "ruport/util/graph"
+  # then just use whatever tools you want.
 
 == Help?
    

data/Rakefile

@@ -1,24 +1,39 @@
-require "rake/rdoctask"
-require "rake/testtask"
-require "rake/gempackagetask"
-
 begin
   require "rubygems"
 rescue LoadError
   nil
 end
 
-task :default => [:test]
+require 'rake'
+require "rake/rdoctask"
+require "rake/gempackagetask"
+
+require 'spec/rake/spectask'
+
+task :default => [:wraptest]
+
+desc "Run all tests"
+Spec::Rake::SpecTask.new('test') do |t|
+  t.spec_files = FileList['test/test_*.rb']
+end
+
+desc "Generate specdocs for examples for inclusion in RDoc"
+Spec::Rake::SpecTask.new('specdoc') do |t|
+  t.spec_files = FileList['test/test_*.rb']
+  t.spec_opts = ["--format", "rdoc"]
+  t.out = 'EXAMPLES.rd'
+end
 
-Rake::TestTask.new do |test|
-  test.libs << "test"
-  test.test_files = Dir[ "test/test_*.rb" ]
-  test.verbose = true
+desc "Generate HTML report for failing examples"
+Spec::Rake::SpecTask.new('failing_examples_with_html') do |t|
+  t.spec_files = FileList['test/test_*.rb']
+  t.spec_opts = ["--format", "html:failing_examples.html", "--diff"]
+  t.fail_on_error = false
 end
 
 spec = Gem::Specification.new do |spec|
   spec.name = "ruport-util"
-  spec.version = "0.6.0"
+  spec.version = "0.7.0"
   spec.platform = Gem::Platform::RUBY
   spec.summary = "A set of tools and helper libs for Ruby Reports"
   spec.files =  Dir.glob("{example,lib,test,bin}/**/**/*") +
@@ -28,7 +43,7 @@ spec = Gem::Specification.new do |spec|
   
   spec.test_files = Dir[ "test/test_*.rb" ]
   spec.bindir = "bin"
-  spec.executables = FileList["rope"]
+  spec.executables = FileList["rope", "csv2ods"]
   spec.has_rdoc = true
   spec.extra_rdoc_files = %w{INSTALL}
   spec.rdoc_options << '--title' << 'ruport-util Documentation' <<
@@ -67,3 +82,43 @@ begin
 rescue LoadError
   nil
 end
+
+## RSpec Wrapper
+
+require 'test/helper/layout'
+
+class String
+  def /(obj)
+    File.join(self, obj.to_s)
+  end
+end
+
+SPEC_BASE = File.expand_path('test')
+
+# ignore files with these paths
+ignores = [ './helper/*', './helper.rb' ]
+
+files = Dir[SPEC_BASE/'**'/'*.rb']
+ignores.each do |ignore|
+  ignore_files = Dir[SPEC_BASE/ignore]
+  ignore_files.each do |ignore_file|
+    files.delete File.expand_path(ignore_file)
+  end
+end
+
+files.sort!
+
+spec_layout = Hash.new{|h,k| h[k] = []}
+
+files.each do |file|
+  name = file.gsub(/^#{SPEC_BASE}/, '.')
+  dir_name = File.dirname(name)[2..-1] || './'
+  task_name = 'wrap' + ([:test] + dir_name.split('/')).join(':')
+  spec_layout[task_name] << file
+end
+
+desc "Test all"
+task "wraptest" => [] do
+  wrap = SpecWrap.new(*spec_layout.values.flatten)
+  wrap.run
+end

data/bin/csv2ods

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'ostruct'
+require 'fileutils'
+
+begin
+  require 'rubygems'
+rescue LoadError
+end
+
+require 'ruport'
+require 'ruport/util'
+
+options = OpenStruct.new(:output => 'output.ods')
+
+opts = OptionParser.new do |opt|
+  ruby_version = "ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  ruport_util_version = "Ruport Util Version #{Ruport::Util::VERSION}"
+  ruport_version = "Ruport Version #{Ruport::VERSION}, on #{ruby_version}"
+  version = "#{ruport_util_version} - #{ruport_version}"
+
+  opt.banner = "Usage: csv2ods [ OPTIONS ] input.csv [ output.ods ]"
+  opt.define_head(version)
+
+  opt.separator ''
+  opt.separator 'Common options:'
+
+  opt.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+
+  opt.on_tail('-v', '--version', 'Show version') do
+    puts version
+    exit
+  end
+end
+
+opts.parse!(ARGV)
+
+input = ARGV.shift
+options.input = input if input
+output = ARGV.shift
+options.output = output if output
+
+unless options.input and options.output
+  puts opts
+  exit
+end
+
+ods = Table(options.input).to_ods(:tempfile => true)
+FileUtils.cp(ods.path, options.output)

data/example/graph_report.rb

@@ -4,13 +4,17 @@ require "ruport/util"
 
 class GraphReport < Ruport::Report
   
+  renders_as_graph
+  
   def generate
     graph = Ruport::Graph(:column_names => %w[a b c d e])
     graph.add_line [1,2,3,4,5], :name => "foo" 
     graph.add_line [11,22,70,2,19], :name => "bar"
-    graph.to_svg
+    return graph
   end
 
 end
 
-GraphReport.run { |r| r.write("foo.svg") }
+GraphReport.generate do |r| 
+  r.save_as("foo.svg") 
+end

data/example/invoice_report.rb

@@ -24,4 +24,5 @@ class SampleReport < Ruport::Report
   end
 end
 
-SampleReport.run { |r| r.write "out.pdf" }
+a = SampleReport.new
+File.open("invoice.pdf","wb") { |f| f << a.generate }

data/example/mailer.rb

@@ -2,6 +2,9 @@ require "ruport"
 require "ruport/util"
 require "fileutils"
 class MyReport < Ruport::Report
+
+  renders_as_table
+  
   def prepare
     add_mailer :default,
       :host => "mail.adelphia.net",
@@ -9,17 +12,14 @@ class MyReport < Ruport::Report
    end
 
   def generate
-    Table(%w[a b c]) { |t| t << [1,2,3] << [4,5,6] }.to_pdf
+    Table(%w[a b c]) { |t| t << [1,2,3] << [4,5,6] }
   end
 
-  def cleanup
-    FileUtils.rm("foo.pdf")
-  end
 end
 
-MyReport.run do |res|
- res.write "foo.pdf";
- res.send_to("gregory.t.brown@gmail.com") do |mail|
+MyReport.generate do |report|
+ report.save_as "foo.pdf"
+ report.send_to("gregory.t.brown@gmail.com") do |mail|
    mail.subject = "Sample report"
    mail.attach "foo.pdf"
    mail.text = <<-EOS

data/example/managed_report.rb

@@ -5,7 +5,7 @@ class MyReport < Ruport::Report
   
   acts_as_managed_report 
    
-  def generate
+  def content
      "Hello Mike"
   end
   
@@ -15,7 +15,7 @@ class YourReport < Ruport::Report
   
   acts_as_managed_report
   
-  def generate
+  def content
     "Hello Joe"
   end 
   
@@ -25,12 +25,12 @@ class HisReport < Ruport::Report
   
   acts_as_managed_report
   
-  def generate
+  def content
     "Hello Robert"
   end 
   
 end
 
 %w[MyReport YourReport HisReport].each do |report|
-  puts Ruport::ReportManager[report].run  
-end
+  puts Ruport::ReportManager[report].generate { |r| r.content }
+end

data/example/ods.rb

@@ -0,0 +1,12 @@
+require 'ruport'
+require "ruport/util"
+
+csv = %{
+first col,second col,third col
+first row,cell 1,cell 2
+second row,cell 3,cell 4
+}.strip
+
+
+f = Table(:string => csv).to_ods(:tempfile => true)
+FileUtils.cp(f.path,"out.ods")

data/lib/ruport/util/generator.rb

@@ -175,15 +175,12 @@ REP = <<EOR
 require "lib/init"
 class #{class_name} < Ruport::Report
 
-  def generate
+  def renderable_data
 
   end
   
 end
 
-if __FILE__ == $0
-  puts #{class_name}.run
-end
 EOR
 
 TEST = <<EOR
@@ -296,13 +293,7 @@ README = <<END_README
 
 Rope provides you with a number of simple utilities that script away
 much of your boilerplate code, and also provide useful tools for
-development, such as automatic test running and a way to check your
-SQL queries for validity. Additionally, you'll get logging for free
-and you can share a common configuration file between applications 
-in the same project.
-
-Though each tool on it's own isn't complicated, having them all
-working together can be a major win.
+development
 
 # The Basics
 

data/lib/ruport/util/graph.rb

@@ -14,6 +14,14 @@ end
 
 module Ruport
 
+  module Renderer::Hooks
+    module ClassMethods
+      def renders_as_graph
+        renders_with Ruport::Renderer::Graph
+      end
+    end
+  end
+
   def Graph(*args)
     Graph.new(*args)
   end

data/lib/ruport/util/ods.rb

@@ -0,0 +1,80 @@
+require 'cgi'
+require 'tmpdir'
+
+require 'zip/zip'
+
+module Ruport
+
+  class Formatter::ODS < Formatter
+    BLANK_ODS = File.join(Ruport::Util::BASEDIR, 'example', 'data', 'blank.ods')
+
+    renders :ods, :for => [ Renderer::Row, Renderer::Table]
+
+    def prepare_table
+      output << %{<?xml version="1.0" encoding="UTF-8"?>
+<office:document-content xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0" xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0" xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0" xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0" xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0" xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0" xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0" xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0" xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0" xmlns:math="http://www.w3.org/1998/Math/MathML" xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0" xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0" xmlns:ooo="http://openoffice.org/2004/office" xmlns:ooow="http://openoffice.org/2004/writer" xmlns:oooc="http://openoffice.org/2004/calc" xmlns:dom="http://www.w3.org/2001/xml-events" xmlns:xforms="http://www.w3.org/2002/xforms" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" office:version="1.0">
+  <office:scripts/>
+  <office:font-face-decls/>
+  <office:automatic-styles/>
+  <office:body>
+    <office:spreadsheet>
+      <table:table table:name="Ruport" table:print="false">
+        <office:forms form:automatic-focus="false" form:apply-design-mode="false"/>
+}
+    end
+
+    def build_table_header
+      if @options.show_table_headers
+        table_row{ build_cells(data.column_names) }
+      end
+    end
+
+    def build_table_body
+      render_data_by_row
+    end
+
+    def build_row
+      table_row{ build_cells(data.to_a) }
+    end
+
+    def table_row
+      output << %{        <table:table-row>\n}
+      yield
+      output << %{        </table:table-row>\n}
+    end
+
+    def build_cells(values)
+      values.each do |value|
+        value = CGI.escapeHTML(value.to_s)
+        output << %{          <table:table-cell>\n}
+        output << %{            <text:p>#{value}</text:p>\n}
+        output << %{          </table:table-cell>\n}
+      end
+    end
+
+    def finalize_table
+      output << %{      </table:table>
+    </office:spreadsheet>
+  </office:body>
+</office:document-content>}
+
+      @tempfile = Tempfile.new('output.ods')
+
+      File.open(BLANK_ODS){|bo| @tempfile.print(bo.read(1024)) until bo.eof? }
+      @tempfile.close
+
+      zip = Zip::ZipFile.open(@tempfile.path)
+      zip.get_output_stream('content.xml') do |cxml|
+        cxml.write(output)
+      end
+      zip.close
+
+      options.io =
+        if options.tempfile
+          @tempfile
+        else
+          File.read(@tempfile.path)
+        end
+    end
+  end
+end