RubyGems - jsanders-ruport - Versions diffs - 1.7.1 - Mend

jsanders-ruport 1.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (76) hide show

data/AUTHORS +48 -0
data/LICENSE +59 -0
data/README +114 -0
data/Rakefile +93 -0
data/examples/RWEmerson.jpg +0 -0
data/examples/anon.rb +43 -0
data/examples/btree/commaleon/commaleon.rb +263 -0
data/examples/btree/commaleon/sample_data/ticket_count.csv +124 -0
data/examples/btree/commaleon/sample_data/ticket_count2.csv +119 -0
data/examples/centered_pdf_text_box.rb +83 -0
data/examples/data/tattle.dump +82 -0
data/examples/example.csv +3 -0
data/examples/line_plotter.rb +61 -0
data/examples/pdf_report_with_common_base.rb +72 -0
data/examples/png_embed.rb +54 -0
data/examples/roadmap.png +0 -0
data/examples/row_renderer.rb +39 -0
data/examples/simple_pdf_lines.rb +25 -0
data/examples/simple_templating_example.rb +34 -0
data/examples/tattle_ruby_version.rb +39 -0
data/examples/tattle_rubygems_version.rb +37 -0
data/examples/trac_ticket_status.rb +59 -0
data/lib/ruport.rb +127 -0
data/lib/ruport/controller.rb +616 -0
data/lib/ruport/controller/grouping.rb +71 -0
data/lib/ruport/controller/table.rb +54 -0
data/lib/ruport/data.rb +4 -0
data/lib/ruport/data/feeder.rb +111 -0
data/lib/ruport/data/grouping.rb +399 -0
data/lib/ruport/data/record.rb +297 -0
data/lib/ruport/data/table.rb +950 -0
data/lib/ruport/extensions.rb +4 -0
data/lib/ruport/formatter.rb +254 -0
data/lib/ruport/formatter/csv.rb +149 -0
data/lib/ruport/formatter/html.rb +161 -0
data/lib/ruport/formatter/pdf.rb +591 -0
data/lib/ruport/formatter/template.rb +187 -0
data/lib/ruport/formatter/text.rb +231 -0
data/lib/uport.rb +1 -0
data/test/controller_test.rb +743 -0
data/test/csv_formatter_test.rb +164 -0
data/test/data_feeder_test.rb +88 -0
data/test/grouping_test.rb +410 -0
data/test/helpers.rb +11 -0
data/test/html_formatter_test.rb +201 -0
data/test/pdf_formatter_test.rb +354 -0
data/test/record_test.rb +332 -0
data/test/samples/addressbook.csv +6 -0
data/test/samples/data.csv +3 -0
data/test/samples/data.tsv +3 -0
data/test/samples/dates.csv +1409 -0
data/test/samples/erb_test.sql +1 -0
data/test/samples/query_test.sql +1 -0
data/test/samples/ruport_test.sql +8 -0
data/test/samples/test.sql +2 -0
data/test/samples/test.yaml +3 -0
data/test/samples/ticket_count.csv +124 -0
data/test/table_pivot_test.rb +134 -0
data/test/table_test.rb +838 -0
data/test/template_test.rb +48 -0
data/test/text_formatter_test.rb +258 -0
data/util/bench/data/record/bench_as_vs_to.rb +18 -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 +176 -0

data/examples/pdf_report_with_common_base.rb ADDED Viewed

@@ -0,0 +1,72 @@
+#################################################################
+# This example shows how to build custom PDF output with Ruport #
+# that shares some common elements between reports.  Basically, #
+# CompanyPDFBase implements some default rendering options,     #
+# and derived classes such as ClientPDF would implement the     #
+# stuff specific to a given report.                             #
+#################################################################
+require "ruport"
+# only used for the titleize call in ClientController#setup
+# tweak as needed if you don't want to install AS.
+require "active_support"
+# This looks a little more messy than usual, but it addresses the
+# concern of wanting to have a standard template for reports.
+#
+class ClientController < Ruport::Controller
+  prepare :standard_report
+  stage :company_header, :client_header, :client_body, :client_footer
+  finalize :standard_report
+  def setup
+    data.rename_columns { |c| c.to_s.titleize }
+  end
+end
+# This defines the base PDF output, you'd do similar for other
+# formats if needed. It implements the common hooks that will be used
+# across the company's reports.
+#
+class CompanyPDFBase < Ruport::Formatter::PDF
+  def prepare_standard_report
+    # defaults to US Letter, but this overrides
+    options.paper_size = "A4"
+  end
+  def build_company_header
+    add_text "This would be my company header",
+             :justification => :center, :font_size => 14
+  end
+  def finalize_standard_report
+    render_pdf
+  end
+end
+#  This is actual report's formatter
+#
+#  It implements the remaining hooks the standard formatter didn't
+#  Notice the footer is not implemented and it doesn't complain.
+#
+class ClientPDF < CompanyPDFBase
+  renders :pdf, :for => ClientController
+  def build_client_header
+   pad(10) do
+    add_text "Specific Report Header with example=#{options.example}",
+             :justification => :center, :font_size => 12
+   end
+  end
+  def build_client_body
+    draw_table(data, :width => 300)
+  end
+end
+table = Table([:a,:b,:c]) << [1,2,3] << [4,5,6]
+File.open("example.pdf","w") do |f|
+  f << ClientController.render_pdf(:data => table,:example => "apple")
+end

