ruport 0.7.0 → 0.7.1

data/README

@@ -52,7 +52,7 @@
 #
 # To install ruport via rubygems with all it's dependencies (except DBI):
 #   
-#   sudo gem install ruport
+#   sudo gem install ruport -y
 #
 # To install ruport manually via setup.rb:
 # 
@@ -75,29 +75,32 @@
 #
 # == Data Collection and Manipulation
 # 
-# To begin, your data must be read from its source and stored in Ruports 
-# standard data structures. Ruport::Data::Set, Ruport::Data::Table and 
-# Ruport::Data::Record have further information on how to work with with
+# To begin, your data must be read from its source and stored in Ruport's 
+# standard data structures. Ruport::Data::Table and  Ruport::Data::Record 
+# have further information on how to work with with
 # and store data in ruport.
 #
 # If you wish to retrieve your data using Ruby on Rails and ActiveRecord,
-# Ruport::Reportable has some useful information; To pull your data directly
-# from a database, Ruport::Query will be useful, and to build it manually
-# Array has been extended with a convenience function or two.
+# please see the acts_as_reportable plugin.
 # 
 # == Report Generation
 #
 # Once the data is ready, it can be rendered using a combination of
-# Ruport::Format, Ruport::Format::Engine and Ruport::Format::Plugin. 
-# The engine defines the report type (tablular, invoice, graph, etc), and 
+# Ruport::Renderer and Ruport::Format::Plugin. 
+# The renderer defines the report type (tablular, graph, etc), and 
 # the plugin renders the engine into a final format (PDF, CSV, HTML, SVG). 
-# Engines will often interact with more than one plugin, to allow the same
+# Renderers will often interact with more than one plugin, to allow the same
 # report to be rendered in multiple ways ie. as HTML and a PDF.
 # 
 # To tie these together, a basic DSL is provided by Ruport::Report
 #
 # For further reading and specific examples, please explore the examples/ 
-# directory in the source tree and read the Ruport Cookbook.
+# directory in the source tree.
+#
+# = Bug Reports / Feature Requests
+#
+#  Our Trac is at: http://stonecode.svnrepository.com
+#  You may use the username ruport and password blinky to file tickets
 #
 # = Resources
 #
@@ -106,14 +109,14 @@
 # up to date information.
 #
 # - You can sign up and/or view the archives here:
-#   http://lists.stonecode.org/listinfo.cgi/ruport-stonecode.org
+#   http://stonecode.svnrepository.com/ruport/trac.cgi/browser/trunk/test/test_table.rb
 #
 # 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, RAA, and the new_haven.rb mailing list.  If you would like to
+# Freshmeat, and RAAt.  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:
@@ -122,7 +125,7 @@
 #   - The latest stable API documentation is available at:
 #     http://reporting.stonecode.org/docs
 #
-# There also will be some tutorials on reporting.stonecode.org
+# There also will be some tutorials on rubyreports.org
 #
 # 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
@@ -138,12 +141,6 @@
 #
 #   svn co svn://rubyforge.org//var/svn/ruport/branches/stable
 #
-# Those who would like to become regular contributors will be given write
-# access.  Also, anyone interested in the internal design and project
-# management aspects of Ruport can request to be added to our Trac
-# account.  This is primarily intended for people who are working on the
-#
-#
 # Thanks for checking out Ruport!
 #
 # If you have any questions or concerns, hop on the mailing list and fire away!

data/Rakefile

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

data/examples/invoice.rb

