ruport-util 0.7.2 → 0.8.0

data/INSTALL

@@ -3,7 +3,7 @@
 ruport-util provides a home for marooned former parts of Ruby Reports,
 and newer fringe ideas.
 
-Support as of 2007.06.07:
+Support as of 2007.08.28:
 
   * Basic Graphing (util/graph)
   * Report runner  (util/report)
@@ -20,7 +20,7 @@ See example/ for more information
 
 == Getting Ruport
 
-To use ruport-util, you'll need Ruport >= 0.12.0
+To use ruport-util >= 0.8.0, you'll need Ruport >= 1.2.0
 
   sudo gem install ruport -y
 

data/Rakefile

@@ -33,7 +33,7 @@ end
 
 spec = Gem::Specification.new do |spec|
   spec.name = "ruport-util"
-  spec.version = "0.7.2"
+  spec.version = "0.8.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}/**/**/*") +
@@ -48,7 +48,7 @@ spec = Gem::Specification.new do |spec|
   spec.extra_rdoc_files = %w{INSTALL}
   spec.rdoc_options << '--title' << 'ruport-util Documentation' <<
                        '--main' << 'INSTALL' << '-q'
-  spec.add_dependency('ruport', ">=0.11.0")
+  spec.add_dependency('ruport', ">=1.2.0")
   spec.add_dependency('scruffy', ">=0.2.2")
   spec.add_dependency('mailfactory',">=1.2.3")
   spec.add_dependency('rubyzip','>=0.9.1')

data/lib/ruport/util/generator.rb

@@ -80,14 +80,14 @@ module Ruport
     mkdir project        
     puts "creating directories.."
     %w[ test config output data data/models lib lib/reports 
-        lib/renderers templates sql log util ].each do |d|
+        lib/renderers sql util ].each do |d|
       m="#{project}/#{d}" 
       puts "  #{m}"
       mkdir(m)
     end
     
     puts "creating files.."