data/examples/png_embed.rb ADDED Viewed

@@ -0,0 +1,54 @@
+require "rubygems"
+require "ruport"
+class RoadmapController < Ruport::Controller
+  stage :roadmap_image, :roadmap_text_body
+  finalize :roadmap
+end
+class HTMLRoadmap < Ruport::Formatter
+  renders :html, :for => RoadmapController
+  def layout
+     output << "<html><body>\n"
+     yield
+     output << "</body></html>\n"
+  end
+  def build_roadmap_image
+    output << "<img src='#{options.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 => RoadmapController
+  def build_roadmap_image
+    center_image_in_box options.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|
+  RoadmapController.render(format, :image_file => "roadmap.png",
+                                 :file => "roadmap.#{format}")
+end

data/examples/roadmap.png ADDED Viewed

Binary file

data/examples/row_renderer.rb ADDED Viewed

@@ -0,0 +1,39 @@
+require "ruport"
+class CSV2Something < Ruport::Controller
+  required_option :csv_file
+  stage :table_body
+  module Helpers
+    def table_feeder
+      Table(options.csv_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(:csv_file => "example.csv",:io => STDOUT)

data/examples/simple_pdf_lines.rb ADDED Viewed

@@ -0,0 +1,25 @@
+require "ruport"
+# draws pretty little lines all over the place on a PDF
+class SimpleLines < Ruport::Controller
+  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/examples/simple_templating_example.rb ADDED Viewed

@@ -0,0 +1,34 @@
+require "ruport"
+Ruport::Formatter::Template.create(:simple) do |format|
+  format.page = {
+    :size   => "LETTER",
+    :layout => :landscape
+  }
+  format.text = {
+    :font_size => 16
+  }
+  format.table = {
+    :font_size      => 16,
+    :show_headings  => false
+  }
+  format.column = {
+    :alignment => :center,
+  }
+  format.heading = {
+    :alignment => :right
+  }
+  format.grouping = {
+    :style => :separated
+  }
+end
+Ruport::Formatter::Template.create(:derived, :base => :simple) do |t|
+  t.table_format[:show_headings] = true
+end
+t = Table(%w[a b c]) << [1,2,3] << [1,"hello",6] << [2,3,4]
+g = Grouping(t, :by => "a")
+puts g.to_pdf(:template => :simple)
+#puts g.to_pdf(:template => :derived)

data/examples/tattle_ruby_version.rb ADDED Viewed

@@ -0,0 +1,39 @@
+# A dump of the database for this example can be found in ./data/tattle.dump
+require "active_record"
+require "ruport"
+# Update with your connection parameters
+ActiveRecord::Base.establish_connection(
+    :adapter  => 'mysql',
+    :host     => 'localhost',
+    :username => 'root',
+    :database => 'tattle')
+class Report < ActiveRecord::Base
+  acts_as_reportable
+end
+table = Report.report_table(:all,
+  :only       => %w[host_os ruby_version user_key],
+  :conditions => "user_key is not null and user_key <> ''",
+  :group      => "host_os, ruby_version, user_key")
+grouping = Grouping(table, :by => "host_os")
+ruby_versions = Table(%w[platform ruby_version count])
+grouping.each do |name,group|
+  Grouping(group, :by => "ruby_version").each do |vname,group|
+    ruby_versions << { "platform"         => name,
+                       "ruby_version"     => vname,
+                       "count"            => group.length }
+  end
+end
+sorted_table = ruby_versions.sort_rows_by { |r| -r.count }
+g = Grouping(sorted_table, :by => "platform")
+File.open("platforms_ruby.html", "w") do |f|
+  f.write g.to_html(:style => :justified)
+end

data/examples/tattle_rubygems_version.rb ADDED Viewed

@@ -0,0 +1,37 @@
+# A dump of the database for this example can be found in ./data/tattle.dump
+require "active_record"
+require "ruport"
+# Update with your connection parameters
+ActiveRecord::Base.establish_connection(
+    :adapter  => 'mysql',
+    :host     => 'localhost',
+    :username => 'root',
+    :database => 'tattle')
+class Report < ActiveRecord::Base
+  acts_as_reportable
+end
+table = Report.report_table(:all,
+  :only       => %w[host_os rubygems_version user_key],
+  :conditions => "user_key is not null and user_key <> ''",
+  :group      => "host_os, rubygems_version, user_key")
+grouping = Grouping(table, :by => "host_os")
+rubygems_versions = Table(%w[platform rubygems_version count])
+grouping.each do |name,group|
+  Grouping(group, :by => "rubygems_version").each do |vname,group|
+    rubygems_versions << { "platform"         => name,
+                           "rubygems_version" => vname,
+                           "count"            => group.length }
+  end
+end
+sorted_table = rubygems_versions.sort_rows_by("count", :order => :descending)
+sorted_table.reduce { |r| r["platform"] !~ /darwin/i }
+g = Grouping(sorted_table, :by => "platform", :order => "name")
+puts g.to_pdf

data/examples/trac_ticket_status.rb ADDED Viewed

@@ -0,0 +1,59 @@
+ %w[ruport hpricot open-uri].each { |lib| require lib }
+class TracSummaryReport
+  include Ruport::Controller::Hooks
+  renders_as_table
+  def initialize(options={})
+    @days = options[:days] || 7
+    @timeline_uri = options[:timeline_uri]
+  end
+  class TicketStatus < Ruport::Data::Record
+    def closed
+      title =~ /Ticket.+(\w+ closed)/ ? 1 : 0
+    end
+    def opened
+      title =~ /Ticket.+(\w+ created)|(\w+ reopened)/ ? 1 : 0
+    end
+  end
+  def feed_data
+    uri = @timeline_uri + "?wiki=on&milestone=on&ticket=on&changeset=on"+
+     "&max=10000&daysback=#{@days-1}&format=rss"
+    feed = Hpricot(open(uri))
+    table = Table([:title, :date], :record_class => TicketStatus) do |table|
+      (feed/"item").each do |r|
+         title = (r/"title").innerHTML
+         next unless title =~ /Ticket.*(created|closed|reopened)/
+         table <<  { :title => title,
+                     :date  => Date.parse((r/"pubdate").innerHTML) }
+       end
+    end
+    Grouping(table,:by => :date)
+  end
+  def renderable_data(format)
+    summary = feed_data.summary :date,
+      :opened => lambda { |g| g.sigma { |r| r.opened  } },
+      :closed => lambda { |g| g.sigma { |r| r.closed  } },
+      :order => [:date,:opened,:closed]
+    summary.sort_rows_by! { |r| r.date }
+    return summary
+  end
+end
+timeline = "http://stonecode.svnrepository.com/ruport/trac.cgi/timeline"
+report = TracSummaryReport.new(:timeline_uri => timeline, :days => 30)
+puts report.as(:text)

data/lib/ruport.rb ADDED Viewed

@@ -0,0 +1,127 @@
+# ruport.rb : Ruby Reports top level module
+#
+# Author: Gregory T. Brown (gregory.t.brown at gmail dot com)
+#
+# Copyright (c) 2005-2007, 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
+#
+if RUBY_VERSION > "1.9"
+  require "csv"
+  unless defined? FCSV
+    class Object
+      FCSV = CSV
+      alias_method :FCSV, :CSV
+    end
+  end
+end
+module Ruport #:nodoc:#
+  VERSION = "1.7.0"
+  class FormatterError < RuntimeError #:nodoc:
+  end
+  # SystemExtensions lovingly ganked from HighLine 1.2.1
+  #
+  # The following modifications have been made by Gregory Brown on 2006.06.25
+  #
+  # - Outer Module is changed from HighLine to Ruport
+  # - terminal_width / terminal_height added
+  #
+  # The following modifications have been made by Gregory Brown on 2006.08.13
+  # - removed most methods, preserving only terminal geometry features
+  #
+  # All modifications are under the distributions terms of Ruport.
+  # Copyright 2006, Gregory Brown.  All Rights Reserved
+  #
+  # Original copyright notice preserved below.
+  # --------------------------------------------------------------------------
+  #
+  #  Created by James Edward Gray II on 2006-06-14.
+  #  Copyright 2006 Gray Productions. All rights reserved.
+  #
+  #  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 = if /solaris/ =~ RUBY_PLATFORM
+          output = `stty`
+          [output.match('columns = (\d+)')[1].to_i,
+          output.match('rows = (\d+)')[1].to_i]
+        else
+           `stty size`.split.map { |x| x.to_i }.reverse
+        end
+        return $? == 0 ? size : [80,24]
+      end
+   end
+   def terminal_width
+     terminal_size.first
+   end
+  end
+  # quiets warnings for block
+  def quiet #:nodoc:
+    warns = $VERBOSE
+    $VERBOSE = nil
+    result = yield
+    $VERBOSE = warns
+    return result
+  end
+  module_function :quiet
+end
+require "enumerator"
+require "ruport/controller"
+require "ruport/data"
+require "ruport/formatter"
+begin
+  if Object.const_defined? :ActiveRecord
+    require "ruport/acts_as_reportable"
+  end
+rescue LoadError
+  nil
+end