ruport-util 0.4.0 → 0.5.0

data/INSTALL

@@ -0,0 +1,42 @@
+== What is it?
+
+ruport-util provides a home for marooned former parts of Ruby Reports,
+and newer fringe ideas.
+
+Support as of 2007.05.01:
+
+  * Basic Graphing (util/graph)
+  * Report runner  (util/report)
+  * Report Mailing (util/mailer)
+  * Report Manager (util/report_manager)
+  * Invoices       (util/invoice)
+  * Ruport centric code generation via the rope command.
+
+See example/ for more information
+
+== Getting Ruport
+
+To use ruport-util, you'll need Ruport >= 0.12.0
+
+  sudo gem install ruport -y
+
+== Installing ruport-util
+
+It's on RubyForge:
+
+  gem install ruport-util -y
+
+== Using
+
+To load all of the tools at once:
+
+  require "ruport/util"
+
+To load just one tool:
+
+  require "ruport/util/graph"
+
+== Help?
+   
+Please report any problems on the Ruport mailing list:
+http://list.rubyreports.org

data/Rakefile

@@ -18,7 +18,7 @@ end
 
 spec = Gem::Specification.new do |spec|
   spec.name = "ruport-util"
-  spec.version = "0.4.0"
+  spec.version = "0.5.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}/**/**/*") +
@@ -30,10 +30,10 @@ spec = Gem::Specification.new do |spec|
   spec.bindir = "bin"
   spec.executables = FileList["rope"]
   spec.has_rdoc = true
-  spec.extra_rdoc_files = %w{}
-  spec.rdoc_options << '--title' << 'Ruport Documentation' #<<
-                      # '--main'  << 'README' << '-q'
-  spec.add_dependency('ruport', ">=0.9.3")
+  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('scruffy', ">=0.2.2")
   spec.add_dependency('mailfactory',">=1.2.3")
   spec.author = "Gregory Brown"
