ruport 0.7.2 → 0.8.0

data/AUTHORS

@@ -40,6 +40,10 @@ Marshall T. Vandegrift:
 Stefan Mahlitz:
  - Table#sort_rows_by
 
-Mike Milner:
- - mock object for Mailer
- - mock objects for Report (#130)
+Michael Milner
+ - Refactoring for Table#column_names= (r436)
+ - Mock object for Mailer
+ - Mock object for Report (#130)
+
+Chris Carter
+ - Table#remove_columns (r440)

data/Rakefile

@@ -23,7 +23,7 @@ end
 
 spec = Gem::Specification.new do |spec|
 	spec.name = LEAN ? "lean-ruport" : "ruport"
-	spec.version = "0.7.2"
+	spec.version = "0.8.0"
 	spec.platform = Gem::Platform::RUBY
 	spec.summary = "A generalized Ruby report generation and templating engine."
 	spec.files =  Dir.glob("{examples,lib,test,bin}/**/**/*") +
@@ -39,10 +39,10 @@ spec = Gem::Specification.new do |spec|
 	spec.rdoc_options << '--title' << 'Ruport Documentation' <<
 	                     '--main'  << 'README' << '-q'
   unless LEAN
-    spec.add_dependency('fastercsv', '>= 0.1.0')
-    spec.add_dependency('RedCloth',  '>= 3.0.0')
+    spec.add_dependency('fastercsv', '>= 1.1.0')
+    spec.add_dependency('RedCloth',  '>= 3.0.4')
     spec.add_dependency('pdf-writer', '>= 1.1.3')
-    spec.add_dependency("mailfactory", ">= 1.2.2")
+    spec.add_dependency("mailfactory", ">= 1.2.3")
     spec.add_dependency('scruffy', '>= 0.2.2')
   end
   spec.author = "Gregory Brown"
@@ -50,16 +50,15 @@ spec = Gem::Specification.new do |spec|
 	spec.rubyforge_project = "ruport"
 	spec.homepage = "http://reporting.stonecode.org"
 	spec.description = <<END_DESC
-Ruport is a powerful report generation engine that allows users to generate
-custom ERb templates and easily query various forms of SQL databases via DBI.
-It provides helper methods and utilities to generate professional reports
-quickly and cleanly. 
+  Ruby Reports is a software library that aims to make the task of reporting
+  less tedious and painful. It provides tools for data acquisition,
+  database interaction, formatting, and parsing/munging.
 END_DESC
 end
 
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include( "README",
-                           "TODO", "CHANGELOG",
+                           "TODO", #"CHANGELOG",
                            "AUTHORS", "COPYING",
                            "LICENSE", "lib/" )
   rdoc.main     = "README"

data/TODO

@@ -1,5 +1,21 @@
 = TODO
 
+--
+
+ * fix whitespace
+
+ * table should have record_class constructor
+
+ * logging in util/build.rb?
+
+ * Table#add_row ?
+
+ * Table#col_merge
+
+ * Table#join
+
+--
+
 - Any future plans are available on Ruport's Trac website
   
   http://stonecode.svnrepository.com/ruport/trac.cgi

data/examples/centered_pdf_text_box.rb

@@ -0,0 +1,66 @@
+require "ruport"                             
+
+class Document < Ruport::Renderer
+  
+  include Ruport::Renderer::Helpers
+  
+  required_option :text
+  required_option :author
+  option :heading
+
+  stage :document_body
+  finalize :document                            
+end
+
+
+class CenteredPDFTextBox < Ruport::Format::PDF
+
+  Document.add_format self, :pdf
+
+  def build_document_body
+
+    add_text "-- " << options.author << " --",
+             :justification => :center, :font_size => 20 
+    
+    
+    c = pdf_writer.absolute_x_middle - 239/2
+    
+    #img,x,y,width,height
+    center_image_in_box("RWEmerson.jpg",c,325,239,359)
+ 
+    rounded_text_box(options.text) do |o|
+       o.radius = 5
+       o.width     = layout.width  || 400
+       o.height    = layout.height || 130
+       o.font_size = layout.font_size || 12
+       o.heading   = options.heading
+       
+       o.x = pdf_writer.absolute_x_middle - o.width/2
+       o.y = 300
+    end         
+
+  end
+  
+  def finalize_document
+    output << pdf_writer.render
+  end
+end
+
+a = Document.render_pdf { |r|
+  r.heading = "a good quote"
+  r.author  = "Ralph Waldo Emerson"
+  r.text = <<EOS
+A foolish consistency is the hobgoblin of little minds, adored by little
+statesmen and philosophers and divines. With consistency a great soul has simply
+nothing to do. He may as well concern himself with his shadow on the wall. Speak
+what you think now in hard words and to-morrow speak what to-morrow thinks in
+hard words again, though it contradict every thing you said to-day.--"Ah, so you
+shall be sure to be misunderstood."--Is it so bad then to be misunderstood?
+Pythagoras was misunderstood, and Socrates, and Jesus, and Luther, and
+Copernicus, and Galileo, and Newton, and every pure and wise spirit that ever
+took flesh. To be great is to be misunderstood. . . .
+EOS
+
+}
+
+puts a

data/examples/invoice.rb

@@ -3,22 +3,18 @@ module Ruport
     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
+               
+      required_option :customer_info
+      required_option :company_info
+      required_option :order_info
+      option :title
+      required_option :comments
       
-      def run
-        init_options
-        build [:headers,:body,:footer], :invoice
-        finalize :invoice
-      end
+      stage :invoice_headers
+      stage :invoice_body
+      stage :invoice_footer
+      
+      finalize :invoice
 
       module InvoiceHelpers
         def build_company_header
@@ -27,23 +23,37 @@ module Ruport
         end
 
         def build_customer_header
-          pdf_writer.y -= 10
+          move_cursor -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
+          add_title(options.title) if options.title
         end
+        
+        def add_title( title )  
+          rounded_text_box("<b>#{title}</b>") do |o|
+            o.fill_color = Color::RGB::Gray80
+            o.radius    = 5  
+            o.width     = layout.header_width || 200
+            o.height    = layout.header_height || 20
+            o.font_size = layout.header_font_size || 11
+            o.x         = pdf_writer.absolute_right_margin - o.width 
+            o.y         = pdf_writer.absolute_top_margin
+          end
+        end      
 
         def build_order_header
           if options.order_info
-            text_box(options.order_info, 
-              :position => layout.order_info_position || 350)
+            rounded_text_box("<b>#{options.order_info}</b>") do |o|
+              o.radius    = 5  
+              o.heading   = "Billing Information"
+              o.width     = layout.header_width || 200
+              o.height    = layout.header_height || 80
+              o.font_size = layout.header_font_size || 10
+              o.x         = pdf_writer.absolute_right_margin - o.width 
+              o.y         = pdf_writer.absolute_top_margin - 25
+            end 
           end
         end
 
@@ -81,7 +91,7 @@ module Ruport
         def build_invoice_body
          
           pdf_writer.start_page_numbering(500,20,8,:right)
-          pdf_writer.y = 620
+          pdf_writer.y = 550
 
           Ruport::Renderer::Table.render_pdf { |r|
             r.data = data

data/examples/invoice_report.rb

@@ -14,7 +14,7 @@ class SampleReport < Ruport::Report
         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"
+        o.title         = "Invoice for 12.15.2006 - 12.31.2006"
       end
 
       i.layout do |lay|

data/examples/line_plotter.rb

@@ -28,7 +28,7 @@ class SVG < Ruport::Format::Plugin
 
   def initialize
     require "builder"
-     @builder = Builder::XmlMarkup.new(:indent => 2)
+    @builder = Builder::XmlMarkup.new(:indent => 2)
   end
 
   def render_plot

data/examples/pdf_table_with_title.rb

@@ -0,0 +1,42 @@
+require "ruport"
+
+class TitledPDFTable < Ruport::Format::PDF
+
+  Ruport::Renderer::Table.add_format self, :titled_pdf
+  
+  def add_title( title )  
+    rounded_text_box("<b>#{title}</b>") do |o|
+      o.fill_color = Color::RGB::Gray80
+      o.radius    = 5  
+      o.width     = layout.header_width || 200
+      o.height    = layout.header_height || 20
+      o.font_size = layout.header_font_size || 12
+      o.x         = pdf_writer.absolute_right_margin - o.width 
+      o.y         = pdf_writer.absolute_top_margin
+    end
+  end      
+
+  def prepare_table
+    layout.header_margin ||= 50
+  end
+
+  def build_table_header
+    add_title options.title
+    move_cursor -layout.header_margin 
+  end
+
+end
+
+
+a = Ruport::Renderer::Table.render_titled_pdf { |r|
+  r.options.title = "This is a sample header"
+  r.data = Table(%w[a b]) { |t| t << [1,2] << [3,4] }
+  # NOTE: uncomment some options to play with layout
+  r.layout do |la|
+  #  la.header_margin = 25
+  #  la.header_width = 250
+  #  la.header_height = 50
+  end
+}
+
+puts a

data/lib/ruport.rb

@@ -9,9 +9,10 @@
 #
 # See LICENSE and COPYING for details
 #
+
 module Ruport
   
-  VERSION = "0.7.2"
+  VERSION = "0.8.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 
@@ -45,13 +46,10 @@ module Ruport
       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[:exception] || RuntimeError, message) 
+      raise(options[:raises] || RuntimeError, message) 
     end
-  end
- 
-  # Alias for <tt>Ruport.log</tt>.
-  def self.complain(*args); Ruport.log(*args) end
-  
+  end 
+
   # This method yields a <tt>Ruport::Config</tt> object, allowing you to 
   # set the configuration options for your application.
   #

data/lib/ruport.rb.rej

@@ -0,0 +1,41 @@
+***************
+*** 9,20 ****
+  #
+  # See LICENSE and COPYING for details
+  #
+- 
+  module Ruport
+    
+    VERSION = "0.7.2"
+    
+-   #
+    # 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>.
+--- 9,18 ----
+  #
+  # See LICENSE and COPYING for details
+  #
+  module Ruport
+    
+    VERSION = "0.7.2"
+    
+    # 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>.
+***************
+*** 54,60 ****
+    # Alias for <tt>Ruport.log</tt>.
+    def self.complain(*args); Ruport.log(*args) end
+    
+-   #
+    # This method yields a <tt>Ruport::Config</tt> object, allowing you to 
+    # set the configuration options for your application.
+    #
+--- 52,57 ----
+    # Alias for <tt>Ruport.log</tt>.
+    def self.complain(*args); Ruport.log(*args) end
+    
+    # This method yields a <tt>Ruport::Config</tt> object, allowing you to 
+    # set the configuration options for your application.
+    #

data/lib/ruport.rb~

@@ -0,0 +1,85 @@
+# ruport.rb : Ruby Reports top level module
+#
+# 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
+#
+
+module Ruport
+  
+  VERSION = "0.7.99"
+  
+  #
+  # 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:
+  #
+  # <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>:exception</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.
+  #
+  # Example: 
+  #
+  #   Ruport.configure do |c|
+  #
+  #     c.source :default, 
+  #              :dsn => "dbi:mysql:foo",
+  #              :user => "clyde", 
+  #              :password => "pman"
+  #
+  #     c.mailer :default, 
+  #              :host => "mail.example.com", 
+  #              :address => "inky@example.com"
+  #
+  #   end
+  #
+  def self.configure(&block)
+    block.call(Ruport::Config)
+  end
+end
+
+require "ruport/attempt" 
+require "ruport/config" 
+require "ruport/data" 
+require "ruport/report" 
+require "ruport/format" 
+require "ruport/query" 
+require "ruport/mailer"
+require "ruport/layout"
+require "ruport/renderer"