ruport 0.6.0 → 0.6.1

data/AUTHORS

@@ -31,3 +31,7 @@ Simon Claret:
 Daniel Berger:
  - we vendored and modified attempt.rb to support it directly in Report.
    Original website: http://raa.ruby-lang.org/project/attempt/
+
+Marshall T. Vandegrift:
+ - Fixed a bug in Record's struct-like accessors (method_missing)
+ - Provided performance enhancements and tests for query.rb

data/CHANGELOG

@@ -1,4 +1,13 @@
-The current version of Ruby Reports is 0.6.0
+The current version of Ruby Reports is 0.6.1
+
+changes since 0.6.0
+
+- Fixed Table.load() bug.  (Now accepts block properly)
+- 100% C0 coverage for Query via Mocha. (Thanks Marshall!)
+- Row by row Query iteration no longer grabs entire result set first
+- Major performance enhancements to Groupable
+- Reformatted and enhanced API documentation
+- Added simple table interface example
 
 changes since 0.5.4
 

data/Rakefile

@@ -23,7 +23,7 @@ end
 
 spec = Gem::Specification.new do |spec|
 	spec.name = LEAN ? "lean-ruport" : "ruport"
-	spec.version = "0.6.0"
+	spec.version = "0.6.1"
 	spec.platform = Gem::Platform::RUBY
 	spec.summary = "A generalized Ruby report generation and templating engine."
 	spec.files =  Dir.glob("{examples,lib,test,bin}/**/**/**/*") +

data/examples/simple_table_interface.rb

@@ -0,0 +1,20 @@
+require "ruport"
+class SimpleTableShortcut < Ruport::Report
+
+  prepare do
+    log_file "foo.log"
+    @table = table(%w[a b c]) do |t|
+      t << [1,2,3]
+      t << { "a" => 1, "c" => 9, "b" => 2 }
+    end
+  end
+
+  generate do
+    @table.to_csv
+  end
+
+end
+
+SimpleTableShortcut.run(:tries => 3, :interval => 5) { |r| 
+  puts r.results
+}

data/lib/ruport.rb