-    %w[reports helpers renderers].each { |f|
+    %w[reports helpers renderers templates].each { |f|
       m = "#{project}/lib/#{f}.rb"
       puts "  #{m}"
       touch(m)
@@ -175,7 +175,7 @@ REP = <<EOR
 require "lib/init"
 class #{class_name} < Ruport::Report
 
-  def renderable_data
+  def renderable_data(format)
 
   end
   
@@ -283,6 +283,7 @@ require "ruport"
 require "ruport/util"
 require "lib/helpers"
 require "config/environment" 
+require "lib/templates"
 END_INIT
 
 README = <<END_README

data/lib/ruport/util/mailer.rb

@@ -22,8 +22,7 @@ module Ruport
     
     extend Forwardable
    
-    # Creates a new Mailer object. Optionally, you can select a mailer 
-    # specified by Ruport::Config.
+    # Creates a new Mailer object. Optionally, you can select a mailer by label
     #
     # Example:
     #
@@ -31,7 +30,7 @@ module Ruport
     #   a = Mailer.new :foo   # uses :foo mail config from Ruport::Config
     #
     def initialize( mailer_label=:default )
-      select_mailer(mailer_label); 
+      select_mailer(mailer_label)
       mail_object.from = @mailer.address if mail_object.from.to_s.empty?
       rescue
         raise "you need to specify a mailer to use"
@@ -55,20 +54,20 @@ module Ruport
       #                                 to 25.
       # <b><tt>:auth_type</tt></b>::    SMTP authorization method. Optional, 
       #                                 defaults to <tt>:plain</tt>.
-      # <b><tt>:mail_klass</tt></b>::   If you don't want to use the default 
+      # <b><tt>:mail_class</tt></b>::   If you don't want to use the default 
       #                                 <tt>MailFactory</tt> object, you can 
       #                                 pass another mailer to use here.
       #                               
       # Example (creating a mailer config):
-      #   mailer :alternate, :host => "mail.test.com", 
-      #                      :address => "test@test.com",
-      #                      :user => "test", 
-      #                      :password => "blinky"
-      #                      :auth_type => :cram_md5
+      #   add_mailer :alternate, :host => "mail.test.com", 
+      #                          :address => "test@test.com",
+      #                          :user => "test", 
+      #                          :password => "blinky"
+      #                          :auth_type => :cram_md5
       #
       # Example (retreiving a mailer config):
-      #   mail_conf = mailer(:alternate)  #=> <OpenStruct ..>
-      #   mail_conf.address               #=> test@test.com
+      #   mail_conf = mailers[:alternate]  #=> <OpenStruct ..>
+      #   mail_conf.address                #=> test@test.com
       #
       def add_mailer(name,options)
         mailers[name] = OpenStruct.new(options)
@@ -119,12 +118,12 @@ module Ruport
       @address    = @mailer.address
       @port       = @mailer.port       || 25
       @auth       = @mailer.auth_type  || :plain
-      @mail_klass = @mailer.mail_klass
+      @mail_class = @mailer.mail_class
     end
 
     def mail_object
       return @mail if @mail
-      return @mail ||= @mail_klass.new if @mail_klass
+      return @mail ||= @mail_class.new if @mail_class
       require "mailfactory"
       @mail ||= MailFactory.new
     end

data/lib/ruport/util/report.rb

@@ -32,7 +32,7 @@ module Ruport
   #
   #     renders_as_grouping(:style => :inline)   
   #
-  #     def generate
+  #     def renderable_data(format)
   #       table = Table("foo.csv")
   #       Grouping(table, :by => "username")
   #     end  
@@ -81,9 +81,11 @@ module Ruport
         q.result
       end
     end
-
-    def renderable_data #:nodoc:
-      generate
+    
+    def renderable_data(format)
+       raise NotImplementedError, 
+          "You must implement renderable_data(format) if you wish to use as()
+          or save_as()"
     end
 
     alias_method :old_as, :as
@@ -95,16 +97,16 @@ module Ruport
       return output
     end
     
-    def save_as(filename,options={})
+    def save_as(filename,options={},&block)
       formats = { "csv" => ["w",:csv], "txt" => ["w",:text], 
                   "html" => ["w", :html], "pdf" => ["wb", :pdf ] }
       
       fo = filename =~ /.*\.(.*)/ && formats[$1]
       flags = options.delete(:flags)
       if fo
-        File.open(filename,flags || fo[0]) { |f| f << as(fo[1],options) }
+        File.open(filename,flags || fo[0]) { |f| f << as(fo[1],options,&block) }
       else
-        File.open(filename,flags || "w") { |f| f << as($1.to_sym,options) }
+        File.open(filename,flags || "w") { |f| f << as($1.to_sym,options,&block) }
       end
     end
 

data/lib/ruport/util/report_manager.rb

@@ -8,11 +8,7 @@ module Ruport
     def self.add_report(*new_reports)
       self.reports |= new_reports
     end
-               
-    # Looks in reports first, then models.
-    # if there is a conflict, you are F'ed.
-    #
-    # just kidding, use models#find or reports#find
+
     def self.[](name)     
       (reports + models).find{|n| n.name == name }
     end

data/lib/ruport/util.rb

@@ -1,6 +1,6 @@
 module Ruport
   module Util
-    VERSION = "0.7.2"
+    VERSION = "0.8.0"
 
     file = __FILE__
     file = File.readlink(file) if File.symlink?(file)

data/test/test_report.rb

@@ -4,7 +4,7 @@ require 'net/smtp'
 class SampleReport < Ruport::Report
   renders_with Ruport::Renderer::Table
 
-  def generate
+  def renderable_data(format)
     Table(%w[not abc]) << %w[o r] << %w[one two] << %w[thr ee]
   end
 end
@@ -13,7 +13,7 @@ class MyReport < Ruport::Report
 
   attr_accessor :data
   
-  def generate
+  def renderable_data(format)
     data
   end
 
@@ -55,6 +55,14 @@ describe 'Writing Report to files' do
     file_mock(mode = 'w', filename = 'foo.csv', 
                           content = "not,abc\no,r\none,two\nthr,ee\n")
     @report.save_as(filename).should_not be_nil
+  end   
+  
+  it 'should yield the renderer object' do
+    file_mock(mode = 'w', filename = 'foo.csv', 
+                          content = "not,abc\no,r\none,two\nthr,ee\n")
+    @report.save_as(filename) do |r|
+      r.should be_an_instance_of(Ruport::Renderer::Table)
+    end
   end
 end
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: ruport-util
 version: !ruby/object:Gem::Version 
-  version: 0.7.2
-date: 2007-07-05 00:00:00 -04:00
+  version: 0.8.0
+date: 2007-08-28 00:00:00 -04:00
 summary: A set of tools and helper libs for Ruby Reports
 require_paths: 
 - lib
@@ -30,50 +30,50 @@ authors:
 - Gregory Brown
 files: 
 - example/data
-- example/data/blank.ods
-- example/mailer.rb
 - example/form.rb
-- example/ods.rb
+- example/graph_report.rb
 - example/invoice_report.rb
+- example/mailer.rb
 - example/managed_report.rb
-- example/graph_report.rb
+- example/ods.rb
+- example/data/blank.ods
 - lib/ruport
 - lib/ruport/util
-- lib/ruport/util/pdf
-- lib/ruport/util/pdf/form.rb
-- lib/ruport/util/generator.rb
+- lib/ruport/util.rb
 - lib/ruport/util/bench.rb
+- lib/ruport/util/generator.rb
 - lib/ruport/util/graph.rb
-- lib/ruport/util/ods.rb
-- lib/ruport/util/report_manager.rb
+- lib/ruport/util/invoice.rb
 - lib/ruport/util/mailer.rb
+- lib/ruport/util/ods.rb
+- lib/ruport/util/pdf
 - lib/ruport/util/report.rb
-- lib/ruport/util/invoice.rb
-- lib/ruport/util.rb
+- lib/ruport/util/report_manager.rb
+- lib/ruport/util/pdf/form.rb
 - test/helper
+- test/helper.rb
+- test/samples
+- test/test_format_ods.rb
+- test/test_graph_renderer.rb
+- test/test_invoice.rb
+- test/test_mailer.rb
+- test/test_report.rb
+- test/test_report_manager.rb
 - test/helper/layout.rb
 - test/helper/wrap.rb
-- test/samples
 - test/samples/data.csv
 - test/samples/foo.rtxt
-- test/test_mailer.rb
-- test/helper.rb
-- test/test_report_manager.rb
-- test/test_graph_renderer.rb
-- test/test_report.rb
-- test/test_invoice.rb
-- test/test_format_ods.rb
 - bin/csv2ods
 - bin/rope
 - Rakefile
 - INSTALL
 test_files: 
-- test/test_mailer.rb
-- test/test_report_manager.rb
+- test/test_format_ods.rb
 - test/test_graph_renderer.rb
-- test/test_report.rb
 - test/test_invoice.rb
-- test/test_format_ods.rb
+- test/test_mailer.rb
+- test/test_report.rb
+- test/test_report_manager.rb
 rdoc_options: 
 - --title
 - ruport-util Documentation
@@ -97,7 +97,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.11.0
+        version: 1.2.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: scruffy