ruport 0.7.1 → 0.7.2

data/AUTHORS

@@ -35,9 +35,11 @@ Daniel Berger:
 Marshall T. Vandegrift:
  - Fixed a bug in Record's struct-like accessors (method_missing)
  - Provided performance enhancements and tests for query.rb
+ - Improved alignment for Text Tables.
 
 Stefan Mahlitz:
  - Table#sort_rows_by
 
-llasram@gmail.com
- - Improved alignment for Text Tables.
+Mike Milner:
+ - mock object for Mailer
+ - mock objects for Report (#130)

data/README

@@ -109,14 +109,14 @@
 # up to date information.
 #
 # - You can sign up and/or view the archives here:
-#   http://stonecode.svnrepository.com/ruport/trac.cgi/browser/trunk/test/test_table.rb
+#     http://groups.google.com/group/ruby-reports
 #
 # Please do not hesitate to use this list!  I am happily accepting patches and
 # documentation, as well as encouraging design discussions and also am quite
 # curious about what people use or want to use ruport for.
 #
 # I will announce Ruport releases on RubyTalk, on the Ruport mailing list, on
-# Freshmeat, and RAAt.  If you would like to
+# Freshmeat, and RAA.  If you would like to
 # keep an eye out for releases, please monitor one of those places.
 #
 #   - You may download Ruport's source from the project page:
@@ -125,7 +125,8 @@
 #   - The latest stable API documentation is available at:
 #     http://reporting.stonecode.org/docs
 #
-# There also will be some tutorials on rubyreports.org
+# There are also some tutorial available:
+# http://stonecode.svnrepository.com/ruport/trac.cgi/wiki/TutorialsAndArticles
 #
 # If you are interested in developing Ruport, please *never* study code in
 # official releases.  As this software is in it's early stages, it's essential

data/Rakefile

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

data/lib/ruport.rb

@@ -9,12 +9,10 @@
 #
 # See LICENSE and COPYING for details
 #
-
 module Ruport
   
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
   
-  #
   # 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>.
@@ -54,7 +52,6 @@ module Ruport
   # 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.
   #

data/lib/ruport/config.rb

@@ -11,7 +11,7 @@
 #
 require "ostruct"
 module Ruport
-  #
+
   # === Overview
   #
   # This class serves as the configuration system for Ruport.
@@ -29,7 +29,7 @@ module Ruport
   #   Ruport.configure do |config|
   #
   #     config.log_file 'foo.log'
-  #     config.enable_paranoia
+  #     config.debug_mode = true
   #
   #     config.source :default,
   #                   :dsn => "dbi:mysql:somedb:db.blixy.org",
@@ -69,7 +69,7 @@ module Ruport
   #
   module Config
     module_function
-    # 
+    
     # :call-seq:
     #   source(source_name, options)
     #
@@ -96,13 +96,12 @@ module Ruport
       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>:address</tt></b>::      Address the email is being sent from.
     # <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.
@@ -160,12 +159,7 @@ module Ruport
     # 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
-
+    # returns true if in debug mode
     def debug_mode?; !!@debug_mode; end
     
     # Verifies that you have provided a DSN for your source.
@@ -190,6 +184,7 @@ module Ruport
       end
     end
 
+    # forces messages with :level of :log_only to be printed
     def debug_mode=(something)
       @debug_mode = !!something
     end

data/lib/ruport/data/collection.rb

@@ -6,7 +6,6 @@
 
 module Ruport::Data
   
-  #
   # === Overview
   #
   # This is the base class for Ruport's Data structures. It mixes in the 
@@ -26,8 +25,14 @@ module Ruport::Data
     # A simple formatting tool which allows you to quickly generate a formatted
     # table from a <tt>Collection</tt> object.
     #
-    # Example:
+    # If given a block, the Renderer::Table object will be yielded
+    #
+    #
+    # Examples:
+    #
     #   my_collection.as(:csv)  #=> "1,2,3\n4,5,6"
+    #
+    #   my_collection.as(:csv) { |e| e.layout.show_table_headers = false }
     def as(type)
       Ruport::Renderer::Table.render(type) do |rend|
         rend.data = self
@@ -47,6 +52,7 @@ module Ruport::Data
 
     # Provides a shortcut for the <tt>as()</tt> method by converting a call to
     # <tt>as(:format_name)</tt> into a call to <tt>to_format_name</tt>
+    # 
     def method_missing(id,*args)
      return as($1.to_sym) if id.to_s =~ /^to_(.*)/ 
      super

data/lib/ruport/data/groupable.rb

@@ -8,7 +8,6 @@ module Ruport::Data
   #
   module Groupable
 
-    #
     # Creates a <tt>Record</tt> made up of <tt>Table</tt>s containing all the
     # records in the original table with the same tag. 
     #
@@ -54,7 +53,6 @@ module Ruport::Data
       end; r
     end
 
-    #
     # Tags each row of the <tt>Table</tt> for which the <tt>block</tt> is not 
     # false with <tt>label</tt>.
     # 

data/lib/ruport/data/record.rb

@@ -5,7 +5,6 @@
 # Copyright 2006 by respective content owners, all rights reserved.
 module Ruport::Data
 
-  #
   # === Overview
   # 
   # Data::Records are the work horse of Ruport's data model. These can behave
@@ -18,7 +17,6 @@ module Ruport::Data
     include Enumerable
     include Taggable
 
-    # 
     # Creates a new Record object.  If the <tt>:attributes</tt> 
     # keyword is specified, Hash-like and Struct-like 
     # access will be enabled.  Otherwise, Record elements may be 
@@ -64,7 +62,6 @@ module Ruport::Data
     
     def_delegators :@data,:each, :length
   
-    #
     # Allows either Array or Hash-like indexing.
     #
     # Examples:
@@ -83,8 +80,6 @@ module Ruport::Data
       end
     end
 
-
-    # 
     # Allows setting a <tt>value</tt> at an <tt>index</tt>.
     # 
     # Examples:
@@ -103,7 +98,6 @@ module Ruport::Data
       end
     end
 
-    #
     # If <tt>attributes</tt> and <tt>data</tt> are equivalent, then 
     # <tt>==</tt> evaluates to true. Otherwise, <tt>==</tt> returns false.
     #
@@ -115,7 +109,6 @@ module Ruport::Data
 
     alias_method :eql?, :==
    
-    #
     # Converts a Record into an Array.
     #
     # Example:
@@ -125,7 +118,6 @@ module Ruport::Data
     #
     def to_a; @data.dup; end
     
-    #
     # Converts a Record into a Hash. This only works if <tt>attributes</tt> 
     # are specified in the Record.
     #
@@ -135,7 +127,6 @@ module Ruport::Data
     #   a.to_h #=> {"a" => 1, "b" => 2}
     def to_h; Hash[*@attributes.zip(data).flatten] end
   
-    #
     # Returns a copy of the <tt>attributes</tt> from this Record.
     #
     # Example:
@@ -145,7 +136,6 @@ module Ruport::Data
     #
     def attributes; @attributes.map { |a| a.to_s }; end
 
-    #
     # Sets the <tt>attribute</tt> list for this Record.
     #
     # Example:
@@ -154,7 +144,6 @@ module Ruport::Data
     #
     attr_writer :attributes
 
-    #
     # Allows you to change the order of or reduce the number of columns in a
     # Record.  
     #
@@ -202,7 +191,6 @@ module Ruport::Data
     #FIXME: This does not take into account frozen / tainted state
     alias_method :clone, :dup
     
-    #
     # Provides a unique hash value. If a Record contains the same data and
     # attributes as another Record, they will hash to the same value, even if
     # they are not the same object. This is similar to the way Array works, 
@@ -212,7 +200,6 @@ module Ruport::Data
       (attributes.to_a + data.to_a).hash
     end
 
-    #
     # Provides accessor style methods for attribute access.
     #
     # Example:

data/lib/ruport/data/set.rb

@@ -7,7 +7,6 @@ require 'set'
 
 module Ruport::Data
   
-  #
   # === Overview
   #
   # This class is one of the core classes for building and working with data 
@@ -23,7 +22,6 @@ module Ruport::Data
   #
   class Set < Collection
     
-    #
     # Creates a new Set containing the elements of <tt>options[:data]</tt>.
     #
     # Example:
@@ -35,7 +33,6 @@ module Ruport::Data
       options[:data].each {|e| self << e} if options[:data]
     end
     
-    #
     # Adds the given object to the Set and returns self. 
     #
     # Example:
@@ -54,7 +51,6 @@ module Ruport::Data
     end
     alias_method :<<, :add
     
-    #
     # Produces a shallow copy of the Set: the same data elements are 
     # referenced by both the old and new Sets.
     #
@@ -73,7 +69,6 @@ module Ruport::Data
     end
     alias_method :clone, :dup
 
-    #
     # Two Sets are equal if they contain the same set of objects.
     # 
     # Example:
@@ -102,7 +97,6 @@ module Ruport::Data
     alias_method :union, :|
     alias_method :+, :|
     
-    #
     # Returns a new Set containing the objects common to the two Sets.
     #
     # Example:
@@ -118,7 +112,6 @@ module Ruport::Data
     end
     alias_method :intersection, :&
     
-    #
     # Returns a new Set containing those objects present in this Set but not 
     # the other.
     #
@@ -135,7 +128,6 @@ module Ruport::Data
     end
     alias_method :difference, :-
 
-    #
     # Returns a new Set containing those objects that are either in this Set 
     # or the other Set but not in both.
     #

data/lib/ruport/data/table.rb

@@ -7,7 +7,6 @@
 
 module Ruport::Data
 
-  # 
   # === Overview
   #
   # This class is one of the core classes for building and working with data 
@@ -24,7 +23,6 @@ module Ruport::Data
   class Table < Collection
     include Groupable
     
-    #
     # Creates a new table based on the supplied options.
     # Valid options: 
     # <b><tt>:data</tt></b>::         An Array of Arrays representing the 
@@ -41,7 +39,7 @@ module Ruport::Data
       @data         = []
       if options[:data]
         if options[:data].all? { |r| r.kind_of? Record }
-          record_tags = options[:data].map { |r| r.tags }
+          record_tags = options[:data].map { |r| r.tags.dup }
           options[:data] = options[:data].map { |r| r.to_a } 
         end 
         options[:data].each { |e| self << e }  
@@ -53,7 +51,6 @@ module Ruport::Data
     attr_reader :column_names
     def_delegator :@data, :[]
     
-    #
     # Sets the column names for this table. <tt>new_column_names</tt> should 
     # be an array listing the names of the columns.
     #
@@ -68,7 +65,6 @@ module Ruport::Data
       @column_names.replace(new_column_names.dup)
     end
 
-    #
     # Compares this Table to another Table and returns <tt>true</tt> if
     # both the <tt>data</tt> and <tt>column_names</tt> are equal.
     #
@@ -88,7 +84,6 @@ module Ruport::Data
 
     alias_method :==, :eql?
 
-    #
     # Uses Ruport's built-in text plugin to render this Table into a String
     # 
     # Example:
@@ -101,7 +96,6 @@ module Ruport::Data
       as(:text)
     end
 
-    #
     # Used to add extra data to the Table. <tt>other</tt> can be an Array, 
     # Hash or Record.
     #
@@ -131,7 +125,6 @@ module Ruport::Data
       self
     end
   
-    #
     # Used to combine two Tables. Throws an ArgumentError if the Tables don't
     # have identical columns.
     #
@@ -151,7 +144,6 @@ module Ruport::Data
       Table.new(:column_names => @column_names, :data => @data + other.data)
     end
   
-    #
     # Reorders the columns that exist in the Table. Modifies this Table 
     # in-place.
     #
@@ -179,7 +171,6 @@ module Ruport::Data
       }; self
     end
 
