ruport 0.7.2 → 0.8.0

data/lib/ruport/format/pdf.rb~

@@ -0,0 +1,189 @@
+module Ruport::Format
+
+  # PDF generation plugin
+  #
+  #  layout options:
+  #     General:
+  #       * paper_size  #=> "LETTER"
+  #       * orientation #=> :center
+  #     
+  #     Table:
+  #       * table_width
+  #       * max_table_width #=> 500
+  #
+  class PDF < Plugin
+    attr_writer :pdf_writer
+    attr_accessor :table_header_proc
+    attr_accessor :table_footer_proc
+
+    def initialize
+      require "pdf/writer"
+      require "pdf/simpletable"
+    end
+
+    def pdf_writer
+      @pdf_writer ||= 
+        ::PDF::Writer.new( :paper => layout.paper_size || "LETTER" )
+    end
+
+    def build_table_header
+       table_header_proc[pdf_writer] if table_header_proc
+    end
+
+    def build_table_body
+      draw_table
+    end
+
+    def build_table_footer
+      table_footer_proc[pdf_writer] if table_footer_proc
+    end
+
+    def finalize_table
+      output << pdf_writer.render
+    end
+
+    def add_text(*args)
+      pdf_writer.text(*args)
+    end
+       
+    # - if the image is bigger than the box, it will be scaled down until it fits
+    # - if the image is smaller than the box it's won't be resized
+    #
+    # arguments:
+    # - x: left bound of box
+    # - y: bottom bound of box
+    # - width: width of box
+    # - height: height of box
+    def center_image_in_box(path, x, y, width, height)
+      info = ::PDF::Writer::Graphics::ImageInfo.new(File.read(path))
+
+      # if the image is larger than the requested box, prepare to
+      # scale it down
+      fits = !(info.width > width || info.height > height)
+
+      # setup initial sizes for the image. These will be reduced as necesary
+      img_width = info.width
+      img_height = info.height
+      img_ratio = info.height.to_f / info.width.to_f
+
+      # reduce the size of the image until it fits into the requested box
+      until fits
+        img_width -= 1
+        img_height = img_width * img_ratio
+        fits = true if img_width < width && img_height < height
+      end
+
+      # if the width of the image is less than the requested box, calculate
+      # the white space buffer
+      if img_width < width
+        white_space = width - img_width
+        x = x + (white_space / 2)
+      end
+
+      # if the height of the image is less than the requested box, calculate
+      # the white space buffer
+      if img_height < height
+        white_space = height - img_height
+        y = y + (white_space / 2)
+      end
+
+      pdf_writer.add_image_from_file(path, x, y, img_width, img_height) 
+    end
+
+    # Draws some text on the canvas, surrounded by a box with rounded corners
+    #
+    def rounded_text_box(text)
+       opts = OpenStruct.new
+       yield(opts)
+       
+       # resize the text automatically to ensure it isn't wider than the box
+       loop do
+         sz = pdf_writer.text_width( text, opts.font_size )
+         opts.x + sz > opts.x + opts.width or break
+         opts.font_size -= 1
+       end
+
+       # save the drawing state (colors, etc) so we can restore it later
+       pdf_writer.save_state
+
+       # draw our box
+       pdf_writer.fill_color(opts.fill_color || Color::RGB::White)
+       pdf_writer.stroke_color(opts.stroke_color || Color::RGB::Black)
+       pdf_writer.rounded_rectangle( opts.x, opts.y, 
+                                     opts.width, opts.height, 
+                                     opts.radius).fill_stroke
+
+       # if a heading for this box has been specified
+       if opts.heading
+         pdf_writer.line( opts.x, opts.y - 20, 
+                          opts.x + opts.width, opts.y - 20).stroke
+         pdf_writer.fill_color(Color::RGB::Black)
+         move_cursor_to(opts.y - 3)
+         add_text("<b>#{opts.heading}</b>", 
+           :absolute_left => opts.x, :absolute_right => opts.x + opts.width,
+           :justification => :center, :font_size => opts.font_size)
+       end
+
+       # restore the original colors
+       pdf_writer.restore_state
+
+       # move our y cursor into position, write the text, then move the cursor
+       # to be just below the box
+       pdf_writer.y = opts.heading ? opts.y - 20 : opts.y
+
+       add_text( text,  :absolute_left  => opts.x,
+                        :absolute_right => opts.x + opts.width,
+                        :justification => opts.justification || :center,
+                        :font_size => opts.font_size )     
+
+       pdf_writer.y = opts.y - opts.height
+    end
+
+    # adds an image to every page. The color and size won't be modified,
+    # but it will be centered.
+    #
+    def watermark(imgpath)
+      x = pdf_writer.absolute_left_margin
+      y = pdf_writer.absolute_bottom_margin
+      width = pdf_writer.absolute_right_margin - x
+      height = pdf_writer.absolute_top_margin - y
+
+      pdf_writer.open_object do |wm|
+        pdf_writer.save_state
+        center_image_in_box(imgpath, x, y, width, height)
+        pdf_writer.restore_state
+        pdf_writer.close_object
+        pdf_writer.add_object(wm, :all_pages)
+      end
+    end
+
+    def move_cursor(n) 
+      pdf_writer.y += n
+    end
+
+    def move_cursor_to(n)
+      pdf_writer.y = n
+    end
+
+    def pad(y,&block)
+      move_cursor -y
+      block.call
+      move_cursor -y
+    end
+
+    def draw_table
+      m = "Sorry, cant build PDFs from array like things (yet)"
+      raise m if data.column_names.empty?
+      ::PDF::SimpleTable.new do |table|
+        table.maximum_width = layout.max_table_width || 500
+        table.width         = layout.table_width if layout.table_width
+        table.orientation   = layout.orientation || :center
+        table.data          = data
+        table.column_order  = data.column_names
+        table.render_on(pdf_writer)
+      end
+    end
+
+
+  end
+end