@@ -47,10 +47,9 @@ END_DESC
 end
 
 Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_files.include( "TODO", #"CHANGELOG",
-                           "AUTHORS", "COPYING",
+  rdoc.rdoc_files.include( "COPYING", "INSTALL",
                            "LICENSE", "lib/" )
-  rdoc.main     = "README"
+  rdoc.main     = "INSTALL"
   rdoc.rdoc_dir = "doc/html"
   rdoc.title    = "Ruport Documentation"
 end

data/example/graph_report.rb

@@ -1,7 +1,7 @@
 require "rubygems"
 require "ruport"
 
-require "ruport/util/graph"
+require "ruport/util"
 
 class GraphReport < Ruport::Report
   

data/lib/ruport/util/bench.rb

@@ -1,3 +1,38 @@
+# A strange little benchmarking utility that uses Ruport
+# to output the results of benchmark suites. This is primarily an internal
+# developers tool for Ruport, but you might find it interesting or useful.
+#
+# Example:
+#
+#  require "ruport"  
+#  require "ruport/util/bench"
+#  include Ruport::Bench
+#
+#  class MyFormat < Ruport::Formatter;
+#     renders :nothing, :for => Ruport::Renderer::Row
+#  end
+#
+#  record = Ruport::Data::Record.new [1,2,3]
+#
+#  bench_suite do
+#    N = 10000   
+#    bench_case("as(:nothing)",N) { record.as(:nothing) }
+#    bench_case("to_nothing",N) { record.to_nothing }
+#  end 
+# 
+#  # output
+#
+#  Running Bench Suite...
+#  > as(:nothing)... ok[2.12905] 
+#  > to_nothing... ok[2.00278] 
+#  +--------------------------------------+
+#  |     name     | iterations | realtime |
+#  +--------------------------------------+
+#  | as(:nothing) |      10000 | 2.12905  |
+#  | to_nothing   |      10000 | 2.00278  |
+#  +--------------------------------------+
+#  Suite run time: 4.13183  
+#
 module Ruport::Bench
   
   require "benchmark"  

data/lib/ruport/util/generator.rb

@@ -1,8 +1,8 @@
 module Ruport
-  class Generator
+  class Generator #:nodoc:
   extend FileUtils
 
-  module Helpers
+  module Helpers  #:nodoc:
     def format_class_name(string)
       string.downcase.split("_").map { |s| s.capitalize }.join
     end
@@ -32,27 +32,38 @@ module Ruport
     build_init
     build_config
     build_utils         
-    build_rakefile  
+    build_rakefile 
+    build_readme
+     
     puts "\nSuccessfully generated project: #{proj}"
-  end
-
-
+  end 
+  
+  def self.write_file(path,options={})
+    options = {:io => STDOUT}.merge(options)
+    m = "#{project}/#{path}"
+    options[:io].puts "  #{m}"
+    if options[:file]
+       options[:file] << yield   
+    else             
+      File.open(m,"w") { |f| f << yield }
+    end
+  end                                
+  
   def self.build_init
-    m = "#{project}/lib/init.rb" 
-    puts "  #{m}"
-    File.open(m,"w") { |f| f << INIT }
+    write_file("lib/init.rb") { INIT }
   end
 
   # Generates a trivial rakefile for use with Ruport.
   def self.build_rakefile
-    m = "#{project}/Rakefile"
-    puts "  #{m}"
-    File.open(m,"w") { |f| f << RAKEFILE }
+    write_file("Rakefile") { RAKEFILE }
+  end  
+  
+  def self.build_readme
+     write_file("README") { README }
   end
 
   # Generates the build.rb and sql_exec.rb utilities
   def self.build_utils           
-    
     m = "#{project}/util/build"   
     puts "  #{m}"
     File.open(m,"w") { |f| f << BUILD } 
@@ -68,8 +79,8 @@ module Ruport
   def self.build_directory_structure
     mkdir project        
     puts "creating directories.."
-    %w[ test config output data lib lib/reports 
-        lib/renderers templates sql log util].each do |d|
+    %w[ test config output data data/models lib lib/reports 
+        lib/renderers templates sql log util ].each do |d|
       m="#{project}/#{d}" 
       puts "  #{m}"
       mkdir(m)
@@ -84,9 +95,7 @@ module Ruport
   end
 
   def self.build_config
-    m = "#{project}/config/environment.rb"
-    puts "  #{m}"
-    File.open(m,"w") { |f| f << CONFIG }
+    write_file("config/environment.rb") { CONFIG }
   end
 
   # returns the project's name
@@ -109,6 +118,8 @@ task :build do
     sh "ruby util/build report #{ENV['report']}"
   elsif ENV['renderer']
     sh "ruby util/build renderer #{ENV['renderer']}"
+  elsif ENV['model']
+    sh "ruby util/build model #{ENV['model']}"
   end
 end
 
@@ -120,8 +131,23 @@ END_RAKEFILE
 CONFIG = <<END_CONFIG
 require "ruport"
 
-Ruport::Query.add_source :default, :user => "root",
-                                   :dsn  => "dbi:mysql:mydb"
+# Uncomment and modify the lines below if you want to use query.rb
+#
+# Ruport::Query.add_source :default, :user => "root",
+#                                    :dsn  => "dbi:mysql:mydb"     
+
+# Uncomment and modify the lines below if you want to use AAR
+#  
+# require "active_record"
+# require "ruport/acts_as_reportable"
+# ActiveRecord::Base.establish_connection(
+#      :adapter  => 'mysql',
+#      :host     => 'localhost',
+#      :username => 'name',
+#      :password => 'password',
+#      :database => 'mydb'
+# )
+
 END_CONFIG
 
 BUILD = <<'END_BUILD'
@@ -217,7 +243,24 @@ EOR
   puts "test file: test/test_#{ARGV[1]}.rb"
 
   puts "class name: #{class_name}"
-  File.open("test/test_#{ARGV[1]}.rb","w") { |f| f << TEST }
+  File.open("test/test_#{ARGV[1]}.rb","w") { |f| f << TEST } 
+elsif ARGV[0].eql? "model"
+  if File.exist?("data/models/#{ARGV[1]}.rb")
+    raise "Model #{class_name} exists!"
+  end
+  File.open("data/models.rb","a") { |f|
+    f.puts("require \"data/models/#{ARGV[1]}\"")
+  }
+REP = <<EOR
+class #{class_name} < ActiveRecord::Base
+  
+  acts_as_reportable
+  
+end
+EOR
+  puts "model file: data/models/#{ARGV[1]}.rb"
+  File.open("data/models/#{ARGV[1]}.rb", "w") { |f| f << REP }
+  puts "class name: #{class_name}"
 else
   puts "Incorrect usage."
 end
@@ -242,39 +285,257 @@ end
 require "ruport"
 require "ruport/util"
 require "lib/helpers"
-require "config/environment"
+require "config/environment" 
+END_INIT
 
-class String
-  def /(other)
-   self + "/" + other
-  end
-end
+README = <<END_README
+
+== rope : A Code Generation Tool for Ruby Reports ==
+
+# Overview
+
+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.
+
+# The Basics
+
+-- Starting a new rope project
+
+$ rope labyrith
+creating directories..
+  labyrith/test
+  labyrith/config
+  labyrith/output
+  labyrith/data
+  labyrith/data/models
+  labyrith/lib
+  labyrith/lib/reports
+  labyrith/lib/renderers
+  labyrith/templates
+  labyrith/sql
+  labyrith/log
+  labyrith/util
+creating files..
+  labyrith/lib/reports.rb
+  labyrith/lib/helpers.rb
+  labyrith/lib/renderers.rb
+  labyrith/lib/init.rb
+  labyrith/config/environment.rb
+  labyrith/util/build
+  labyrith/util/sql_exec
+  labyrith/Rakefile
+  labyrith/README
+
+Successfully generated project: labyrith
+
+Once this is complete, you'll have a large number of mostly empty
+folders laying around, along with some helpful tools at your disposal.
+
+-- utilities
+
+ * build : A tool for generating reports and formatting system extensions
+ * sql_exec: A simple tool for getting a result set from a SQL file
+             (possibly with ERb)
+ * Rakefile: Script for project automation tasks.  
+
+-- directories
+
+ * test : unit tests stored here can be auto-run
+ * config : holds a configuration file which is shared across your applications
+ * reports : when reports are autogenerated, they are stored here
+ * renderers : autogenerated formatting system extensions are stored here
+ * models : stores autogenerated activerecord models 
+ * templates : erb templates may be stored here
+ * sql : SQL files can be stored here, which are pre-processed by erb
+ * log : The logger will automatically store your logfiles here by default
+ * util : contains rope related tools
+
+# Generating a Report definition with rope
+
+ $ ./util/build report ghosts
+ report file: lib/reports/ghosts.rb
+ test file: test/test_ghosts.rb
+ class name: Ghosts
+
+ $ rake
+ (in /home/sandal/labyrinth)
+ /usr/bin/ruby -Ilib:test
+"/usr/lib/ruby/gems/1.8/gems/rake-0.7.1/lib/rake/rake_test_loader.rb"
+"test/test_ghosts.rb"
+ Loaded suite /usr/lib/ruby/gems/1.8/gems/rake-0.7.1/lib/rake/rake_test_loader
+ Started
+ F
+ Finished in 0.001119 seconds.
+
+   1) Failure:
+   test_flunk(TestGhosts) [./test/test_ghosts.rb:6]:
+   Write your real tests here or in any test/test_* file.
+
+   1 tests, 1 assertions, 1 failures, 0 errors
+   rake aborted!
+   Command failed with status (1): [/usr/bin/ruby -Ilib:test
+"/usr/lib/ruby/ge...]
+
+   (See full trace by running task with --trace)
+
+You can now edit lib/reports/ghosts.rb as needed and write tests for
+it in test/test_ghosts.rb without having to hook up any underplumbing.
+
+# Rope's Auto-generated Configuration File
+
+-- Basic Details
+
+roped projects will automatically make use of the configuration details in
+config/environment.rb , which can be used to set up database
+connections, Ruport's mailer, and other project information.
+
+The default file is shown below.
 
-class Ruport::Report
-  
-  def output_dir
-    config.output_dir or dir('output')
-  end
+require "ruport"
 
-  def data_dir
-    config.data_dir or dir('data')
-  end
+# Uncomment and modify the lines below if you want to use query.rb
+#
+# Ruport::Query.add_source :default, :user => "root",
+#                                    :dsn  => "dbi:mysql:mydb"     
 
-  def query_dir
-    config.query_dir or dir('sql')
-  end
+# Uncomment and modify the lines below if you want to use AAR
+#  
+# require "active_record"
+# require "ruport/acts_as_reportable"
+# ActiveRecord::Base.establish_connection(
+#      :adapter  => 'mysql',
+#      :host     => 'localhost',
+#      :username => 'name',
+#      :password => 'password',
+#      :database => 'mydb'
+# )
 
-  def template_dir
-    config.template_dir or dir('templates')
-  end
+You'll need to tweak this as needed to fit your database configuration needs.
+If you need to require any third party libraries which are shared across your
+project, you should do it in this file.
+
+# Custom rendering with rope generators.
+
+-- By Example
+
+ $ rope my_reverser
+ $ cd my_reverser
+ $ rake build renderer=reverser
+
+Edit test/test_reverser.rb to look like the code below:
+
+ require "test/unit"
+ require "lib/renderers/reverser"
+
+ class TestReverser < Test::Unit::TestCase
+   def test_reverser
+     assert_equal "baz", Reverser.render_text("zab")
+   end
+ end
+
+Now edit lib/renderers/reverser.rb to look like this:
+
+ require "lib/init"
+
+ class Reverser < Ruport::Renderer
+   stage :reverser
+ end
+
+ class ReverserFormatter < Ruport::Formatter
+
+   renders :text, :for => Reverser
+
+   def build_reverser
+     output << data.reverse
+   end
+
+ end
+
+The tests should pass.  You can now generate a quick report using this renderer
+
+ $ rake build report=reversed_report
+
+Edit test/test_reversed_report.rb as such:
+
+ require "test/unit"
+ require "lib/reports/reversed_report"
+
+ class TestReversedReport < Test::Unit::TestCase
+   def test_reversed_report
+     report = ReversedReport.new
+     report.message = "hello"
+     assert_equal "olleh", report.to_text
+   end
+ end
+
+edit lib/reports/reversed_report.rb as below and run the tests.
+
+ require "lib/init"  
+ require "lib/renderers/reverser"
+ class ReversedReport < Ruport::Report
+
+   renders_with Reverser
+   attr_accessor :message
+
+   def generate
+     message
+   end
+
+ end
+
+# ActiveRecord integration the lazy way.
+
+Ruport now has built in support for acts_as_reportable, which provides
+ActiveRecord integration with ruport.
+
+-- Setup details
+
+Edit the following code in config/environment.rb 
+(change as needed to match your config information)
+
+ ActiveRecord::Base.establish_connection(
+       :adapter  => 'mysql',
+       :host     => 'localhost',
+       :username => 'name',
+       :password => 'password',
+       :database => 'mydb'
+ )
+
+-- Generating a model 
+
+Here is an example of generating the model file:
+
+$ util/build model my_model
+model file: data/models/my_model.rb             
+class name: MyModel                             
+  
+This will create a barebones model that looks like this:
+
+class MyModel < ActiveRecord::Base
+
+  acts_as_reportable
 
-  private
-  def dir(name)
-    "#{FileUtils.pwd}/#{ARGV[0]}/\#{name}"
-  end
 end
-END_INIT
 
+The data/models.rb file will require all generated models,
+but you can of course require specific models in your reports.  
+
+This should be enought to get you started, but for more complex needs, 
+check the appropriate acts_as_reportable / ActiveRecord documentation.   
+
+# Getting Help / Reporting Problems
+
+rope is an officially supported utility for the Ruby Reports project, in
+the ruport-util package.   If you run into problems or have feature requests,
+please contact us at http://list.rubyreports.org
+END_README
 
   end
 end

data/lib/ruport/util/graph.rb

@@ -60,8 +60,8 @@ module Ruport
   #
   # == Supported Format Plugins
   # 
-  # * Format::XML
-  # * Format::SVG
+  # * Formatter::XML
+  # * Formatter::SVG
   #
   # == Default layout options
   #
@@ -85,8 +85,8 @@ module Ruport
     finalize :graph
 
   end
-  
-  class SVG < Formatter
+ 
+  class Formatter::SVG < Formatter
 
     renders :svg, :for => Renderer::Graph
 
@@ -94,7 +94,7 @@ module Ruport
     #
     # You can use these by setting options.theme like this:
     #
-    #   Graph.render_svg { |r| r.options.theme = r.plugin.themes[:mephisto] }
+    #   Graph.render_svg(:theme => :mephisto)
     #  
     # Available themes: ( :mephisto, :keynote, :ruby_blog )
     #
@@ -122,9 +122,8 @@ module Ruport
     #
     def prepare_graph 
       @graph.title ||= options.title
-      @graph.theme = options.theme if options.theme
+      @graph.theme = themes[options.theme] if options.theme
       @graph.point_markers ||= data.column_names
-
     end
 
     # Generates an SVG using Scruffy.
@@ -134,7 +133,8 @@ module Ruport
       end
 
       output << @graph.render( 
-        :size => [options.width||500, options.height||300]
+        :size => [options.width||500, options.height||300],
+        :min_value => options[:min], :max_value => options[:max]
       )
     end
     
@@ -148,7 +148,7 @@ module Ruport
 
   end
   
-  class XML_SWF < Formatter
+  class Formatter::XML_SWF < Formatter
 
     renders :xml_swf, :for => Renderer::Graph
 

data/lib/ruport/util/invoice.rb

@@ -1,6 +1,6 @@
 module Ruport
-  class Renderer
-    class Invoice < Ruport::Renderer
+  class Renderer #:nodoc:
+    class Invoice < Ruport::Renderer 
                
       required_option :customer_info,:company_info,:order_info,:comments
 

data/lib/ruport/util/mailer.rb

@@ -38,7 +38,9 @@ module Ruport
   #
   class Mailer
 
-    class InvalidMailerConfigurationError < RuntimeError; end
+    class InvalidMailerConfigurationError < RuntimeError #:nodoc:   
+    end
+    
     extend Forwardable
    
     # Creates a new Mailer object. Optionally, you can select a mailer 

data/lib/ruport/util/report.rb

@@ -317,8 +317,6 @@ module Ruport
       # Defines an instance method which will be run before the
       # <tt>generate</tt> method when Ruport.run is executed.
       #
-      # Good for setting config info and perhaps files and/or loggers.
-      #
       def prepare(&block); define_method(:prepare,&block) end
       
       # Defines an instance method which will be executed by Report.run.

data/lib/ruport/util/report_manager.rb

@@ -46,48 +46,4 @@ class Ruport::Report
   def self.acts_as_managed_report
     Ruport::ReportManager.add_report(self)
   end
-end
-
-if __FILE__ == $PROGRAM_NAME                        
-  
-  include Ruport     
-  
-  require "test/unit"
-  
-  # we'll autoregister this one  
-  class FakeModel
-    ReportManager.add_model(self)
-  end                          
-  
-  # we'll add these afterwards
-  class FakeModel2;end
-  class FakeModel3;end
-  
-  
-  class TestReportManager < Test::Unit::TestCase     
-     
-     def test_simple_usage
-        assert_equal [FakeModel], ReportManager.models
-        assert_equal FakeModel, ReportManager["FakeModel"]
-     end         
-     
-     def test_add_models_externally
-        klass = ReportManager.dup # we need to do this to make the tests work 
-                                  # no need in production code
-        assert_equal [FakeModel], klass.models        
-        
-        klass.add_model(FakeModel2)
-        assert_equal [FakeModel,FakeModel2], klass.models
-        
-        klass.add_model(FakeModel3)
-        assert_equal [FakeModel,FakeModel2, FakeModel3], klass.models
-        
-        # let's make sure we can still grab these by name (a string)
-        [FakeModel,FakeModel2,FakeModel3].each do |m|  
-          assert_equal m, klass[m.name]
-        end
-     end 
-     
-  end
-end
-  
+end

data/lib/ruport/util.rb

@@ -1,6 +1,6 @@
 module Ruport
   module Util
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end
 require "ruport/util/report"

data/test/test_invoice.rb

@@ -1,5 +1,5 @@
 require "test/init"
-require "ruport/util/invoice"
+require "ruport/util"
 
 class TestInvoice < Test::Unit::TestCase
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: ruport-util
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2007-05-01 00:00:00 -04:00
+  version: 0.5.0
+date: 2007-05-14 00:00:00 -04:00
 summary: A set of tools and helper libs for Ruby Reports
 require_paths: 
 - lib
@@ -54,6 +54,7 @@ files:
 - test/samples/foo.rtxt
 - bin/rope
 - Rakefile
+- INSTALL
 test_files: 
 - test/test_graph_renderer.rb
 - test/test_invoice.rb
@@ -62,9 +63,12 @@ test_files:
 - test/test_report_manager.rb
 rdoc_options: 
 - --title
-- Ruport Documentation
-extra_rdoc_files: []
-
+- ruport-util Documentation
+- --main
+- INSTALL
+- -q
+extra_rdoc_files: 
+- INSTALL
 executables: 
 - rope
 extensions: []
@@ -79,7 +83,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.9.3
+        version: 0.11.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: scruffy