RubyGems - ruport - Versions diffs - 0.8.14 → 0.10.0 - Mend

ruport 0.8.14 → 0.10.0

Files changed (102) hide show

data/README +42 -107
data/Rakefile +29 -32
data/examples/centered_pdf_text_box.rb +13 -19
data/examples/example.csv +3 -0
data/examples/line_plotter.rb +15 -15
data/examples/pdf_complex_report.rb +10 -23
data/examples/pdf_table_with_title.rb +12 -12
data/examples/rope_examples/itunes/Rakefile +22 -1
data/examples/rope_examples/itunes/config/environment.rb +4 -0
data/examples/rope_examples/itunes/lib/init.rb +32 -2
data/examples/rope_examples/itunes/util/build +50 -16
data/examples/rope_examples/sales_report/README +1 -1
data/examples/rope_examples/sales_report/Rakefile +22 -1
data/examples/rope_examples/sales_report/config/environment.rb +4 -0
data/examples/rope_examples/sales_report/lib/init.rb +32 -2
data/examples/rope_examples/sales_report/lib/reports/sales.rb +10 -16
data/examples/rope_examples/sales_report/util/build +50 -16
data/examples/row_renderer.rb +39 -0
data/examples/ruport_list/png_embed.rb +61 -0
data/examples/ruport_list/roadmap.png +0 -0
data/examples/sample.rb +16 -0
data/examples/simple_pdf_lines.rb +24 -0
data/lib/ruport.rb +143 -57
data/lib/ruport/acts_as_reportable.rb +246 -0
data/lib/ruport/data.rb +1 -2
data/lib/ruport/data/grouping.rb +311 -0
data/lib/ruport/data/record.rb +113 -84
data/lib/ruport/data/table.rb +275 -174
data/lib/ruport/formatter.rb +149 -0
data/lib/ruport/formatter/csv.rb +87 -0
data/lib/ruport/formatter/html.rb +89 -0
data/lib/ruport/formatter/pdf.rb +357 -0
data/lib/ruport/formatter/text.rb +151 -0
data/lib/ruport/generator.rb +127 -30
data/lib/ruport/query.rb +46 -99
data/lib/ruport/renderer.rb +238 -194
data/lib/ruport/renderer/grouping.rb +67 -0
data/lib/ruport/renderer/table.rb +25 -98
data/lib/ruport/report.rb +45 -96
data/test/acts_as_reportable_test.rb +229 -0
data/test/csv_formatter_test.rb +97 -0
data/test/{_test_database.rb → database_test_.rb} +0 -0
data/test/grouping_test.rb +305 -0
data/test/html_formatter_test.rb +104 -0
data/test/pdf_formatter_test.rb +25 -0
data/test/{test_query.rb → query_test.rb} +32 -121
data/test/{test_record.rb → record_test.rb} +40 -23
data/test/renderer_test.rb +344 -0
data/test/{test_report.rb → report_test.rb} +74 -44
data/test/samples/ticket_count.csv +124 -0
data/test/{test_sql_split.rb → sql_split_test.rb} +0 -0
data/test/{test_table.rb → table_test.rb} +255 -44
data/test/text_formatter_test.rb +144 -0
data/util/bench/data/record/bench_as_vs_to.rb +17 -0
data/util/bench/data/record/bench_constructor.rb +46 -0
data/util/bench/data/record/bench_indexing.rb +65 -0
data/util/bench/data/record/bench_reorder.rb +35 -0
data/util/bench/data/record/bench_to_a.rb +19 -0
data/util/bench/data/table/bench_column_manip.rb +103 -0
data/util/bench/data/table/bench_dup.rb +24 -0
data/util/bench/data/table/bench_init.rb +67 -0
data/util/bench/data/table/bench_manip.rb +125 -0
data/util/bench/formatter/bench_csv.rb +14 -0
data/util/bench/formatter/bench_html.rb +14 -0
data/util/bench/formatter/bench_pdf.rb +14 -0
data/util/bench/formatter/bench_text.rb +14 -0
data/util/bench/samples/tattle.csv +1237 -0
metadata +121 -143
data/TODO +0 -21
data/examples/invoice.rb +0 -142
data/examples/invoice_report.rb +0 -29
data/examples/line_graph.rb +0 -38
data/examples/rope_examples/itunes/config/ruport_config.rb +0 -8
data/examples/rope_examples/sales_report/config/ruport_config.rb +0 -8
data/lib/ruport/attempt.rb +0 -63
data/lib/ruport/config.rb +0 -204
data/lib/ruport/data/groupable.rb +0 -93
data/lib/ruport/data/taggable.rb +0 -80
data/lib/ruport/format.rb +0 -1
data/lib/ruport/format/csv.rb +0 -29
data/lib/ruport/format/html.rb +0 -42
data/lib/ruport/format/latex.rb +0 -47
data/lib/ruport/format/pdf.rb +0 -233
data/lib/ruport/format/plugin.rb +0 -31
data/lib/ruport/format/svg.rb +0 -60
data/lib/ruport/format/text.rb +0 -103
data/lib/ruport/format/xml.rb +0 -32
data/lib/ruport/layout.rb +0 -1
data/lib/ruport/layout/component.rb +0 -7
data/lib/ruport/mailer.rb +0 -99
data/lib/ruport/renderer/graph.rb +0 -46
data/lib/ruport/report/graph.rb +0 -14
data/lib/ruport/system_extensions.rb +0 -71
data/test/test_config.rb +0 -88
data/test/test_format_text.rb +0 -63
data/test/test_graph_renderer.rb +0 -97
data/test/test_groupable.rb +0 -56
data/test/test_mailer.rb +0 -170
data/test/test_renderer.rb +0 -151
data/test/test_ruport.rb +0 -58
data/test/test_table_renderer.rb +0 -141
data/test/test_taggable.rb +0 -52