@@ -1,69 +1,87 @@
-# ruport.rb : Ruby Reports toplevel module
-#
-# Author: Gregory T. Brown (gregory.t.brown at gmail dot com)
-#
-# Copyright (c) 2006, All Rights Reserved.
-#
-# This is free software.  You may modify and redistribute this freely under
-# your choice of the GNU General Public License or the Ruby License. 
-#
-# See LICENSE and COPYING for details
-#
-module Ruport
-  
-  VERSION = "0.6.0"
-  
-  # Ruports logging and error interface.
-  # Can generate warnings or raise fatal errors
-  # 
-  # Takes a message to display and a set of options.
-  # Will log to the file defined by Config::log_file
-  #
-  # Options:
-  # <tt>:status</tt>::    sets the severity level. defaults to <tt>:warn</tt>
-  # <tt>:output</tt>::    optional 2nd output, defaults to <tt>$stderr</tt>
-  # <tt>:level</tt>::     set to <tt>:log_only</tt> to disable secondary output
-  # <tt>:exception</tt>:: exception to throw on fail.  Defaults to RunTimeError
-  # 
-  # The status <tt>:warn</tt> will invoke Logger#warn.  A status of
-  # <tt>:fatal</tt> will invoke Logger#fatal and raise an exception
-  # 
-  # By default, <tt>log()</tt> will also print warnings to $stderr
-  # You can redirect this to any I/O object via <tt>:output</tt>
-  #
-  # You can prevent messages from appearing on the secondary output by setting
-  # <tt>:level</tt> to <tt>:log_only</tt>
-  # 
-  # If you want to recover these messages to secondary output for debugging, you
-  # can use Config::enable_paranoia 
-  def self.log(message,options={})
-    options = {:status => :warn, :output => $stderr}.merge(options)
-    options[:output].puts "[!!] #{message}" unless 
-      options[:level].eql?(:log_only) and not Ruport::Config.paranoid?
-    Ruport::Config::logger.send(options[:status],message) if Config.logger
-    if options[:status].eql? :fatal
-      raise(options[:exception] || RuntimeError, message) 
-    end
-  end
- 
-  #Alias for Ruport.log
-  def self.complain(*args); Ruport.log(*args) end
- 
-  # yields a Ruport::Config object, allowing you to specify configuration
-  # options.
-  #
-  # Example: 
-  #
-  #   Ruport.configure do |c|
-  #     c.source :default, :dsn => "dbi:mysql:foo",
-  #                        :user => "clyde", :password => "pman"
-  #   end
-  def self.configure(&block)
-    block.call(Ruport::Config)
-  end
-end
-
-
-%w[attempt config data meta_tools report format query mailer].each { |lib|
-  require "ruport/#{lib}" 
-}
+# ruport.rb : Ruby Reports top level module
+#
+# Author: Gregory T. Brown (gregory.t.brown at gmail dot com)
+#
+# Copyright (c) 2006, All Rights Reserved.
+#
+# This is free software.  You may modify and redistribute this freely under
+# your choice of the GNU General Public License or the Ruby License. 
+#
+# See LICENSE and COPYING for details
+#
+module Ruport
+  
+  VERSION = "0.6.1"
+  
+  #
+  # This method is Ruport's logging and error interface. It can generate 
+  # warnings or raise fatal errors, logging +message+ to the file defined by 
+  # <tt>Config::log_file</tt>.
+  # 
+  # You can configure the logging preferences with the +options+ hash. 
+  # Available options are:
+  #
+  # <b><tt>:status</tt></b>::    Sets the severity level. This defaults to 
+  #                              <tt>:warn</tt>, which will invoke 
+  #                              <tt>Logger#warn</tt>. A status of 
+  #                              <tt>:fatal</tt> will invoke 
+  #                              <tt>Logger#fatal</tt> and raise an exception.    
+  # <b><tt>:output</tt></b>::    Optional 2nd output. By default, <tt>log()</tt>
+  #                              will print warnings to <tt>$stderr</tt> in
+  #                              addition to <tt>Config::log_file</tt>. You
+  #                              can redirect this to any I/O object with this
+  #                              option.
+  # <b><tt>:level</tt></b>::     Set this to <tt>:log_only</tt> to disable 
+  #                              secondary output. If you want to globally 
+  #                              override this setting for all calls to 
+  #                              <tt>log()</tt> (which can be useful for 
+  #                              debugging), you can set 
+  #                              <tt>Config::enable_paranoia</tt>.
+  # <b><tt>:exception</tt></b>:: The +Exception+ to throw on failure.  This 
+  #                              defaults to +RunTimeError+.
+  # 
+  def self.log(message, options={})
+    options = {:status => :warn, :output => $stderr}.merge(options)
+    options[:output].puts "[!!] #{message}" unless 
+      options[:level].eql?(:log_only) and not Ruport::Config.paranoid?
+    Ruport::Config::logger.send(options[:status],message) if Config.logger
+    if options[:status].eql? :fatal
+      raise(options[:exception] || RuntimeError, message) 
+    end
+  end
+ 
+  # Alias for <tt>Ruport.log</tt>.
+  def self.complain(*args); Ruport.log(*args) end
+  
+  #
+  # This method yields a <tt>Ruport::Config</tt> object, allowing you to 
+  # set the configuration options for your application.
+  #
+  # Example: 
+  #
+  #   Ruport.configure do |c|
+  #
+  #     c.source :default, 
+  #              :dsn => "dbi:mysql:foo",
+  #              :user => "clyde", 
+  #              :password => "pman"
+  #
+  #     c.mailer :default, 
+  #              :host => "mail.example.com", 
+  #              :address => "inky@example.com"
+  #
+  #   end
+  #
+  def self.configure(&block)
+    block.call(Ruport::Config)
+  end
+end
+
+require "ruport/attempt" 
+require "ruport/config" 
+require "ruport/data" 
+require "ruport/meta_tools" 
+require "ruport/report" 
+require "ruport/format" 
+require "ruport/query" 
+require "ruport/mailer"