@@ -0,0 +1,132 @@
+module Ruport
+  module Extensions
+    class Invoice < Ruport::Renderer
+
+      include Renderer::Helpers
+
+      def init_options
+        options do |o|
+          o.customer_info ||= ""
+          o.company_info  ||= ""
+          o.comments      ||= ""
+          o.order_info    ||= ""
+          o.title         ||= ""
+        end
+      end
+      
+      def run
+        init_options
+        build [:headers,:body,:footer], :invoice
+        finalize :invoice
+      end
+
+      module InvoiceHelpers
+        def build_company_header
+          @tod = pdf_writer.y
+          text_box(options.company_info)
+        end
+
+        def build_customer_header
+          pdf_writer.y -= 10
+          text_box(options.customer_info)
+        end
+
+        def build_title
+          pdf_writer.y = @tod
+          if options.title
+            pdf_writer.text options.title, :left => 350, 
+            :font_size => layout.title_font_size || 14
+            pdf_writer.y -= 10
+          end
+        end
+
+        def build_order_header
+          if options.order_info
+            text_box(options.order_info, 
+              :position => layout.order_info_position || 350)
+          end
+        end
+
+        def text_box(content,opts={})
+            ::PDF::SimpleTable.new do |table| 
+            table.data = content.to_a.inject([]) do |s,line|
+              s << { "value" => line, }
+            end
+            
+            table.column_order = "value"
+            table.show_headings = false
+            table.show_lines  = :outer
+            table.shade_rows  = :none
+            table.width       = opts[:width] || 200
+            table.orientation = opts[:orientation] || :right
+            table.position = opts[:position] || :left
+            table.font_size = opts[:font_size] || 10
+            table.render_on(pdf_writer)
+          end    
+        end
+      end
+       
+      class PDF < Ruport::Format::PDF
+        
+        include InvoiceHelpers
+        Invoice.add_format self, :pdf
+
+        def build_invoice_headers
+          build_company_header
+          build_customer_header
+          build_title
+          build_order_header
+        end
+        
+        def build_invoice_body
+         
+          pdf_writer.start_page_numbering(500,20,8,:right)
+          pdf_writer.y = 620
+
+          Ruport::Renderer::Table.render_pdf { |r|
+            r.data = data
+            r.plugin.pdf_writer = pdf_writer
+            r.layout.table_width = layout.body_width || 450
+          }
+
+        end
+
+        def build_invoice_footer
+         # footer
+          pdf_writer.open_object do |footer|
+            pdf_writer.save_state
+            pdf_writer.stroke_color! Color::RGB::Black
+            pdf_writer.stroke_style! ::PDF::Writer::StrokeStyle::DEFAULT
+            if options.comments  
+              pdf_writer.y -= 20
+              text_box options.comments, 
+                :position      => layout.comments_position    || 110, 
+                :width         => layout.comments_width       || 400, 
+                :font_size     => layout.comments_font_size   || 14, 
+                :orientation   => layout.comments_orientation
+            end
+            pdf_writer.add_text_wrap( 50, 20, 200, "Generated at " + 
+              Time.now.strftime(options.date_format || "%H:%M %Y-%m-%d"), 8)
+
+            pdf_writer.restore_state
+            pdf_writer.close_object
+            pdf_writer.add_object(footer, :all_pages)
+          end
+          pdf_writer.stop_page_numbering(true, :current)
+        end
+
+        def finalize_invoice
+          output << pdf_writer.render
+        end
+
+      end 
+    end 
+  end  
+end
+
+module Ruport::Report::Invoice
+  def render_invoice(&block)
+    Ruport::Extensions::Invoice.render_pdf(&block)
+  end
+end
+

data/examples/invoice_report.rb

@@ -0,0 +1,29 @@
+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         = "Hey There"
+      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_plotter.rb

@@ -0,0 +1,63 @@
+require "ruport"
+
+class LinePlotter < Ruport::Renderer
+
+  layout do |l|
+    l.line_color   = "green"
+    l.line_width   = 2
+    l.width        = "100%"
+    l.height       = "100%"
+  end
+
+  def run
+    plugin do |p|
+      p.data = get_lines
+      p.render_plot
+    end
+  end
+
+  Line = Struct.new(:x1,:y1,:x2,:y2)
+
+  def get_lines
+    data.map { |r| Line.new( r[0][0],r[0][1],r[1][0],r[1][1] ) }
+  end
+
+end
+
+class SVG < Ruport::Format::Plugin
+
+  def initialize
+    require "builder"
+     @builder = Builder::XmlMarkup.new(:indent => 2)
+  end
+
+  def render_plot
+
+    opts = { :width => layout.width, :height => layout.height,
+             :xmlns => "http://www.w3.org/2000/svg" }
+
+    output << @builder.svg(opts) do |builder|
+      builder.g( :stroke        => layout.line_color,
+                 "stroke-width" => layout.line_width ) do |g|
+        data.each { |r| render_line(r,g) }
+      end
+    end
+
+  end
+
+  def render_line(line,xml_obj)
+    opts = { :x1 => line.x1, :x2 => line.x2,
+             :y1 => line.y1, :y2 => line.y2 }
+    xml_obj.line(opts)
+   end
+
+  LinePlotter.add_format self, :svg
+
+end
+
+puts LinePlotter.render_svg { |r|
+  r.data = [ [ [0,0],     [0,100]   ],
+             [ [0,100],   [100,100] ],
+             [ [100,100], [100,0]   ],
+             [ [100,0],   [0,0]     ] ]
+}