data/lib/ruport/format/plugin.rb

@@ -8,10 +8,7 @@ module Ruport
   module Format
     class Plugin
 
-      # Shared with renderer
       attr_accessor :layout
-
-      # Shared with renderer
       attr_accessor :data
 
       # Stores a string used for outputting formatted data.
@@ -20,8 +17,6 @@ module Ruport
       end
 
       # Provides a generic OpenStruct for storing plugin options
-      #
-      # This is shared with the renderer object
       def options
         @options ||= OpenStruct.new
       end 

data/lib/ruport/format/svg.rb

@@ -1,6 +1,6 @@
 module Ruport::Format
   class SVG < Plugin
-    
+
     # a hash of Scruffy themes.
     #
     # You can use these by setting layout.theme like this:
@@ -35,18 +35,18 @@ module Ruport::Format
       @graph.title ||= options.title
       @graph.theme = layout.theme if layout.theme
       @graph.point_markers ||= data.column_names
-    end
 
+    end
 
     # Generates an SVG using Scruffy.
     def build_graph
       data.each_with_index do |r,i|
-        add_line(r.data,r.tags[0] || "series #{i+1}")
+        add_line(r.to_a,r.tags.to_a[0] || "series #{i+1}")
       end
 
       output << @graph.render(:size => [layout.width, layout.height])
     end
-   
+    
     # Uses Scruffy::Graph#add to add a new line to the graph.
     #
     # Will use the first tag on a Record as the label if present.

data/lib/ruport/format/xml.rb

@@ -1,8 +1,8 @@
 module Ruport::Format
-  class XML < Plugin #:nodoc:
+  class XML < Plugin
 
     def prepare_graph
-      require_gem "builder"
+      gem "builder"
       @builder = Builder::XmlMarkup.new(:indent => 2)
     end
 