data/examples/row_renderer.rb ADDED Viewed

@@ -0,0 +1,39 @@
+require "ruport"
+class CSV2Something < Ruport::Renderer
+  required_option :file
+  stage :table_body
+  module Helpers
+    def table_feeder
+      Table(options.file,:has_names => false) { |t,r| yield(r) }
+    end
+  end
+end
+class HTML < Ruport::Formatter::HTML
+  renders :html, :for => CSV2Something
+  def layout
+    output << "<html><div id='ruport'><table>\n"
+    yield
+    output << "</table></div></html>\n"
+  end
+  def build_table_body
+    table_feeder { |r| render_row(r) }
+  end
+end
+class Text < Ruport::Formatter::Text
+  renders :text, :for => CSV2Something
+  def build_table_body
+    table_feeder { |r|  output << r.to_a.join("$") }
+  end
+end
+CSV2Something.render_html(:file => "example.csv",:io => STDOUT)

data/examples/ruport_list/png_embed.rb ADDED Viewed

@@ -0,0 +1,61 @@
+require "rubygems"
+require "ruport"
+class RoadmapRenderer < Ruport::Renderer
+  option :image_file
+  stage :roadmap_image, :roadmap_text_body
+  finalize :roadmap
+end
+class HTMLRoadmap < Ruport::Formatter
+  renders :html, :for => RoadmapRenderer
+  opt_reader :image_file
+  def layout
+     output << "<html><body>\n"
+     yield
+     output << "</body></html>\n"
+  end
+  def build_roadmap_image
+    output << "<img src='#{image_file}'/>"
+  end
+  def build_roadmap_text_body
+    output << "<h2>This is a sample HTML report w. PDF</h2>"
+  end
+end
+class PDFRoadmap < Ruport::Formatter::PDF
+  renders :pdf, :for => RoadmapRenderer
+  opt_reader :image_file
+  def build_roadmap_image
+    center_image_in_box image_file, :x => 0, :y => 200,
+                                   :width => 624, :height => 432
+    move_cursor_to 80
+  end
+  def build_roadmap_text_body
+    draw_text "This is a sample PDF with embedded PNG", :font_size => 16,
+                                                        :x1 => 150
+  end
+  def finalize_roadmap
+    render_pdf
+  end
+end
+formats = [:html, :pdf]
+formats.each do  |format|
+  File.open("roadmap.#{format}","w") { |f|
+     RoadmapRenderer.render format, :io => f, :image_file => "roadmap.png"
+   }
+end

data/examples/ruport_list/roadmap.png ADDED Viewed

Binary file

data/examples/sample.rb ADDED Viewed

@@ -0,0 +1,16 @@
+require "ruport"
+class Sample < Ruport::Report
+  renders_with Ruport::Renderer::Table
+  def generate
+    Table(%w[a b c]) << [1,2,3] << [4,5,6]
+  end
+end
+if __FILE__ == $0
+  report = Sample.new(:csv)
+  puts report.run
+end

data/examples/simple_pdf_lines.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require 'rubygems'
+require "ruport"
+class SimpleLines < Ruport::Renderer
+  stage :horizontal_lines
+end
+class PDFLines < Ruport::Formatter::PDF
+  renders :pdf, :for => SimpleLines
+  def build_horizontal_lines
+    data.each do |points|
+      pad(10) { horizontal_line(*points) }
+    end
+    render_pdf
+  end
+end
+# generate 35 random lines
+data = (0..34).inject([]) { |s,r|
+  s << [rand(100),100+rand(400)]
+}
+puts SimpleLines.render_pdf(:data => data)