data/lib/ruport/attempt.rb

@@ -1,6 +1,6 @@
 require 'timeout'
 
-class Attempt
+class Attempt # :nodoc:
    VERSION = '0.1.0'
    
    # Number of attempts to make before failing.  The default is 3.

data/lib/ruport/config.rb

@@ -1,166 +1,198 @@
-# ruport/config.rb : Ruby Reports configuration system
-#
-# Author: Gregory T. Brown (gregory.t.brown at gmail dot com)
-#
-# Copyright (c) 2006, All Rights Reserved.
-#
-# This is free software.  You may modify and redistribute this freely under
-# your choice of the GNU General Public License or the Ruby License. 
-#
-# See LICENSE and COPYING for details
-#
-require "ostruct"
-module Ruport
-  # This class serves as the configuration system for Ruport.
-  # It's functionality is implemented through Config::method_missing
-  #  
-  # source :default and mailer :default will become the fallback values if one
-  # is not specified in Report::Mailer or Query, but you may define as many
-  # sources as you like and switch between them later.
-  #
-  # An example config file is shown below:
-  #   
-  #   # password is optional, dsn may omit hostname for localhost
-  #   Ruport::Config.source :default,
-  #   :dsn => "dbi:mysql:somedb:db.blixy.org",
-  #   :user => "root", :password => "chunky_bacon"
-  #   
-  #   # :password, :port, and :auth_type are optional. :port defaults to 25 and
-  #   # :auth_type defaults to :plain.  For more information, see the source
-  #   # of Report::Mailer#select_mailer
-  #   Ruport::Config.mailer :default,
-  #   :host => "mail.chunkybacon.org", :address => "chunky@bacon.net",
-  #   :user => "cartoon", :password => "fox", :port => 25, :auth_type => :login
-  #   
-  #   # optional, if specifed, Ruport#complain will report to it
-  #   Ruport::Config.log_file 'foo.log'
-  #
-  #   # optional, if enabled, will force :log_only complaint calls to
-  #   # print to secondary output ($sterr by default).
-  #   # call Ruport::Config.disable_paranoia to disable
-  #   Ruport::Config.enable_paranoia
-  #
-  # Alternatively, this configuration could be done by opening the class:
-  #   class Ruport::Config
-  #
-  #     source :default, :dsn => "dbi:mysql:some_db", :user => "root"
-  #     
-  #     mailer :default, :host => "mail.iheartwhy.com", 
-  #     :address => "sandal@ruby-harmonix.net", :user => "sandal",
-  #     :password => "abc123"
-  #     
-  #     logfile 'foo.log'
-  #
-  #   end
-  #
-  # Saving this config information into a file and then requiring it can allow
-  # you share configurations between Ruport applications.
-  #
-  module Config
-    module_function
-
-
-    # create or retrieve a database source configuration.
-    #
-    # setting a source
-    #
-    #   source :default, :user => "root", :password => "clyde",
-    #                    :dsn  => "dbi:mysql:blinkybase"
-    #
-    # retrieving a source
-    #
-    #   db = source(:default) #=> <OpenStruct ..>
-    #   db.dsn #=> "dbi:mysql:blinkybase"
-    def source(*args) 
-      return sources[args.first] if args.length == 1
-      sources[args.first] = OpenStruct.new(*args[1..-1])
-      check_source(sources[args.first],args.first)
-    end
-
-    # create or retrieve a mailer configuration
-    #
-    # creating a mailer config
-    #
-    #   mailer :alternate, :host => "mail.test.com", 
-    #                      :address => "test@test.com",
-    #                      :user => "test", :password => "blinky"
-    #                      :auth_type => :cram_md5
-    #
-    # retreiving a mailer config
-    #
-    #   mail_conf = mailer(:alternate) #=> <OpenStruct ..>
-    #   mail_conf.address #=> test@test.com
-    def mailer(*args)
-      return mailers[args.first] if args.length == 1
-      mailers[args.first] = OpenStruct.new(*args[1..-1])
-      check_mailer(mailers[args.first],args.first)
-    end
-
-
-    # Sets the logger to use the specified file.
-    #
-    #   log_file "foo.log"
-    def log_file(file)
-      @logger = Logger.new(file)
-    end
-    
-    # Same as Config.log_file, but accessor style
-    def log_file=(file)
-      log_file(file)
-    end
-
-    # Returns the source which is labeled :default
-    def default_source
-      sources[:default]
-    end
-
-    # Returns the mailer which is labeled :default
-    def default_mailer
-      mailers[:default]
-    end
-
-    # Returns an array of database source configs
-    def sources; @sources ||= {}; end
-
-    # Returns an array of mailer configs
-    def mailers; @mailers ||= {}; end
-
-    # Returns the currently active logger
-    def logger; @logger; end
-
-    # Forces all messages marked :log_only to surface
-    def enable_paranoia; @paranoid = true; end
-
-    # Disables the printing of :log_only messages to STDERR
-    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
-    
-    # Verifies that you have provided a DSN for your source
-    def check_source(settings,label)
-      unless settings.dsn
-        Ruport.complain( 
-          "Missing DSN for source #{label}!",
-          :status => :fatal, :level => :log_only,
-          :exception => ArgumentError 
-        )
-      end
-    end
-
-    # Verifies that you have provided a host for your mailer
-    def check_mailer(settings, label)
-      unless settings.host
-        Ruport.complain(
-          "Missing host for mailer #{label}",
-          :status => :fatal, :level => :log_only,
-          :exception => ArgumentError
-        )
-      end
-    end
-    
-  end
-end
+# ruport/config.rb : Ruby Reports configuration system
+#
+# Author: Gregory T. Brown (gregory.t.brown at gmail dot com)
+#
+# Copyright (c) 2006, All Rights Reserved.
+#
+# This is free software.  You may modify and redistribute this freely under
+# your choice of the GNU General Public License or the Ruby License. 
+#
+# See LICENSE and COPYING for details
+#
+require "ostruct"
+module Ruport
+  #
+  # === Overview
+  #
+  # This class serves as the configuration system for Ruport.
+  #  
+  # The source and mailer defined as <tt>:default</tt> will become the 
+  # fallback values if you don't specify one in <tt>Report::Mailer</tt> or 
+  # <tt>Query</tt>, but you may define as many sources as you like and switch 
+  # between them later.
+  #
+  # === Example
+  #
+  # The most common way to access your application configuration is through 
+  # the <tt>Ruport.configure</tt> method, like this:
+  #   
+  #   Ruport.configure do |config|
+  #
+  #     config.log_file 'foo.log'
+  #     config.enable_paranoia
+  #
+  #     config.source :default,
+  #                   :dsn => "dbi:mysql:somedb:db.blixy.org",
+  #                   :user => "root", 
+  #                   :password => "chunky_bacon"
+  #   
+  #     config.mailer :default,
+  #                   :host => "mail.chunkybacon.org", 
+  #                   :address => "chunky@bacon.net",
+  #                   :user => "cartoon", 
+  #                   :password => "fox", 
+  #                   :port => 25, 
+  #                   :auth_type => :login
+  #
+  #   end
+  #
+  # You can accomplish the same thing by opening the class directly:
+  #
+  #   class Ruport::Config
+  #
+  #     source :default, 
+  #            :dsn => "dbi:mysql:some_db", 
+  #            :user => "root"
+  #     
+  #     mailer :default, 
+  #            :host => "mail.iheartwhy.com", 
+  #            :address => "sandal@ruby-harmonix.net", 
+  #            :user => "sandal",
+  #            :password => "abc123"
+  #     
+  #     logfile 'foo.log'
+  #
+  #   end
+  #
+  # Saving this config information into a file and then requiring it allows
+  # you to share configurations between Ruport applications. 
+  #
+  module Config
+    module_function
+    # 
+    # :call-seq:
+    #   source(source_name, options)
+    #
+    # Creates or retrieves a database source configuration. Available options
+    # are:
+    # <b><tt>:user</tt></b>::       The user used to connect to the database.
+    # <b><tt>:password</tt></b>::   The password to use to connect to the 
+    #                               database (optional).
+    # <b><tt>:dsn</tt></b>::        The dsn string that dbi will use to 
+    #                               access the database.
+    #
+    # Example (setting a source): 
+    #   source :default, :user => "root", 
+    #                    :password => "clyde",
+    #                    :dsn  => "dbi:mysql:blinkybase"
+    #
+    # Example (retrieving a source):
+    #   db = source(:default) #=> <OpenStruct ..>
+    #   db.dsn                #=> "dbi:mysql:blinkybase"
+    #
+    def source(*args) 
+      return sources[args.first] if args.length == 1
+      sources[args.first] = OpenStruct.new(*args[1..-1])
+      check_source(sources[args.first],args.first)
+    end
+
+    # 
+    # :call-seq:
+    #   mailer(mailer_name, options)
+    #
+    # Creates or retrieves a mailer configuration. Available options:
+    # <b><tt>:host</tt></b>::         The SMTP host to use.
+    # <b><tt>:address</tt></b>::      The email address to send to.
+    # <b><tt>:user</tt></b>::         The username to use on the SMTP server
+    # <b><tt>:password</tt></b>::     The password to use on the SMTP server. 
+    #                                 Optional.
+    # <b><tt>:port</tt></b>::         The SMTP port to use. Optional, defaults
+    #                                 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 
+    #                                 <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
+    #
+    # Example (retreiving a mailer config):
+    #   mail_conf = mailer(:alternate)  #=> <OpenStruct ..>
+    #   mail_conf.address               #=> test@test.com
+    #
+    def mailer(*args)
+      return mailers[args.first] if args.length == 1
+      mailers[args.first] = OpenStruct.new(*args[1..-1])
+      check_mailer(mailers[args.first],args.first)
+    end
+
+    # The file that <tt>Ruport.log()</tt> will write to.
+    def log_file(file)
+      @logger = Logger.new(file)
+    end
+    
+    # Same as <tt>Config.log_file</tt>, but accessor style.
+    def log_file=(file)
+      log_file(file)
+    end
+
+    # Alias for <tt>sources[:default]</tt>.
+    def default_source
+      sources[:default]
+    end
+
+    # Alias for <tt>mailers[:default]</tt>.
+    def default_mailer
+      mailers[:default]
+    end
+
+    # Returns all <tt>source</tt>s defined in this <tt>Config</tt>.
+    def sources; @sources ||= {}; end
+
+    # Returns all the <tt>mailer</tt>s defined in this <tt>Config</tt>.
+    def mailers; @mailers ||= {}; end
+
+    # Returns the currently active logger.
+    def logger; @logger; end
+
+    # Forces all messages marked <tt>:log_only</tt> to print anyway.
+    def enable_paranoia; @paranoid = true; end
+
+    # Disables the printing of <tt>:log_only</tt> messages.
+    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
+    
+    # Verifies that you have provided a DSN for your source.
+    def check_source(settings,label) # :nodoc:
+      unless settings.dsn
+        Ruport.complain( 
+          "Missing DSN for source #{label}!",
+          :status => :fatal, :level => :log_only,
+          :exception => ArgumentError 
+        )
+      end
+    end
+
+    # Verifies that you have provided a host for your mailer.
+    def check_mailer(settings, label) # :nodoc:
+      unless settings.host
+        Ruport.complain(
+          "Missing host for mailer #{label}",
+          :status => :fatal, :level => :log_only,
+          :exception => ArgumentError
+        )
+      end
+    end
+    
+  end
+end