-    #
     # Returns a copy of the Table with its columns in the requested order.
     #
     # Example:
@@ -193,7 +184,6 @@ module Ruport::Data
       dup.reorder!(*indices)
     end
 
-    #
     # Adds an extra column to the Table. Available Options:
     #
     # <b><tt>:name</tt></b>:: The new column's name (required)
@@ -216,7 +206,6 @@ module Ruport::Data
       end; self
     end
 
-    # 
     # Removes a column from the Table. Any values in the specified column are
     # lost.
     #
@@ -244,7 +233,6 @@ module Ruport::Data
       reorder! column_names - [name]
     end
 
-    #
     # Create a copy of the Table: records will be copied as well.
     #
     # Example:
@@ -259,7 +247,6 @@ module Ruport::Data
       return a
     end
 
-    #
     # Loads a CSV file directly into a Table using the FasterCSV library.
     #
     # Example:
@@ -277,7 +264,6 @@ module Ruport::Data
         get_table_from_csv(:foreach, csv_file, options,&block)
     end
     
-    #
     # Creates a Table from a CSV string using FasterCSV.  See Table.load for
     # additional examples.
     #
@@ -306,7 +292,6 @@ module Ruport::Data
       end ; loaded_data
     end
 
-    # 
     # Allows you to split Tables into multiple Tables for grouping.
     #
     # Example:
@@ -369,7 +354,6 @@ module Ruport::Data
       end; rec
     end
     
-    # 
     # Calculates sums. If a column name or index is given, it will try to
     # convert each element of that column to an integer or float 
     # and add them together.
@@ -401,7 +385,6 @@ module Ruport::Data
 
     alias_method :sum, :sigma
     
-    #
     # Returns a sorted table. If col_names is specified, 
     # the block is ignored and the table is sorted by the named columns. All
     # options are used in constructing the new Table (see Array#to_table