data/lib/ruport.rb

@@ -12,7 +12,7 @@
 
 module Ruport
   
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
   
   #
   # This method is Ruport's logging and error interface. It can generate 

data/lib/ruport/format/csv.rb

@@ -17,7 +17,7 @@ module Ruport::Format
 
     # Calls build_csv_row for each row in the Data::Table
     def build_table_body
-      data.map { |r| build_csv_row(r) }.join("\n")
+      data.each { |r| build_csv_row(r) }
     end
 
     # Produces CSV output for a data row.

data/test/unit.log

@@ -257,3 +257,21 @@ F, [2006-12-25T12:16:59.960464 #2969] FATAL -- : no block given!
 W, [2006-12-25T12:17:00.167594 #2969]  WARN -- : Error on attempt # 1: ; retrying
 W, [2006-12-25T12:17:01.164421 #2969]  WARN -- : Error on attempt # 2: ; retrying
 W, [2006-12-25T12:17:02.572305 #2969]  WARN -- : Error on attempt # 1: ; retrying
+F, [2006-12-25T13:08:12.541594 #3379] FATAL -- : Missing host for mailer bar
+F, [2006-12-25T13:08:12.542918 #3379] FATAL -- : Missing DSN for source foo!
+F, [2006-12-25T13:08:12.946874 #3379] FATAL -- : no block given!
+W, [2006-12-25T13:08:13.152682 #3379]  WARN -- : Error on attempt # 1: ; retrying
+W, [2006-12-25T13:08:14.152472 #3379]  WARN -- : Error on attempt # 2: ; retrying
+W, [2006-12-25T13:08:16.157324 #3379]  WARN -- : Error on attempt # 1: execution expired; retrying
+F, [2007-01-18T01:47:24.338302 #2551] FATAL -- : Missing host for mailer bar
+F, [2007-01-18T01:47:24.361525 #2551] FATAL -- : Missing DSN for source foo!
+F, [2007-01-18T01:47:25.244275 #2551] FATAL -- : no block given!
+W, [2007-01-18T01:47:25.851688 #2551]  WARN -- : Error on attempt # 1: ; retrying
+W, [2007-01-18T01:47:26.849615 #2551]  WARN -- : Error on attempt # 2: ; retrying
+W, [2007-01-18T01:47:28.854434 #2551]  WARN -- : Error on attempt # 1: execution expired; retrying
+F, [2007-01-18T12:45:33.550978 #3525] FATAL -- : Missing host for mailer bar
+F, [2007-01-18T12:45:33.552282 #3525] FATAL -- : Missing DSN for source foo!
+F, [2007-01-18T12:45:33.921435 #3525] FATAL -- : no block given!
+W, [2007-01-18T12:45:34.086657 #3525]  WARN -- : Error on attempt # 1: ; retrying
+W, [2007-01-18T12:45:35.085521 #3525]  WARN -- : Error on attempt # 2: ; retrying
+W, [2007-01-18T12:45:37.090298 #3525]  WARN -- : Error on attempt # 1: execution expired; retrying

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ruport
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
-date: 2006-12-25 00:00:00 -05:00
+  version: 0.7.1
+date: 2007-01-18 00:00:00 -05:00
 summary: A generalized Ruby report generation and templating engine.
 require_paths: 
 - lib
@@ -30,46 +30,47 @@ authors:
 - Gregory Brown
 files: 
 - examples/pdf_complex_report.rb
-- examples/line_graph_report.rb~
-- examples/line_graph_report.rb.rej
+- examples/line_plotter.rb
+- examples/invoice.rb
+- examples/invoice_report.rb
 - lib/ruport
-- lib/uport.rb
 - lib/ruport.rb
+- lib/uport.rb
 - lib/ruport.rb~
 - lib/ruport/query
 - lib/ruport/format
 - lib/ruport/data
 - lib/ruport/report
+- lib/ruport/renderer
+- lib/ruport/data.rb
 - lib/ruport/system_extensions.rb
 - lib/ruport/config.rb
 - lib/ruport/query.rb
 - lib/ruport/layout.rb
-- lib/ruport/renderer
-- lib/ruport/data.rb
+- lib/ruport/layout
 - lib/ruport/mailer.rb
 - lib/ruport/report.rb
 - lib/ruport/attempt.rb
 - lib/ruport/data.rb~
 - lib/ruport/data.rb.rej
 - lib/ruport/generator.rb
-- lib/ruport/layout
 - lib/ruport/format.rb
 - lib/ruport/renderer.rb
 - lib/ruport/query/sql_split.rb
-- lib/ruport/format/latex.rb
 - lib/ruport/format/plugin.rb
+- lib/ruport/format/latex.rb
 - lib/ruport/format/svg.rb
 - lib/ruport/format/xml.rb
 - lib/ruport/format/html.rb
 - lib/ruport/format/text.rb
 - lib/ruport/format/pdf.rb
 - lib/ruport/format/csv.rb
+- lib/ruport/data/collection.rb
 - lib/ruport/data/record.rb
 - lib/ruport/data/taggable.rb
 - lib/ruport/data/table.rb
-- lib/ruport/data/collection.rb
-- lib/ruport/data/set.rb
 - lib/ruport/data/groupable.rb
+- lib/ruport/data/set.rb
 - lib/ruport/data/table.rb~
 - lib/ruport/data/table.rb.rej
 - lib/ruport/data/record.rb~
@@ -78,32 +79,32 @@ files:
 - lib/ruport/renderer/table.rb
 - lib/ruport/layout/component.rb
 - test/samples
+- test/test_collection.rb
 - test/test_record.rb
 - test/test_table.rb
 - test/test_renderer.rb
 - test/test_ruport.rb
-- test/test_collection.rb
+- test/test_query.rb
 - test/test_set.rb
-- test/test_groupable.rb
 - test/test_graph_renderer.rb
+- test/test_groupable.rb
+- test/test_table_renderer.rb
 - test/_test_database.rb
-- test/test_query.rb
 - test/test_config.rb
 - test/test_text_table.rb
 - test/test_taggable.rb
 - test/test_mailer.rb
 - test/test_sql_split.rb
 - test/test_report.rb
-- test/test_table_renderer.rb
 - test/unit.log
 - test/test_record.rb.rej
 - test/test_table.rb~
 - test/test_query.rb~
 - test/test_query.rb.rej
-- test/samples/test.yaml
 - test/samples/query_test.sql
-- test/samples/data.csv
+- test/samples/test.yaml
 - test/samples/erb_test.sql
+- test/samples/data.csv
 - test/samples/stonecodeblog.sql
 - test/samples/ruport_test.sql
 - test/samples/addressbook.csv
@@ -120,22 +121,22 @@ files:
 - TODO
 - AUTHORS
 test_files: 
+- test/test_collection.rb
 - test/test_record.rb
 - test/test_table.rb
 - test/test_renderer.rb
 - test/test_ruport.rb
-- test/test_collection.rb
+- test/test_query.rb
 - test/test_set.rb
-- test/test_groupable.rb
 - test/test_graph_renderer.rb
-- test/test_query.rb
+- test/test_groupable.rb
+- test/test_table_renderer.rb
 - test/test_config.rb
 - test/test_text_table.rb
 - test/test_taggable.rb
 - test/test_mailer.rb
 - test/test_sql_split.rb
 - test/test_report.rb
-- test/test_table_renderer.rb
 rdoc_options: 
 - --title
 - Ruport Documentation

data/examples/line_graph_report.rb.rej

@@ -1,15 +0,0 @@
-***************
-*** 19,24 ****
-    end
-  end
-  
-- GraphSample.run { |r| puts r.write }
-  
-  
---- 19,24 ----
-    end
-  end
-  
-+ GraphSample.run(:tries => 3, :timeout => 1) { |r| sleep 2; puts r.results }
-  
-  

data/examples/line_graph_report.rb~

@@ -1,23 +0,0 @@
-require "ruport"
-class GraphSample < Ruport::Report
-  
-  include Graph
-
-  prepare do
-    @data = [[5,7,9,12,14,16,18]].to_table(%w[jan feb mar apr may jun jul])
-  end
-
-  generate do
-    render_graph do |g|
-      g.data   = @data
-      g.width  = 700
-      g.height = 500
-      g.title  = "A Simple Line Graph"
-      g.style  = :line
-    end
-  end
-end
-
-GraphSample.run { |r| puts r.results }
-
-