ruport 1.2.3 → 1.4.0

data/test/text_formatter_test.rb

@@ -4,38 +4,36 @@ require File.join(File.expand_path(File.dirname(__FILE__)), "helpers")
 class TestRenderTextTable < Test::Unit::TestCase 
   
   def setup
-    Ruport::Formatter::Template.create(:simple) do |t|
-      t.table_format = {
+    Ruport::Formatter::Template.create(:simple) do |format|
+      format.table = {
         :show_headings  => false,
         :width          => 50,
         :ignore_width   => true
       }
-      t.column_format = {
+      format.column = {
         :maximum_width  => [5,5,7],
         :alignment => :center
       }
-      t.grouping_format = {
+      format.grouping = {
         :show_headings  => false
       }
     end
   end
 
   def test_basic
-
     tf = "+-------+\n"
     
-    a = [[1,2],[3,4]].to_table.to_text
+    a = Table([], :data => [[1,2],[3,4]]).to_text
     assert_equal("#{tf}| 1 | 2 |\n| 3 | 4 |\n#{tf}",a)
 
-    a = [[1,2],[3,4]].to_table(%w[a b]).to_text
+    a = Table(%w[a b], :data => [[1,2],[3,4]]).to_text
     assert_equal("#{tf}| a | b |\n#{tf}| 1 | 2 |\n| 3 | 4 |\n#{tf}", a)
-    
   end
   
   def test_centering
     tf = "+---------+\n" 
 
-    a = [[1,2],[300,4]].to_table
+    a = Table([], :data => [[1,2],[300,4]])
     assert_equal( "#{tf}|  1  | 2 |\n| 300 | 4 |\n#{tf}",
                   a.to_text(:alignment => :center) )
 
@@ -47,7 +45,7 @@ class TestRenderTextTable < Test::Unit::TestCase
 
   def test_justified
     tf = "+----------+\n"
-    a = [[1,'Z'],[300,'BB']].to_table
+    a = Table([], :data => [[1,'Z'],[300,'BB']])
     
     # justified alignment can be set explicitly
     assert_equal "#{tf}|   1 | Z  |\n| 300 | BB |\n#{tf}", 
@@ -58,18 +56,18 @@ class TestRenderTextTable < Test::Unit::TestCase
   end
 
   def test_wrapping  
-    a = [[1,2],[300,4]].to_table.to_text(:table_width => 10)
+    a = Table([], :data => [[1,2],[300,4]]).to_text(:table_width => 10)
     assert_equal("+------->>\n|   1 | >>\n| 300 | >>\n+------->>\n",a)
   end  
   
   def test_ignore_wrapping
-    a = [[1,2],[300,4]].to_table.to_text(:table_width => 10, 
+    a = Table([], :data => [[1,2],[300,4]]).to_text(:table_width => 10, 
                                          :ignore_table_width => true )
     assert_equal("+---------+\n|   1 | 2 |\n| 300 | 4 |\n+---------+\n",a)
   end 
   
   def test_render_empty_table
-    assert_raise(Ruport::FormatterError) { [].to_table.to_text }
+    assert_raise(Ruport::FormatterError) { Table([]).to_text }
     assert_nothing_raised { Table(%w[a b c]).to_text }
 
     a = Table(%w[a b c]).to_text
@@ -154,7 +152,7 @@ class TestRenderTextTable < Test::Unit::TestCase
   # -- BUG TRAPS ------------------------------
 
   def test_should_render_without_column_names
-    a = [[1,2,3]].to_table.to_text
+    a = Table([], :data => [[1,2,3]]).to_text
     expected = "+-----------+\n"+
                "| 1 | 2 | 3 |\n"+
                "+-----------+\n"

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
+rubygems_version: 0.9.2
 specification_version: 1
 name: ruport
 version: !ruby/object:Gem::Version 
-  version: 1.2.3
-date: 2007-11-24 00:00:00 -05:00
+  version: 1.4.0
+date: 2007-12-25 00:00:00 -05:00
 summary: A generalized Ruby report generation and templating engine.
 require_paths: 
 - lib
@@ -30,113 +30,103 @@ authors:
 - Gregory Brown
 files: 
 - examples/btree
-- examples/centered_pdf_text_box.rb
-- examples/data
-- examples/example.csv
-- examples/line_plotter.rb
-- examples/pdf_report_with_common_base.rb
-- examples/png_embed.rb
-- examples/roadmap.png
-- examples/row_renderer.rb
-- examples/RWEmerson.jpg
-- examples/simple_pdf_lines.rb
-- examples/simple_templating_example.rb
-- examples/tattle_ruby_version.rb
-- examples/tattle_rubygems_version.rb
-- examples/trac_ticket_status.rb
 - examples/btree/commaleon
-- examples/btree/commaleon/commaleon.rb
 - examples/btree/commaleon/sample_data
 - examples/btree/commaleon/sample_data/ticket_count.csv
 - examples/btree/commaleon/sample_data/ticket_count2.csv
+- examples/btree/commaleon/commaleon.rb
+- examples/data
 - examples/data/tattle.dump
+- examples/row_renderer.rb
+- examples/RWEmerson.jpg
+- examples/centered_pdf_text_box.rb
+- examples/tattle_rubygems_version.rb
+- examples/trac_ticket_status.rb
+- examples/line_plotter.rb
+- examples/png_embed.rb
+- examples/pdf_report_with_common_base.rb
+- examples/example.csv
+- examples/tattle_ruby_version.rb
+- examples/roadmap.png
+- examples/simple_templating_example.rb
+- examples/simple_pdf_lines.rb
 - lib/ruport
-- lib/ruport.rb
-- lib/uport.rb
-- lib/ruport/acts_as_reportable.rb
-- lib/ruport/data
-- lib/ruport/data.rb
-- lib/ruport/extensions.rb
 - lib/ruport/formatter
-- lib/ruport/formatter.rb
-- lib/ruport/query
-- lib/ruport/query.rb
-- lib/ruport/renderer
-- lib/ruport/renderer.rb
-- lib/ruport/data/feeder.rb
-- lib/ruport/data/grouping.rb
-- lib/ruport/data/record.rb
-- lib/ruport/data/table.rb
-- lib/ruport/formatter/csv.rb
 - lib/ruport/formatter/html.rb
+- lib/ruport/formatter/text.rb
 - lib/ruport/formatter/pdf.rb
+- lib/ruport/formatter/csv.rb
 - lib/ruport/formatter/template.rb
-- lib/ruport/formatter/text.rb
-- lib/ruport/query/sql_split.rb
-- lib/ruport/renderer/grouping.rb
+- lib/ruport/renderer
 - lib/ruport/renderer/table.rb
-- test/acts_as_reportable_test.rb
-- test/csv_formatter_test.rb
-- test/data_feeder_test.rb
-- test/grouping_test.rb
-- test/helpers.rb
-- test/html_formatter_test.rb
-- test/pdf_formatter_test.rb
-- test/query_test.rb
-- test/record_test.rb
-- test/renderer_test.rb
+- lib/ruport/renderer/grouping.rb
+- lib/ruport/data
+- lib/ruport/data/record.rb
+- lib/ruport/data/table.rb
+- lib/ruport/data/feeder.rb
+- lib/ruport/data/grouping.rb
+- lib/ruport/extensions.rb
+- lib/ruport/formatter.rb
+- lib/ruport/renderer.rb
+- lib/ruport/data.rb
+- lib/uport.rb
+- lib/ruport.rb
 - test/samples
-- test/sql_split_test.rb
-- test/table_test.rb
-- test/template_test.rb
-- test/text_formatter_test.rb
-- test/samples/addressbook.csv
+- test/samples/test.yaml
+- test/samples/query_test.sql
 - test/samples/data.csv
 - test/samples/data.tsv
-- test/samples/dates.csv
 - test/samples/erb_test.sql
-- test/samples/query_test.sql
+- test/samples/ticket_count.csv
 - test/samples/ruport_test.sql
+- test/samples/addressbook.csv
+- test/samples/dates.csv
 - test/samples/test.sql
-- test/samples/test.yaml
-- test/samples/ticket_count.csv
-- util/bench/data
+- test/csv_formatter_test.rb
+- test/record_test.rb
+- test/data_feeder_test.rb
+- test/helpers.rb
+- test/renderer_test.rb
+- test/html_formatter_test.rb
+- test/table_test.rb
+- test/text_formatter_test.rb
+- test/grouping_test.rb
+- test/template_test.rb
+- test/pdf_formatter_test.rb
 - util/bench/formatter
+- util/bench/formatter/bench_html.rb
+- util/bench/formatter/bench_text.rb
+- util/bench/formatter/bench_pdf.rb
+- util/bench/formatter/bench_csv.rb
 - util/bench/samples
-- util/bench/data/record
+- util/bench/samples/tattle.csv
+- util/bench/data
 - util/bench/data/table
-- util/bench/data/record/bench_as_vs_to.rb
-- util/bench/data/record/bench_constructor.rb
-- util/bench/data/record/bench_indexing.rb
-- util/bench/data/record/bench_reorder.rb
-- util/bench/data/record/bench_to_a.rb
 - util/bench/data/table/bench_column_manip.rb
-- util/bench/data/table/bench_dup.rb
 - util/bench/data/table/bench_init.rb
 - util/bench/data/table/bench_manip.rb
-- util/bench/formatter/bench_csv.rb
-- util/bench/formatter/bench_html.rb
-- util/bench/formatter/bench_pdf.rb
-- util/bench/formatter/bench_text.rb
-- util/bench/samples/tattle.csv
+- util/bench/data/table/bench_dup.rb
+- util/bench/data/record
+- util/bench/data/record/bench_reorder.rb
+- util/bench/data/record/bench_to_a.rb
+- util/bench/data/record/bench_constructor.rb
+- util/bench/data/record/bench_indexing.rb
+- util/bench/data/record/bench_as_vs_to.rb
 - Rakefile
 - README
 - LICENSE
 - AUTHORS
 test_files: 
-- test/acts_as_reportable_test.rb
 - test/csv_formatter_test.rb
-- test/data_feeder_test.rb
-- test/grouping_test.rb
-- test/html_formatter_test.rb
-- test/pdf_formatter_test.rb
-- test/query_test.rb
 - test/record_test.rb
+- test/data_feeder_test.rb
 - test/renderer_test.rb
-- test/sql_split_test.rb
+- test/html_formatter_test.rb
 - test/table_test.rb
-- test/template_test.rb
 - test/text_formatter_test.rb
+- test/grouping_test.rb
+- test/template_test.rb
+- test/pdf_formatter_test.rb
 rdoc_options: 
 - --title
 - Ruport Documentation
@@ -154,15 +144,6 @@ extensions: []
 requirements: []
 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: transaction-simple
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 1.4.0
-    version: 
 - !ruby/object:Gem::Dependency 
   name: fastercsv
   version_requirement: 
@@ -177,7 +158,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: 1.1.3
+        version: 1.1.7
     version: 

data/lib/ruport/acts_as_reportable.rb

@@ -1,378 +0,0 @@
-# Ruport : Extensible Reporting System                                
-#
-# acts_as_reportable.rb provides ActiveRecord integration for Ruport.
-#     
-# Originally created by Dudley Flanders, 2006
-# Revised and updated by Michael Milner, 2007     
-# Copyright (C) 2006-2007 Dudley Flanders / Michael Milner, All Rights Reserved.  
-#
-# This is free software distributed under the same terms as Ruby 1.8
-# See LICENSE and COPYING for details.   
-#
-require "ruport"
-Ruport.quiet { require "active_record" }
-
-module Ruport
-  
-  # === Overview
-  # 
-  # This module is designed to allow an ActiveRecord model to be converted to
-  # Ruport's data structures.  If ActiveRecord is available when Ruport is
-  # loaded, this module will be automatically mixed into ActiveRecord::Base.
-  #
-  # Add the acts_as_reportable call to the model class that you want to
-  # integrate with Ruport:
-  #
-  #   class Book < ActiveRecord::Base
-  #     acts_as_reportable
-  #     belongs_to :author
-  #   end
-  #
-  # Then you can use the <tt>report_table</tt> method to get data from the
-  # model using ActiveRecord.
-  #
-  #   Book.report_table(:all, :include => :author)
-  #
-  module Reportable
-    
-    def self.included(base) #:nodoc:
-      base.extend ClassMethods  
-    end
-    
-    # === Overview
-    # 
-    # This module contains class methods that will automatically be available
-    # to ActiveRecord models.
-    #
-    module ClassMethods 
-      
-      # In the ActiveRecord model you wish to integrate with Ruport, add the 
-      # following line just below the class definition:
-      #
-      #   acts_as_reportable
-      #
-      # Available options:
-      #
-      # <b><tt>:only</tt></b>::     an attribute name or array of attribute
-      #                             names to include in the results, other
-      #                             attributes will be excuded.
-      # <b><tt>:except</tt></b>::   an attribute name or array of attribute
-      #                             names to exclude from the results.
-      # <b><tt>:methods</tt></b>::  a method name or array of method names
-      #                             whose result(s) will be included in the
-      #                             table.
-      # <b><tt>:include</tt></b>::  an associated model or array of associated
-      #                             models to include in the results.
-      #
-      # Example:
-      # 
-      #   class Book < ActiveRecord::Base
-      #     acts_as_reportable, :only => 'title', :include => :author
-      #   end
-      #
-      def acts_as_reportable(options = {})
-        cattr_accessor :aar_options, :aar_columns
-
-        self.aar_options = options
-
-        include Ruport::Reportable::InstanceMethods
-        extend Ruport::Reportable::SingletonMethods
-      end
-    end
-    
-    # === Overview
-    # 
-    # This module contains methods that will be made available as singleton
-    # class methods to any ActiveRecord model that calls
-    # <tt>acts_as_reportable</tt>.
-    #
-    module SingletonMethods
-      
-      # Creates a Ruport::Data::Table from an ActiveRecord find. Takes 
-      # parameters just like a regular find.
-      #
-      # Additional options include:
-      #
-      # <b><tt>:only</tt></b>::     An attribute name or array of attribute
-      #                             names to include in the results, other
-      #                             attributes will be excuded.
-      # <b><tt>:except</tt></b>::   An attribute name or array of attribute
-      #                             names to exclude from the results.
-      # <b><tt>:methods</tt></b>::  A method name or array of method names
-      #                             whose result(s) will be included in the
-      #                             table.
-      # <b><tt>:include</tt></b>::  An associated model or array of associated
-      #                             models to include in the results.
-      # <b><tt>:filters</tt></b>::  A proc or array of procs that set up
-      #                             conditions to filter the data being added
-      #                             to the table.
-      # <b><tt>:transforms</tt></b>::  A proc or array of procs that perform
-      #                                transformations on the data being added
-      #                                to the table.
-      # <b><tt>:record_class</tt></b>::  Specify the class of the table's
-      #                                  records.
-      # <b><tt>:eager_loading</tt></b>::  Set to false if you don't want to
-      #                                   eager load included associations.
-      #
-      # The :only, :except, :methods, and :include options may also be passed
-      # to the :include option in order to specify the output for any
-      # associated models. In this case, the :include option must be a hash,
-      # where the keys are the names of the associations and the values
-      # are hashes of options.
-      #
-      # Any options passed to report_table will disable the options set by
-      # the acts_as_reportable class method.
-      #
-      # Example:
-      # 
-      #   class Book < ActiveRecord::Base
-      #     belongs_to :author
-      #     acts_as_reportable
-      #   end
-      #
-      #   Book.report_table(:all, :only => ['title'],
-      #     :include => { :author => { :only => 'name' } }).as(:html)
-      #
-      # Returns:
-      #
-      # an html version of the table with two columns, title from 
-      # the book, and name from the associated author.
-      #
-      # Example:
-      # 
-      #   Book.report_table(:all, :include => :author).as(:html)
-      #
-      # Returns:
-      #
-      # an html version of the table with all columns from books and authors.
-      #
-      # Note: column names for attributes of included models will be qualified
-      # with the name of the association. 
-      #
-      def report_table(number = :all, options = {})
-        only = options.delete(:only)
-        except = options.delete(:except)
-        methods = options.delete(:methods)
-        includes = options.delete(:include)
-        filters = options.delete(:filters) 
-        transforms = options.delete(:transforms)
-        record_class = options.delete(:record_class) || Ruport::Data::Record
-        self.aar_columns = []
-
-        unless options.delete(:eager_loading) == false
-          options[:include] = get_include_for_find(includes)
-        end
-        
-        data = [find(number, options)].flatten
-        data = data.map {|r| r.reportable_data(:include => includes,
-                               :only => only,
-                               :except => except,
-                               :methods => methods) }.flatten
-
-
-        table = Ruport::Data::Table.new(:data => data,
-                                        :column_names => aar_columns,
-                                        :record_class => record_class,
-                                        :filters => filters,
-                                        :transforms => transforms )
-      end
-      
-      # Creates a Ruport::Data::Table from an ActiveRecord find_by_sql.
-      #
-      # Additional options include:
-      #
-      # <b><tt>:filters</tt></b>::  A proc or array of procs that set up
-      #                             conditions to filter the data being added
-      #                             to the table.
-      # <b><tt>:transforms</tt></b>::  A proc or array of procs that perform
-      #                                transformations on the data being added
-      #                                to the table.
-      # <b><tt>:record_class</tt></b>::  Specify the class of the table's
-      #                                  records.
-      #
-      # Example:
-      # 
-      #   class Book < ActiveRecord::Base
-      #     belongs_to :author
-      #     acts_as_reportable
-      #   end
-      #
-      #   Book.report_table_by_sql("SELECT * FROM books")
-      #
-      def report_table_by_sql(sql, options = {})
-        record_class = options.delete(:record_class) || Ruport::Data::Record
-        filters = options.delete(:filters) 
-        transforms = options.delete(:transforms)
-        self.aar_columns = []
-
-        data = find_by_sql(sql)
-        data = data.map {|r| r.reportable_data }.flatten
-
-        table = Ruport::Data::Table.new(:data => data,
-                                        :column_names => aar_columns,
-                                        :record_class => record_class,
-                                        :filters => filters,
-                                        :transforms => transforms)
-      end
-
-      private
-      
-      def get_include_for_find(report_option)
-        includes = report_option.blank? ? aar_options[:include] : report_option
-        if includes.is_a?(Hash)
-          result = {}
-          includes.each do |k,v|
-            if v.empty? || !v[:include]
-              result.merge!(k => {})
-            else
-              result.merge!(k => get_include_for_find(v[:include]))
-            end
-          end
-          result
-        elsif includes.is_a?(Array)
-          result = {}
-          includes.each {|i| result.merge!(i => {}) }
-          result
-        else
-          includes
-        end
-      end
-    end
-    
-    # === Overview
-    # 
-    # This module contains methods that will be made available as instance
-    # methods to any ActiveRecord model that calls <tt>acts_as_reportable</tt>.
-    #
-    module InstanceMethods
-      
-      # Grabs all of the object's attributes and the attributes of the
-      # associated objects and returns them as an array of record hashes.
-      # 
-      # Associated object attributes are stored in the record with
-      # "association.attribute" keys.
-      # 
-      # Passing :only as an option will only get those attributes.
-      # Passing :except as an option will exclude those attributes.
-      # Must pass :include as an option to access associations.  Options
-      # may be passed to the included associations by providing the :include
-      # option as a hash.
-      # Passing :methods as an option will include any methods on the object.
-      #
-      # Example:
-      # 
-      #   class Book < ActiveRecord::Base
-      #     belongs_to :author
-      #     acts_as_reportable
-      #   end
-      # 
-      #   abook.reportable_data(:only => ['title'], :include => [:author])
-      #
-      # Returns:
-      #
-      #   [{'title' => 'book title',
-      #     'author.id' => 'author id',
-      #     'author.name' => 'author name' }]
-      #  
-      # NOTE: title will only be returned if the value exists in the table.
-      # If the books table does not have a title column, it will not be
-      # returned.
-      #
-      # Example:
-      #
-      #   abook.reportable_data(:only => ['title'],
-      #     :include => { :author => { :only => ['name'] } })
-      #
-      # Returns:
-      #
-      #   [{'title' => 'book title',
-      #     'author.name' => 'author name' }]
-      #
-      def reportable_data(options = {})
-        options = options.merge(self.class.aar_options) unless
-          has_report_options?(options)
-        
-        data_records = [get_attributes_with_options(options)]
-        Array(options[:methods]).each do |method|
-          data_records.first[method.to_s] = send(method)
-        end
-        
-        # Reorder columns to match options[:only]
-        self.class.aar_columns = options[:only] if Array === options[:only]
-        
-        self.class.aar_columns |= data_records.first.keys
-        
-        data_records =
-          add_includes(data_records, options[:include]) if options[:include]
-        data_records
-      end
-      
-      private
-
-      # Add data for all included associations
-      #
-      def add_includes(data_records, includes)
-        include_has_options = includes.is_a?(Hash)
-        associations = include_has_options ? includes.keys : Array(includes)
-        
-        associations.each do |association|
-          existing_records = data_records.dup
-          data_records = []
-          
-          if include_has_options
-            assoc_options = includes[association].merge({
-              :qualify_attribute_names => association })
-          else
-            assoc_options = { :qualify_attribute_names => association }
-          end
-          
-          association_objects = [send(association)].flatten.compact
-          
-          existing_records.each do |existing_record|
-            if association_objects.empty?
-              data_records << existing_record
-            else
-              association_objects.each do |obj|
-                association_records = obj.reportable_data(assoc_options)
-                association_records.each do |assoc_record|
-                  data_records << existing_record.merge(assoc_record)
-                end
-                self.class.aar_columns |= data_records.last.keys
-              end
-            end
-          end
-        end
-        data_records
-      end
-      
-      # Check if the options hash has any report options
-      # (:only, :except, :methods, or :include).
-      #
-      def has_report_options?(options)
-        options[:only] || options[:except] || options[:methods] ||
-          options[:include]
-      end
-
-      # Get the object's attributes using the supplied options.
-      # 
-      # Use the :only or :except options to limit the attributes returned.
-      #
-      # Use the :qualify_attribute_names option to append the association
-      # name to the attribute name as association.attribute
-      #
-      def get_attributes_with_options(options = {})
-        only_or_except =
-          if options[:only] or options[:except]
-            { :only => options[:only], :except => options[:except] }
-          end
-        attrs = attributes(only_or_except)
-        attrs = attrs.inject({}) {|h,(k,v)|
-                  h["#{options[:qualify_attribute_names]}.#{k}"] = v; h
-                } if options[:qualify_attribute_names]
-        attrs
-      end
-    end
-  end
-end
-
-ActiveRecord::Base.send :include, Ruport::Reportable