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/invoice_report.rb DELETED Viewed

@@ -1,29 +0,0 @@
-require "rubygems"
-require "ruport"
-require "invoice"
-class SampleReport < Ruport::Report
-  include Invoice
-  def generate
-    render_invoice do |i|
-      i.data = [[1,2,3],[4,5,6]].to_table(%w[a b c])
-      i.options do |o|
-        o.company_info  = "Stone Code Productions\n43 Neagle Street"
-        o.customer_info = "Gregory Brown\n200 Foo Ave."
-        o.comments      = "J. Random Comment"
-        o.order_info    = "Some info\nabout your order"
-        o.title         = "Invoice for 12.15.2006 - 12.31.2006"
-      end
-      i.layout do |lay|
-        lay.body_width = 480
-        lay.comments_font_size = 12
-        lay.title_font_size = 10
-      end
-    end
-  end
-end
-SampleReport.run { |r| r.write "out.pdf" }

data/examples/line_graph.rb DELETED Viewed

@@ -1,38 +0,0 @@
-require "ruport"
-table = Table(%w[jan feb mar apr may jun jul]) do |t|
-  t << [5,7,9,12,14,16,18]
-  t << [21,3,8,19,13,15,1]
-end
-table[0].tag :ghosts
-table[1].tag "pirates"
-results = Ruport::Renderer::Graph.render_svg do |r|
-  r.data = table
-  r.options.title = "Simple Line Graph"
-  r.layout do |l|
-    l.width  = 700
-    l.height = 500
-    l.theme  = r.plugin.themes[:keynote]
-    l.style  = :line
-  end
-end
-File.open("line_graph.svg","w") { |f| f << results }
-PAGE = <<-END_HTML
-<html>
-  <body>
-  <embed
-  src="line_graph.svg"
-  width="700"
-  height="500"
-  />
-</body>
-<html>
-END_HTML
-File.open("line_graph.html","w") { |f| f << PAGE }

data/examples/rope_examples/itunes/config/ruport_config.rb DELETED Viewed

@@ -1,8 +0,0 @@
-require "ruport"
-# For details, see Ruport::Config documentation
-Ruport.configure { |c|
-  c.source :default, :user     => "root",
-                     :dsn      =>  "dbi:mysql:mydb"
-  c.log_file "log/ruport.log"
-}

data/examples/rope_examples/sales_report/config/ruport_config.rb DELETED Viewed

@@ -1,8 +0,0 @@
-require "ruport"
-# For details, see Ruport::Config documentation
-Ruport.configure { |c|
-  c.source :default, :user     => "root",
-                     :dsn      =>  "dbi:mysql:mydb"
-  c.log_file "log/ruport.log"
-}

data/lib/ruport/attempt.rb DELETED Viewed

@@ -1,63 +0,0 @@
-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
-          Ruport.log(msg, :level => log_level)
-          @interval += @increment if @increment
-          sleep @interval
-          retry
-       end
-       raise
-    end
-  end
-end

data/lib/ruport/config.rb DELETED Viewed

@@ -1,204 +0,0 @@
-# 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.debug_mode = true
-  #
-  #     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>::      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.
-    # <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
-    # returns true if in debug mode
-    def debug_mode?; !!@debug_mode; end
-    # Verifies that you have provided a DSN for your source.
-    def check_source(settings,label) # :nodoc:
-      unless settings.dsn
-        Ruport.log(
-          "Missing DSN for source #{label}!",
-          :status => :fatal, :level => :log_only,
-          :raises => ArgumentError
-        )
-      end
-    end
-    # Verifies that you have provided a host for your mailer.
-    def check_mailer(settings, label) # :nodoc:
-      unless settings.host
-        Ruport.log(
-          "Missing host for mailer #{label}",
-          :status => :fatal, :level => :log_only,
-          :raises => ArgumentError
-        )
-      end
-    end
-    # forces messages with :level of :log_only to be printed
-    def debug_mode=(something)
-      @debug_mode = !!something
-    end
-    # Allows users to set their own accessors on the Config module
-    def method_missing(meth, *args)
-      @config ||= OpenStruct.new
-      if args.empty? || meth.to_s =~ /.*=/
-        @config.send(meth, *args)
-      else
-        @config.send("#{meth}=".to_sym, *args)
-      end
-    end
-  end
-end

data/lib/ruport/data/groupable.rb DELETED Viewed

@@ -1,93 +0,0 @@
-module Ruport::Data
-  #
-  # === Overview
-  #
-  # This module provides a simple mechanism for grouping objects based on
-  # tags.
-  #
-  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.
-    #
-    # Example:
-    #   table = [['inky',  1],
-    #            ['blinky',2],
-    #            ['pinky', 3],
-    #            ['clyde', 4]].to_table(['name','score'])
-    #
-    #   table[0].tag("grp_winners")
-    #   table[1].tag("grp_losers")
-    #   table[2].tag("grp_winners")
-    #   table[3].tag("grp_losers")
-    #
-    #   r = table.groups
-    #   puts r["winners"]
-    #   => +---------------+
-    #      | name  | score |
-    #      +---------------+
-    #      | inky  |   1   |
-    #      | pinky |   3   |
-    #      +---------------+
-    #
-    #   puts r["losers"]
-    #   => +----------------+
-    #      |  name  | score |
-    #      +----------------+
-    #      | blinky |   2   |
-    #      | clyde  |   4   |
-    #      +----------------+
-    #
-    def groups
-      r_tags = group_names_intern
-      tables_hash = Hash.new { |h,k| h[k] = Table(column_names) }
-      r_tags.each { |t|
-        tables_hash[t.gsub(/^grp_/,"")] = sub_table { |r| r.tags.include? t }}
-      r = Record.new tables_hash, :attributes => group_names
-    end
-    # Gets the names of the groups
-    def group_names
-       group_names_intern.map { |r| r.gsub(/^grp_/,"") }
-    end
-    # Gets a subtable of the rows matching the group name
-    #
-    def group(tag)
-      sub_table { |r| r.tags.include?("grp_#{tag}") }
-    end
-    #
-    # Tags each row of the <tt>Table</tt> for which the <tt>block</tt> is not
-    # false with <tt>label</tt>.
-    #
-    # Example:
-    #   table = [['inky',  1],
-    #            ['blinky',2],
-    #            ['pinky', 3]].to_table(['name','score'])
-    #
-    #   table.create_group(:cool_kids) {|r| r.score > 1}
-    #   groups = table.groups
-    #
-    #   puts groups["cool_kids"]
-    #   => +----------------+
-    #      |  name  | score |
-    #      +----------------+
-    #      | blinky |   2   |
-    #      | pinky  |   3   |
-    #      +----------------+
-    #
-    def create_group(label,&block)
-      each { |r| block[r] && r.tag("grp_#{label}") }
-    end
-    private
-    def group_names_intern
-       map { |r| r.tags.select { |r| r =~ /^grp_/  } }.flatten.uniq
-    end
-  end
-end