data/lib/ruport.rb CHANGED Viewed

@@ -12,73 +12,159 @@
 module Ruport
-  VERSION = "0.8.14"
+  VERSION = "0.10.0"
-  # 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:
+  # SystemExtensions lovingly ganked from HighLine 1.2.1
   #
-  # <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.debug_mode</tt>.
-  # <b><tt>:raises</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.debug_mode?
-    Ruport::Config::logger.send(options[:status],message) if Config.logger
-    if options[:status].eql? :fatal
-      raise(options[:raises] || RuntimeError, message)
-    end
-  end
-  # This method yields a <tt>Ruport::Config</tt> object, allowing you to
-  # set the configuration options for your application.
+  # The following modifications have been made by Gregory Brown on 2006.06.25
   #
-  # Example:
+  # - Outer Module is changed from HighLine to Ruport
+  # - terminal_width / terminal_height added
   #
-  #   Ruport.configure do |c|
+  # The following modifications have been made by Gregory Brown on 2006.08.13
+  # - removed most methods, preserving only terminal geometry features
   #
-  #     c.source :default,
-  #              :dsn => "dbi:mysql:foo",
-  #              :user => "clyde",
-  #              :password => "pacman"
+  # All modifications are under the distributions terms of Ruport.
+  # Copyright 2006, Gregory Brown.  All Rights Reserved
   #
-  #     c.mailer :default,
-  #              :host => "mail.example.com",
-  #              :address => "inky@example.com"
+  # Original copyright notice preserved below.
+  # --------------------------------------------------------------------------
   #
-  #   end
+  #  Created by James Edward Gray II on 2006-06-14.
+  #  Copyright 2006 Gray Productions. All rights reserved.
   #
-  def self.configure(&block)
-    block.call(Ruport::Config)
+  #  This is Free Software.  See LICENSE and COPYING for details.
+  module SystemExtensions #:nodoc:
+    module_function
+    # This section builds character reading and terminal size functions
+    # to suit the proper platform we're running on.  Be warned:  Here be
+    # dragons!
+    #
+    begin
+      require "Win32API"       # See if we're on Windows.
+      # A Windows savvy method to fetch the console columns, and rows.
+      def terminal_size
+        m_GetStdHandle               = Win32API.new( 'kernel32',
+                                                     'GetStdHandle',
+                                                     ['L'],
+                                                     'L' )
+        m_GetConsoleScreenBufferInfo = Win32API.new(
+          'kernel32', 'GetConsoleScreenBufferInfo', ['L', 'P'], 'L'
+        )
+        format        = 'SSSSSssssSS'
+        buf           = ([0] * format.size).pack(format)
+        stdout_handle = m_GetStdHandle.call(0xFFFFFFF5)
+        m_GetConsoleScreenBufferInfo.call(stdout_handle, buf)
+        bufx, bufy, curx, cury, wattr,
+        left, top, right, bottom, maxx, maxy = buf.unpack(format)
+        return right - left + 1, bottom - top + 1
+      end
+    rescue LoadError             # If we're not on Windows try...
+      # A Unix savvy method to fetch the console columns, and rows.
+      def terminal_size
+        size = `stty size 2>/dev/null`.split.map { |x| x.to_i }.reverse
+        return $? == 0 ? size : [80,24]
+      end
+   end
+   def terminal_width
+     terminal_size.first
+   end
   end
+  require 'timeout'
+  class Attempt # :nodoc:
+    VERSION = '0.1.0'
+    # Number of attempts to make before failing.  The default is 3.
+    attr_accessor :tries
+    # Number of seconds to wait between attempts.  The default is 60.
+    attr_accessor :interval
+    # a level which ruport understands.
+    attr_accessor :log_level
+    # If set, this increments the interval with each failed attempt by that
+    # number of seconds.
+    attr_accessor :increment
+    # If set, the code block is further wrapped in a timeout block.
+    attr_accessor :timeout
+    # Determines which exception level to check when looking for errors to
+    # retry.  The default is 'Exception' (i.e. all errors).
+    attr_accessor :level
+    # :call-seq:
+    #    Attempt.new{ |a| ... }
+    #
+    # Creates and returns a new +Attempt+ object.  Use a block to set the
+    # accessors.
+    #
+    def initialize
+      @tries     = 3         # Reasonable default
+      @interval  = 60        # Reasonable default
+      @increment = nil       # Should be an int, if provided
+      @timeout   = nil       # Wrap the code in a timeout block if provided
+      @level     = Exception # Level of exception to be caught
+      yield self if block_given?
+    end
+    def attempt
+      count = 1
+      begin
+         if @timeout
+            Timeout.timeout(@timeout){ yield }
+         else
+            yield
+         end
+      rescue @level => error
+         @tries -= 1
+         if @tries > 0
+            msg = "Error on attempt # #{count}: #{error}; retrying"
+            count += 1
+            @interval += @increment if @increment
+            sleep @interval
+            retry
+         end
+         raise
+      end
+    end
+  end
 end
-require "ruport/attempt"
-require "ruport/config"
+module Kernel
+  # quiets warnings for block
+  def quiet #:nodoc:
+    warnings = $VERBOSE
+    $VERBOSE = nil
+    result = yield
+    $VERBOSE = warnings
+    return result
+  end
+end
+require "enumerator"
+require "ruport/renderer"
 require "ruport/data"
-require "ruport/report"
-require "ruport/format"
+require "ruport/report"
+require "ruport/formatter"
 require "ruport/query"
-require "ruport/mailer"
-require "ruport/layout"
-require "ruport/renderer"
+if Object.const_defined? :ActiveRecord
+  require "ruport/acts_as_reportable"
+end

data/lib/ruport/acts_as_reportable.rb ADDED Viewed

@@ -0,0 +1,246 @@
+require "ruport"
+quiet { require "active_record" }
+module Ruport
+  # This module is designed to be mixed in with an ActiveRecord model
+  # to add easy conversion to Ruport's data structures.
+  module Reportable
+    def self.included(base) # :nodoc:
+      base.extend ClassMethods
+    end
+    module ClassMethods
+      # In the ActiveRecord model you wish to integrate with Ruport, add the
+      # following line just below the class definition:
+      #
+      #   acts_as_reportable
+      #
+      # This will automatically make all the methods in this module available
+      # in the model.
+      #
+      # You may pass the acts_as_reportable method the :only, :except,
+      # :methods, and :include options.  See report_table for the format
+      # of these options.
+      #
+      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
+    module SingletonMethods
+      # Creates a Ruport::Data::Table from an ActiveRecord find. Takes
+      # parameters just like a regular find. If you use the :include
+      # option, it will return a table with all columns from the model and
+      # the included associations. If you use the :only option, it will
+      # return a table with only the specified columns. If you use the
+      # :except option, it will return a table with all columns except
+      # those specified.
+      #
+      # Options may 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.
+      #
+      # Use the :methods option to include a column with the same name as
+      # the method and the value resulting from calling the method on the
+      # model object.
+      #
+      # 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 a report with two columns, title from
+      # the book, and name from the associated author.
+      #
+      # Calling Book.report_table(:all, :include => [:author]).as(:html) will
+      # return a table with all columns from books and authors.
+      #
+      # Note: column names for attributes of included models will be qualified
+      #       with the model's underscored class name, e.g. 'author.name'
+      #       By default, this will not preserve the entire namespace, but you
+      #       can get the fully qualified namespace by using the
+      #       :preserve_namespace => true option to report_table.  So if the
+      #       Author model was enclosed in a module called MyModule, you'd
+      #       get 'my_module/author.name' as the column name.
+      #
+      def report_table(number = :all, options = {})
+        only = options.delete(:only)
+        except = options.delete(:except)
+        methods = options.delete(:methods)
+        includes = options.delete(:include)
+        preserve_namespace = options.delete(:preserve_namespace)
+        self.aar_columns = []
+        options[:include] = get_include_for_find(includes)
+        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)
+        normalize_column_names(table) unless preserve_namespace
+        table
+      end
+      private
+      def get_include_for_find(report_option) #:nodoc:
+        includes = report_option.blank? ? aar_options[:include] : report_option
+        includes.is_a?(Hash) ? includes.keys : includes
+      end
+      def normalize_column_names(table) #:nodoc:
+        renamed = table.column_names.inject({}) do |s,c|
+           s.merge(c => c.sub(/.*\//,""))
+        end
+        table.rename_columns(renamed)
+     end
+    end
+    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
+        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 => true })
+          else
+            assoc_options = { :qualify_attribute_names => true }
+          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 underscored
+      # model name to the attribute name as model.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)
+        namespace = self.class.to_s.underscore
+        attrs = attrs.inject({}) {|h,(k,v)|
+                  h["#{namespace}.#{k}"] = v; h
+                } if options[:qualify_attribute_names]
+        attrs
+      end
+    end
+  end
+end
+ActiveRecord::Base.send :include, Ruport::Reportable