@@ -18,7 +18,7 @@ module Ruport::Format
           }
 
           data.each_with_index { |r,i|
-            label = r.tags[0] || "Region #{i}"
+            label = r.tags.to_a[0] || "Region #{i}"
             cd.row { |data_row|
               data_row.string(label)
               r.each { |e| data_row.number(e) }

data/lib/ruport/generator.rb

@@ -1,5 +1,5 @@
 module Ruport
-  class Generator #:nodoc:
+  class Generator
   extend FileUtils
 
   begin
@@ -14,47 +14,69 @@ module Ruport
     build_directory_structure
     build_init
     build_config
-    build_rakefile
-    build_utils
+    build_utils         
+    build_rakefile  
+    puts "\nSuccessfully generated project: #{proj}"
   end
 
   def self.build_init
-    File.open("#{project}/app/init.rb","w") { |f| f << INIT }
+    m = "#{project}/lib/init.rb" 
+    puts "  #{m}"
+    File.open(m,"w") { |f| f << INIT }
   end
 
   # Generates a trivial rakefile for use with Ruport.
   def self.build_rakefile
-    File.open("#{project}/Rakefile","w") { |f| f << RAKEFILE }
+    m = "#{project}/Rakefile"
+    puts "  #{m}"
+    File.open(m,"w") { |f| f << RAKEFILE }
   end
 
   # Generates the build.rb, sql_exec.rb, and cabinet.rb utilities
-  def self.build_utils
-    File.open("#{project}/util/build.rb","w") { |f| f << BUILD }
-    File.open("#{project}/util/sql_exec.rb","w") { |f| f << SQL_EXEC }
+  def self.build_utils           
+    
+    m = "#{project}/util/build"   
+    puts "  #{m}"
+    File.open(m,"w") { |f| f << BUILD } 
+    chmod(0755, m)
+    
+    m = "#{project}/util/sql_exec"  
+    puts "  #{m}"
+    File.open(m,"w") { |f| f << SQL_EXEC }
+    chmod(0755, m)
   end
 
   # sets up the basic directory layout for a Ruport application
   def self.build_directory_structure
-    mkdir project
-    %w[ test config output data app app/reports 
+    mkdir project        
+    puts "creating directories.."
+    %w[ test config output data lib lib/reports 
         templates sql log util].each do |d|
-      mkdir "#{project}/#{d}"
+      m="#{project}/#{d}" 
+      puts "  #{m}"
+      mkdir(m)
     end
-
-    touch("#{project}/app/reports.rb")
-    touch("#{project}/app/helpers.rb")
+    
+    puts "creating files.."
+    %w[reports helpers].each { |f|
+      m = "#{project}/lib/#{f}.rb"
+      puts "  #{m}"
+      touch(m)
+    }
   end
 
   # Builds a file called config/ruport_config.rb which stores a Ruport::Config
   # skeleton
   def self.build_config
-    File.open("#{project}/config/ruport_config.rb","w") { |f| f << CONFIG }
+    m = "#{project}/config/ruport_config.rb"
+    puts "  #{m}"
+    File.open(m,"w") { |f| f << CONFIG }
   end
 
   # returns the project's name
   def self.project; @project; end
 
-RAKEFILE = <<END_RAKEFILE
+RAKEFILE = <<'END_RAKEFILE'
 begin; require "rubygems"; rescue LoadError; end
 require "rake/testtask"
 
@@ -65,6 +87,14 @@ Rake::TestTask.new do |test|
   test.pattern =  'test/**/test_*.rb'
   test.verbose =  true
 end
+
+task :build do
+  sh "ruby util/build report #{ENV['report']}"
+end
+
+task :run do
+  sh "ruby lib/reports/#{ENV['report']}.rb"
+end
 END_RAKEFILE
 
 CONFIG = <<END_CONFIG
@@ -79,6 +109,8 @@ Ruport.configure { |c|
 END_CONFIG
 
 BUILD = <<'END_BUILD'
+#!/usr/bin/env ruby
+
 require 'fileutils'
 include FileUtils
 
@@ -87,19 +119,19 @@ def format_class_name(string)
 end
 
 unless ARGV.length > 1
-  puts "usage build.rb [command] [options]"
+  puts "usage: build [command] [options]"
   exit
 end
 
 class_name = format_class_name(ARGV[1])
 
-exit if File.exist? "app/reports/#{ARGV[1]}.rb"
+exit if File.exist? "lib/reports/#{ARGV[1]}.rb"
 if ARGV[0].eql? "report"
-  File.open("app/reports.rb", "a") { |f| 
-    f.puts("require \"app/reports/#{ARGV[1]}\"")
+  File.open("lib/reports.rb", "a") { |f| 
+    f.puts("require \"lib/reports/#{ARGV[1]}\"")
   }
 REP = <<EOR
-require "app/init"
+require "lib/init"
 class #{class_name} < Ruport::Report
   
   def prepare
@@ -123,7 +155,7 @@ EOR
 
 TEST = <<EOR
 require "test/unit"
-require "app/reports/#{ARGV[1]}"
+require "lib/reports/#{ARGV[1]}"
 
 class Test#{class_name} < Test::Unit::TestCase
   def test_flunk
@@ -131,13 +163,20 @@ class Test#{class_name} < Test::Unit::TestCase
   end
 end
 EOR
-  File.open("app/reports/#{ARGV[1]}.rb", "w") { |f| f << REP }
-  File.open("test/test_#{ARGV[1]}.rb","w") { |f| f << TEST } 
+  puts "report file: lib/reports/#{ARGV[1]}.rb"
+  File.open("lib/reports/#{ARGV[1]}.rb", "w") { |f| f << REP }
+  puts "test file: test/test_#{ARGV[1]}.rb"
+  puts "class name: #{class_name}" 
+  File.open("test/test_#{ARGV[1]}.rb","w") { |f| f << TEST }  
+else
+  puts "Incorrect usage."
 end
 END_BUILD
 
 SQL_EXEC = <<'END_SQL'
-require "app/init"
+#!/usr/bin/env ruby
+
+require "lib/init"
 
 puts Ruport::Query.new(ARGF.read).result
 END_SQL
@@ -145,12 +184,12 @@ END_SQL
 INIT = <<END_INIT
 begin
   require "rubygems"
-  require_gem "ruport","=#{Ruport::VERSION}"
+  gem "ruport","=#{Ruport::VERSION}"
 rescue LoadError 
   nil
 end
 require "ruport"
-require "app/helpers"
+require "lib/helpers"
 require "config/ruport_config"
 END_INIT
 

data/lib/ruport/mailer.rb

@@ -9,6 +9,7 @@ require "forwardable"
 
 module Ruport
   
+  #
   # === Overview
   #
   # This class uses SMTP to provide a simple mail sending mechanism.
@@ -38,6 +39,7 @@ module Ruport
   class Mailer
     extend Forwardable
    
+    #
     # Creates a new Mailer object. Optionally, you can select a mailer 
     # specified by Ruport::Config.
     #
@@ -56,7 +58,8 @@ module Ruport
     def_delegators( :@mail, :to, :to=, :from, :from=, 
                            :subject, :subject=, :attach, 
                            :text, :text=, :html, :html= )
-
+   
+    # 
     # Sends the message.
     #
     # Example: